List of Wiki Codes

Wiki linking BB-Codes allow forum users to use BB-Code to easily create links to wiki articles. Most link codes can only create links to articles in one namespace. As a result, there is one link code for each namespace.

This Wiki Code can be used by clicking this button in the editor.

The tag [book] is used to create links to articles in the namespace called "Books". If the article does not exist, the link may appear in this color, and clicking the link will allow users to create the article. You can also use an optional parameter to "name" your link.

Usage	[book]value[/book] [book=Option]value[/book]
Example Usage	[book]Example[/book] [book=Example]Click here to view the article![/book]
Example Output	Example Click here to view this article!

The tag [brcs] is used to create links to articles in the namespace called "BRCS". If the article does not exist, the link may appear in this color, and clicking the link will allow users to create the article. You can also use an optional parameter to "name" your link.

Usage	[brcs]value[/brcs] [brcs=Option]value[/brcs]
Example Usage	[brcs]Example[/brcs] [brcs=Example]Click here to view the article![/brcs]
Example Output	Example Click here to view this article!

The tag [brwiki] is used to create links to articles in the namespace called "BrWiki". If the article does not exist, the link may appear in this color, and clicking the link will allow users to create the article. You can also use an optional parameter to "name" your link.

Usage	[brwiki]value[/brwiki] [brwiki=Option]value[/brwiki]
Example Usage	[brwiki]Example[/brwiki] [brwiki=Example]Click here to view the article![/brwiki]
Example Output	Example Click here to view this article!

This Wiki Code can be used by clicking this button in the editor.

The tag [category] is used to create links to articles in the namespace called "Category". If the article does not exist, the link may appear in this color, and clicking the link will allow users to create the article. In regular forum posts, you can also use an optional parameter to "name" your link.

Usage	[category]value[/category] [category=Option]value[/category]
Example Usage	[category]Example[/category] [category=Example]Click here to view the category![/category]
Example Output	Example Click here to view the category!

In wiki articles, the additional parameter is required, or the following functionality will be applied. Rather than simply linking to the category, the article will be added to the directory listing on the category's page, and the category will be added to a list of category tags at the bottom of the tagged article.

Usage	[category]value[/category]
Example Usage	[category]Example[/category]
Example Output	Category: Example

The tag [help] is used to create links to articles in the namespace called "Help". If the article does not exist, the link may appear in this color, and clicking the link will allow users to create the article. You can also use an optional parameter to "name" your link.

Usage	[help]value[/help] [help=Option]value[/help]
Example Usage	[help]Example[/help] [help=Example]Click here to view the article![/help]
Example Output	Example Click here to view this article!

This Wiki Code can be used by clicking this button in the editor.

The tag [image] is used to create links to articles in the namespace called "Image". If the article does not exist, the link may appear in this color, and clicking the link will allow users to create the article. For a link, you must use an optional parameter to "name" your link.

Usage	[image=Option]value[/image]
Example Usage	[image=Example.jpg]Click here to view the page![/image]
Example Output	Click here to view the page!

As mentioned above, the additional parameter is required, or the following functionality will be applied. Rather than simply linking to the image, the image will be inserted into the current page. Using additional arguments in the tag's value (separated by "|"), you can also customize the appearance of the image. In any order and any combination, try experimenting by specifying:

width	in px
alignment	left, right, center
display	border, frame, none
thumbnail	thumb, thumbnail
caption	any other text
Example Usage	[image]Example.jpg|60px|right|border|thumb|some caption text[/image]

This Wiki Code can be used by clicking this button in the editor.

The tag [special] is used to create links to articles in the namespace called "Special". If the article does not exist, the link may appear in this color, and clicking the link will allow users to create the article. You can also use an optional parameter to "name" your link.

Usage	[special]value[/special] [special=Option]value[/special]
Example Usage	[special]Example[/special] [special=Example]Click here to view the article![/special]
Example Output	Example Click here to view this article!

The tag [srd] is used to create links to articles in the namespace called "D20". If the article does not exist, the link may appear in this color, and clicking the link will allow users to create the article. You can also use an optional parameter to "name" your link.

Usage	[srd]value[/srd] [srd=Option]value[/srd]
Example Usage	[srd]Example[/srd] [srd=Example]Click here to view the article![/srd]
Example Output	Example Click here to view this article!

The tag [statblock] is used to create links to articles in the namespace called "Stat Blocks". If the article does not exist, the link may appear in this color, and clicking the link will allow users to create the article. You can also use an optional parameter to "name" your link.

Usage	[statblock]value[/statblock] [statblock=Option]value[/statblock]
Example Usage	[statblock]Example[/statblock] [statblock=Example]Click here to view the article![/statblock]
Example Output	Example Click here to view this article!

This Wiki Code can be used by clicking this button in the editor.

The tag [template] is used to create links to pages in the namespace called "Template". If the page does not exist, the link may appear in this color, and clicking the link will allow users to create the page. In regular forum posts, you can also use an optional parameter to "name" your link.

Normal Usage	[template]value[/template] [template=Option]value[/template]
Example Usage	[template]Example[/template] [template=Example]Click here to view the template![/template]
Example Output	Example Click here to view this article!

In wiki articles, the additional parameter is required, or the following functionality will be applied. Rather than simply linking to the template, the tag will insert the body text of the resulting page into the current article. Users can also provide additional parameters in the tag's value, which will fill in the "blanks" (which take the form {{{parameter name}}}) within the inserted template's text.

Wiki Usage	[template]value[/template]
"Example" Template	Hello, this is {{{parameter1|default}}} text about something I like to call {{{parameter2|an example}}}.
Example Usage	[template] Example | parameter1=Sample | parameter2=Sample 2 [/template]
Example Output	Hello, this is Sample text about something I like to call Sample 2.

The tag [user] is used to create links to articles in the namespace called "User". If the article does not exist, the link may appear in this color, and clicking the link will allow users to create the article. You can also use an optional parameter to "name" your link.

Usage	[user]value[/user] [user=Option]value[/user]
Example Usage	[user]Example[/user] [user=Example]Click here to view the article![/user]
Example Output	Example Click here to view this article!

This Wiki Code can be used by clicking this button in the editor.

The tag [wiki] is used to create links to articles in the namespace called "Main". If the article does not exist, the link may appear in this color, and clicking the link will allow users to create the article. You can also use an optional parameter to "name" your link.

Usage	[wiki]value[/wiki] [wiki=Option]value[/wiki]
Example Usage	[wiki]Example[/wiki] [wiki=Example]Click here to view the article![/wiki]
Example Output	Example Click here to view this article!

There are also other Wiki Codes that users can use to mark up wiki articles. Unless otherwise specified, many of these can also be used in normal forum posts.

The [bookindex] tag will insert the Table of Contents for the selected book. Simply set the tag's value to the Book Title. However, the tag only works in wiki pages. It does nothing in regular posts.

Usage	[bookindex]value[/bookindex]
Example Usage	[bookindex]Example Book[/bookindex]
Example Explanation	This would show the Table of Contents for the Book called "Example Book".

This Wiki Code can be used by clicking this button in the editor.

The tag [comment] allows editors to leave comments in their messages, for future reference or the benefit of other editors. The value will only appear in the message editor and it will not appear in the visible page.

Usage	[comment]value[/comment]
Example Usage	[comment]Example[/comment]
Example Output

The [div] tag allows you to wrap content in a block container and apply styles to that container. Attributes and styles are separated from the content using a pipe character |

Usage	[div]value[/div]
Example Usage	[div] style="border: 1px dotted green; background: yellow; color: brown; width: 100px; padding: 5px" | This box has a green dotted border, a yellow background, and brown text. [/div]
Example Output	This box has a green dotted border, a yellow background, and brown text.

This Wiki Code can be used by clicking this button in the editor.

The tag [footnote] inserts a footnote into wiki articles. This will leave a numerical indication at the current position. In order to display the full value of the footnote, [reflist] must also be used. If [reflist] was used, clicking a footnote will highlight the footnote's full text, and the browser window will jump to it.

Providing an option for the footnote gives it a name. By using matching options, users can include the same footnote more than once without re-typing the value. This BB-Code will only parse in wiki articles, and it will not parse in regular forum posts.

Usage	[footnote]value[/footnote] [footnote=Option]value[/footnote]
Example Usage	This text requires citations.[footnote]Example[/footnote] This text requires citations.[footnote=sample]Example[/footnote]
Example Output	This text requires citations.[1] This text requires citations.[2]

The [forumindex] tag will insert a multiple-page list of all threads in the selected forum, sorted alphabetically. Set the tag's value to a forum ID to get threads from the corresponding forum, or leave it blank to get threads from the current forum. This tag only works in wiki pages. It does nothing in regular posts.

Usage	[forumindex]value[/forumindex]
Example Usage	[forumindex]17[/forumindex]
Example Explanation	This would list all threads from forum #17 in alphabetical order. If there are a lot of threads, it will break the list into multiple pages.

This Wiki Code can be used by clicking this button in the editor.

The tag [h] inserts a new heading into messages. The BB-Code's option is required and must be a value between 2 and 6.

Usage	[h=Option]value[/h]
Example Usage	[h=2]Example[/h]
Example Output	[top]Example

The tag [hr] inserts a horizontal line into messages. The value of the tag can accept a number of parameters. An empty value uses the style's default width.

Usage	[hr]value[/hr]
Example Usage	[hr]width=100%|size=5|color=blue|color1=blue|color2=red[/hr]
Example Output

This Wiki Code can be used by clicking this button in the editor.

The tag [redirect] completely replaces the text of the current article with the text of another article. The article with the replacement text is identified by the BB-Code's value, using the format "Namespace:Article". [redirect] will not parse in regular posts, and can only be used in articles.

Usage	[redirect]value[/redirect]
Example Usage	[redirect]Main:Example[/redirect]
Example Output	Example

This Wiki Code can be used by clicking this button in the editor.

The tag [reflist] inserts a list of footnotes into wiki articles. This prints the full text of footnotes into the list. [reflist] does not normally take a value, but providing a numerical value will separate the footnotes into the same number of columns. This tag cannot be used in regular posts, and will only parse in wiki articles.

Usage	[reflist][/reflist] [reflist]value[/reflist]
Example Usage	[reflist][/reflist] [reflist]2[/reflist]
Example Output	^ Example ^ Example ^ Example ^ Example

The [showthreads] tag will insert a short list of threads, the threads with more recent posts appearing first. Set the tag's value to a forum ID to get threads from the corresponding forum. This tag cannot be used in regular posts, and will only parse in wiki articles.

Usage	[showthreads]value[/showthreads]
Example Usage	[showthreads]17[/showthreads]
Example Explanation	This would list several threads from forum #17 that have recent posts.

The [span] tag allows you to wrap content in an inline container and apply styles to that container. Attributes and styles are separated from the content using a pipe character |

Usage	[span]value[/span]
Example Usage	[span] style="border: 1px dotted green; background: yellow; color: brown" | This box has a green dotted border, a yellow background, and brown text. [/span]
Example Output	This text has a green dotted border, a yellow background, and brown face.

This Wiki Code can be used by clicking this button in the editor.

The tag [table] creates tables in messages. Editors use special characters in the value to distinguish between table rows and cells.

Usage	[table]value[/table]
Example Usage	[table] border="1" |- | class="tcat" colspan="2" | Example Header |- | style="font-style: italic" | Example Data 1 | Example Data 2 |- [/table]
Example Output	Example Header Example Data 1 Example Data 2

The tag [toc] can customize how an article's table of contents is displayed. Normally, the table of contents will appear below the first paragraph when there are at least four (4) sections created using [h]. It takes any number of pre-defined flags as a value, separated using |. This tag cannot be used in regular posts, and will only parse in wiki articles.

Usage	[toc]value[/toc]
[toc]NO[/toc]	prevents the default table of contents placement from occuring
[toc]FORCE[/toc]	displays the table of contents even if there are too few sections, or even if the NO flag was used
[toc]BOOK[/toc]	if the article belongs to a book, merges the other chapters into the table of contents
[toc]NONUM[/toc]	removes the table of contents numbering, leaving only the bullet points
[toc][/toc]	places a table of contents at the current position

The [var] tag allows you to include wiki page data or perform other dynamic functions in wiki content. It does nothing in regular posts.

As its value, the [var] tag takes a function name, followed by an optional text argument. These must be separated by a pipe character |

Usage	[var]value[/var]
Example Usage	[var]PAGENAME[/var] [var]URLENCODE|URL Safe Text[/var]
Example Output	List of Wiki Codes URL+Safe+Text

A full list of [var] functions can be found here: VaultWiki Manual - Parser Extensions

There are several BB-Codes that perform special functions when they are used in the text of a wiki template. They don't do anything in regular wiki pages or regular posts.

When the template is used in another wiki page, the [if] tag only shows its content when the wiki page meets a set condition. The optional parameter is required, or the condition will evaluate to false.

Example: [if=true]Show this content[/if]

You can also place the [else /] code in the tag value. If the condition evaluates true, anything before the [else /] is shown; false, anything after it.

Example: [if=false]Not shown[else /]Shown[/if]

A common use of the [if] tag is to test the values of template parameters ({{{name|}}}) to check if they contain any text. Keep in mind that white-space characters are considered text.

You can also use a number of comparative operators in your condition, to check if things are equal or not: == > < >= <= !=

Usage	[if=Option]value[/if]
Example Usage	[if="{{{name|}}}"]Name has a value[/if] [if="{{{name|}}}"]Name has a value[else /]Name has no value[/if] [if="{{{name|}}}==Fred"]Name is Fred[else /]Name is not Fred[/if].

The [includeonly] tag defines text that is only visible when the template is used in another wiki page. Any text enclosed in these tags are ignored when the template page is viewed directly.

The [noinclude] tag defines text that is only visible when visiting the wiki template page. Any text enclosed in these tags are ignored when the template is used in another wiki page.