![(please configure the [header_logo] section in trac.ini)](/ceasy/chrome/site/your_project_logo.png){kind=logo}
Changes between Version 5 and Version 6 of WikiFormatting
- Timestamp:
- May 5, 2019, 8:06:32 PM (6 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
WikiFormatting
v5 v6 3 3 [[TracGuideToc]] 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. 6 7 Trac has a built-in small and powerful wiki rendering engine. This wiki engine implements a 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. 5 Wiki markup is a core feature in Trac, tightly integrating all the other parts of Trac into a flexible and unified whole. 6 7 Trac has a powerful wiki rendering engine that implements a subset of the commands from other popular Wikis, such as [http://moinmo.in/ MoinMoin] and [trac:WikiCreole]. 8 9 The sections below provide an overview for the most common syntax, each link in the ''Category'' column leads you to the more detailed explanation later in this page. 10 11 The following wiki pages present the advanced features of the Trac wiki markup in more depth: 12 - TracLinks covers all the possible ways to refer to any Trac resource or parts thereof. 15 13 - WikiPageNames covers the various names a wiki page can take, whether in CamelCase or not. 16 14 - WikiMacros lists the macros available for generating dynamic content. … … 27 25 || `'''bold'''`, `''italic''`, `'''''Wikipedia style'''''` || \ 28 26 || '''bold''', ''italic'', '''''Wikipedia style''''' || 27 || `**bold**`, `//italic//`, `**//!WikiCreole style//**` || \ 28 || **bold**, //italic//, **//!WikiCreole style//** || 29 29 || {{{`monospaced (''other markup ignored'')`}}} || \ 30 30 || `monospaced (''other markup ignored'')` || 31 || `**bold**`, `//italic//`, `**//!WikiCreole style//**` || \32 || **bold**, //italic//, **//!WikiCreole style//** ||33 31 |----------------------------------------------------------- 34 32 ||= [#Headings Headings] =||\ … … 96 94 {{{ 97 95 {{{ 98 multiple lines, ''no wiki'' 96 multiple lines, ''no wiki'', 99 97 white space respected 100 98 }}} … … 103 101 {{{#!td 104 102 {{{ 105 multiple lines, ''no wiki'' 103 multiple lines, ''no wiki'', 106 104 white space respected 107 105 }}} … … 195 193 {{{#!td 196 194 {{{ 197 {{{ 198 #!div style="font-size: 80%" 195 {{{#!div style="font-size: 80%" 199 196 Code highlighting: 200 197 {{{#!python … … 205 202 }}} 206 203 {{{#!td style="padding-left: 2em" 207 {{{ 208 #!div style="font-size: 80%" 204 {{{#!div style="font-size: 80%" 209 205 Code highlighting: 210 206 {{{#!python … … 222 218 }}} 223 219 }}} 224 {{{#!td style="padding-left: 2em" 225 {{{#!comment 226 Note to Editors: ... 227 }}} 228 }}} 220 || ''(comment is shown in edit mode only)'' || 229 221 |----------------------------------------------------------- 230 222 ||= [#Miscellaneous Miscellaneous] =||\ … … 285 277 Notes: 286 278 * `{{{...}}}` 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. 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.279 * {{{ ! }}} 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. 288 280 * all the font styles marks have to be used in opening/closing pairs, 289 281 and they must nest properly; in particular, an `''` italic can't be paired … … 292 284 == Headings 293 285 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.286 You can create a heading by starting a line with one up to six ''equal'' characters (`=`) followed by a single space and the headline text. 295 287 296 288 [=#hn] 297 The headline text can be followed by the same number of "="characters, but this is not mandatory. That is, `=== Section3 ===` is identical to `=== Section3`.289 The headline text can be followed by the same number of `=` characters, but this is not mandatory. That is, `=== Section3 ===` is identical to `=== Section3`. 298 290 299 291 Finally, the heading might optionally be followed by an explicit id. If not, an implicit but nevertheless readable id will be generated. … … 352 344 The wiki supports both ordered/numbered and unordered lists. 353 345 354 Example:355 346 ||= Wiki Markup =||= Display =|| 356 347 {{{#!td … … 468 459 == Discussion Citations 469 460 470 To delineate a citation in an ongoing discussion thread, such as the ticket comment area, email-like citation marks ( ">", ">>", etc.) may be used.461 To delineate a citation in an ongoing discussion thread, such as the ticket comment area, email-like citation marks (`>`, `>>`, etc.) may be used. 471 462 472 463 ||= Wiki Markup =||= Display =|| … … 489 480 === Simple Tables 490 481 491 Simple tables can be created like this:482 Simple tables can be created: 492 483 ||= Wiki Markup =||= Display =|| 493 484 {{{#!td … … 502 493 }}} 503 494 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:495 Cell headings can be specified by wrapping the content in a pair of `=` characters. 496 Note that the `=` characters have to stick to the cell separators: 506 497 ||= Wiki Markup =||= Display =|| 507 498 {{{#!td … … 518 509 }}} 519 510 520 Finally, specifying an empty cell means that the next non empty cell will span the empty cells . For example:511 Finally, specifying an empty cell means that the next non empty cell will span the empty cells: 521 512 ||= Wiki Markup =||= Display =|| 522 513 {{{#!td … … 535 526 }}} 536 527 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:528 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: 538 529 ||= Wiki Markup =||= Display =|| 539 530 {{{#!td … … 560 551 }}} 561 552 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 .553 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 554 564 555 ||= Wiki Markup =|| … … 580 571 === Complex Tables 581 572 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 elaborate tables by using [#Processors-example-tables WikiProcessor based tables].573 If the possibilities offered by the simple pipe-based markup (`||`) for tables described above are not enough for your needs, you can create more elaborate tables by using [#Processors-example-tables WikiProcessor based tables]. 583 574 584 575 == Links 585 576 586 Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark ( '!'), such as {{{!WikiPageLink}}}.577 Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark (`!`), such as `!WikiPageLink`. 587 578 588 579 ||= Wiki Markup =||= Display =|| … … 615 606 }}} 616 607 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.608 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 609 619 610 {{{#!td … … 671 662 == Setting Anchors 672 663 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 orderto uniquely identify a position in the document:664 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, to uniquely identify a position in the document: 674 665 675 666 {{{ … … 677 668 }}} 678 669 679 This syntax was chosen to match the format for explicitly naming the header id [#Headings documented above] . For example:670 This syntax was chosen to match the format for explicitly naming the header id [#Headings documented above]: 680 671 {{{ 681 672 == Long title == #title … … 715 706 == Escaping Links, WikiPageNames and other Markup == #Escaping 716 707 717 You may avoid making hyperlinks out of TracLinks by preceding an expression with a single exclamation mark ( '!').708 You may avoid making hyperlinks out of TracLinks by preceding an expression with a single exclamation mark (`!`). 718 709 719 710 ||= Wiki Markup =||= Display =|| … … 766 757 == Macros 767 758 768 Macros are ''custom functions'' t oinsert dynamic content in a page.759 Macros are ''custom functions'' that insert dynamic content in a page. 769 760 770 761 ||= Wiki Markup =||= Display =|| … … 780 771 See WikiMacros for more information, and a list of installed macros. 781 772 782 The detailed help for a specific macro can also be obtained more directly by appending a "?"to the macro name.773 The detailed help for a specific macro can also be obtained more directly by appending a `?` to the macro name. 783 774 784 775 ||= Wiki Markup =||= Display =|| … … 807 798 {{{#!td style="border: 0px" 808 799 {{{ 809 {{{ 810 #!html 800 {{{#!html 811 801 <h1 style="text-align: right; color: blue"> 812 802 HTML Test … … 817 807 {{{#!td valign="top" style="border: 0px" 818 808 819 {{{ 820 #!html 809 {{{#!html 821 810 <h1 style="text-align: right; color: blue">HTML Test</h1> 822 811 }}} … … 832 821 {{{#!td style="border: 0px" 833 822 {{{ 834 {{{ 835 #!python 823 {{{#!python 836 824 class Test: 837 825 … … 843 831 }}} 844 832 }}} 845 {{{ 846 #!td valign="top" style="border: 0px" 847 848 {{{ 849 #!python 833 {{{#!td valign="top" style="border: 0px" 834 835 {{{#!python 850 836 class Test: 851 837 def __init__(self): … … 894 880 }}} 895 881 }}} 896 {{{ 897 #!td valign="top" style="border: 0px" 882 {{{#!td valign="top" style="border: 0px" 898 883 899 884 {{{#!th rowspan=4 align=justify … … 937 922 {{{ 938 923 Nothing to 939 {{{ 940 #!comment 924 {{{#!comment 941 925 Your comment for editors here 942 926 }}} … … 946 930 {{{#!td 947 931 Nothing to 948 {{{ 949 #!comment 932 {{{#!comment 950 933 Your comment for editors here 951 934 }}}
