Changes between Version 26 and Version 27 of WikiFormatting
- Timestamp:
- Mar 18, 2017, 3:45:33 PM (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
WikiFormatting
v26 v27 1 = WikiFormatting = 1 = WikiFormatting 2 2 3 [[TracGuideToc]] 3 4 4 5 Wiki markup is a core feature in Trac, tightly integrating all the other parts of Trac into a flexible and powerful whole. 5 6 6 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, 7 especially [http://moinmoin.wikiwikiweb.de/ MoinMoin]. 8 9 10 This page demonstrates the formatting syntax available anywhere WikiFormatting is allowed. 11 12 13 == Font Styles == 7 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://moinmo.in/ MoinMoin] and [trac:WikiCreole]. 8 9 This page will give you an in-depth explanation of the wiki markup available anywhere WikiFormatting is allowed. 10 11 The sections below provide an overview for the most common syntax, each link in the ''Category'' column will lead you to the more detailed explanation later in this page. 12 13 A few other wiki pages present the advanced features of the Trac wiki markup in more depth: 14 - TracLinks covers all the possible ways to refer precisely to any Trac resource or parts thereof 15 - WikiPageNames covers the various names a wiki page can take, CamelCase or not 16 - WikiMacros lists the macros available for generating dynamic content 17 - WikiProcessors and WikiHtml details how parts of the wiki text can be processed in special ways 18 - [trac:wiki:TracDev/Proposals/AdvancedWikiOperations AdvancedWikiOperations] provides some operations in uncommon or administrative scenarios 19 20 == Common wiki markup 21 22 ||= '''Category''' =||= '''Wiki Markup''' =||= '''Display''' =|| 23 |----------------------------------------------------------- 24 {{{#!th rowspan=3 25 [#FontStyles Font Styles] 26 }}} 27 || `'''bold'''`, `''italic''`, `'''''Wikipedia style'''''` || \ 28 || '''bold''', ''italic'', '''''Wikipedia style''''' || 29 || {{{`monospaced (''other markup ignored'')`}}} || \ 30 || `monospaced (''other markup ignored'')` || 31 || `**bold**`, `//italic//`, `**//!WikiCreole style//**` || \ 32 || **bold**, //italic//, **//!WikiCreole style//** || 33 |----------------------------------------------------------- 34 ||= [#Headings Headings] =||\ 35 {{{#!td 36 {{{ 37 == Level 2 == 38 === Level 3 ^([#hn note])^ 39 }}} 40 }}} 41 {{{#!td style="padding-left: 2em" 42 == Level 2 == 43 === Level 3 ^([#hn note])^ 44 }}} 45 |----------------------------------------------------------- 46 ||= [#Paragraphs Paragraphs] =||\ 47 {{{#!td 48 {{{ 49 First paragraph 50 on multiple lines. 51 52 Second paragraph. 53 }}} 54 }}} 55 {{{#!td 56 First paragraph 57 on multiple lines. 58 59 Second paragraph. 60 }}} 61 |----------------------------------------------------------- 62 ||= [#Lists Lists] =||\ 63 {{{#!td 64 {{{ 65 * bullets list 66 on multiple lines 67 1. nested list 68 a. different numbering 69 styles 70 }}} 71 }}} 72 {{{#!td 73 * bullets list 74 on multiple lines 75 1. nested list 76 a. different numbering 77 styles 78 }}} 79 |----------------------------------------------------------- 80 {{{#!th 81 [#DefinitionLists Definition Lists] 82 }}} 83 {{{#!td 84 {{{ 85 term:: definition on 86 multiple lines 87 }}} 88 }}} 89 {{{#!td 90 term:: definition on 91 multiple lines 92 }}} 93 |----------------------------------------------------------- 94 ||= [#PreformattedText Preformatted Text] =||\ 95 {{{#!td 96 {{{ 97 {{{ 98 multiple lines, ''no wiki'' 99 white space respected 100 }}} 101 }}} 102 }}} 103 {{{#!td 104 {{{ 105 multiple lines, ''no wiki'' 106 white space respected 107 }}} 108 }}} 109 |----------------------------------------------------------- 110 ||= [#Blockquotes Blockquotes] =||\ 111 {{{#!td 112 {{{ 113 if there's some leading 114 space the text is quoted 115 }}} 116 }}} 117 {{{#!td 118 if there's some leading 119 space the text is quoted 120 }}} 121 |----------------------------------------------------------- 122 ||= [#DiscussionCitations Discussion Citations] =||\ 123 {{{#!td 124 {{{ 125 >> ... (I said) 126 > (he replied) 127 }}} 128 }}} 129 {{{#!td 130 >>... (I said) 131 > (he replied) 132 }}} 133 |----------------------------------------------------------- 134 ||= [#Tables Tables] =||\ 135 {{{#!td 136 {{{ 137 ||= Table Header =|| Cell || 138 |||| (details below) || 139 }}} 140 }}} 141 {{{#!td 142 ||= Table Header =|| Cell || 143 |||| (details below) || 144 }}} 145 |----------------------------------------------------------- 146 {{{#!th rowspan=2 147 [#Links Links] 148 }}} 149 || `http://trac.edgewall.org` ||\ 150 || http://trac.edgewall.org || 151 || `WikiFormatting (CamelCase)` ||\ 152 || WikiFormatting (CamelCase) || 153 |----------------------------------------------------------- 154 {{{#!th rowspan=5 155 [#TracLinks TracLinks] 156 }}} 157 || `wiki:WikiFormatting`, `wiki:"WikiFormatting"` ||\ 158 || wiki:WikiFormatting, wiki:"WikiFormatting" || 159 || `#1 (ticket)`, `[1] (changeset)`, `{1} (report)` ||\ 160 || #1 (ticket), [1] (changeset), {1} (report) || 161 || `ticket:1, ticket:1#comment:1` ||\ 162 || ticket:1, ticket:1#comment:1 || 163 || `Ticket [ticket:1]`, `[ticket:1 ticket one]` ||\ 164 || Ticket [ticket:1], [ticket:1 ticket one] || 165 || `Ticket [[ticket:1]]`, `[[ticket:1|ticket one]]` ||\ 166 || Ticket [[ticket:1]], [[ticket:1|ticket one]] || 167 |----------------------------------------------------------- 168 {{{#!th rowspan=2 169 [#SettingAnchors Setting Anchors] 170 }}} 171 || `[=#point1 (1)] First...` ||\ 172 || [=#point1 (1)] First... || 173 || `see [#point1 (1)]` ||\ 174 || see [#point1 (1)] || 175 |----------------------------------------------------------- 176 {{{#!th rowspan=3 177 [#Escaping Escaping Markup] 178 }}} 179 || `!'' doubled quotes` ||\ 180 || !'' doubled quotes || 181 || `!wiki:WikiFormatting`, `!WikiFormatting` ||\ 182 || !wiki:WikiFormatting, !WikiFormatting || 183 || [[html(<code>`{{{-}}}` triple curly brackets</code>)]] ||\ 184 || `{{{-}}}` triple curly brackets || 185 |----------------------------------------------------------- 186 ||= [#Images Images] =|| `[[Image(`''link''`)]]` || [[Image(htdocs:../common/trac_logo_mini.png)]] || 187 |----------------------------------------------------------- 188 {{{#!th rowspan=2 189 [#Macros Macros] 190 }}} 191 || `[[MacroList(*)]]` || ''(short list of all available macros)'' || 192 || `[[Image?]]` || ''(help for the Image macro)'' || 193 |----------------------------------------------------------- 194 ||= [#Processors Processors] =||\ 195 {{{#!td 196 {{{ 197 {{{ 198 #!div style="font-size: 80%" 199 Code highlighting: 200 {{{#!python 201 hello = lambda: "world" 202 }}} 203 }}} 204 }}} 205 }}} 206 {{{#!td style="padding-left: 2em" 207 {{{ 208 #!div style="font-size: 80%" 209 Code highlighting: 210 {{{#!python 211 hello = lambda: "world" 212 }}} 213 }}} 214 }}} 215 |----------------------------------------------------------- 216 ||= [#Comments Comments] =||\ 217 {{{#!td 218 {{{ 219 {{{#!comment 220 Note to Editors: ... 221 }}} 222 }}} 223 }}} 224 {{{#!td style="padding-left: 2em" 225 {{{#!comment 226 Note to Editors: ... 227 }}} 228 }}} 229 |----------------------------------------------------------- 230 ||= [#Miscellaneous Miscellaneous] =||\ 231 {{{#!td 232 {{{ 233 Line [[br]] break 234 Line \\ break 235 ---- 236 }}} 237 }}} 238 {{{#!td style="padding-left: 2em" 239 Line [[br]] break 240 Line \\ break 241 ---- 242 }}} 243 244 == Font Styles 14 245 15 246 The Trac wiki supports the following font styles: 16 {{{ 17 * '''bold''', '''!''' can be bold too''', and '''! ''' 247 ||= Wiki Markup =||= Display =|| 248 {{{#!td 249 {{{ 250 * '''bold''', 251 ''' triple quotes !''' 252 can be bold too if prefixed by ! ''', 253 * ''italic'' 254 * '''''bold italic''''' or ''italic and 255 ''' italic bold ''' '' 256 * __underline__ 257 * {{{monospace}}} or `monospace` 258 (hence `{{{` or {{{`}}} quoting) 259 * ~~strike-through~~ 260 * ^superscript^ 261 * ,,subscript,, 262 * **also bold**, //italic as well//, 263 and **'' bold italic **'' //(since 0.12)// 264 * [[span(style=color: #FF0000, a red text )]] 265 }}} 266 }}} 267 {{{#!td 268 * '''bold''', 269 ''' triple quotes !''' 270 can be bold too if prefixed by ! ''', 18 271 * ''italic'' 19 * '''''bold italic''''' 272 * '''''bold italic''''' or ''italic and 273 ''' italic bold ''' '' 20 274 * __underline__ 21 275 * {{{monospace}}} or `monospace` 276 (hence `{{{` or {{{`}}} quoting) 22 277 * ~~strike-through~~ 23 278 * ^superscript^ 24 279 * ,,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,, 280 * **also bold**, //italic as well//, 281 and **'' bold italic **'' //(since 0.12)// 282 * [[span(style=color: #FF0000, a red text )]] 283 }}} 36 284 37 285 Notes: 38 286 * `{{{...}}}` 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 287 * {{{ ! }}} 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 ("=") 44 followed by a single space and the headline text. The line should end with a space 45 followed by the same number of ''='' characters. 46 The heading might optionally be followed by an explicit id. If not, an implicit but nevertheless readable id will be generated. 288 * all the font styles marks have to be used in opening/closing pairs, 289 and they must nest properly (in particular, an `''` italic can't be paired 290 with a `//` one, and `'''` can't be paired with `**`) 291 292 == Headings 293 294 You can create heading by starting a line with one up to six ''equal'' characters ("=") followed by a single space and the headline text. 295 296 [=#hn] 297 The headline text can be followed by the same number of "=" characters, but this is no longer mandatory. 298 299 Finally, the heading might optionally be followed by an explicit id. If not, an implicit but nevertheless readable id will be generated. 300 301 ||= Wiki Markup =||= Display =|| 302 {{{#!td 303 {{{ 304 = Heading = 305 == Subheading 306 === About ''this'' === 307 === Explicit id === #using-explicit-id-in-heading 308 == Subheading #sub2 309 }}} 310 }}} 311 {{{#!td style="padding: 1em;" 312 {{{ 313 #!div 314 = Heading = 315 == Subheading 316 === About ''this'' === 317 === Explicit id === #using-explicit-id-in-heading 318 == Subheading #sub2 319 }}} 320 }}} 321 322 == Paragraphs 323 324 A new text paragraph is created whenever two blocks of text are separated by one or more empty lines. 325 326 A forced line break can also be inserted, using: 327 ||= Wiki Markup =||= Display =|| 328 {{{#!td 329 {{{ 330 Line 1[[BR]]Line 2 331 }}} 332 {{{ 333 Paragraph 334 one 335 336 Paragraph 337 two 338 }}} 339 }}} 340 {{{#!td 341 Line 1[[BR]]Line 2 342 343 Paragraph 344 one 345 346 Paragraph 347 two 348 }}} 349 350 == Lists 351 352 The wiki supports both ordered/numbered and unordered lists. 47 353 48 354 Example: 49 {{{ 50 = Heading = 51 == Subheading == 52 === About ''this'' === 53 === Explicit id === #using-explicit-id-in-heading 54 }}} 55 56 Display: 57 = Heading = 58 == Subheading == 59 === About ''this'' === 60 === Explicit id === #using-explicit-id-in-heading 61 62 == Paragraphs == 63 64 A new text paragraph is created whenever two blocks of text are separated by one or more empty lines. 65 66 A forced line break can also be inserted, using: 67 {{{ 68 Line 1[[BR]]Line 2 69 }}} 70 Display: 71 72 Line 1[[BR]]Line 2 73 74 75 == Lists == 76 77 The wiki supports both ordered/numbered and unordered lists. 78 79 Example: 80 {{{ 355 ||= Wiki Markup =||= Display =|| 356 {{{#!td 357 {{{ 358 * Item 1 359 * Item 1.1 360 * Item 1.1.1 361 * Item 1.1.2 362 * Item 1.1.3 363 * Item 1.2 364 * Item 2 365 - items can start at the beginning of a line 366 and they can span multiple lines 367 - be careful though to continue the line 368 with the appropriate indentation, otherwise 369 that will start a new paragraph... 370 371 1. Item 1 372 a. Item 1.a 373 a. Item 1.b 374 i. Item 1.b.i 375 i. Item 1.b.ii 376 1. Item 2 377 And numbered lists can also be restarted 378 with an explicit number: 379 3. Item 3 380 }}} 381 }}} 382 {{{#!td 81 383 * Item 1 82 384 * Item 1.1 … … 86 388 * Item 1.2 87 389 * Item 2 390 - items can start at the beginning of a line 391 and they can span multiple lines 392 - be careful though to continue the line 393 with the appropriate indentation, otherwise 394 that will start a new paragraph... 88 395 89 396 1. Item 1 … … 93 400 i. Item 1.b.ii 94 401 1. Item 2 95 And numbered lists can also be givenan explicit number:402 And numbered lists can also be restarted with an explicit number: 96 403 3. Item 3 97 404 }}} 98 405 99 Display: 100 * Item 1 101 * Item 1.1 102 * Item 1.1.1 103 * Item 1.1.2 104 * Item 1.1.3 105 * Item 1.2 106 * Item 2 107 108 1. Item 1 109 a. Item 1.a 110 a. Item 1.b 111 i. Item 1.b.i 112 i. Item 1.b.ii 113 1. Item 2 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 406 == Definition Lists 122 407 123 408 The wiki also supports definition lists. 124 409 125 Example: 126 {{{ 410 ||= Wiki Markup =||= Display =|| 411 {{{#!td 412 {{{ 413 llama:: 414 some kind of mammal, with hair 415 ppython:: 416 some kind of reptile, without hair 417 (can you spot the typo?) 418 }}} 419 }}} 420 {{{#!td 127 421 llama:: 128 422 some kind of mammal, with hair … … 132 426 }}} 133 427 134 Display:135 llama::136 some kind of mammal, with hair137 ppython::138 some kind of reptile, without hair139 (can you spot the typo?)140 141 428 Note that you need a space in front of the defined term. 142 429 143 144 == Preformatted Text == 430 == Preformatted Text 145 431 146 432 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. 147 433 148 Example: 434 ||= Wiki Markup =||= Display =|| 435 {{{#!td 436 {{{ 437 {{{ 438 def HelloWorld(): 439 print '''Hello World''' 440 }}} 441 }}} 442 }}} 443 {{{#!td 444 {{{ 445 def HelloWorld(): 446 print '''Hello World''' 447 }}} 448 }}} 449 450 Note that this kind of block is also used for selecting lines that should be processed through WikiProcessors. 451 452 == Blockquotes 453 454 In order to mark a paragraph as blockquote, indent that paragraph with two spaces. 455 456 ||= Wiki Markup =||= Display =|| 457 {{{#!td 149 458 {{{ 150 {{{ 151 def HelloWorld(): 152 print "Hello World" 153 }}} 154 }}} 155 156 Display: 157 {{{ 158 def HelloWorld(): 159 print "Hello World" 160 }}} 161 162 163 == Blockquotes == 164 165 In order to mark a paragraph as blockquote, indent that paragraph with two spaces. 166 167 Example: 168 {{{ 459 Paragraph 169 460 This text is a quote from someone else. 170 461 }}} 171 172 Display: 462 }}} 463 {{{#!td 464 Paragraph 173 465 This text is a quote from someone else. 174 175 == Discussion Citations == 466 }}} 467 468 == Discussion Citations 176 469 177 470 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 471 179 Example: 180 {{{ 472 ||= Wiki Markup =||= Display =|| 473 {{{#!td 474 {{{ 475 >> Someone's original text 476 > Someone else's reply text 477 > - which can be any kind of Wiki markup 478 My reply text 479 }}} 480 }}} 481 {{{#!td 181 482 >> Someone's original text 182 483 > Someone else's reply text 484 > - which can be any kind of Wiki markup 183 485 My reply text 184 486 }}} 185 487 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.'' 192 193 == Tables == 488 == Tables 489 === Simple Tables 194 490 195 491 Simple tables can be created like this: 196 {{{ 492 ||= Wiki Markup =||= Display =|| 493 {{{#!td 494 {{{ 495 ||Cell 1||Cell 2||Cell 3|| 496 ||Cell 4||Cell 5||Cell 6|| 497 }}} 498 }}} 499 {{{#!td style="padding: 2em;" 197 500 ||Cell 1||Cell 2||Cell 3|| 198 501 ||Cell 4||Cell 5||Cell 6|| 199 502 }}} 200 503 201 Display: 202 ||Cell 1||Cell 2||Cell 3|| 203 ||Cell 4||Cell 5||Cell 6|| 204 205 Note that more complex tables can be created using 206 [wiki:WikiRestructuredText#BiggerReSTExample reStructuredText]. 207 208 209 == Links == 504 Cell headings can be specified by wrapping the content in a pair of '=' characters. 505 Note that the '=' characters have to stick to the cell separators, like this: 506 ||= Wiki Markup =||= Display =|| 507 {{{#!td 508 {{{ 509 || ||= stable =||= latest =|| 510 ||= 0.10 =|| 0.10.5 || 0.10.6dev|| 511 ||= 0.11 =|| 0.11.6 || 0.11.7dev|| 512 }}} 513 }}} 514 {{{#!td style="padding: 2em;" 515 || ||= stable =||= latest =|| 516 ||= 0.10 =|| 0.10.5 || 0.10.6dev|| 517 ||= 0.11 =|| 0.11.6 || 0.11.7dev|| 518 }}} 519 520 Finally, specifying an empty cell means that the next non empty cell will span the empty cells. For example: 521 ||= Wiki Markup =||= Display =|| 522 {{{#!td 523 {{{ 524 || 1 || 2 || 3 || 525 |||| 1-2 || 3 || 526 || 1 |||| 2-3 || 527 |||||| 1-2-3 || 528 }}} 529 }}} 530 {{{#!td style="padding: 2em;" 531 || 1 || 2 || 3 || 532 |||| 1-2 || 3 || 533 || 1 |||| 2-3 || 534 |||||| 1-2-3 || 535 }}} 536 537 Note that if the content of a cell "sticks" to one side of the cell and only one, then the text will be aligned on that side. Example: 538 ||= Wiki Markup =||= Display =|| 539 {{{#!td 540 {{{ 541 ||=Text =||= Numbers =|| 542 ||left align || 1.0|| 543 || center || 4.5|| 544 || right align|| 4.5|| 545 || default alignment || 2.5|| 546 ||default|| 2.5|| 547 || default || 2.5|| 548 || default || 2.5|| 549 }}} 550 }}} 551 {{{#!td style="padding: 2em;" 552 ||=Text =||= Numbers =|| 553 ||left align || 1.0|| 554 || center || 4.5|| 555 || right align|| 4.5|| 556 || default alignment || 2.5|| 557 ||default|| 2.5|| 558 || default || 2.5|| 559 || default || 2.5|| 560 }}} 561 562 If contrary to the example above, the cells in your table contain more text, it might be convenient to spread a table row over multiple lines of markup. The `\` character placed at the end of a line after a cell separator tells Trac to not start a new row for the cells on the next line. 563 564 ||= Wiki Markup =|| 565 {{{#!td 566 {{{ 567 || this is column 1 [http://trac.edgewall.org/newticket new ticket] || \ 568 || this is column 2 [http://trac.edgewall.org/roadmap the road ahead] || \ 569 || that's column 3 and last one || 570 }}} 571 }}} 572 |------------- 573 ||= Display =|| 574 {{{#!td style="padding: 2em;" 575 || this is column 1 [http://trac.edgewall.org/newticket new ticket] || \ 576 || this is column 2 [http://trac.edgewall.org/roadmap the road ahead] || \ 577 || that's column 3 and last one || 578 }}} 579 580 === Complex Tables 581 582 If the possibilities offered by the simple "pipe"-based markup for tables described above are not enough for your needs, you can create more elaborated tables by using [#Processors-example-tables WikiProcessor based tables]. 583 584 == Links 210 585 211 586 Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark "!" character, such as {{{!WikiPageLink}}}. 212 587 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: 224 {{{ 225 * [http://www.edgewall.com/ Edgewall Software] 226 * [wiki:TitleIndex Title Index] 227 * [wiki:ISO9000] 228 }}} 229 230 Display: 231 * [http://www.edgewall.com/ Edgewall Software] 232 * [wiki:TitleIndex Title Index] 233 * [wiki:ISO9000] 234 235 == Trac Links == 588 ||= Wiki Markup =||= Display =|| 589 {{{#!td 590 {{{ 591 TitleIndex, http://www.edgewall.com/, !NotAlink 592 }}} 593 }}} 594 {{{#!td 595 TitleIndex, http://www.edgewall.com/, !NotAlink 596 }}} 597 598 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. 599 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. 600 601 ||= Wiki Markup =||= Display =|| 602 {{{#!td 603 {{{ 604 * [http://www.edgewall.com Edgewall Software] 605 * [wiki:TitleIndex Title Index] 606 * [wiki:TitleIndex] 607 * [wiki:ISO9000] 608 }}} 609 }}} 610 {{{#!td 611 * [http://www.edgewall.com Edgewall Software] 612 * [wiki:TitleIndex Title Index] 613 * [wiki:TitleIndex] 614 * [wiki:ISO9000] 615 }}} 616 617 Following the [trac:WikiCreole] trend, the descriptive title can also be specified by writing the link followed by a pipe ('|') and a title and all this inside //double// square brackets. 618 619 {{{#!td 620 {{{ 621 * [[http://www.edgewall.com|Edgewall Software]] 622 * [[wiki:TitleIndex|Title Index]] 623 or even [[TitleIndex|Title Index]] 624 * [[wiki:TitleIndex]] 625 ''' but not ![[TitleIndex]]! ''' 626 * [[ISO9000]] 627 }}} 628 }}} 629 {{{#!td 630 * [[http://www.edgewall.com|Edgewall Software]] 631 * [[wiki:TitleIndex|Title Index]] 632 or even [[TitleIndex|Title Index]] 633 * [[wiki:TitleIndex]] 634 ''' but not ![[TitleIndex]]! ''' 635 * [[ISO9000]] 636 }}} 637 638 '''Note''': the [trac:WikiCreole] style for links is quick to type and certainly looks familiar as it is the one used on Wikipedia and in many other wikis. Unfortunately it conflicts with the syntax for [#Macros macros]. 639 So in the rare case when you need to refer to a page which is named after a macro (typical examples being TitleIndex, InterTrac and InterWiki), by writing `[[TitleIndex]]` you will actually call the macro instead of linking to the page. 640 641 == Trac Links 236 642 237 643 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 {{{ 239 * Tickets: #1 or ticket:1 240 * Reports: {1} or report:1 241 * Changesets: r1, [1] or changeset:1 242 * ... 243 }}} 244 245 Display: 644 645 ||= Wiki Markup =||= Display =|| 646 {{{#!td 647 {{{ 648 * Tickets: #1 or ticket:1 649 * Reports: {1} or report:1 650 * Changesets: r1, [1] or changeset:1 651 * ... 652 * targeting other Trac instances, 653 so called InterTrac links: 654 - Tickets: #Trac1 or Trac:ticket:1 655 - Changesets: [Trac1] or Trac:changeset:1 656 }}} 657 }}} 658 {{{#!td 246 659 * Tickets: #1 or ticket:1 247 660 * Reports: {1} or report:1 248 661 * Changesets: r1, [1] or changeset:1 249 662 * ... 250 251 There are many more flavors of Trac links, see TracLinks for more in-depth information. 252 253 254 == Escaping Links and WikiPageNames == 663 * targeting other Trac instances, 664 so called InterTrac links: 665 - Tickets: #Trac1 or Trac:ticket:1 666 - Changesets: [Trac1] or Trac:changeset:1 667 }}} 668 669 There are many more flavors of Trac links, see TracLinks for more in-depth information and a reference for all the default link resolvers. 670 671 == Setting Anchors 672 673 An anchor, or more correctly speaking, an [http://www.w3.org/TR/REC-html40/struct/links.html#h-12.2.1 anchor name] can be added explicitly at any place in the Wiki page, in order to uniquely identify a position in the document: 674 675 {{{ 676 [=#point1] 677 }}} 678 679 This syntax was chosen to match the format for explicitly naming the header id [#Headings documented above]. For example: 680 {{{ 681 == Long title == #title 682 }}} 683 684 It's also very close to the syntax for the corresponding link to that anchor: 685 {{{ 686 [#point1] 687 }}} 688 689 Optionally, a label can be given to the anchor: 690 {{{ 691 [[=#point1 '''Point 1''']] 692 }}} 693 694 ||= Wiki Markup =||= Display =|| 695 |---------------------------------- 696 {{{#!td 697 {{{ 698 [#point2 jump to the second point] 699 700 ... 701 702 Point2: [=#point2] Jump here 703 }}} 704 }}} 705 {{{#!td 706 [#point2 jump to the second point] 707 708 ... 709 710 Point2: [=#point2] Jump here 711 }}} 712 713 For more complex anchors (e.g. when a custom title is wanted), one can use the Span macro, e.g. `[[span(id=point2, class=wikianchor, title=Point 2, ^(2)^)]]`. 714 715 == Escaping Links, WikiPageNames and other Markup == #Escaping 255 716 256 717 You may avoid making hyperlinks out of TracLinks by preceding an expression with a single "!" (exclamation mark). 257 718 258 Example: 259 {{{ 719 ||= Wiki Markup =||= Display =|| 720 {{{#!td 721 {{{ 722 !NoHyperLink 723 !#42 is not a link 724 }}} 725 {{{ 726 Various forms of escaping for list markup: 727 ^^- escaped minus sign \\ 728 ^^1. escaped number \\ 729 ^^* escaped asterisk sign 730 }}} 731 }}} 732 {{{#!td 260 733 !NoHyperLink 261 734 !#42 is not a link 262 }}} 263 264 Display: 265 !NoHyperLink266 !#42 is not a link267 268 269 == Images ==735 736 Various forms of escaping for list markup: 737 ^^- escaped minus sign \\ 738 ^^1. escaped number \\ 739 ^^* escaped asterisk sign 740 }}} 741 742 == Images 270 743 271 744 Urls ending with `.png`, `.gif` or `.jpg` are no longer automatically interpreted as image links, and converted to `<img>` tags. … … 276 749 * `[[Image(wiki:WikiFormatting:picture.gif)]]` (referring to attachment on another page) 277 750 * `[[Image(ticket:1:picture.gif)]]` (file attached to a ticket) 278 * `[[Image(htdocs:picture.gif)]]` (referring to a file inside project htdocs)751 * `[[Image(htdocs:picture.gif)]]` (referring to a file inside the [TracEnvironment environment] `htdocs` directory) 279 752 * `[[Image(source:/trunk/trac/htdocs/trac_logo_mini.png)]]` (a file in repository) 280 753 281 Example display: [[Image(htdocs:../common/trac_logo_mini.png)]] 282 283 284 See WikiMacros for further documentation on the `[[Image()]]` macro. 285 286 287 == Macros == 754 ||= Wiki Markup =||= Display =|| 755 {{{#!td 756 {{{ 757 [[Image(htdocs:../common/trac_logo_mini.png)]] 758 }}} 759 }}} 760 {{{#!td 761 [[Image(htdocs:../common/trac_logo_mini.png)]] 762 }}} 763 764 See WikiMacros for further documentation on the `[[Image()]]` macro, which has several useful options (`title=`, `link=`, etc.) 765 766 == Macros 288 767 289 768 Macros are ''custom functions'' to insert dynamic content in a page. 290 769 291 Example: 292 {{{ 293 [[RecentChanges(Trac,3)]] 294 }}} 295 296 Display: 297 [[RecentChanges(Trac,3)]] 770 ||= Wiki Markup =||= Display =|| 771 {{{#!td 772 {{{ 773 [[RecentChanges(Trac,3)]] 774 }}} 775 }}} 776 {{{#!td style="padding-left: 2em" 777 [[RecentChanges(Trac,3)]] 778 }}} 298 779 299 780 See WikiMacros for more information, and a list of installed macros. 300 781 301 302 == Processors == 782 The detailed help for a specific macro can also be obtained more directly by appending a "?" to the macro name. 783 784 ||= Wiki Markup =||= Display =|| 785 {{{#!td 786 {{{ 787 [[MacroList?]] 788 }}} 789 }}} 790 {{{#!td style="padding-left: 2em" 791 [[MacroList?]] 792 }}} 793 794 == Processors 303 795 304 796 Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in 305 797 [wiki:WikiRestructuredText reStructuredText] or [wiki:WikiHtml HTML]. 306 798 307 Example 1: 308 {{{ 309 #!html 310 <pre class="wiki">{{{ 311 #!html 312 <h1 style="text-align: right; color: blue">HTML Test</h1> 313 }}}</pre> 314 }}} 315 316 Display: 799 ||= Wiki Markup =||= Display =|| 800 |-------------------------------------------------------- 801 {{{#!td align="center" colspan=2 style="border: 0px; font-size: 90%" 802 803 [=#Processors-example-html Example 1:] HTML 804 805 }}} 806 |-------------------------------------------------------- 807 {{{#!td style="border: 0px" 808 {{{ 809 {{{ 810 #!html 811 <h1 style="text-align: right; color: blue"> 812 HTML Test 813 </h1> 814 }}} 815 }}} 816 }}} 817 {{{#!td valign="top" style="border: 0px" 818 317 819 {{{ 318 820 #!html … … 320 822 }}} 321 823 322 Example: 824 }}} 825 |-------------------------------------------------------- 826 {{{#!td align="center" colspan=2 style="border: 0px; font-size: 90%" 827 828 [=#Processors-example-highlight Example 2:] Code Highlighting 829 830 }}} 831 |-------------------------------------------------------- 832 {{{#!td style="border: 0px" 833 {{{ 834 {{{ 835 #!python 836 class Test: 837 838 def __init__(self): 839 print "Hello World" 840 if __name__ == '__main__': 841 Test() 842 }}} 843 }}} 844 }}} 323 845 {{{ 324 #!html 325 <pre class="wiki">{{{ 326 #!python 327 class Test: 328 329 def __init__(self): 330 print "Hello World" 331 if __name__ == '__main__': 332 Test() 333 }}}</pre> 334 }}} 335 336 Display: 846 #!td valign="top" style="border: 0px" 847 337 848 {{{ 338 849 #!python … … 344 855 }}} 345 856 346 Perl: 857 }}} 858 |-------------------------------------------------------- 859 {{{#!td align="center" colspan=2 style="border: 0px; font-size: 90%" 860 861 [=#Processors-example-tables Example 3:] Complex Tables 862 863 }}} 864 |-------------------------------------------------------- 865 {{{#!td style="border: 0px" 866 {{{ 867 {{{#!th rowspan=4 align=justify 868 With the `#td` and `#th` processors, 869 table cells can contain any content: 870 }}} 871 |---------------- 872 {{{#!td 873 - lists 874 - embedded tables 875 - simple multiline content 876 }}} 877 |---------------- 878 {{{#!td 879 As processors can be easily nested, 880 so can be tables: 881 {{{#!th 882 Example: 883 }}} 884 {{{#!td style="background: #eef" 885 || must be at the third level now... || 886 }}} 887 }}} 888 |---------------- 889 {{{#!td 890 Even when you don't have complex markup, 891 this form of table cells can be convenient 892 to write content on multiple lines. 893 }}} 894 }}} 895 }}} 347 896 {{{ 348 #!perl 349 my ($test) = 0; 350 if ($test > 0) { 351 print "hello"; 352 } 897 #!td valign="top" style="border: 0px" 898 899 {{{#!th rowspan=4 align=justify 900 With the `#td` and `#th` processors, 901 table cells can contain any content: 902 }}} 903 |---------------- 904 {{{#!td 905 - lists 906 - embedded tables 907 - simple multiline content 908 }}} 909 |---------------- 910 {{{#!td 911 As processors can be easily nested, 912 so can be tables: 913 {{{#!th 914 Example: 915 }}} 916 {{{#!td style="background: #eef" 917 || must be at the third level now... || 918 }}} 919 }}} 920 |---------------- 921 {{{#!td 922 Even when you don't have complex markup, 923 this form of table cells can be convenient 924 to write content on multiple lines. 925 }}} 926 353 927 }}} 354 928 355 929 See WikiProcessors for more information. 356 930 357 358 == Comments == 931 == Comments 359 932 360 933 Comments can be added to the plain text. These will not be rendered and will not display in any other format than plain text. 361 {{{ 362 {{{ 363 #!comment 364 Your comment here 365 }}} 366 }}} 367 368 369 == Miscellaneous == 370 371 Four or more dashes will be replaced by a horizontal line (<HR>) 372 373 Example: 374 {{{ 375 ---- 376 }}} 377 378 Display: 934 935 ||= Wiki Markup =||= Display =|| 936 {{{#!td 937 {{{ 938 Nothing to 939 {{{ 940 #!comment 941 Your comment for editors here 942 }}} 943 see ;-) 944 }}} 945 }}} 946 {{{#!td 947 Nothing to 948 {{{ 949 #!comment 950 Your comment for editors here 951 }}} 952 see ;-) 953 }}} 954 955 == Miscellaneous 956 957 An horizontal line can be used to separated different parts of your page: 958 959 ||= Wiki Markup =||= Display =|| 960 {{{#!td 961 {{{ 962 Four or more dashes will be replaced 963 by an horizontal line (<HR>) 964 ---- 965 See? 966 }}} 967 }}} 968 {{{#!td 969 Four or more dashes will be replaced 970 by an horizontal line (<HR>) 379 971 ---- 380 381 382 383 ---- 384 See also: TracLinks, TracGuide, WikiHtml, WikiMacros, WikiProcessors, TracSyntaxColoring. 972 See? 973 }}} 974 |---------------------------------- 975 {{{#!td 976 {{{ 977 "macro" style [[br]] line break 978 }}} 979 }}} 980 {{{#!td 981 "macro" style [[br]] line break 982 }}} 983 |---------------------------------- 984 {{{#!td 985 {{{ 986 !WikiCreole style \\ line\\break 987 }}} 988 }}} 989 {{{#!td 990 !WikiCreole style \\ line\\break 991 }}}
