Wiki Syntax

When creating and editing Wiki pages, the default forum markup language (BB Codes) may be used. Additionally, this page shows other syntax, and custom templates, that may be used specifically on wiki pages.

Headings(top)

You can create different level headings to add structure to your wiki page. The level 1 heading is reserved for the page's title, so you may add headings at level 2 or lower. For readability, it is suggested that you do not beyond a level 4 heading. The heading bb codes and their results are shown below:

Level 2 Heading(top)

Level 3 Heading(top)

Level 4 Heading(top)

Level 5 Heading(top)

Templates(top)

The following are templates that I created to enhance the presentation of wiki content. The basic syntax for a template is as follows:

Each template has a unique name (template_name) and may have zero or more uniquely named parameters defined (parameter1, parameter2, etc). Each parameter needs to be supplied a value (value1, value2, etc), and these values can be any inline element you can insert into a regular post (i.e. text, image, smileys, links, etc).

All parameters are mandatory. If you do not supply a value for a parameter, the template will return the parameter name in its place.

So, in order to use a template you must know its template name and the parameters required. These are all detailed below, however, please note the following:

In the code samples below, the opening and closing "template" tags have spaces inserted around them to prevent the actual template from triggering. To use these, ensure that there are no spaces between the word "template" and the surrounding square brackets.

You cannot nest, or include, templates within each other.

Notes(top)

Use notes to bring attention to, or highlight small parts of, your content. The standard note should be used for a stand-alone note. The side-note should be used in conjunction with surrounding text.

Note(top)

• Template name: note
• Parameter(s): content
• Value(s): any standard post content

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Side Note(top)

• Template name: side-note
• Parameter(s): content
• Value(s): any standard post content

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Floating Images(top)

These templates allow you to float an image either to the left or right, so that text in line will naturally flow around the image.

Float Left(top)

• Template name: float-left
• Parameter(s): content
• Value(s): an image (full size or thumbnail).

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Float Right(top)

• Template name: float-right
• Parameter(s): content
• Value(s): an image (full size or thumbnail).

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Tiles(top)

Use this template to add captions to your thumbnail images.

• Template name: tile
• Parameter(s):
  • (1) img;
  • (2) cap
• Value(s):
  • (1) a thumbnail image;
  • (2) the caption text

Tables(top)

To create a table, you must use three templates.

1. table-start
2. table-colX (where X is the number of columns = 2, 3, 4, or 5)
3. table-end

The table-start and table-end templates require no parameters. The table-colX requires a parameter for each column you have defined, named cellY where Y starts at 1 and goes to X. Basically, you need one "cell" parameter for each column.

Let's look at a basic table with 2 columns and 4 rows:

1. Do
   Ray
2. Me
   Fa
3. So
   La
4. Te
   Do

Or a tabale with 5 columns, and 2 rows:

1. Do
   Ray
   Me
   Fa
   So
2. Mon
   Tue
   Wed
   Thu
   Fri

By default, all columns are created with equal width.

Header Rows(top)

You can make a row appear as a header simply by appending "-hdr" to the column template name.

1. Do
   Ray
2. Me
   Fa
3. So
   La
4. Te
   Do

You can make any row a "header" this way, and are not limited to just one either.

Left Table(top)

For want of a better description, the "Left-Column" variety of tables are exactly as described above, except that the left-most, or first, column is narrow in width, while the remaining columns are of equal width in the remaining space available. These types of tables are useful if you only have small/key data in the first column (such as the Frames in a punishment chart) -- this saves on real estate and improves readability.

To create this style of table, simply append "left" to "table-colX".

1. Frames
   Action
2. 10
   
3. 11
   
4. Image
   

As shown above, the cell contents in your table can be any standard post content. This includes text, images, smileys, etc.

Character Arrays(top)

Use these character arrays to display test results of some input against the entire cast. The cast will be ordered by weight and will display the result of the test as either success, failure or indeterminate (i.e. more information to be provided).

To use the Character Array, you must use three templates:

1. chara-array-start
2. chara-array-row (as many as required)
3. chara-array-end

The chara-array-start and chara-array-end templates require no parameters. The chara-array-row template is defined as:

• Template name: chara-array-row
• Parameter(s): (1) input; (2) ei; (3) el; (4) ao; (5) sa; (6) sh; (7) pa; (8) li; (9) va; (10) la; (11) ka; (12) le; (13) br; (14) go; (15) ak; (16) ja; (17) jn; (18) je; (19) wo; (20) ta
• Value(s):
  • (1) standard inline content: text, smilies, etc.
  • (2) ~ (20) y, n or i : this will display an icon representing success, failure or info

Here's an example:

1. Input
   EI
   EL
   AO
   SA
   SH
   PA
   LI
   VA
   LA
   KA
   LE
   BR
   GO
   AK
   JA
   JN
   JE
   WO
   TA
2. >
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
3. >