Version 5 (modified by Igor Rodacovski, 13 years ago) (diff)

--

# WikiFormatting

Wiki markup is a core feature in Trac, tightly integrating all the other parts of Trac into a flexible and powerful whole.

Trac has a built in small and powerful wiki rendering engine. This wiki engine implements an ever growing subset of the commands from other popular Wikis, especially MoinMoin.

## Font Styles

The Trac wiki supports the following font styles:

 * '''bold''', '''!''' can be bold too''', and '''! '''
* ''italic''
* '''''bold italic'''''
* __underline__
* {{{monospace}}} or monospace
* ~~strike-through~~
* ^superscript^
* ,,subscript,,


Display:

• bold, ''' can be bold too, and !
• italic
• bold italic
• underline
• monospace or monospace
• strike-through
• superscript
• subscript

Notes:

• {{{...}}} and ... commands not only select a monospace font, but also treat their content as verbatim text, meaning that no further wiki processing is done on this text.
•  !  tells wiki parser to not take the following characters as wiki format, so pay attention to put a space after !, e.g. when ending bold.

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 = characters. The heading might optionally be followed by an explicit id. If not, an implicit but nevertheless readable id will be generated.

Example:

= Heading =


Display:

## Paragraphs

A new text paragraph is created whenever two blocks of text are separated by one or more empty lines.

A forced line break can also be inserted, using:

Line 1[[BR]]Line 2


Display:

Line 1
Line 2

## Lists

The wiki supports both ordered/numbered and unordered lists.

Example:

 * Item 1
* Item 1.1
* Item 2

1. Item 1
a. Item 1.a
a. Item 1.b
i. Item 1.b.i
i. Item 1.b.ii
1. Item 2
And numbered lists can also be given an explicit number:
3. Item 3


Display:

• Item 1
• Item 1.1
• Item 2
1. Item 1
1. Item 1.a
2. Item 1.b
1. Item 1.b.i
2. Item 1.b.ii
2. Item 2

And numbered lists can also be given an explicit number:

1. Item 3

Note that there must be one or more spaces preceding the list item markers, otherwise the list will be treated as a normal paragraph.

## 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 containing preformatted text are suitable for source code snippets, notes and examples. Use three curly braces wrapped around the text to define a block quote. The curly braces need to be on a separate line. 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


Display:

Someone's original 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

Note that more complex tables can be created using reStructuredText.

Hyperlinks are automatically created for WikiPageNames and URLs. WikiPageLinks can be disabled by prepending an exclamation mark "!" character, such as !WikiPageLink.

Example:

 TitleIndex, http://www.edgewall.com/, !NotAlink


Display:

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 discarded, unless the link is an external link. This can be useful for wiki pages not adhering to the WikiPageNames convention.

Example:

 * [http://www.edgewall.com/ Edgewall Software]
* [wiki:TitleIndex Title Index]
* [wiki:ISO9000]


Display:

Wiki pages can link directly to other parts of the Trac system. Pages can refer to tickets, reports, changesets, milestones, source files and other Wiki pages using the following notations:

 * Tickets: #1 or ticket:1
* Reports: {1} or report:1
* Changesets: r1, [1] or changeset:1
* ...


Display:

See TracLinks for more in-depth information.

You may avoid making hyperlinks out of TracLinks by preceding an expression with a single "!" (exclamation mark).

Example:

 !NoHyperLink


Display:

## 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 below).

## Macros

Macros are custom functions to insert dynamic content in a page.

Example:

 [[Timestamp]]


Display:

## Processors

Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in reStructuredText or HTML.

Example 1:

{{{
#!html
<h1 style="text-align: right; color: blue">HTML Test</h1>
}}}

Display:

# HTML Test

EMSO modeling language example:

{{{
#!mso
Model stream_therm as stream
PARAMETERS
PP as CalcObject (Brief = "External Physical Properties");

EQUATIONS
h = (1-v)*PP.LiquidEnthalpy(T, P, z) + v*PP.VapourEnthalpy(T, P, z);
end
}}}

Display:

Error: Failed to load processor mso
No macro or processor named 'mso' found

Example:

{{{
#!python
class Test:

def __init__(self):
print "Hello World"
if __name__ == '__main__':
Test()
}}}

Display:

class Test:
def __init__(self):
print "Hello World"
if __name__ == '__main__':
Test()


Perl:

my ($test) = 0; if ($test > 0) {
print "hello";
}


## Displaying a formula

To allow to the formula exhibition using the syntax Latex, was installed the macro latex-math. To use it, it uses the following syntax:
Para permitir a exibição de fórmulas usando a sintaxe LaTeX, foi instalada a macro latex-math. Para utilizá-la, use a seguinte sintaxe:

[[formula(latex code)]]


Examples:
Exemplos:

[[formula(x=\frac{-b\pm\sqrt{b^2-4ac}}{2a}})]]


it produces the following result:

[[formula(K = \frac{12 \sum_{i=1}^g n_i(\bar{r}_{i\cdot} - \bar{r})^2}{N(N+1)})]]


it produces the following result:

For more complex formulas it uses the following syntax:
Para fórmulas mais complexas use a seguinte sintaxe:

{{{
#!formula
.
.
.
}}}


Example:
Exemplo:

{{{
#!formula
\delta_k = \left\{
\begin{array}{ll}
1 & \textrm{se } k=0 \\
0 & \textrm{se } k\neq 0
\end{array}
\right.
\to
Z(\delta_k)=\Delta(z)=1
}}}


it produces the following result:

Other examples can be gotten from the page http://meta.wikimedia.org/wiki/Help:Formula, substituting itself
Outros exemplos podem ser obtidos a partir da página http://meta.wikimedia.org/wiki/Help:Formula, substituindo-se

$...$


by
por

[[formula(...)]]


## Miscellaneous

Four or more dashes will be replaced by a horizontal line (<HR>)

Example:

 ----


Display: