A New Template System

Forum Attachments

Summary:

I have set up the framework for a new template system

A New Template System

GoVegan 09 May 2008 14:52

Hello everybody,

I have just set up the framework for a new template system, which should supersede the current template system if we all like the concept.

I have put it all in a sandbox category, because it was under construction, and is yet to be liked before its integration.

What I'm hoping to do is replace all of that code in the templates "program", "routine" and "command" with the template code. This makes the pages much easier to understand and comprehend when looking at the source code, as well as using less bytes on repeated parts.

How it works is that it doesn't display variables that equal @@, and displays only the ones that you have typed in. The only problem with it is that you can't seem to use three consecutive square brackets (which is used for internal links). However, this is easily countered by a full URL within a single pair of square brackets.

What do you guys think of the proposal?

Cheers ~ James Kanjo

PS. I can't use the computer tomorrow, so I'll make the new logo version the day after…sorry krazyness and Weregoose!

Last edited on 16 May 2008 10:17 by GoVegan Show more

Re: A New Template System

GoVegan 10 May 2008 13:19

Seeing as there are no comments so far, I thought I might explain it a bit more.

Basically, the new template system I constructed turns a code like this:

[[div style="float:right; width: 16em; padding: 1em 1em 0; margin: 1em 0 1em 1em; border-left: solid #888888 1px; background-color: #FFFFFF;"]]

[[image IPART.GIF]]

**Command Summary**

Returns the integer part of a value.

**Command Syntax**

iPart(//value//)

**Menu Location**

Press:
# MATH to access the [[[math]]] menu.
# RIGHT to access the NUM submenu
# 3 to select iPart(, or use arrows.

**Calculator Compatibility**

TI-83/84/+/SE

**Token Size**

[[[tokens|1 byte]]]
[[/div]]

into a code like this:

[[include inc:command
|picture=IPART.GIF
|summary=Returns the integer part of a value.
|syntax=iPart(//value//)
|location=Press:
# MATH to access the [[[math]]] menu.
# RIGHT to access the NUM submenu
# 3 to select iPart(, or use arrows.
|compatibility=TI-83/84/+/SE
|size=[http://tibasicdev.wikidot.com/tokens 1 byte]
]]

which produces the exact same results.

In my opinion, this looks much neater and is much easier to understand - especially when it comes to debugging and analysing code, which is why I constructed it in the first place. It also makes it much easier to add a sidebar

Now that there is a visual comparison, what do you guys think now?

Cheers ~ James Kanjo

Edit:
I'm just finding more and more advantages! This new system, if implemented, would make life so much easier in a few more ways.

You see, now we don't need to worry about formatting (such as spacing between sections, and appropriate headings). Also, the same formatting and layout can be used across all pages - excellent for consistency and professionalism. Another benefit is if we decide to change the formatting and layout at any stage, we only need to change one page - the template page, which would in turn update all pages using the template.

Last edited on 10 May 2008 13:30 by GoVegan Show more

Re: A New Template System

DarkerLine 10 May 2008 14:42

I don't see this as a high priority - it's better to spend time on content than on formatting.

That being said, you could look at the TI-89 command pages to see my approach to this.

Re: A New Template System

burr 10 May 2008 16:06

While I like the idea of using templates, the majority of the TI-83 pages — as far as commands, programs, and routines are concerned — are already finished, and they don't actually use templates within the page (it was more a template to follow). If you were to implement your templates solution, you would have to manually go through each page one by one; I imagine that could take a fair amount of time to do.

Re: A New Template System

GoVegan 11 May 2008 00:11

@ DarkerLine, I wouldn't classify it as a high priority for the 83 portal, but I do think it is useful for the 68k portal. I just had a look at your approach. What you've done is similar, except you have separate includes for different sections, and you also still have the "[[div style="float:right; width: 16em; padding: 1em 1em 0; margin: 1em 0 1em 1em; border-left: solid #888888 1px; background-color: #FFFFFF;"]]" code, which looks ugly, is difficult to comprehend, and takes up space. My system has only one include, with all sections in it. If a command doesn't have a section, then it isn't displayed at all. For example, if there is no URL to a site in a program template, it doesn't display "URL=" and then nothing, it simply displays nothing as there is no set value for the URL.

This template system would work very well under the 68k section of the site, because next to none of the commands have been documented.

@ burr, yes you're right, all of the commands, programs and routines are finished. I personally don't mind going through each page one-by-one, it would give me something to do. But for future programs and routines that may be documented, it could be used to make life easier then.

What do we think now?

Cheers ~ James Kanjo

Re: A New Template System

GoVegan 12 May 2008 21:45

Hey everybody!

Check out the templates I made (sandbox) for the 68k section on commands. It makes a lot of the current includes for that part of the site redundant.

Cheers ~ James Kanjo

Re: A New Template System

GoVegan 15 May 2008 07:28

Okay, it's been two days and no comments. I figured that the improved 68k include wasn't enough, so I went ahead and integrated the menu location includes into it. Here is a list of includes which this one include I made makes redundant:

1. 68k-command
2. 68k-popup2 for popup menus (2 levels deep)
3. 68k-popup3 for popup menus (3 levels deep)
4. 68k-kbd for commands on the keyboard
5. 68k-kbd-cross for commands on the keyboard different between calculators.
6. 68k-toolbar2 for commands in the toolbar
7. 68k-toolbar3 for nested commands in the toolbar
8. 68k-allcalcs if the command works for all calculators.
9. 68k-flash if the command requires Flash ROM.
10. 68k-ams2 if the command requires AMS 2.xx
11. 68k-ams3 if the command requires AMS 3.xx
12. 68k-simple-token for 1-byte tokens.
13. 68k-instr-token for 2-byte 'extra instruction' tokens.
14. 68k-cmd-token for 2-byte 'extra command' tokens.
15. 68k-simple-endtag for 2-byte tokens with optional arguments.
16. 68k-instr-endtag for 3-byte 'extra instruction' tokens with optional arguments.
17. 68k-cmd-endtag for 3-byte 'extra command' tokens with optional arguments.

In lamens terms, I have integrated the features of all of the above 17 includes into one compact include.

However, the menu location part is a tincy bit less simple. I'm not sure whether or not it would be easier to simply type out each instruction to access a command. I suppose this method does keep the format and layout consistent though.

Anyway, I have put a lot of effort into this. I feel the need to ask DarkerLine if he would like to use this system instead, and if it would make it easier for him and the rest of the TI|BD community to create and modify pages.

So here is a list of pages I would like you to check out:

1. sandbox:inc:68k-command (the actual template which command pages would 'include')
2. sandbox:inc:68k-command-help (a page which gives instructions on how to use the template)
3. sandbox:68k-command (the template page which people would use when creating new pages by clicking the drop-down-combo-box)
4. sandbox:68k-commandexample (an example of how this template could be used if it was to be integrated into the 68k:getkey command page)

Cheers ~ James Kanjo

Edit: Also, seeing as there are only 6 commands documented, it wouldn't be too hard to integrate this into the system.

Last edited on 15 May 2008 07:32 by GoVegan Show more

Re: A New Template System

GoVegan 16 May 2008 10:13

Well, aren't I going have lots of fun!

I have decided to start integrating the command template into all current commands on the TI-83 portal. All 324 of them. In one hour I have managed to do exactly 30. That is 30edits/per hour. There are now only *sighs* 294 to go. A quick calculation says that it should take me exactly 9 hours and 48 minutes to go.

Like I said, I'm going to have LOTS of fun!

Cheers ~ James Kanjo

Edit: PS. I'm still waiting on DarkerLine's approval before I even touch the 68k portal of the site

Last edited on 16 May 2008 10:15 by GoVegan Show more

Re: A New Template System

krazyness 16 May 2008 12:47

Ahahah good luck, man! By the way, how do you een get 9 hours of free time? Do you like not have homework? Or sports?

Peace

~kRaZiNeSs

Re: A New Template System

GoVegan 16 May 2008 13:24

Ha! You think I'm going to do it all at once? If I did that from start to finish, I would be finished at 6 in the morning! (oh, I started at 7pm and did 30 in an hour) I've done 52 so far, but I think I'm going to take it slowly…that is, I have done all of the "ops", "#", "A" and "B" commands, and from now on I think I will take it one letter at a time. Now I have only 272 pages to go!

Actually, what's really interesting is the number of inconsistencies. For example, in a lot of commands that just require one keypress (like plus and minus), it has it on a numbered list on its own, instead on just one line. So it looks something like this in some:

Press:

1. [+] key

and in others:

Press the [+] key

I changed these inconsistencies as I edited to the latter.

And, by the way, I do so have homework and sports! Debating is a sport, right? Plus I do beach volleyball (this one is not debatable - it's a sport). You also wouldn't want me to start mentioning all of the co-curricular things I do at school =D I'm REALLY involved!

By the way, what did you think of logo version 9? Did it meet your vision?

Cheers ~ James Kanjo

Re: A New Template System

GoVegan 25 May 2008 11:39

Progress update: Today I did the letters "C" and "D". That's 43 pages down today, and 229 to go!

I also implemented all of the templates I had in the Sandbox into their appropriate sections on the site. So when I've done all 324 commands, I will start on the routines, and then the programs.

Cheers ~ James Kanjo

Last edited on 25 May 2008 21:15 by GoVegan Show more

A New Template System

GoVegan 23 May 2008 05:44

No news is good news?

Can I implement the new 68k include system?

Re: A New Template System

burr 23 May 2008 12:06

I would tell you to go ahead with implementing it, but that's really DarkerLine's call (he's the main guy working on the 68k section of the site).

Re: A New Template System

DarkerLine 23 May 2008 14:53

A wiki is a wiki. Go ahead and do it, it's a pretty impressive bit of wiki-coding.

Re: A New Template System

GoVegan 30 May 2008 23:45

Progress Update:

This morning, I have done the letters "E", "F", "G" and "H". That's another 49 down, and another 180 command pages to go!

I also applaud DarkerLine on his improvement to the 68k:command infobox. He made it even simpler by making it include another page (an include which includes another page), in order to show only the commands that have been entered. That is, instead of "|command=@@", it is simply nothing. This is also useful for making code even "simpler" to read with less code to filter when analysing. DarkerLine also managed to create a "default unless specified" option with compatibility. Perhaps this could be implemented on the 83 portal.

Cheers ~ James Kanjo

Re: A New Template System

GoVegan 31 May 2008 23:26

Progress Update:

Between last night and this morning, I have done the letters "I", "L", "M", "N", "O", "P", "Q" and "R". That's 113 pages down, and only 67 more to go!

Cheers ~ James Kanjo

COMPLETED: The New Template System

GoVegan 06 Jun 2008 13:41

At last, after gradual work over the past few weekends, I have finished integrating the new template system into all 324 command pages! It took three weeks, but it was most certainly worth it.

Also, thank you burr for sparing me the time to integrate this into the program and routine pages. And thank you DarkerLine, for improving the template system for the 68k portal, for even simpler creation, and the possibility of future command types of which we were previously unprepared for.

Cheers ~ James Kanjo