| | 1 | = WikiFormatting = |
| | 2 | |
| | 3 | Wiki serves as the core component of Trac, which tightly integrates all the other parts of Trac into flexible and powerful system. |
| | 4 | 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 [http://moin.sf.net/ MoinWiki]. |
| | 5 | |
| | 6 | This page demonstrates some of the formatting commands available in the Trac Wiki. |
| | 7 | |
| | 8 | == Font styles == |
| | 9 | |
| | 10 | The Trac wiki support the following font styles: '''bold''', ''italic'' |
| | 11 | and __underline__. |
| | 12 | |
| | 13 | {{{ |
| | 14 | The Trac wiki support the following font styles: '''bold''', ''italic'' |
| | 15 | and __underline__. |
| | 16 | }}} |
| | 17 | |
| | 18 | == Heading == |
| | 19 | |
| | 20 | You can create heading by starting a line with one up to five equal signs |
| | 21 | followed by a space and the headline text. The line should end with a space |
| | 22 | followed by the same number of equal signs. |
| | 23 | |
| | 24 | === Example: === |
| | 25 | {{{ |
| | 26 | = Heading = |
| | 27 | == Subheading == |
| | 28 | }}} |
| | 29 | |
| | 30 | |
| | 31 | == Paragraphs == |
| | 32 | |
| | 33 | A new text paragraph is created whenever two blocks of text are separated |
| | 34 | by an empty line. A newline can also be inserted like this: |
| | 35 | {{{ |
| | 36 | Line 1[[BR]]Line 2 |
| | 37 | }}} |
| | 38 | Display: |
| | 39 | |
| | 40 | Line 1[[BR]]Line 2 |
| | 41 | |
| | 42 | Text paragraphs can also be indented by starting the lines with a few spaces. |
| | 43 | == Lists == |
| | 44 | Example: |
| | 45 | {{{ |
| | 46 | * Item 1 |
| | 47 | * Item 1.1 |
| | 48 | * Item 2 |
| | 49 | |
| | 50 | 1. Item 1 |
| | 51 | 1. Item 1.1 |
| | 52 | 1. Item 2 |
| | 53 | }}} |
| | 54 | Display: |
| | 55 | * Item 1 |
| | 56 | * Item 1.1 |
| | 57 | * Item 2 |
| | 58 | |
| | 59 | 1. Item 1 |
| | 60 | 1. Item 1.1 |
| | 61 | 1. Item 2 |
| | 62 | |
| | 63 | == Preformatted text == |
| | 64 | Block quotes, also know as preformatted text, is suitable for source code snippets, notes and examples. Use three ''curly braces'' wrapped around the text: |
| | 65 | |
| | 66 | {{{ |
| | 67 | {{{ |
| | 68 | def HelloWorld() |
| | 69 | print "Hello World" |
| | 70 | }}} |
| | 71 | }}} |
| | 72 | |
| | 73 | Display: |
| | 74 | {{{ |
| | 75 | def HelloWorld() |
| | 76 | print "Hello World" |
| | 77 | }}} |
| | 78 | |
| | 79 | == Tables == |
| | 80 | |
| | 81 | Simple tables can be created like this: |
| | 82 | {{{ |
| | 83 | ||Cell 1||Cell 2||Cell 3|| |
| | 84 | ||Cell 4||Cell 5||Cell 6|| |
| | 85 | }}} |
| | 86 | Display: |
| | 87 | ||Cell 1||Cell 2||Cell 3|| |
| | 88 | ||Cell 4||Cell 5||Cell 6|| |
| | 89 | |
| | 90 | == Links == |
| | 91 | |
| | 92 | Hyperlinks are automatically created for WikiPageNames and urls. !WikiPageLinks can be disabled by |
| | 93 | prepending a bang (!) character like this {{{!WikiPageLink}}}. |
| | 94 | |
| | 95 | For example: |
| | 96 | |
| | 97 | TitleIndex, http://www.edgewall.com/. |
| | 98 | |
| | 99 | Links can be given a more descriptive title by writing the link followed by |
| | 100 | a space and a title and all this inside two square brackets. Like this: |
| | 101 | {{{ |
| | 102 | * [http://www.edgewall.com/ Edgewall Software] |
| | 103 | * [wiki:TitleIndex Title Index] |
| | 104 | }}} |
| | 105 | Display: |
| | 106 | |
| | 107 | * [http://www.edgewall.com/ Edgewall Software] |
| | 108 | * [wiki:TitleIndex Title Index] |
| | 109 | |
| | 110 | === Intra Trac Links === |
| | 111 | |
| | 112 | Trac allows wiki pages to link directly to other parts of the Trac system. |
| | 113 | Pages can refer to tickets, reports and changesets by simply writing the |
| | 114 | ticket, report and changeset numbers in the following notation: |
| | 115 | {{{ |
| | 116 | * Ticket #1 |
| | 117 | * Report {1} |
| | 118 | * Changeset [1] |
| | 119 | * File source:trunk/COPYING. |
| | 120 | * A specific file revision: source:/trunk/COPYING#200 |
| | 121 | }}} |
| | 122 | Display: |
| | 123 | * Ticket #1 |
| | 124 | * Report {1} |
| | 125 | * Changeset [1] |
| | 126 | * File source:trunk/COPYING. |
| | 127 | * A specific file revision: source:/trunk/COPYING#200 |
| | 128 | |
| | 129 | See TracLinks for more information about intra-trac linking. |
| | 130 | |
| | 131 | == Images == |
| | 132 | |
| | 133 | Urls ending with .png, .gif or .jpg will be converted to an IMG-tag. |
| | 134 | |
| | 135 | Example: |
| | 136 | {{{ |
| | 137 | http://www.edgewall.com/gfx/trac_example_image.png |
| | 138 | }}} |
| | 139 | Display: |
| | 140 | |
| | 141 | http://www.edgewall.com/gfx/trac_example_image.png |
| | 142 | |
| | 143 | == Macros == |
| | 144 | Macros are ''custom functions'' to insert dynamic content in a page. See WikiMacros for usage. |
| | 145 | |
| | 146 | Example: |
| | 147 | {{{ |
| | 148 | [[Timestamp]] |
| | 149 | }}} |
| | 150 | Display: |
| | 151 | [[Timestamp]] |
| | 152 | |
| | 153 | == Processors == |
| | 154 | Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in [wiki:WikiRestructuredText reStructuredText] or [wiki:WikiHtml HTML]. See WikiProcessors for documentation. |
| | 155 | |
| | 156 | '''Example 1:''' |
| | 157 | {{{ |
| | 158 | #!html |
| | 159 | <pre class="wiki">{{{ |
| | 160 | #!html |
| | 161 | <h1 style="text-align: right; color: blue">HTML Test</h1> |
| | 162 | }}}</pre> |
| | 163 | }}} |
| | 164 | Display: |
| | 165 | {{{ |
| | 166 | #!html |
| | 167 | <h1 style="text-align: right; color: blue">HTML Test</h1> |
| | 168 | }}} |
| | 169 | |
| | 170 | '''Example 2:''' |
| | 171 | {{{ |
| | 172 | #!html |
| | 173 | <pre class="wiki">{{{ |
| | 174 | #!python |
| | 175 | class Test: |
| | 176 | def __init__(self): |
| | 177 | print "Hello World" |
| | 178 | if __name__ == '__main__': |
| | 179 | Test() |
| | 180 | }}}</pre> |
| | 181 | }}} |
| | 182 | Display: |
| | 183 | {{{ |
| | 184 | #!python |
| | 185 | class Test: |
| | 186 | def __init__(self): |
| | 187 | print "Hello World" |
| | 188 | if __name__ == '__main__': |
| | 189 | Test() |
| | 190 | }}} |
| | 191 | == Miscellaneous == |
| | 192 | |
| | 193 | Four or more dashes will be replaced by a horizontal line (<HR>) |
| | 194 | |
| | 195 | {{{ |
| | 196 | ---- |
| | 197 | }}} |
| | 198 | |
| | 199 | Display: |
| | 200 | ---- |
| | 201 | |
| | 202 | |
| | 203 | ---- |
| | 204 | See also: TracLinks, TracGuide, WikiMacros, WikiProcessors, TracSyntaxColoring. |