Changes between Version 2 and Version 3 of WikiFormatting
- Timestamp:
- Jul 27, 2010, 10:28:37 PM (14 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
WikiFormatting
v2 v3 5 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. 7 especially [http://moinmo.in/ MoinMoin] and [trac:WikiCreole]. 8 9 10 This page will give you an in-depth explanation of the wiki markup available anywhere WikiFormatting is allowed. 11 12 The ''Cheat sheet'' below gives you a quick overview for the most common syntax, each link in the ''Category'' column will lead you to the more detailed explanation later in this page. 13 14 A few other wiki pages present the advanced features of the Trac wiki markup in more depth: 15 - TracLinks covers all the possible ways to refer precisely to any Trac resource or parts thereof, 16 - WikiPageNames talks about the various names a wiki page can take, CamelCase or not 17 - WikiMacros lists the macros available for generating dynamic content, 18 - WikiProcessors and WikiHtml details how parts of the wiki text can be processed in special ways 19 20 21 == Cheat sheet == 22 23 ||= '''Category''' =||= '''Wiki Markup''' =||= '''Display''' =|| 24 |----------------------------------------------------------- 25 {{{#!th rowspan=3 26 [#FontStyles Font Styles] 27 }}} 28 || `'''bold'''`, `''italic''`, `'''''Wikipedia style'''''` || \ 29 || '''bold''', ''italic'', '''''Wikipedia style''''' || 30 || {{{`monospaced and ''nowiki''`}}} || \ 31 || `monospaced and nowiki` || 32 || `**bold**`, `//italic//`, `**//!WikiCreole style//**` || \ 33 || **bold**, //italic//, **//!WikiCreole style//** || 34 |----------------------------------------------------------- 35 ||= [#Headings Headings] =||\ 36 {{{#!td 37 {{{ 38 == Level 2 == 39 === Level 3 ^([#hn note])^ 40 }}} 41 }}} 42 {{{#!td style="padding-left: 2em" 43 == Level 2 44 === Level 3 ^([#hn note])^ 45 }}} 46 |----------------------------------------------------------- 47 ||= [#Paragraphs Paragraphs] =||\ 48 {{{#!td 49 {{{ 50 First paragraph 51 on multiple lines. 52 53 Second paragraph. 54 }}} 55 }}} 56 {{{#!td 57 First paragraph 58 on multiple lines. 59 60 Second paragraph. 61 }}} 62 |----------------------------------------------------------- 63 ||= [#Lists Lists] =||\ 64 {{{#!td 65 {{{ 66 * bullets list 67 on multiple paragraphs 68 1. nested list 69 a. different numbering 70 styles 71 }}} 72 }}} 73 {{{#!td 74 * bullets list 75 on multiple paragraphs 76 1. nested list 77 a. different numbering 78 styles 79 }}} 80 |----------------------------------------------------------- 81 {{{#!th 82 [#DefinitionLists Definition Lists] 83 }}} 84 {{{#!td 85 {{{ 86 term:: definition on 87 multiple paragraphs 88 }}} 89 }}} 90 {{{#!td 91 term:: definition on 92 multiple paragraphs 93 }}} 94 |----------------------------------------------------------- 95 ||= [#PreformattedText Preformatted Text] =||\ 96 {{{#!td 97 {{{ 98 {{{ 99 multiple lines, ''no wiki'' 100 white space respected 101 }}} 102 }}} 103 }}} 104 {{{#!td 105 {{{ 106 multiple lines, ''no wiki'' 107 white space respected 108 }}} 109 }}} 110 |----------------------------------------------------------- 111 ||= [#Blockquotes Blockquotes] =||\ 112 {{{#!td 113 {{{ 114 if there's some leading 115 space the text is quoted 116 }}} 117 }}} 118 {{{#!td 119 if there's some leading 120 space the text is quoted 121 }}} 122 |----------------------------------------------------------- 123 ||= [#DiscussionCitations Discussion Citations] =||\ 124 {{{#!td 125 {{{ 126 >> ... (I said) 127 > (he replied) 128 }}} 129 }}} 130 {{{#!td 131 >>... (I said) 132 > (he replied) 133 }}} 134 |----------------------------------------------------------- 135 ||= [#Tables Tables] =||\ 136 {{{#!td 137 {{{ 138 ||= Table Header =|| Cell || 139 |||| (details below) || 140 }}} 141 }}} 142 {{{#!td 143 ||= Table Header =|| Cell || 144 |||| (details below) || 145 }}} 146 |----------------------------------------------------------- 147 {{{#!th rowspan=2 148 [#Links Links] 149 }}} 150 || `http://trac.edgewall.org` ||\ 151 || http://trac.edgewall.org || 152 || `WikiFormatting (CamelCase)` ||\ 153 || WikiFormatting (CamelCase) || 154 |----------------------------------------------------------- 155 {{{#!th rowspan=5 156 [#TracLinks TracLinks] 157 }}} 158 || `wiki:WikiFormatting`, `wiki:"WikiFormatting"` ||\ 159 || wiki:WikiFormatting, wiki:"WikiFormatting" || 160 || `#1 (ticket)`, `[1] (changeset)`, `{1} (report)` ||\ 161 || #1 (ticket), [1] (changeset), {1} (report) || 162 || `ticket:1, ticket:1#comment:1` ||\ 163 || ticket:1, ticket:1#comment:1 || 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 || Ticket [[ticket:1]], [[ticket:1|ticket one]] || 168 |----------------------------------------------------------- 169 {{{#!th rowspan=2 170 [#SettingAnchors Setting Anchors] 171 }}} 172 || `[=#point1 (1)] First...` ||\ 173 || [=#point1 (1)] First... || 174 || `see [#point1 (1)]` ||\ 175 || see [#point1 (1)] || 176 |----------------------------------------------------------- 177 {{{#!th rowspan=2 178 [#EscapingLinksandWikiPageNames Escaping Markup] 179 }}} 180 || `!'' doubled quotes` ||\ 181 || !'' doubled quotes || 182 || `!wiki:WikiFormatting`, `!WikiFormatting` ||\ 183 || !wiki:WikiFormatting, !WikiFormatting || 184 |----------------------------------------------------------- 185 ||= [#Images Images] =|| `[[Image(`''link''`)]]` || [[Image(htdocs:../common/trac_logo_mini.png)]] || 186 |----------------------------------------------------------- 187 {{{#!th rowspan=2 188 [#Macros Macros] 189 }}} 190 || `[[MacroList(*)]]` || ''(short list of all available macros)'' || 191 || `[[Image?]]` || ''(help for the Image macro)'' || 192 |----------------------------------------------------------- 193 ||= [#Processors Processors] =||\ 194 {{{#!td 195 {{{ 196 {{{ 197 #!div style="font-size: 80%" 198 Code highlighting: 199 {{{#!python 200 hello = lambda: "world" 201 }}} 202 }}} 203 }}} 204 }}} 205 {{{#!td style="padding-left: 2em" 206 {{{ 207 #!div style="font-size: 80%" 208 Code highlighting: 209 {{{#!python 210 hello = lambda: "world" 211 }}} 212 }}} 213 }}} 214 |----------------------------------------------------------- 215 ||= [#Comments Comments] =||\ 216 {{{#!td 217 {{{ 218 {{{#!comment 219 Note to Editors: ... 220 }}} 221 }}} 222 }}} 223 {{{#!td style="padding-left: 2em" 224 {{{#!comment 225 Note to Editors: ... 226 }}} 227 }}} 228 |----------------------------------------------------------- 229 ||= [#Miscellaneous Miscellaneous] =||\ 230 {{{#!td 231 {{{ 232 Line [[br]] break 233 Line \\ break 234 ---- 235 }}} 236 }}} 237 {{{#!td style="padding-left: 2em" 238 Line [[br]] break 239 Line \\ break 240 ---- 241 }}} 11 242 12 243 … … 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 }}} 265 }}} 266 {{{#!td 267 * '''bold''', 268 ''' triple quotes !''' 269 can be bold too if prefixed by ! ''', 18 270 * ''italic'' 19 * '''''bold italic''''' 271 * '''''bold italic''''' or ''italic and 272 ''' italic bold ''' '' 20 273 * __underline__ 21 274 * {{{monospace}}} or `monospace` 275 (hence `{{{` or {{{`}}} quoting) 22 276 * ~~strike-through~~ 23 277 * ^superscript^ 24 278 * ,,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,, 279 * **also bold**, //italic as well//, 280 and **'' bold italic **'' //(since 0.12)// 281 }}} 36 282 37 283 Notes: 38 284 * `{{{...}}}` 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 285 * {{{ ! }}} 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. 286 * all the font styles marks have to be used in opening/closing pairs, 287 and they must nest properly (in particular, an `''` italic can't be paired 288 with a `//` one, and `'''` can't be paired with `**`) 289 40 290 41 291 == Headings == 42 292 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. 293 You can create heading by starting a line with one up to six ''equal'' characters ("=") 294 followed by a single space and the headline text. 295 296 [=#hn] The headline text can be followed by the same number of "=" characters, but this is no longer mandatory. 297 298 Finally, the heading might optionally be followed by an explicit id. If not, an implicit but nevertheless readable id will be generated. 299 300 ||= Wiki Markup =||= Display =|| 301 {{{#!td 302 {{{ 303 = Heading = 304 == Subheading 305 === About ''this'' === 306 === Explicit id === #using-explicit-id-in-heading 307 == Subheading #sub2 308 }}} 309 }}} 310 {{{#!td style="padding: 1em;" 311 {{{ 312 #!div 313 == Subheading 314 === About ''this'' === 315 === Explicit id === #using-explicit-id-in-heading 316 == Subheading #sub2 317 }}} 318 }}} 319 320 == Paragraphs == 321 322 A new text paragraph is created whenever two blocks of text are separated by one or more empty lines. 323 324 A forced line break can also be inserted, using: 325 ||= Wiki Markup =||= Display =|| 326 {{{#!td 327 {{{ 328 Line 1[[BR]]Line 2 329 }}} 330 {{{ 331 Paragraph 332 one 333 334 Paragraph 335 two 336 }}} 337 }}} 338 {{{#!td 339 Line 1[[BR]]Line 2 340 341 Paragraph 342 one 343 344 Paragraph 345 two 346 }}} 347 348 == Lists == 349 350 The wiki supports both ordered/numbered and unordered lists. 47 351 48 352 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 {{{ 353 ||= Wiki Markup =||= Display =|| 354 {{{#!td 355 {{{ 356 * Item 1 357 * Item 1.1 358 * Item 1.1.1 359 * Item 1.1.2 360 * Item 1.1.3 361 * Item 1.2 362 * Item 2 363 - items can start at the beginning of a line 364 and they can span multiple lines 365 - be careful though to continue the line 366 with the appropriate indentation, otherwise 367 that will start a new paragraph... 368 369 1. Item 1 370 a. Item 1.a 371 a. Item 1.b 372 i. Item 1.b.i 373 i. Item 1.b.ii 374 1. Item 2 375 And numbered lists can also be restarted 376 with an explicit number: 377 3. Item 3 378 }}} 379 }}} 380 {{{#!td 81 381 * Item 1 82 382 * Item 1.1 383 * Item 1.1.1 384 * Item 1.1.2 385 * Item 1.1.3 386 * Item 1.2 83 387 * Item 2 388 - items can start at the beginning of a line 389 and they can span multiple lines 390 - be careful though to continue the line 391 with the appropriate indentation, otherwise 392 that will start a new paragraph... 84 393 85 394 1. Item 1 … … 89 398 i. Item 1.b.ii 90 399 1. Item 2 91 And numbered lists can also be givenan explicit number:400 And numbered lists can also be restarted with an explicit number: 92 401 3. Item 3 93 402 }}} 94 403 95 Display:96 * Item 197 * Item 1.198 * Item 299 100 1. Item 1101 a. Item 1.a102 a. Item 1.b103 i. Item 1.b.i104 i. Item 1.b.ii105 1. Item 2106 And numbered lists can also be given an explicit number:107 3. Item 3108 109 Note that there must be one or more spaces preceding the list item markers, otherwise the list will be treated as a normal paragraph.110 111 404 112 405 == Definition Lists == 113 406 114 115 407 The wiki also supports definition lists. 116 408 117 Example: 118 {{{ 409 ||= Wiki Markup =||= Display =|| 410 {{{#!td 411 {{{ 412 llama:: 413 some kind of mammal, with hair 414 ppython:: 415 some kind of reptile, without hair 416 (can you spot the typo?) 417 }}} 418 }}} 419 {{{#!td 119 420 llama:: 120 421 some kind of mammal, with hair … … 124 425 }}} 125 426 126 Display:127 llama::128 some kind of mammal, with hair129 ppython::130 some kind of reptile, without hair131 (can you spot the typo?)132 133 427 Note that you need a space in front of the defined term. 134 428 … … 138 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. 139 433 140 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 141 458 {{{ 142 {{{ 143 def HelloWorld(): 144 print "Hello World" 145 }}} 146 }}} 147 148 Display: 149 {{{ 150 def HelloWorld(): 151 print "Hello World" 152 }}} 153 154 155 == Blockquotes == 156 157 In order to mark a paragraph as blockquote, indent that paragraph with two spaces. 158 159 Example: 160 {{{ 459 Paragraph 161 460 This text is a quote from someone else. 162 461 }}} 163 164 Display: 462 }}} 463 {{{#!td 464 Paragraph 165 465 This text is a quote from someone else. 466 }}} 166 467 167 468 == Discussion Citations == … … 169 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. 170 471 171 Example: 172 {{{ 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 173 482 >> Someone's original text 174 483 > Someone else's reply text 484 > - which can be any kind of Wiki markup 175 485 My reply text 176 486 }}} 177 487 178 Display:179 >> Someone's original text180 > Someone else's reply text181 My reply text182 183 ''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.''184 488 185 489 == Tables == 186 490 === Simple Tables === 187 491 Simple tables can be created like this: 188 {{{ 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;" 189 500 ||Cell 1||Cell 2||Cell 3|| 190 501 ||Cell 4||Cell 5||Cell 6|| 191 502 }}} 192 503 193 Display: 194 ||Cell 1||Cell 2||Cell 3|| 195 ||Cell 4||Cell 5||Cell 6|| 196 197 Note that more complex tables can be created using 198 [wiki:WikiRestructuredText#BiggerReSTExample reStructuredText]. 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]. 199 583 200 584 … … 203 587 Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark "!" character, such as {{{!WikiPageLink}}}. 204 588 205 Example: 206 {{{ 207 TitleIndex, http://www.edgewall.com/, !NotAlink 208 }}} 209 210 Display: 211 TitleIndex, http://www.edgewall.com/, !NotAlink 212 213 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. 214 215 Example: 216 {{{ 217 * [http://www.edgewall.com/ Edgewall Software] 218 * [wiki:TitleIndex Title Index] 219 * [wiki:ISO9000] 220 }}} 221 222 Display: 223 * [http://www.edgewall.com/ Edgewall Software] 224 * [wiki:TitleIndex Title Index] 225 * [wiki:ISO9000] 226 227 228 === Trac Links === 589 ||= Wiki Markup =||= Display =|| 590 {{{#!td 591 {{{ 592 TitleIndex, http://www.edgewall.com/, !NotAlink 593 }}} 594 }}} 595 {{{#!td 596 TitleIndex, http://www.edgewall.com/, !NotAlink 597 }}} 598 599 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. 600 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. 601 602 ||= Wiki Markup =||= Display =|| 603 {{{#!td 604 {{{ 605 * [http://www.edgewall.com Edgewall Software] 606 * [wiki:TitleIndex Title Index] 607 * [wiki:TitleIndex] 608 * [wiki:ISO9000] 609 }}} 610 }}} 611 {{{#!td 612 * [http://www.edgewall.com Edgewall Software] 613 * [wiki:TitleIndex Title Index] 614 * [wiki:TitleIndex] 615 * [wiki:ISO9000] 616 }}} 617 618 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. 619 620 {{{#!td 621 {{{ 622 * [[http://www.edgewall.com|Edgewall Software]] 623 * [[wiki:TitleIndex|Title Index]] 624 or even [[TitleIndex|Title Index]] 625 * [[wiki:TitleIndex]] 626 ''' but not ![[TitleIndex]]! ''' 627 * [[ISO9000]] 628 }}} 629 }}} 630 {{{#!td 631 * [[http://www.edgewall.com|Edgewall Software]] 632 * [[wiki:TitleIndex|Title Index]] 633 or even [[TitleIndex|Title Index]] 634 * [[wiki:TitleIndex]] 635 ''' but not ![[TitleIndex]]! ''' 636 * [[ISO9000]] 637 }}} 638 639 '''Note''': the [trac:WikiCreole] style for links is quick to type and 640 certainly looks familiar as it's the one used on Wikipedia and in many 641 other wikis. Unfortunately it conflicts with the syntax for [#Macros macros]. 642 So in the rare case when you need to refer to a page which is named after 643 a macro (typical examples being TitleIndex, InterTrac and InterWiki), 644 by writing `[[TitleIndex]]` you will actually call the macro instead of linking 645 to the page. 646 647 == Trac Links == 229 648 230 649 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: 231 {{{ 232 * Tickets: #1 or ticket:1 233 * Reports: {1} or report:1 234 * Changesets: r1, [1] or changeset:1 235 * ... 236 }}} 237 238 Display: 650 651 ||= Wiki Markup =||= Display =|| 652 {{{#!td 653 {{{ 654 * Tickets: #1 or ticket:1 655 * Reports: {1} or report:1 656 * Changesets: r1, [1] or changeset:1 657 * ... 658 * targeting other Trac instances, 659 so called InterTrac links: 660 - Tickets: #Trac1 or Trac:ticket:1 661 - Changesets: [Trac1] or Trac:changeset:1 662 }}} 663 }}} 664 {{{#!td 239 665 * Tickets: #1 or ticket:1 240 666 * Reports: {1} or report:1 241 667 * Changesets: r1, [1] or changeset:1 242 668 * ... 243 244 See TracLinks for more in-depth information. 669 * targeting other Trac instances, 670 so called InterTrac links: 671 - Tickets: #Trac1 or Trac:ticket:1 672 - Changesets: [Trac1] or Trac:changeset:1 673 }}} 674 675 There are many more flavors of Trac links, see TracLinks for more in-depth information and a reference for all the default link resolvers. 676 677 678 == Setting Anchors == 679 680 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: 681 682 {{{ 683 [=#point1] 684 }}} 685 686 This syntax was chosen to match the format for explicitly naming the header id [#Headings documented above]. For example: 687 {{{ 688 == Long title == #title 689 }}} 690 691 It's also very close to the syntax for the corresponding link to that anchor: 692 {{{ 693 [#point1] 694 }}} 695 696 Optionally, a label can be given to the anchor: 697 {{{ 698 [[=#point1 '''Point 1''']] 699 }}} 700 701 ||= Wiki Markup =||= Display =|| 702 |---------------------------------- 703 {{{#!td 704 {{{ 705 [#point2 jump to the second point] 706 707 ... 708 709 Point2: [=#point2] Jump here 710 }}} 711 }}} 712 {{{#!td 713 [#point2 jump to the second point] 714 715 ... 716 717 Point2: [=#point2] Jump here 718 }}} 719 720 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)^)]]`. 245 721 246 722 … … 249 725 You may avoid making hyperlinks out of TracLinks by preceding an expression with a single "!" (exclamation mark). 250 726 251 Example: 252 {{{ 727 ||= Wiki Markup =||= Display =|| 728 {{{#!td 729 {{{ 730 !NoHyperLink 731 !#42 is not a link 732 }}} 733 }}} 734 {{{#!td 253 735 !NoHyperLink 254 736 !#42 is not a link 255 737 }}} 256 738 257 Display:258 !NoHyperLink259 !#42 is not a link260 261 262 739 == Images == 263 740 264 741 Urls ending with `.png`, `.gif` or `.jpg` are no longer automatically interpreted as image links, and converted to `<img>` tags. 265 742 266 You now have to use the ![[Image]] macro (see below). 743 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)]]`. 744 745 In addition to the current page, it is possible to refer to other resources: 746 * `[[Image(wiki:WikiFormatting:picture.gif)]]` (referring to attachment on another page) 747 * `[[Image(ticket:1:picture.gif)]]` (file attached to a ticket) 748 * `[[Image(htdocs:picture.gif)]]` (referring to a file inside project htdocs) 749 * `[[Image(source:/trunk/trac/htdocs/trac_logo_mini.png)]]` (a file in repository) 750 751 ||= Wiki Markup =||= Display =|| 752 {{{#!td 753 {{{ 754 [[Image(htdocs:../common/trac_logo_mini.png)]] 755 }}} 756 }}} 757 {{{#!td 758 [[Image(htdocs:../common/trac_logo_mini.png)]] 759 }}} 760 761 See WikiMacros for further documentation on the `[[Image()]]` macro. 267 762 268 763 … … 271 766 Macros are ''custom functions'' to insert dynamic content in a page. 272 767 273 Example: 274 {{{ 275 [[Timestamp]] 276 }}} 277 278 Display: 279 [[Timestamp]] 768 ||= Wiki Markup =||= Display =|| 769 {{{#!td 770 {{{ 771 [[RecentChanges(Trac,3)]] 772 }}} 773 }}} 774 {{{#!td style="padding-left: 2em" 775 [[RecentChanges(Trac,3)]] 776 }}} 280 777 281 778 See WikiMacros for more information, and a list of installed macros. 779 780 The detailed help for a specific macro can also be obtained more directly by appending a "?" to the macro name. 781 782 ||= Wiki Markup =||= Display =|| 783 {{{#!td 784 {{{ 785 [[MacroList?]] 786 }}} 787 }}} 788 {{{#!td style="padding-left: 2em" 789 [[MacroList?]] 790 }}} 282 791 283 792 … … 287 796 [wiki:WikiRestructuredText reStructuredText] or [wiki:WikiHtml HTML]. 288 797 289 Example 1: 290 {{{ 291 #!html 292 <pre class="wiki">{{{ 293 #!html 294 <h1 style="text-align: right; color: blue">HTML Test</h1> 295 }}}</pre> 296 }}} 297 298 Display: 798 ||= Wiki Markup =||= Display =|| 799 |-------------------------------------------------------- 800 {{{#!td align="center" colspan=2 style="border: 0px; font-size: 90%" 801 802 [=#Processors-example-html Example 1:] HTML 803 804 }}} 805 |-------------------------------------------------------- 806 {{{#!td style="border: 0px" 807 {{{ 808 {{{ 809 #!html 810 <h1 style="text-align: right; color: blue"> 811 HTML Test 812 </h1> 813 }}} 814 }}} 815 }}} 816 {{{#!td valign="top" style="border: 0px" 817 299 818 {{{ 300 819 #!html … … 302 821 }}} 303 822 304 Example: 823 }}} 824 |-------------------------------------------------------- 825 {{{#!td align="center" colspan=2 style="border: 0px; font-size: 90%" 826 827 [=#Processors-example-highlight Example 2:] Code Highlighting 828 829 }}} 830 |-------------------------------------------------------- 831 {{{#!td style="border: 0px" 832 {{{ 833 {{{ 834 #!python 835 class Test: 836 837 def __init__(self): 838 print "Hello World" 839 if __name__ == '__main__': 840 Test() 841 }}} 842 }}} 843 }}} 305 844 {{{ 306 #!html 307 <pre class="wiki">{{{ 308 #!python 309 class Test: 310 311 def __init__(self): 312 print "Hello World" 313 if __name__ == '__main__': 314 Test() 315 }}}</pre> 316 }}} 317 318 Display: 845 #!td valign="top" style="border: 0px" 846 319 847 {{{ 320 848 #!python … … 326 854 }}} 327 855 328 Perl: 856 }}} 857 |-------------------------------------------------------- 858 {{{#!td align="center" colspan=2 style="border: 0px; font-size: 90%" 859 860 [=#Processors-example-tables Example 3:] Complex Tables 861 862 }}} 863 |-------------------------------------------------------- 864 {{{#!td style="border: 0px" 865 {{{ 866 {{{#!th rowspan=4 align=justify 867 With the `#td` and `#th` processors, 868 table cells can contain any content: 869 }}} 870 |---------------- 871 {{{#!td 872 - lists 873 - embedded tables 874 - simple multiline content 875 }}} 876 |---------------- 877 {{{#!td 878 As processors can be easily nested, 879 so can be tables: 880 {{{#!th 881 Example: 882 }}} 883 {{{#!td style="background: #eef" 884 || must be at the third level now... || 885 }}} 886 }}} 887 |---------------- 888 {{{#!td 889 Even when you don't have complex markup, 890 this form of table cells can be convenient 891 to write content on multiple lines. 892 }}} 893 }}} 894 }}} 329 895 {{{ 330 #!perl 331 my ($test) = 0; 332 if ($test > 0) { 333 print "hello"; 334 } 896 #!td valign="top" style="border: 0px" 897 898 {{{#!th rowspan=4 align=justify 899 With the `#td` and `#th` processors, 900 table cells can contain any content: 901 }}} 902 |---------------- 903 {{{#!td 904 - lists 905 - embedded tables 906 - simple multiline content 907 }}} 908 |---------------- 909 {{{#!td 910 As processors can be easily nested, 911 so can be tables: 912 {{{#!th 913 Example: 914 }}} 915 {{{#!td style="background: #eef" 916 || must be at the third level now... || 917 }}} 918 }}} 919 |---------------- 920 {{{#!td 921 Even when you don't have complex markup, 922 this form of table cells can be convenient 923 to write content on multiple lines. 924 }}} 925 335 926 }}} 336 927 … … 338 929 339 930 931 == Comments == 932 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. 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 340 955 == Miscellaneous == 341 956 342 Four or more dashes will be replaced by a horizontal line (<HR>) 343 344 Example: 345 {{{ 346 ---- 347 }}} 348 349 Display: 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>) 350 971 ---- 351 352 353 ---- 354 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 }}}
