Wiki Syntax
This wiki uses particluar human-readable codes to change the appearance of the output text.
Links
Free Links
Create a link to a wiki page by using the free link syntax:
[[Free Link]]
The letters that directly follow a free link are appended to the free link text. This lets you link to an existing wiki page using a word derivative. This example creates a link that says "Free Links" but links to the "Free Link" page:
[[Free Link]]s
Internal Links
Use this syntax to create a link to an existing wiki page using different text for the link:
[WikiWord|link text]
External Links
Use this syntax to create a link to a page using its URL:
[[URL]]
Here is an example that links to Google:
[[http://www.google.com]]
The link to Google specified as above will appear like this: [1]
URLs specified without the brackets will also be converted into numbered external links.
The numbers used for each new link increment by one as new links are used. Linking to the same URL more than once on a single page re-uses the same number. For example, this link also links to Google, and it uses the same number as the link above: [1]
To produce an external link as text, use this format:
[http://www.google.com|google]
The link to Google specified as above will appear like this: google
Named Anchors
You can create a named anchor in your text by starting a freelink with a hash:
I want to link directly here. [[#sweetspot]]
Named anchors do not produce output on the page other than the tag required to support the anchor.
Create a link to a named anchor by adding a hash and the anchor name via a freelink:
Make a link to [Wiki Syntax#sweetspot|the above]
This produces a link like so: To the above.
Headings automatically create named anchors using the text of the heading.
Headings
Create headings by surrounding the text with equal signs:
=Biggest heading=
Create downlevel (smaller) headings by using more exclamation points:
======Smallest heading======
The same number of equal signs must appear on both sides of the text.
Text Styles
Bold
Create bold text by surrounding it with asterisks:
*This text is bold*
You can also surround bold text with three single quotes:
'''This text is bold, too'''
Italic
Italicize text by surrounding it with underscores:
_This text is italic_
You can also make text italicized by surrounding it with two single quotes:
''This text is italic, too''
Underline
Underline text by surrouding it with two underscores:
__This text is underlined__
Comments
To insert a comment into the wiki text that doesn't appear on the rendered page, prefix the line with two forward slashes:
//This is a comment
Lists
Ordered Lists
To create an automatically numbered orderd list, prefix a block of lines with a hash:
#one
#two
The above list resolves to:
- one
- two
Unordered Lists
To create a bullet list of items, prefix a block of lines with asterisks:
*one
*two
The above list resolves to:
- one
- two
Subordinate Lists
To create a list with different levels, prefix a block of lines with more than one asterisk or hash for those that should be indented:
*level 1- I
**level 2- a1
**level 2- b1
*level 1- II
**level 2- a2
**level 2- b2
The above list resolves to:
- level 1- I
- level 2- a1
- level 2- b1
- level 1- II
- level 2- a2
- level 2- b2
Definition Lists
To create a list of definitions, prefix a block of lines with a semi-colon, and separate the term (first) from the definition (second) with a colon:
;one:Half of two
;two:Half of four
The above list resolves to:
- one
- Half of two
- two
- Half of four
Blockquotes
To indent a block of text as if to quote it, use the greater-than character on the beginning of each line:
>The rain in Spain
>falls mainly in the plain.
Horizonal Rule
To create a horizonal line, use four dashes:
----
To make a thick horizontal line, use four equal signs:
====
HTML Forms
You can insert HTML forms onto a page and have the wiki process the form when it is submitted.
Enclose the HTML form in the htmlform tag:
(htmlform|arguments>
...form goes here...
<htmlform)
The "arguments" parameter tells the wiki what to do with the form when it's processed. You can have the form send email and redirect to a different page when the form is submitted by setting the arguments like so:
(htmlform|email=address@example.com&redirect=Some Wiki Page>
This will send the form data as email to address@example.com, and forward the user on to the wiki page "Some Wiki Page". The names of the fields in the HTML form will be used to identify the values submitted on the form. Arrays (in the form "Fieldname[]" or "Fieldname[index]") can be used as input field names in the form.
The HTML form should not contain the form opening or closing tags, as these will be produced by the wiki, along with some other elements that the wiki requries to process the form.
Wiki Divs
You can create named and classed
--id/class--:content:--id/class--
This will produce a <div> with the id and class specified containing the content. Content can be more than one line, and need not begin or end on the same line as the divider code.
To use only an id on the divider, use this syntax:
--id--:content:--id--
To use only a class on the divider, use this syntax:
--/class--:content:--/class--
Note that the beginnning and ending codes for the divider must be identical except for the placement of the colon.
Macros
Execute a macro by calling it in this format:
{{macrotype:macroname}}
Parameters can be passed to macros that require them by using the pipe symbol to separate the parts. For example:
{{macrotype:macroname|param1|param2}}
There are many macros. Here is a long list of macros.
Macro: Include
Embed the entire contents of another wiki page by using the include macro:
{{WikiWord}}
This is not the same a creating a link to a page. The page specified is inserted directly into the content.
Macro: Format
You can override the format used to display a page (which by default is Format:default) by using the format macro.
This example sets the format to use the page Format:newformat.
{{Format:newformat}}
Some format names are reserved. These include:
- default
- This is the format used for all pages that do not specify a format.
- edit
- This is the format used for the editing page for all pages.
Unformatted Output
Display raw HTML markup by surrounding the HTML code with <nowiki></nowiki> tags:
<nowiki><hr style="color:green;"/></nowiki>