Formatting Rule Summary
- Blank lines are paragraph breaks
- Bullets are "*" surrounded by two spaces at the beginning of the line.
- Enumeration items are "#" surrounded by two spaces at the beginning of a line.
- Indented paragraphs begin with a tab or two spaces.
- Hyperlinks are contained with square brackets: "[target]" or "[target|name]".
- Most ordinary HTML works.
- <verbatim> and <nowiki>.
We call the first five rules above "wiki" formatting rules. The last two rules are the HTML formatting rule.
Formatting Rule Details
Paragraphs. Any sequence of one or more blank lines forms a paragraph break. Centered or right-justified paragraphs are not supported by wiki markup, but you can do these things if you need them using HTML.
Bullet Lists. A bullet list item is a line that begins with a single "*" character surrounded on both sides by two or more spaces or by a tab. Only a single level of bullet list is supported by wiki. For nested lists, use HTML.
Enumeration Lists. An enumeration list item is a line that begins with a single "#" character surrounded on both sides by two or more spaces or by a tab. Only a single level of enumeration list is supported by wiki. For nested lists or for enumerations that count using letters or roman numerials, use HTML.
Indented Paragraphs. Any paragraph that begins with two or more spaces or a tab and which is not a bullet or enumeration list item is rendered indented. Only a single level of indentation is supported by wiki; use HTML for deeper indentation.
Hyperlinks. Text within square brackets ("[...]") becomes a hyperlink. The target can be a wiki page name, the artifact ID of a check-in or ticket, the name of an image, or a URL. By default, the target is displayed as the text of the hyperlink. But you can specify alternative text after the target name separated by a "|" character.
You can also link to internal anchor names using [#anchor-name], providing you have added the necessary "<a name='anchor-name'></a>" tag to your wiki page.
Special Markup. The <nowiki> tag disables all wiki formatting rules through the matching </nowiki> element. The <verbatim> tag works like <pre> with the addition that it also disables all wiki and HTML markup through the matching </verbatim>.