| You are here: |
| Home > | | Howto |
|
Welcome to the Howto page
You can set the style of any block of text by using the command:
CODE BLOCK
01| %STYLE{blink}%My Text%ENDSTYLE%
The contents of the style tag can be one of the following:
| Tag | Example | | underline | My Text | | overline | My Text | | line-through | My Text | | blink | My Text |
Galleries can be added to the pages now using these tags:
CODE BLOCK
01| %GALLERY%image1.gif,image2.gif,image3.jpg,image4.png%ENDGALLERY%
02|
The extensions of file names are allowed to be left off, but the file will be renamed to a file without an extension. It will still work however because the website doesn't care about the actualy extension.
Here is what the above code does:
I use blockquotes extensively on my site, although many of the older pages have too many before I figure out how to use them better and before any proper styling was done to TWiki. You used to have to type in the HTML taqs for them but I wanted it even easier, so now to get a blockquote its:
CODE BLOCK
01| %BLOCK%
02| This is the text inside the blockquote.
03| %ENDBLOCK%
Here is what the above code does:
This is the text inside the blockquote.
How about how I make these posts? It's so easy. Before I had to copy and paste about 20 lines of badly formatted tables and change the values of the table id's and the functions calling the hide and show buttons that were individual buttons, etc, etc. Now It's as simple as a blog tag, with the title encased with the opening tag:
CODE BLOCK
01| %BLOG{This is the title}%
02| Lets talk about something interesting.
03| %ENDBLOG%
Here is what the above code does:
Lets talk about something interesting.
Since I have been using these for every single one of these, I might as well tell you how it works. This is simply an open and close tag, anything on or after the line containing the opening tag is not processed for it's content except for white spaces and newlines. The commands are simply CODE and ENDCODE with percentage signs surrounding them. I cannot display them here though because the processor will still process the ENDCODE tag.
I was just doing some work on special characters and created a kind of escape sequence for special characters. I will describe it in the next post but for now here is how a code block works:
CODE BLOCK
01| %CODE%
02| Anything that you don't want to get processed goes in here.
03| %ENDCODE%
Here is what the above code does:
CODE BLOCK
01| Anything that you don't want to get processed goes in here.
Simply, if you need to display a special character anywhere on the site, and in code blocks where very few tags are still processed you can use this special encapsulating escape sequence. Anything inside the { and } characters are converted into HTML entities. This would be similar to using <nop> in TWiki and should work on an entire line of text as long as the range is kept on a single line.
CODE BLOCK
01| [{$pe(i@l (h@r@(t3r$}]
Here is what the above code does:
$pe(i@l (h@r@(t3r$
The only problem with special characters currently is the use of pipes which try to make tables. The only solution I have to this is currently to use the HTML code when initially makeing a post containing a pipe char. But any time you edit that topic, you have to replace it with the code again because it will be translated into the pipe character when editing the file. I will have to work on this later.
Colors are easily defined with the use of a color tag. There are some predefined colors, but any web compatible color or color code can be used:
CODE BLOCK
01| I want %COLOR{#ff6633}%these words%ENDCOLOR% to be a different color.
Here is what the above code does:
I want these words to be a different color.
Headers are used to define areas of each page. The header at the top is a primary header, all others are offset to match up exactly with blockquotes. Headers are defined just like in TWiki:
CODE BLOCK
01| ---+ This is a primary header, same as using <h1>Header</h1>
02| ---++++++ This is a level 6 header, same as using <h6>Header</h6>
Here is what the above code does:
This is a primary header
This is a level 6 header
Icons are a feature I translated from TWiki since some of my posts off of that site used them. They are simply a tag with the name of the icon stored in the servers icons directory:
CODE BLOCK
01| %ICON{stargold}%
Here is what the above code does:

Images have always been a complication, always needing to know where to put them, make sure they are named correctly and on and on with problems. So I developed a simple image tag where the only thing you need to know is what you want the image to be named, and the format if you know what it will be. After creating the post with the tag in it you can click on the image to upload the image and automatically rename it and put it in the proper place:
CODE BLOCK
01| %IMG%image.png%ENDIMG%
Here is what the above code does:

I have since updated the image feature to allow easier use. Now to create images a much simpler tag can be used and the closing tag no longer exists. You can now use the following code:
CODE BLOCK
01| %IMG{image.png}%
Here is what the above code does:

Links are similar to TWiki, except links are always manually made. I never liked having some things turned into links when I didn't want them to be and most of the time I had to define my links anyways. There are 2 styles, the first uses the link location as the link name, and the second creates a link to an item with the text in the second portion as the link name:
CODE BLOCK
01| [[Link]]
02| [[Link][Go to Link]]
Here is what the above code does:
Link
Go to Link
Lists are simply bullet and numbered lists, currently there is only a single level for both. They are created just like in TWiki as well, with 3 spaces followed by the bullet or number icon with one more space after:
CODE BLOCK
01| * A bullet list, item 1
02| * A bullet list, item 2
03| * A bullet list, item 3
04|
05| 1 A numbered list, item 1
06| 1 A numbered list, item 2
07| 1 A numbered list, item 3
Here is what the above code does:
• A bullet list, item 1
• A bullet list, item 2
• A bullet list, item 3
1) A numbered list, item 1
2) A numbered list, item 2
3) A numbered list, item 3
Mimetex is a cgi script that creates mathmatical expressions using Latex commands. I used to have to type the full address in an <img> tag to the script which was too long to want to do. So I made this special tag specifically for mimetex expressions. There are 3 versions, the blue, white, and black versions respectively:
CODE BLOCK
01| %MIMEB%A^2+B^2=C^2%ENDMIME%
02| %MIMEW%A^2+B^2=C^2%ENDMIME%
03| %MIME%A^2+B^2=C^2%ENDMIME%
Here is what the above code does:



CODE BLOCK
01| | *Title* | *Info* |
02| | Some | things |
03| | go | here |
Here is what the above code does:
| Title | Info | | Some | things | | go | here |
Variables are simply some predefined tags that can be used to set names and titles and such without needing to actually know the name of the web or topic for example:
CODE BLOCK
01| This is the %TOPIC% page,
02| It is inside the %WEB% web
Here is what the above code does:
This is the Howto page,
It is inside the Home web
Highlighting is as simple as it sounds, a very simple tag to highlight text in yellow:
CODE BLOCK
01| I want to highlight %HL%This Text%ENDHL% and that's it.
Here is what the above code does:
I want to highlight This Text and that's it.
|