Table of Contents
Wiki Formatting Syntax
Wiki markup is a core feature, and is tightly integrating all the other parts of the solution into a flexible and powerful whole.
It is a small and powerful wiki rendering engine. This wiki engine implements an ever growing subset of the commands from other popular Wikis.
This page demonstrates the formatting syntax available anywhere Wiki formatting is allowed.
Font styles
The wiki supports the following font styles:
* '''bold'''
* ''italic''
* '''''bold italic'''''
* __underline__
* {{{monospace}}} or `monospace`
* ~~strike-through~~
* ^superscript^
* ,,subscript,,.
Display:
- bold
- italic
- bold italic
- underline
- monospace or monospace
strike-through- superscript
- subscript.
Heading
You can create heading by starting a line with one up to five equal "=" characters followed by a single space and the headline text. The line should end with a space followed by the same number of equal characters.
Example:
= Heading = == Subheading == === About ''this'' ===
Display:
Heading
Subheading
About this
Paragraphs
A new text paragraph is created whenever two blocks of text are separated by one or more empty lines - just write plain text with 'air' between paragraphs:
---
This is some text. And this is some more. They will each be enclosed as HTML paragraphs (`<p>the text</p>`).
This is some text.
And this is some more. They will each be enclosed as HTML paragraphs (<p>the text</p>).
---
If you absolutely need it (really not very often), a forced line break can also be inserted, using:
---
Line 1[[BR]]Line 2
Display:
Line 1
Line 2
---
Text paragraphs can be indented by starting the lines with one or more spaces.
Lists
The wiki supports both ordered/numbered and unordered lists. There must be a space preceding the star "*" or number "1.", or nothing will happen.
Example:
* Item 1 * Item 1.1 * Item 2 1. Item 1 1. Item 1.1 1. Item 2
Display:
- Item 1
- Item 1.1
- Item 2
- Item 1
- Item 1.1
- Item 2
Definition lists
The wiki also supports definition lists.
Example:
llama:: some kind of mammal, with hair ppython:: some kind of reptile, without hair (can you spot the typo?)
Display:
- llama
- some kind of mammal, with hair
- ppython
- some kind of reptile, without hair (can you spot the typo?)
Note that you need a space in front of the defined term.
Preformatted text
Block quotes, preformatted text, are suitable for source code snippets, notes and examples. Use three curly braces wrapped around the text to define a block quote. Example:
{{{
def HelloWorld()
print "Hello World"
}}}
Display:
def HelloWorld()
print "Hello World"
Blockquotes
In order to mark a paragraph as blockquote, indent that paragraph with two spaces.
Example:
This text is a quote from someone else.
Display:
This text is a quote from someone else.
Discussion Citations
To delineate a citation in an ongoing discussion thread, such as the ticket comment area, e-mail-like citation marks (">", ">>", etc.) may be used.
Example:
>> Someone's original text > Someone else's reply text My reply text
Display:
Someone's original text
Someone else's reply text
My reply text
Note: Some WikiFormatting elements, such as lists and preformatted text, are lost in the citation area. Some reformatting may be necessary to create a clear citation.
Tables
Simple tables can be created like this:
||Cell 1||Cell 2||Cell 3|| ||Cell 4||Cell 5||Cell 6||
Display:
| Cell 1 | Cell 2 | Cell 3 |
| Cell 4 | Cell 5 | Cell 6 |
Links
Hyperlinks are automatically created for WikiPages and urls. WikiPages can be disabled by prepending an exclamation mark "!" character, such as !NotWikiPage.
Example:
TitleIndex, http://www.coderesort.com/, !NotAlink
Display:
TitleIndex, http://www.coderesort.com/, NotAlink
Links can be given a more descriptive title by writing the link followed by a space and a title and all this inside square brackets. If the descriptive title is omitted, then the explicit prefix is disguarded, unless the link is an external link. This can be useful for wiki pages not adhering to the wiki page names convention.
Like this:
* [http://www.bvnetwork.no/ BV Network AS] * [wiki:TitleIndex Title Index] * [wiki:mypage]
Display:
Links
Wiki pages can link directly to other parts of the project environment. Pages can refer to tickets, reports, changesets, milestones, source files and other Wiki pages using the following notation:
* Tickets: #1 or ticket:1
* Reports: {1} or report:1
* Changesets: r1, [1] or changeset:1
* Revision Logs: r1:3, [1:3] or log:branches/0.9-stable#1:3
* Wiki pages: CamelCase or wiki:CamelCase
* Milestones: milestone:1.0 or milestone:"End-of-days Release"
* Files: source:trunk/COPYING
* A specific file revision: source:/trunk/COPYING#200
* A filename with embedded space: source:"/trunk/README FIRST"
Display examples (only some, and example data):
- Tickets: #1 or ticket:1
- Reports: {1} or report:1
- Wiki pages: TitleIndex or wiki:TitleIndex
- Milestones: milestone:1.0 or milestone:"End-of-days Release"
See HelpUser/Links for more in-depth information.
Escaping Links and Page Names
You may avoid making hyperlinks out of links by preceding an expression with a single "!" (exclamation mark).
!NoHyperLink !#42 is not a link
Display:
NoHyperLink #42 is not a link
Images
Urls ending with .png, .gif or .jpg are no longer automatically interpreted as image links, and converted to <img> tags.
You now have to use the [[Image()]] macro - see HelpUser/WikiMacros for usage.
Macros
Macros are custom functions to insert dynamic content in a page. See HelpUser/WikiMacros for usage.
Example:
[[RecentChanges(Help,3)]]
Display:
2011-08-04
2011-06-14
Miscellaneous
Four or more dashes will be replaced by a horizontal line (<HR>)
Example:
----
Display:
See also: HelpUser/Links, HelpUser/WikiMacros, HelpUser/SyntaxHighlighting.