Formatting Wiki Pages

Paragraphs

Use one or more blank lines to separate paragraphs. If the first line of a paragraph begins with a tab or with two or more spaces, then that whole paragraph is shown verbatim (that is, within <pre>...</pre> markup in HTML.) The formatting rules below do not apply to verbatim paragraphs.

Fonts

Text contained between asterisks is rendered in a bold font. If you use two or three asterisks in a row, instead of just one, the bold text is also shown in a larger font. Text between underscores is rendered in an italic font. Text between equals is rendered in a fixed font. All font markers must start at the beginning of a word and must finish at the end of a word within the same paragraph.

Lists

If a line begins with the characters "*:" followed by a space or tab, then that line becomes an item in a bullet list. Similarly, if the line begins with "N:" (where N is any number including a multi-digit number) then the line becomes an item in an enumeration list. Enumeration items are automatically renumbered so the values of N do not need to be in accending order.

Lines that begin with "_:" are indented like a bullet list but do not display the bullet.

Make nested lists by adding colons. For example, to make a second level bullet, begin the line with "*::".

Hyperlinks

Links to other pages are created automatically whenever the name of another wiki page is mentioned in the text. (See WikiPageNames .) If you want to use alternative text, use the form " {wiki: TITLE TEXT} ". If you want to put a CamelCase word in your text but you do not want it to become a hyperlink, enclose the name in " {quote: ...} ".

A link to an external website is created for every URL beginning with "http:", "https:", "ftp:", or "mailto:". If the URL ends with ".jpg", ".jpeg", ".gif", or ".png" then the image that the URL points to is displayed inline on the wiki page. You can also create an inline image using markup like this: " {image: URL} ". Using the {image:...} markup allows the image URL to be relative. This allows an image stored in an attachment to be displayed inline.

Text of the form #NNN where the NNN is a valid ticket number becomes a hyperlink to the ticket. Text of the form [NNN] where NNN is a valid check-in or milestone number becomes a hyperlink to that check-in or milestone. This hyperlinks only work if the user has permission to read tickets, check-ins, and/or milestones.

A pathname for any file in the repository becomes a hyperlink to its "rlog" page. This only works if the user has check-out permissions.

To create a hyperlink on arbitrary text, use " {link: ...} " markup. Any text of the form: " {link: URL PHRASE} " displays PHRASE as hyperlink to URL. URL can be an absolute URL beginning with a prefix like "http:", or it can be a relative URL referring to another page within the same CVSTrac server. For example, to create a link to a report, one might write: " {link: rptview?rn=1 Active Tickets} ".

Horizontal Lines

A horizontal line (the <hr> markup of HTML) is generated whenever four or more "-" characters appear on a line by themselves.

Tables

A table is created by starting a line with a "|" character, separating each cell with a "|", and ending each row with a "|". For example, a 3x3 table is created with:

  |cell 1|cell 2|cell 3|
  |cell 4|cell 5|cell 6|
  |cell 7|cell 8|cell 9|

Reports

A report can be embedded on any page using the " {report: rn} " markup. A report can have text flow around it using the " {leftreport: rn} " or " {rightreport: rn} " markups. Note that the report number rn is not the same as the order in the report listing ; follow the link for the report in order to get that.

Other Markup Rules

The special markup " {linebreak} " will be rendered as a line break or hard return. The content of " {quote: ...} " markup is shown verbatim.

Custom Markup Rules

The following are custom markup rules implemented on this server.

The format for the "Fixed Version" and "Broken Version" entries is v070102 (where that represents 7.1.2). Broken Version is the earliest known version with the problem. Fixed Version is when the fixed is planned for (new/open/stalled tickets) or when it actually shipped (resolved)

{blockquote} an indented block quote {endblockquote}

{code} an indented code block {endcode}

{comment: an inline comment that will be in square brackets, prefaced by username, highlighted in yellow}

{pre: foo} maps to <pre class="foo">

Link to an NMI Drupal node. {drupalnode: Drupal-node number}, for example: {drupalnode: 1440}

ends a previous div

{file <name>} an indented example file named <name> {endfile}

Provide an html anchor to that point in the document.

{section: Top level section header}

{snip: <remark>} an indented example file or fragment with optional <remark> {endsnip}

{strike} some text {endstrike}

{subsection: Second level subsection header}

{subsubsection: Third level subsubsection header}

{term} an indented shell/terminal command {endterm}

{verbatim} an indented verbatim block {endverbatim}