Changes between Version 1 and Version 2 of WikiFormatting


Ignore:
Timestamp:
Jan 13, 2020, 11:30:06 PM (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • WikiFormatting

    v1 v2  
    1 = WikiFormatting =
     1= WikiFormatting
     2
    23[[TracGuideToc]]
    34
    4 Wiki markup is a core feature in Trac, tightly integrating all the other parts of Trac into a flexible and powerful whole.
    5 
    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://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 ==
     5Wiki markup is a core feature in Trac, tightly integrating all the other parts of Trac into a flexible and unified whole.
     6
     7Trac 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
     9The 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
     11The 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.
     13 - WikiPageNames covers the various names a wiki page can take, whether in CamelCase or not.
     14 - WikiMacros lists the macros available for generating dynamic content.
     15 - WikiProcessors and WikiHtml details how parts of the wiki text can be processed in special ways.
     16 - [trac:wiki:TracDev/Proposals/AdvancedWikiOperations AdvancedWikiOperations] provides some operations in uncommon or administrative scenarios.
     17
     18== Common wiki markup
    2219
    2320||= '''Category''' =||= '''Wiki Markup''' =||= '''Display''' =||
    … …  
    2825|| `'''bold'''`, `''italic''`, `'''''Wikipedia style'''''` || \
    2926|| '''bold''', ''italic'', '''''Wikipedia style''''' ||
     27|| `**bold**`, `//italic//`, `**//!WikiCreole style//**` || \
     28|| **bold**, //italic//, **//!WikiCreole style//** ||
    3029|| {{{`monospaced (''other markup ignored'')`}}} || \
    3130|| `monospaced (''other markup ignored'')` ||
    32 || `**bold**`, `//italic//`, `**//!WikiCreole style//**` || \
    33 || **bold**, //italic//, **//!WikiCreole style//** ||
    3431|-----------------------------------------------------------
    3532||= [#Headings Headings] =||\
    3633{{{#!td
    3734 {{{
    38  == Level 2 ==
     35 == Level 2
    3936 === Level 3 ^([#hn note])^
    4037 }}}
    4138}}}
    4239{{{#!td style="padding-left: 2em"
    43 == Level 2 ==
     40== Level 2
    4441=== Level 3 ^([#hn note])^
    4542}}}
    … …  
    6461{{{#!td
    6562 {{{
    66  * bullets list
     63 * bullet list
    6764   on multiple lines
    6865   1. nested list
    … …  
    7269}}}
    7370{{{#!td
    74 * bullets list
     71* bullet list
    7572  on multiple lines
    7673  1. nested list
    … …  
    9794 {{{
    9895 {{{
    99  multiple lines, ''no wiki''
     96 multiple lines, ''no wiki'',
    10097       white space respected
    10198 }}}
    … …  
    104101{{{#!td
    105102 {{{
    106  multiple lines, ''no wiki''
     103 multiple lines, ''no wiki'',
    107104       white space respected
    108105 }}}
    … …  
    160157|| `#1 (ticket)`, `[1] (changeset)`, `{1} (report)` ||\
    161158|| #1 (ticket), [1] (changeset), {1} (report) ||
    162 || `ticket:1, ticket:1#comment:1` ||\
    163 || ticket:1, ticket:1#comment:1 ||
     159|| `ticket:1, ticket:1#comment:1, comment:1:ticket:1` ||\
     160|| ticket:1, ticket:1#comment:1, comment:1:ticket:1 ||
    164161|| `Ticket [ticket:1]`, `[ticket:1 ticket one]` ||\
    165162|| Ticket [ticket:1], [ticket:1 ticket one] ||
    … …  
    182179|| `!wiki:WikiFormatting`, `!WikiFormatting` ||\
    183180|| !wiki:WikiFormatting, !WikiFormatting ||
    184 || {{{`}}}`{{{-}}}`{{{`}}}` triple curly brackets` ||\
     181|| [[html(<code>`{{{-}}}` triple curly brackets</code>)]] ||\
    185182|| `{{{-}}}` triple curly brackets ||
    186183|-----------------------------------------------------------
    … …  
    196193{{{#!td
    197194 {{{
    198  {{{
    199  #!div style="font-size: 80%"
     195 {{{#!div style="font-size: 80%"
    200196 Code highlighting:
    201197   {{{#!python
    … …  
    206202}}}
    207203{{{#!td style="padding-left: 2em"
    208  {{{
    209  #!div style="font-size: 80%"
     204 {{{#!div style="font-size: 80%"
    210205 Code highlighting:
    211206   {{{#!python
    … …  
    223218 }}}
    224219}}}
    225 {{{#!td style="padding-left: 2em"
    226  {{{#!comment
    227  Note to Editors: ...
    228  }}}
    229 }}}
     220||  ''(comment is shown in edit mode only)''  ||
    230221|-----------------------------------------------------------
    231222||= [#Miscellaneous Miscellaneous] =||\
    … …  
    243234}}}
    244235
    245 
    246 == Font Styles ==
     236== Font Styles
    247237
    248238The Trac wiki supports the following font styles:
    … …  
    287277Notes:
    288278 * `{{{...}}}` 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.
    289  * {{{ ! }}} 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.
    290280 * all the font styles marks have to be used in opening/closing pairs,
    291    and they must nest properly (in particular, an `''` italic can't be paired
    292    with a `//` one, and `'''` can't be paired with `**`)
    293 
    294 
    295 == Headings ==
    296 
    297 You can create heading by starting a line with one up to six ''equal'' characters ("=")
    298 followed by a single space and the headline text.
     281   and they must nest properly; in particular, an `''` italic can't be paired
     282   with a `//` one, and `'''` can't be paired with `**`.
     283
     284== Headings
     285
     286You can create a heading by starting a line with one up to six ''equal'' characters (`=`) followed by a single space and the headline text.
    299287
    300288[=#hn]
    301 The headline text can be followed by the same number of "=" characters, but this is no longer mandatory.
     289The headline text can be followed by the same number of `=` characters, but this is not mandatory. That is, `=== Section3 ===` is identical to `=== Section3`.
    302290
    303291Finally, the heading might optionally be followed by an explicit id. If not, an implicit but nevertheless readable id will be generated.
    … …  
    324312}}}
    325313
    326 == Paragraphs ==
     314== Paragraphs
    327315
    328316A new text paragraph is created whenever two blocks of text are separated by one or more empty lines.
    … …  
    352340}}}
    353341
    354 == Lists ==
     342== Lists
    355343
    356344The wiki supports both ordered/numbered and unordered lists.
    357345
    358 Example:
    359346||= Wiki Markup =||= Display =||
    360347{{{#!td
    … …  
    408395}}}
    409396
    410 
    411 == Definition Lists ==
     397== Definition Lists
    412398
    413399The wiki also supports definition lists.
    … …  
    433419Note that you need a space in front of the defined term.
    434420
    435 
    436 == Preformatted Text ==
     421== Preformatted Text
    437422
    438423Block 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.
    … …  
    456441Note that this kind of block is also used for selecting lines that should be processed through WikiProcessors.
    457442
    458 == Blockquotes ==
     443== Blockquotes
    459444
    460445In order to mark a paragraph as blockquote, indent that paragraph with two spaces.
    … …  
    472457}}}
    473458
    474 == Discussion Citations ==
    475 
    476 To delineate a citation in an ongoing discussion thread, such as the ticket comment area, e-mail-like citation marks (">", ">>", etc.) may be used. 
     459== Discussion Citations
     460
     461To delineate a citation in an ongoing discussion thread, such as the ticket comment area, email-like citation marks (`>`, `>>`, etc.) may be used. 
    477462
    478463||= Wiki Markup =||= Display =||
    … …  
    492477}}}
    493478
    494 
    495 == Tables ==
    496 === Simple Tables ===
    497 Simple tables can be created like this:
     479== Tables
     480=== Simple Tables
     481
     482Simple tables can be created:
    498483||= Wiki Markup =||= Display =||
    499484{{{#!td
    … …  
    508493}}}
    509494
    510 Cell headings can be specified by wrapping the content in a pair of '=' characters.
    511 Note that the '=' characters have to stick to the cell separators, like this:
     495Cell headings can be specified by wrapping the content in a pair of `=` characters.
     496Note that the `=` characters have to stick to the cell separators:
    512497||= Wiki Markup =||= Display =||
    513498{{{#!td
    … …  
    524509}}}
    525510
    526 Finally, specifying an empty cell means that the next non empty cell will span the empty cells. For example:
     511Finally, specifying an empty cell means that the next non empty cell will span the empty cells:
    527512||= Wiki Markup =||= Display =||
    528513{{{#!td
    … …  
    541526}}}
    542527
    543 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:
     528Note 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:
    544529||= Wiki Markup =||= Display =||
    545530{{{#!td
    … …  
    566551}}}
    567552
    568 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.
     553If 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:
    569554
    570555||= Wiki Markup =||
    … …  
    584569}}}
    585570
    586 === Complex Tables ===
    587 
    588 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].
    589 
    590 
    591 == Links ==
    592 
    593 Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark "!" character, such as {{{!WikiPageLink}}}.
     571=== Complex Tables
     572
     573If 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].
     574
     575== Links
     576
     577Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark (`!`), such as `!WikiPageLink`.
    594578
    595579||= Wiki Markup =||= Display =||
    … …  
    622606}}}
    623607
    624 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.
     608Following 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.
    625609
    626610{{{#!td
    … …  
    643627}}}
    644628
    645 '''Note''': the [trac:WikiCreole] style for links is quick to type and
    646 certainly looks familiar as it's the one used on Wikipedia and in many
    647 other wikis. Unfortunately it conflicts with the syntax for [#Macros macros].
    648 So in the rare case when you need to refer to a page which is named after
    649 a macro (typical examples being TitleIndex, InterTrac and InterWiki),
    650 by writing `[[TitleIndex]]` you will actually call the macro instead of linking
    651 to the page.
    652 
    653 == Trac Links ==
     629'''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].
     630So 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.
     631
     632== Trac Links
    654633
    655634Wiki 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:
    … …  
    681660There are many more flavors of Trac links, see TracLinks for more in-depth information and a reference for all the default link resolvers.
    682661
    683 
    684 == Setting Anchors ==
    685 
    686 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:
     662== Setting Anchors
     663
     664An 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:
    687665
    688666{{{
    … …  
    690668}}}
    691669
    692 This syntax was chosen to match the format for explicitly naming the header id [#Headings documented above]. For example:
     670This syntax was chosen to match the format for explicitly naming the header id [#Headings documented above]:
    693671{{{
    694672== Long title == #title
    695673}}}
    696674
    697 It's also very close to the syntax for the corresponding link to that anchor:
     675It is also very close to the syntax for the corresponding link to that anchor:
    698676{{{
    699677[#point1]
    … …  
    702680Optionally, a label can be given to the anchor:
    703681{{{
    704 [[=#point1 '''Point 1''']]
     682[=#point1 '''Point 1''']
    705683}}}
    706684
    … …  
    724702}}}
    725703
    726 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)^)]]`.
    727 
     704For more complex anchors (eg when a custom title is wanted), you can use the Span macro: `[[span(id=point2, class=wikianchor, title=Point 2, ^(2)^)]]`.
    728705
    729706== Escaping Links, WikiPageNames and other Markup == #Escaping
    730707
    731 You may avoid making hyperlinks out of TracLinks by preceding an expression with a single "!" (exclamation mark).
     708You may avoid making hyperlinks out of TracLinks by preceding an expression with a single exclamation mark (`!`).
    732709
    733710||= Wiki Markup =||= Display =||
    … …  
    754731}}}
    755732
    756 == Images ==
     733== Images
    757734
    758735Urls ending with `.png`, `.gif` or `.jpg` are no longer automatically interpreted as image links, and converted to `<img>` tags.
    … …  
    778755See WikiMacros for further documentation on the `[[Image()]]` macro, which has several useful options (`title=`, `link=`, etc.)
    779756
    780 
    781 == Macros ==
    782 
    783 Macros are ''custom functions'' to insert dynamic content in a page.
     757== Macros
     758
     759Macros are ''custom functions'' that insert dynamic content in a page.
    784760
    785761||= Wiki Markup =||= Display =||
    … …  
    795771See WikiMacros for more information, and a list of installed macros.
    796772
    797 The detailed help for a specific macro can also be obtained more directly by appending a "?" to the macro name.
     773The detailed help for a specific macro can also be obtained more directly by appending a `?` to the macro name.
    798774
    799775||= Wiki Markup =||= Display =||
    … …  
    807783}}}
    808784
    809 
    810 == Processors ==
     785== Processors
    811786
    812787Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in
    … …  
    823798{{{#!td style="border: 0px"
    824799  {{{
    825   {{{
    826   #!html
     800  {{{#!html
    827801  <h1 style="text-align: right; color: blue">
    828802   HTML Test
    … …  
    833807{{{#!td valign="top"  style="border: 0px"
    834808
    835 {{{
    836 #!html
     809{{{#!html
    837810<h1 style="text-align: right; color: blue">HTML Test</h1>
    838811}}}
    … …  
    848821{{{#!td style="border: 0px"
    849822  {{{
    850   {{{
    851   #!python
     823  {{{#!python
    852824  class Test:
    853825 
    … …  
    859831  }}}
    860832}}}
    861 {{{
    862 #!td valign="top"  style="border: 0px"
    863 
    864 {{{
    865 #!python
     833{{{#!td valign="top"  style="border: 0px"
     834
     835{{{#!python
    866836class Test:
    867837    def __init__(self):
    … …  
    910880  }}}
    911881}}}
    912 {{{
    913 #!td  valign="top"  style="border: 0px"
     882{{{#!td  valign="top"  style="border: 0px"
    914883
    915884  {{{#!th rowspan=4 align=justify
    … …  
    945914See WikiProcessors for more information.
    946915
    947 
    948 == Comments ==
     916== Comments
    949917
    950918Comments can be added to the plain text. These will not be rendered and will not display in any other format than plain text.
    … …  
    954922  {{{
    955923  Nothing to
    956   {{{
    957   #!comment
     924  {{{#!comment
    958925  Your comment for editors here
    959926  }}}
    960   see ;-)
     927  see.
    961928  }}}
    962929}}}
    963930{{{#!td
    964931  Nothing to
    965   {{{
    966   #!comment
     932  {{{#!comment
    967933  Your comment for editors here
    968934  }}}
    969   see ;-)
    970 }}}
    971 
    972 == Miscellaneous ==
    973 
    974 An horizontal line can be used to separated different parts of your page:
    975 
    976 ||= Wiki Markup =||= Display =||
    977 {{{#!td
     935  see.
     936}}}
     937
     938== Miscellaneous
     939
     940||= Wiki Markup =||= Display =||
     941{{{#!td
     942  Horizontal line:
    978943  {{{
    979944  Four or more dashes will be replaced
    980   by an horizontal line (<HR>)
     945  by a horizontal line (<HR>)
    981946  ----
    982947  See?
    … …  
    985950{{{#!td
    986951Four or more dashes will be replaced
    987 by an horizontal line (<HR>)
     952by a horizontal line (<HR>)
    988953----
    989954See?
    … …  
    991956|----------------------------------
    992957{{{#!td
    993   {{{
    994   "macro" style [[br]] line break
    995   }}}
    996 }}}
    997 {{{#!td
    998 "macro" style [[br]] line break
     958  Two examples of line breaks:
     959  {{{
     960  "macro" style [[BR]] line break
     961  }}}
     962  or:
     963  {{{
     964  !WikiCreole style \\ line\\break
     965  }}}
     966}}}
     967{{{#!td
     968"macro" style [[BR]] line break
     969
     970!WikiCreole style \\ line\\break
    999971}}}
    1000972|----------------------------------
    1001 {{{#!td
    1002   {{{
    1003   !WikiCreole style \\ line\\break
    1004   }}}
    1005 }}}
    1006 {{{#!td
    1007 !WikiCreole style \\ line\\break
    1008 }}}