9 | | == Font styles == |
10 | | |
11 | | The Trac wiki support the following font styles: '''bold''', ''italic'', |
12 | | __underline__ and ~~strike-through~~. |
13 | | |
14 | | {{{ |
15 | | The Trac wiki support the following font styles: '''bold''', ''italic'', |
16 | | __underline__ and ~~strike-through~~. |
17 | | }}} |
18 | | |
19 | | |
20 | | == Heading == |
21 | | |
22 | | You can create heading by starting a line with one up to five ''equal\\ '=' characters |
| 12 | |
| 13 | == Font Styles == |
| 14 | |
| 15 | The Trac wiki supports the following font styles: |
| 16 | {{{ |
| 17 | * '''bold''', '''!''' can be bold too''', and '''! ''' |
| 18 | * ''italic'' |
| 19 | * '''''bold italic''''' |
| 20 | * __underline__ |
| 21 | * {{{monospace}}} or `monospace` |
| 22 | * ~~strike-through~~ |
| 23 | * ^superscript^ |
| 24 | * ,,subscript,, |
| 25 | }}} |
| 26 | |
| 27 | Display: |
| 28 | * '''bold''', '''!''' can be bold too''', and '''! ''' |
| 29 | * ''italic'' |
| 30 | * '''''bold italic''''' |
| 31 | * __underline__ |
| 32 | * {{{monospace}}} or `monospace` |
| 33 | * ~~strike-through~~ |
| 34 | * ^superscript^ |
| 35 | * ,,subscript,, |
| 36 | |
| 37 | Notes: |
| 38 | * `{{{...}}}` 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. |
| 39 | * {{{ ! }}} 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. |
| 40 | |
| 41 | == Headings == |
| 42 | |
| 43 | You can create heading by starting a line with one up to five ''equal'' characters ("=") |
71 | | |
72 | | == Preformatted text == |
73 | | 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: |
| 114 | And numbered lists can also be given an explicit number: |
| 115 | 3. Item 3 |
| 116 | |
| 117 | Note that there must be one or more spaces preceding the list item markers, otherwise the list will be treated as a normal paragraph. |
| 118 | |
| 119 | |
| 120 | == Definition Lists == |
| 121 | |
| 122 | |
| 123 | The wiki also supports definition lists. |
| 124 | |
| 125 | Example: |
| 126 | {{{ |
| 127 | llama:: |
| 128 | some kind of mammal, with hair |
| 129 | ppython:: |
| 130 | some kind of reptile, without hair |
| 131 | (can you spot the typo?) |
| 132 | }}} |
| 133 | |
| 134 | Display: |
| 135 | llama:: |
| 136 | some kind of mammal, with hair |
| 137 | ppython:: |
| 138 | some kind of reptile, without hair |
| 139 | (can you spot the typo?) |
| 140 | |
| 141 | Note that you need a space in front of the defined term. |
| 142 | |
| 143 | |
| 144 | == Preformatted Text == |
| 145 | |
| 146 | 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. |
| 161 | |
| 162 | |
| 163 | == Blockquotes == |
| 164 | |
| 165 | In order to mark a paragraph as blockquote, indent that paragraph with two spaces. |
| 166 | |
| 167 | Example: |
| 168 | {{{ |
| 169 | This text is a quote from someone else. |
| 170 | }}} |
| 171 | |
| 172 | Display: |
| 173 | This text is a quote from someone else. |
| 174 | |
| 175 | == Discussion Citations == |
| 176 | |
| 177 | To delineate a citation in an ongoing discussion thread, such as the ticket comment area, e-mail-like citation marks (">", ">>", etc.) may be used. |
| 178 | |
| 179 | Example: |
| 180 | {{{ |
| 181 | >> Someone's original text |
| 182 | > Someone else's reply text |
| 183 | My reply text |
| 184 | }}} |
| 185 | |
| 186 | Display: |
| 187 | >> Someone's original text |
| 188 | > Someone else's reply text |
| 189 | My reply text |
| 190 | |
| 191 | ''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.'' |
102 | | !Hyperlinks are automatically created for WikiPageNames and urls. !WikiPageLinks can be disabled by |
103 | | prepending an exclamation mark (!) character, such as {{{!WikiPageLink}}}. |
104 | | |
105 | | Examples: |
106 | | |
107 | | TitleIndex, http://www.edgewall.com/. |
108 | | |
109 | | Links can be given a more descriptive title by writing the link followed by |
110 | | a space and a title and all this inside two square brackets. Like this: |
| 211 | Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark "!" character, such as {{{!WikiPageLink}}}. |
| 212 | |
| 213 | Example: |
| 214 | {{{ |
| 215 | TitleIndex, http://www.edgewall.com/, !NotAlink |
| 216 | }}} |
| 217 | |
| 218 | Display: |
| 219 | TitleIndex, http://www.edgewall.com/, !NotAlink |
| 220 | |
| 221 | 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. |
| 222 | |
| 223 | Example: |
119 | | |
120 | | === Trac Links === |
121 | | |
122 | | Wiki pages can link directly to other parts of the Trac system. |
123 | | Pages can refer to tickets, reports, changesets, milestones, source files and |
124 | | other Wiki pages using the following notation: |
125 | | * Tickets: '''!#1''' or '''!ticket:1''' |
126 | | * Reports: '''!{1}''' or '''!report:1''' |
127 | | * Changesets: '''![1]''' or '''!changeset:1''' |
128 | | * Wiki pages: '''CamelCase''' or '''!wiki:CamelCase''' |
129 | | * Milestones: '''!milestone:1.0''' |
130 | | * Files: '''!source:trunk/COPYING''' |
131 | | * A specific file revision: '''!source:/trunk/COPYING#200''' |
132 | | Display: |
| 233 | * [wiki:ISO9000] |
| 234 | |
| 235 | == Trac Links == |
| 236 | |
| 237 | 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: |
| 238 | {{{ |
135 | | * Changesets: [1] or changeset:1 |
136 | | * Wiki pages: CamelCase or wiki:CamelCase |
137 | | * Milestones: milestone:1.0 |
138 | | * Files: source:trunk/COPYING |
139 | | * A specific file revision: source:/trunk/COPYING#200 |
140 | | |
141 | | See TracLinks for more in-depth information. |
142 | | |
143 | | == Escaping Links and WikiNames == |
144 | | You may avoid making hyperlinks out of TracLinks by preceding an expression with a single '!' (exclamation mark). |
145 | | |
| 241 | * Changesets: r1, [1] or changeset:1 |
| 242 | * ... |
| 243 | }}} |
| 244 | |
| 245 | Display: |
| 246 | * Tickets: #1 or ticket:1 |
| 247 | * Reports: {1} or report:1 |
| 248 | * Changesets: r1, [1] or changeset:1 |
| 249 | * ... |
| 250 | |
| 251 | There are many more flavors of Trac links, see TracLinks for more in-depth information. |
| 252 | |
| 253 | |
| 254 | == Escaping Links and WikiPageNames == |
| 255 | |
| 256 | You may avoid making hyperlinks out of TracLinks by preceding an expression with a single "!" (exclamation mark). |
| 257 | |
| 258 | Example: |
157 | | Urls ending with .png, .gif or .jpg are automatically interpreted as image links, and converted to IMG tags. |
158 | | |
159 | | Example: |
160 | | {{{ |
161 | | http://www.edgewall.com/gfx/trac_example_image.png |
162 | | }}} |
163 | | Display: |
164 | | |
165 | | http://www.edgewall.com/gfx/trac_example_image.png |
| 271 | Urls ending with `.png`, `.gif` or `.jpg` are no longer automatically interpreted as image links, and converted to `<img>` tags. |
| 272 | |
| 273 | You now have to use the ![[Image]] macro. The simplest way to include an image is to upload it as attachment to the current page, and put the filename in a macro call like `[[Image(picture.gif)]]`. |
| 274 | |
| 275 | In addition to the current page, it is possible to refer to other resources: |
| 276 | * `[[Image(wiki:WikiFormatting:picture.gif)]]` (referring to attachment on another page) |
| 277 | * `[[Image(ticket:1:picture.gif)]]` (file attached to a ticket) |
| 278 | * `[[Image(htdocs:picture.gif)]]` (referring to a file inside project htdocs) |
| 279 | * `[[Image(source:/trunk/trac/htdocs/trac_logo_mini.png)]]` (a file in repository) |
| 280 | |
| 281 | Example display: [[Image(htdocs:../common/trac_logo_mini.png)]] |
| 282 | |
| 283 | |
| 284 | See WikiMacros for further documentation on the `[[Image()]]` macro. |
| 285 | |