The most important rules are very simple. With these three simple rules, you can already start writing text.
== Main headings (h2) == === Sub headings (h3) === ==== Sub sub headings (h4) ====
Surround options, settings, variables with double-hash (##).
Go to ##Options > Flow control##
Result:
Go to Options > Flow control
Bold use double-asterisk, Italics use double-slash.
**Bold** and //Italics//
Result:
Bold and Italics
Wrap block in <pre></pre>.
<pre> +*.png +*.gif Result looks just like this </pre>
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.
[[Text Formatting Rules]]
Result:
Text Formatting Rules
You may also specify link text different to the local page name, separating the two with a pipe (|):
[[Text Formatting Rules|How to format wiki pages]]
Result:
How to format wiki pages
Plain URLs get hyperlinked.
Example:
http://www.emacswiki.org/
Result:
http://www.emacswiki.org/
Plain URLs ending in an image suffix will inline the image.
Example:
http://www.emacswiki.org/emacs_logo.png
Result:
Plain URLs in square brackets turn into numbered links, looking like footnotes.
Example:
[http://www.emacswiki.org/]
Result:
[1]
Plain URLs plus some text in square brackets result in the text being linked to the URL.
Example:
[http://www.emacswiki.org/ Emacs Wiki]
Result:
Emacs Wiki
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:
List items start with one or more hash (#) and a space. The number of hashes indicates the indentation level. An empty line ends the list.
Example:
# One item # Another item ## One More
Result:
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:
foo | bar |
bar |
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:
fnordifnord |
foo |
bar |
baz |