Index
Page Contents

List of All Directives

Directives are placed at the front of the line and change the function of the entire line. These directives allow the markup parser to radically change the way it parses a line depending on the directive. For example, the code directive >>< prevents the rest of the line from being parsed for markup.


Tip:It is suggested that the shortest, symbol-based directive be preferred in use over the text-based directives. Text aliases have been provided as an alternative in case of scenarios where symbol-based markup causes parsing glitches.
Note:Directives are not case sensitive. "Tip:", "TIP:", and "tip:" are all interpreted the same.
Code Directive

Code lines do not receive any additional markup parsing, and will render in a mono-spaced font.

> This is a code line code: This is also a code line.
Data Directive

This directive does not render anything, but stores data next to the wiki page which may be used in the game or elsewhere on the page. By default, data is assumed to be in csv format, however json can also be specified.

+ Rakadynn, Gray, 32, Chalei + Vacharii, Blue, 200, Ariiel
data: Rakadynn, Gray, 32, Chalei data: Vacharii, Blue, 200, Ariiel
! id:"my-data", format="json" + &lcub; + "name" : "Rakadynn", + "color" : "Gray", + "shopping-list" : + [ + "jidou milk", + "cheese", + "bread" + ] + &rcub;
Note:Typically this directive would be used following the ! directive which would be used to set an id.
Note:Currently there is no use for data. This feature may be used in the future.
Comment Directive

This directive will prevent the line from being rendered.

// This is a comment
Tip:Comments can help other authors understand what you are doing in the markup. This is especially helpful when creating hidden content that will be rendered elsewhere on the page.
Header Directives
Info:In addition to the code directive, there is also inline markup for indicating >code elements inline ===== My Header 1 =====
h1: My Header 1 header1: My Header 1
===== My Header 2 ===== h1: My Header 2 header1: My Header 2
===== My Header 3 ===== h1: My Header 3 header1: My Header 3
===== My Header 4 ===== h1: My Header 4 header1: My Header 4
Horizontal Line Directive

This directive renders a horizontal line.

--
Note:Authors are free to use as many hyphens as they choose, so long as there are at least two.
List Directives
* Bullet List Item 1 * Bullet List Item 2 * Additional lines on item 2 * Bullet List Item 3 list: Bullet List Item 4
# Numbered List Item # Numbered List Item # Additional line on the item 2. # Numbered List Item numbered-list: Another List Item
Info:List item can span multiple lines. Simply add two spaces after the >< directive and then begin writing. By adding two spaces after the >< and you can also add a blank line to a bullet item.
Paragraph Directives

All lines that do not start with a recognized directive are treated as paragraphs by default.

This is the obvious and 'correct' way to write a paragraph. p: This explicitly tells the parser to treat this line as a paragraph. paragraph: This also works the same.
Tip:The text-based directives >p:< and >paragraph:< for paragraph should not be used unless trying to work around a directive. For example, if for some reason you really needed to start a line with the " character followed by a space, you could do it like this: p: " This will not render as a quote block.
Panel Directives
info: Here is some information magic: This is a magic note note: This is a note notice: This is a notice tip: This is a tip todo: Don't forget to do this thing. to-do: Don't forget to do this thing. warning: This is a warning
Note:The only panel directive with an alias is todo: vs to-do:
Note:The >notice:< panel renders a bit differently than the others. This is intended.
Parameters Directive

The parameters directive allows authors to pass parameters into the following directive that change how it renders or provides additional content.

There are two parameters that can be used on any object: >id< and >hide"< directive will make use of the >author< parameter if specified.

! id:"named-sample" > This code block has an id associated with it. That means it can be embedded elsewhere. > This code block will still render when it is encountered, however, as it is not hidden.
! id="embed-sample", hide > This code block also has an id. It will not be visible unless embedded however, > as the 'hide' parameter was set on it.
params: id: "named-sample", hide
Tip:You can display hidden content by embedding content. The block above could be rendered with the markup ><
Note:Values in the parameter list can be separated by a comma , or semi-colon ;. The name can be separated from the value with equals >=< or a colon >:
Note:Parameters for which the value is not set (for example >hide
Quote Directive
" This is an unattributed quote. " quotes can span multiple lines. quote: This is another unattributed quote.

Quotes can be attributed to a speaker by providing the >author< parameter like such:

! author="Rakadynn" " That sounds like something I might say.
Sidebar Directive

Sidebars render floating to the right.

[ This content will appear in a sidebar. [ [ Additional lines and blanks can appear in the same sidebar together.
sidebar: This is another way to render a sidebar.
Table Row Directive

The table row directive is not required and has no function. It is only provided for use by authors to make the markup cleaner.

|-------------------------
Note:The row directive can contain any amount of hyphens - after the pipe >|< as desired by the author.
Note:While it may be tempting to end the row directive with a pipe, this is currently interpreted as an unknown directive by the parser and will render on the page.
Table Column Parameters Directive

This directive sets parameters on the columns of a table. When setting parameters you can use either >:< or >=< between the name and value. Values can be in quotes, but there are no cases where that is necessary for this directive.

Currently the only parameter that can be set on a column is 'w' to indicate the cell width.

|! w=20% | w=10% | w=30% | w=40% | |! w=20% | w=10% | w=30% | w=40% |! w:20% | w:10% | w=30% | w:40%
Note:It is easy to confuse the syntax of |! with that of !. Use pipe characters | to separate cells, not , or ;
Table Directives

Tables are identified by the >|< directive, which is also used to separate cells.

| A | B | C | D | E | F
table: A | B | C table: D | E | F

If the text in a cell is marked as bold, the cell will be rendered in a style that indicates a header.

There isn't currently a direct way to indicate more than one line in a cell. To place complex content within a cell, use the parameters directive ! to place an id on a hidden block of content above the table, then embed it in the cell.

Example:

! id:"multiline-cell-1", hide This text spans multiple lines.
| Some text over here | [[:multiline-cell-1]] | Some more text

Result:

Some text over here

This text
spans
multiple
lines.

Some more text
Tip:A cell separator can be placed on the right hand side of a table for a more pleasing looking markup. So long as it is the last character on the line no cell will be created by it.
Warning:There is currently a known bug whereby pipes | introduced into a cell via embedding content will still split the text into new cells.

By combining table, table column parameters, and table row directives, tables can look as pleasing or as ugly as the author takes the time for.

| Apple | Rice | Copper | Blue | | Kiwi | Wheat | Quartz | Bluish-red |

With Added Header:

| *Fruits* | *Grains* | *Minerals* | *Colors* | | Apple | Rice | Copper | Blue | | Kiwi | Wheat | Quartz | Bluish-red |

With column widths specified and row indicators

|! w:20% | w:30% | w:30% | w:20% | |-------------------------------------------------- | *Fruits* | *Grains* | *Minerals* | *Colors* | |-------------------------------------------------- | Apple | Rice | Copper | Blue | | Kiwi | Wheat | Quartz | Bluish-red | |--------------------------------------------------