Below are some following text formatting rules:
[anchor first defined here: Numbered List]
Numbered list items start with one or more hashes (#). The number of hashes indicates the indentation level. An empty line ends the list.
Example:
# One item
# Another item
## One More
Result:
- One item
- Another item
- One More
[anchor first defined here: Definition List]
Definition lists start with a semicolon (;), and a colon (:) between term and definition. The number of semicolons indicates the indentation level. An empty line ends the list.
Example:
; foo: a generic placeholder
; bar: a generic placeholder
;; baz: a variation
Result:
- foo
- a generic placeholder
- bar
- a generic placeholder
- baz
- a variation
[anchor first defined here: Tables]
Table rows start and end with two vertical bars (||), with two vertical bars between cells. Empty cells fuse with the next cell; in other words, ||||bar|| is a table row with a cell spanning two columns.
Example:
||foo||bar||
||||bar||
Result:
Whitespace around cell-content controls alignment. If you leave whitespace on both sides, the cell is centered. If you leave whitespace on the right, the cell is aligned to the left, and if you leave whitespace on the left, the cell is aligned to the right.
||fnordifnord||
|| foo ||
||bar ||
|| baz||
Result:
[anchor first defined here: Indented Paragraphs]
Indented paragraphs start with one or more colons (:). The number of colons indicates the indentation level. An empty line ends the indented paragraph.
Example:
: One item
: Another item
:: One More
Result:
- One item
- Another item
- One More
[anchor first defined here: Headings]
Headings are enclosed in equal signs (=) on a line of their own. You can use up to six equal signs to produce headers of level one to six. Level one is the most important one, and should not be used because the page title already uses a level one heading. Using two or three equal signs is recommended (== like this ==).
Example:
=== Heading 3 ===
==== Heading 4 ====
Result:
Heading 3
Heading 4
[anchor first defined here: Horizontal Lines]
Four or more consecutive hyphens on a line of their own (—-) are replaced with a horizontal line.
Example:
----
Result:
[anchor first defined here: Source Code]
Lines starting with spaces are shown using a fixed width font with whitespace preserved. I suggest to use uniform indentation of four spaces.
Example:
foo bar
Result:
foo bar
[anchor first defined here: Traditional Wiki Markup]
Two and three apostrophes are used for emphasis and strong emphasis.
Example:
''two apostrophes'' and '''three apostrophes'''
Result:
two apostrophes and three apostrophes
[anchor first defined here: HTML Tags]
Some HTML tags are also allowed. These tags are used exactly like HTML tags.
Example:
<b>this will be bold</b>
Result:
this will be bold
Supported tags:
- em
- Emphasis (usually italics)
- i
- Italics
- strong
- Strong (usually bold)
- b
- Bold
- u
- Underline
- tt
- Teletype (usually monospaced)
[anchor first defined here: Disable Text Formatting Rules]
The following tags will disable text formatting rules:
- nowiki
- disable text formatting rules
- code
- monospaced font, disable text formatting rules
- pre
- monospaced fonts, no line wrapping, disable text formatting rules
Example:
<code>[[Sandbox]]</code>
Result:
[[Sandbox]]
[anchor first defined here: Special Link Patterns]
In order to link to Request For Comments (RFC), just write them into the text (the keyword RFC and the number should be on the same line).
Example: RFC 822.
In order to link to a book, just write the International Standard Book Number (ISBN) into the text (the keyword ISBN and the number should be on the same line).
Example: ISBN 020171499X (amazon, search)
Default Rules
The most important rules are very simple:
- Empty lines separate paragraphs.
- Paragraphs may span several lines.
- Paragraphs begin in column 1.
With these three simple rules, you can already start writing text.
Local Links
Local pages are linked using various link patterns.
Words in double square brackets are links to local pages. These square brackets will not be rendered if the page exists, since this links to a local page. Note that usual punctuation characters are not allowed in free links.
[[Help]]
Result:
Help
CamelCase words are the traditional links to local pages.
Example:
CamelCase
Result:
CamelCase
URLs
Plain URLs get hyperlinked.
Example:
http://www.egoth.com/
Result:
http://www.egoth.com/
Plain URLs ending in an image suffix will inline the image.
Example:
http://www.egoth.com/images/logos/logo2.gif
Result:
Plain URLs in square brackets turn into numbered links, looking like footnotes.
Example:
[http://www.nikira.com/]
Result:
[1]
Plain URLs plus some text in square brackets result in the text being linked to the URL. The square brackets will remain visible in order to distinguish these links from links to local pages if you do not provide your own [Cascading Style Sheet]?.
Example:
[http://www.iruda.com/ Search Engine]
Result:
Search Engine
Bullet List
List items start with one or more asterisks (*) and a space. The number of asterisks indicates the indentation level. An empty line ends the list.
Example:
* One item
* Another item
** One More
Result:
Numerical Escapes
The Usemod Markup Extension contains a rule for definition lists. It looks as follows:
; term: definition
If you want the term to include a colon, you have to use numerical escapes. The colon has the ASCII code 58, therefore you can write the following:
; foo:bar: example
Result:
- foo:bar
- example
Note that in order to actually show the example code above, I had to replace the & with another escape! The following escapes are possible:
- Numerical escapes using decimal numbers, eg. : for a colon
- Numerical escapes using hexadecimal numbers, eg. : for a colon
- The named entities amp, lt, and gt are also allowed, eg. & for a &
