Changes between Version 9 and Version 10 of WikiFormatting


Ignore:
Timestamp:
10/02/17 20:17:00 (2 weeks ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiFormatting

    v9 v10  
    55Wiki markup is a core feature in Trac, tightly integrating all the other parts of Trac into a flexible and powerful whole.
    66
    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].
     7Trac 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].
    88
    99This page will give you an in-depth explanation of the wiki markup available anywhere WikiFormatting is allowed.
     
    1212
    1313A 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
     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, whether in 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.
    1919
    2020== Common wiki markup
     
    3535{{{#!td
    3636 {{{
    37  == Level 2 ==
     37 == Level 2
    3838 === Level 3 ^([#hn note])^
    3939 }}}
    4040}}}
    4141{{{#!td style="padding-left: 2em"
    42 == Level 2 ==
     42== Level 2
    4343=== Level 3 ^([#hn note])^
    4444}}}
     
    6363{{{#!td
    6464 {{{
    65  * bullets list
     65 * bullet list
    6666   on multiple lines
    6767   1. nested list
     
    7171}}}
    7272{{{#!td
    73 * bullets list
     73* bullet list
    7474  on multiple lines
    7575  1. nested list
     
    159159|| `#1 (ticket)`, `[1] (changeset)`, `{1} (report)` ||\
    160160|| #1 (ticket), [1] (changeset), {1} (report) ||
    161 || `ticket:1, ticket:1#comment:1` ||\
    162 || ticket:1, ticket:1#comment:1 ||
     161|| `ticket:1, ticket:1#comment:1, comment:1:ticket:1` ||\
     162|| ticket:1, ticket:1#comment:1, comment:1:ticket:1 ||
    163163|| `Ticket [ticket:1]`, `[ticket:1 ticket one]` ||\
    164164|| Ticket [ticket:1], [ticket:1 ticket one] ||
     
    287287 * {{{ ! }}} 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.
    288288 * 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 `**`)
     289   and they must nest properly; in particular, an `''` italic can't be paired
     290   with a `//` one, and `'''` can't be paired with `**`.
    291291
    292292== Headings
     
    295295
    296296[=#hn]
    297 The headline text can be followed by the same number of "=" characters, but this is no longer mandatory.
     297The headline text can be followed by the same number of "=" characters, but this is not mandatory. That is, `=== Section3 ===` is identical to `=== Section3`.
    298298
    299299Finally, the heading might optionally be followed by an explicit id. If not, an implicit but nevertheless readable id will be generated.
     
    468468== Discussion Citations
    469469
    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. 
     470To delineate a citation in an ongoing discussion thread, such as the ticket comment area, email-like citation marks (">", ">>", etc.) may be used. 
    471471
    472472||= Wiki Markup =||= Display =||
     
    580580=== Complex Tables
    581581
    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].
     582If 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].
    583583
    584584== Links
    585585
    586 Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark "!" character, such as {{{!WikiPageLink}}}.
     586Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark ('!'), such as {{{!WikiPageLink}}}.
    587587
    588588||= Wiki Markup =||= Display =||
     
    682682}}}
    683683
    684 It's also very close to the syntax for the corresponding link to that anchor:
     684It is also very close to the syntax for the corresponding link to that anchor:
    685685{{{
    686686[#point1]
     
    689689Optionally, a label can be given to the anchor:
    690690{{{
    691 [[=#point1 '''Point 1''']]
     691[=#point1 '''Point 1''']
    692692}}}
    693693
     
    711711}}}
    712712
    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)^)]]`.
     713For 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)^)]]`.
    714714
    715715== Escaping Links, WikiPageNames and other Markup == #Escaping
    716716
    717 You may avoid making hyperlinks out of TracLinks by preceding an expression with a single "!" (exclamation mark).
     717You may avoid making hyperlinks out of TracLinks by preceding an expression with a single exclamation mark ('!').
    718718
    719719||= Wiki Markup =||= Display =||
     
    941941  Your comment for editors here
    942942  }}}
    943   see ;-)
     943  see.
    944944  }}}
    945945}}}
     
    950950  Your comment for editors here
    951951  }}}
    952   see ;-)
     952  see.
    953953}}}
    954954
    955955== Miscellaneous
    956956
    957 An horizontal line can be used to separated different parts of your page:
    958 
    959 ||= Wiki Markup =||= Display =||
    960 {{{#!td
     957||= Wiki Markup =||= Display =||
     958{{{#!td
     959  Horizontal line:
    961960  {{{
    962961  Four or more dashes will be replaced
    963   by an horizontal line (<HR>)
     962  by a horizontal line (<HR>)
    964963  ----
    965964  See?
     
    968967{{{#!td
    969968Four or more dashes will be replaced
    970 by an horizontal line (<HR>)
     969by a horizontal line (<HR>)
    971970----
    972971See?
     
    974973|----------------------------------
    975974{{{#!td
    976   {{{
    977   "macro" style [[br]] line break
    978   }}}
    979 }}}
    980 {{{#!td
    981 "macro" style [[br]] line break
     975  Two examples of line breaks:
     976  {{{
     977  "macro" style [[BR]] line break
     978  }}}
     979  or:
     980  {{{
     981  !WikiCreole style \\ line\\break
     982  }}}
     983}}}
     984{{{#!td
     985"macro" style [[BR]] line break
     986
     987!WikiCreole style \\ line\\break
    982988}}}
    983989|----------------------------------
    984 {{{#!td
    985   {{{
    986   !WikiCreole style \\ line\\break
    987   }}}
    988 }}}
    989 {{{#!td
    990 !WikiCreole style \\ line\\break
    991 }}}