Changes between Version 2 and Version 3 of WikiFormatting


Ignore:
Timestamp:
Mar 27, 2024, 3:32:45 PM (8 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • WikiFormatting

    v2 v3  
    55Wiki markup is a core feature in Trac, tightly integrating all the other parts of Trac into a flexible and unified whole.
    66
    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].
     7Trac has a powerful wiki rendering engine that implements a subset of the commands from other popular Wikis, such as [https://moinmo.in/ MoinMoin] and [trac:WikiCreole].
    88
    99The 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.
    1010
    11 The following wiki pages present the advanced features of the Trac wiki markup in more depth: 
     11The following wiki pages present the advanced features of the Trac wiki markup in more depth:
    1212 - TracLinks covers all the possible ways to refer to any Trac resource or parts thereof.
    1313 - WikiPageNames covers the various names a wiki page can take, whether in CamelCase or not.
    … …  
    3131|-----------------------------------------------------------
    3232||= [#Headings Headings] =||\
    33 {{{#!td 
     33{{{#!td
    3434 {{{
    3535 == Level 2
    … …  
    6464   on multiple lines
    6565   1. nested list
    66      a. different numbering 
     66     a. different numbering
    6767        styles
    6868 }}}
    … …  
    145145[#Links Links]
    146146}}}
    147 || `http://trac.edgewall.org` ||\
    148 || http://trac.edgewall.org ||
     147|| `https://trac.edgewall.org` ||\
     148|| https://trac.edgewall.org ||
    149149|| `WikiFormatting (CamelCase)` ||\
    150150|| WikiFormatting (CamelCase) ||
    … …  
    164164|| Ticket [[ticket:1]], [[ticket:1|ticket one]] ||
    165165|-----------------------------------------------------------
    166 {{{#!th rowspan=2 
     166{{{#!th rowspan=2
    167167[#SettingAnchors Setting Anchors]
    168168}}}
    … …  
    204204 {{{#!div style="font-size: 80%"
    205205 Code highlighting:
    206    {{{#!python 
     206   {{{#!python
    207207   hello = lambda: "world"
    208208   }}}
    … …  
    223223{{{#!td
    224224 {{{
    225  Line [[br]] break 
     225 Line [[br]] break
    226226 Line \\ break
    227227 ----
    … …  
    240240{{{#!td
    241241  {{{
    242    * '''bold''', 
    243      ''' triple quotes !''' 
    244      can be bold too if prefixed by ! ''', 
     242   * '''bold''',
     243     ''' triple quotes !'''
     244     can be bold too if prefixed by ! ''',
    245245   * ''italic''
    246246   * '''''bold italic''''' or ''italic and
    … …  
    250250     (hence `{{{` or {{{`}}} quoting)
    251251   * ~~strike-through~~
    252    * ^superscript^ 
     252   * ^superscript^
    253253   * ,,subscript,,
    254    * **also bold**, //italic as well//, 
     254   * **also bold**, //italic as well//,
    255255     and **'' bold italic **'' //(since 0.12)//
    256256   * [[span(style=color: #FF0000, a red text )]]
    … …  
    258258}}}
    259259{{{#!td
    260  * '''bold''', 
    261    ''' triple quotes !''' 
    262    can be bold too if prefixed by ! ''', 
     260 * '''bold''',
     261   ''' triple quotes !'''
     262   can be bold too if prefixed by ! ''',
    263263 * ''italic''
    264264 * '''''bold italic''''' or ''italic and
    … …  
    268268   (hence `{{{` or {{{`}}} quoting)
    269269 * ~~strike-through~~
    270  * ^superscript^ 
     270 * ^superscript^
    271271 * ,,subscript,,
    272  * **also bold**, //italic as well//, 
     272 * **also bold**, //italic as well//,
    273273   and **'' bold italic **'' //(since 0.12)//
    274274 * [[span(style=color: #FF0000, a red text )]]
    … …  
    278278 * `{{{...}}}` 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.
    279279 * {{{ ! }}} 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.
    280  * all the font styles marks have to be used in opening/closing pairs, 
    281    and they must nest properly; in particular, an `''` italic can't be paired 
     280 * all the font styles marks have to be used in opening/closing pairs,
     281   and they must nest properly; in particular, an `''` italic can't be paired
    282282   with a `//` one, and `'''` can't be paired with `**`.
    283283
    284284== Headings
    285285
    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. 
     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.
    287287
    288288[=#hn]
    … …  
    326326  one
    327327
    328   Paragraph 
     328  Paragraph
    329329  two
    330330  }}}
    … …  
    333333  Line 1[[BR]]Line 2
    334334
    335   Paragraph 
     335  Paragraph
    336336  one
    337337
    338   Paragraph 
     338  Paragraph
    339339  two
    340340}}}
    … …  
    349349   * Item 1
    350350     * Item 1.1
    351         * Item 1.1.1   
     351        * Item 1.1.1
    352352        * Item 1.1.2
    353353        * Item 1.1.3
    … …  
    356356  - items can start at the beginning of a line
    357357    and they can span multiple lines
    358     - be careful though to continue the line 
     358    - be careful though to continue the line
    359359    with the appropriate indentation, otherwise
    360360  that will start a new paragraph...
    361  
     361
    362362   1. Item 1
    363363     a. Item 1.a
    … …  
    374374 * Item 1
    375375   * Item 1.1
    376       * Item 1.1.1   
     376      * Item 1.1.1
    377377      * Item 1.1.2
    378378      * Item 1.1.3
    … …  
    381381- items can start at the beginning of a line
    382382  and they can span multiple lines
    383   - be careful though to continue the line 
     383  - be careful though to continue the line
    384384  with the appropriate indentation, otherwise
    385385that will start a new paragraph...
    … …  
    422422
    423423Block 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.
    424  
     424
    425425||= Wiki Markup =||= Display =||
    426426{{{#!td
    … …  
    459459== Discussion Citations
    460460
    461 To delineate a citation in an ongoing discussion thread, such as the ticket comment area, email-like citation marks (`>`, `>>`, etc.) may be used. 
     461To delineate a citation in an ongoing discussion thread, such as the ticket comment area, email-like citation marks (`>`, `>>`, etc.) may be used.
    462462
    463463||= Wiki Markup =||= Display =||
    … …  
    556556{{{#!td
    557557  {{{
    558   || this is column 1 [http://trac.edgewall.org/newticket new ticket] || \
    559   || this is column 2 [http://trac.edgewall.org/roadmap the road ahead] || \
     558  || this is column 1 [https://trac.edgewall.org/newticket new ticket] || \
     559  || this is column 2 [https://trac.edgewall.org/roadmap the road ahead] || \
    560560  || that's column 3 and last one ||
    561561  }}}
    … …  
    564564||= Display =||
    565565{{{#!td style="padding: 2em;"
    566 || this is column 1 [http://trac.edgewall.org/newticket new ticket] || \
    567 || this is column 2 [http://trac.edgewall.org/roadmap the road ahead] || \
     566|| this is column 1 [https://trac.edgewall.org/newticket new ticket] || \
     567|| this is column 2 [https://trac.edgewall.org/roadmap the road ahead] || \
    568568|| that's column 3 and last one ||
    569569}}}
    … …  
    580580{{{#!td
    581581  {{{
    582   TitleIndex, http://www.edgewall.com/, !NotAlink
    583   }}}
    584 }}}
    585 {{{#!td
    586 TitleIndex, http://www.edgewall.com/, !NotAlink
    587 }}}
    588 
    589 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. 
     582  TitleIndex, https://www.edgewall.com/, !NotAlink
     583  }}}
     584}}}
     585{{{#!td
     586TitleIndex, https://www.edgewall.com/, !NotAlink
     587}}}
     588
     589Links can be given a more descriptive title by writing the link followed by a space and a title and all this inside square brackets.
    590590If 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.
    591591
    … …  
    593593{{{#!td
    594594  {{{
    595    * [http://www.edgewall.com Edgewall Software]
    596    * [wiki:TitleIndex Title Index] 
    597    * [wiki:TitleIndex] 
     595   * [https://www.edgewall.com Edgewall Software]
     596   * [wiki:TitleIndex Title Index]
     597   * [wiki:TitleIndex]
    598598   * [wiki:ISO9000]
    599599  }}}
    600600}}}
    601601{{{#!td
    602    * [http://www.edgewall.com Edgewall Software]
    603    * [wiki:TitleIndex Title Index] 
    604    * [wiki:TitleIndex] 
     602   * [https://www.edgewall.com Edgewall Software]
     603   * [wiki:TitleIndex Title Index]
     604   * [wiki:TitleIndex]
    605605   * [wiki:ISO9000]
    606606}}}
    607607
    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. 
    609 
    610 {{{#!td
    611   {{{
    612    * [[http://www.edgewall.com|Edgewall Software]]
     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.
     609
     610{{{#!td
     611  {{{
     612   * [[https://www.edgewall.com|Edgewall Software]]
    613613   * [[wiki:TitleIndex|Title Index]]
    614614     or even [[TitleIndex|Title Index]]
    … …  
    619619}}}
    620620{{{#!td
    621    * [[http://www.edgewall.com|Edgewall Software]]
     621   * [[https://www.edgewall.com|Edgewall Software]]
    622622   * [[wiki:TitleIndex|Title Index]]
    623623     or even [[TitleIndex|Title Index]]
    … …  
    641641   * Changesets: r1, [1] or changeset:1
    642642   * ...
    643    * targeting other Trac instances, 
     643   * targeting other Trac instances,
    644644     so called InterTrac links:
    645645     - Tickets: #Trac1 or Trac:ticket:1
    … …  
    651651 * Reports: {1} or report:1
    652652 * Changesets: r1, [1] or changeset:1
    653  * ... 
    654  * targeting other Trac instances, 
     653 * ...
     654 * targeting other Trac instances,
    655655   so called InterTrac links:
    656656   - Tickets: #Trac1 or Trac:ticket:1
    … …  
    662662== Setting Anchors
    663663
    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:
     664An anchor, or more correctly speaking, an [https://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:
    665665
    666666{{{
    … …  
    785785== Processors
    786786
    787 Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in 
    788 [wiki:WikiRestructuredText reStructuredText] or [wiki:WikiHtml HTML]. 
     787Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in
     788[wiki:WikiRestructuredText reStructuredText] or [wiki:WikiHtml HTML].
    789789
    790790||= Wiki Markup =||= Display =||
    … …  
    823823  {{{#!python
    824824  class Test:
    825  
     825
    826826      def __init__(self):
    827827          print "Hello World"
    … …  
    863863  |----------------
    864864  {{{#!td
    865   As processors can be easily nested, 
     865  As processors can be easily nested,
    866866  so can be tables:
    867867    {{{#!th
    … …  
    894894  |----------------
    895895  {{{#!td
    896   As processors can be easily nested, 
     896  As processors can be easily nested,
    897897  so can be tables:
    898898    {{{#!th
    … …  
    942942  Horizontal line:
    943943  {{{
    944   Four or more dashes will be replaced 
     944  Four or more dashes will be replaced
    945945  by a horizontal line (<HR>)
    946946  ----