Edgewall Software

Changes between Version 121 and Version 129 of WikiFormatting


Ignore:
Timestamp:
(multiple changes)
Author:
(multiple changes)
Comment:
(multiple changes)

Legend:

Unmodified
Added
Removed
Modified

  • WikiFormatting

    v121 v129  
    44[[TranslatedPages]]
    55
    6 Wiki markup is a core feature in Trac, tightly integrating all the other parts of Trac into a flexible and powerful whole.
    7 
    8 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].
    9 
    10 This page will give you an in-depth explanation of the wiki markup available anywhere WikiFormatting is allowed.
    11 
    12 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.
    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.
     6Wiki markup is a core feature in Trac, tightly integrating all the other parts of Trac into a flexible and unified whole.
     7
     8Trac 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].
     9
     10The 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.
     11
     12The following wiki pages present the advanced features of the Trac wiki markup in more depth:
     13 - TracLinks covers all the possible ways to refer to any Trac resource or parts thereof.
    1614 - WikiPageNames covers the various names a wiki page can take, whether in CamelCase or not.
    1715 - WikiMacros lists the macros available for generating dynamic content.
    … …  
    2826|| `'''bold'''`, `''italic''`, `'''''Wikipedia style'''''` || \
    2927|| '''bold''', ''italic'', '''''Wikipedia style''''' ||
     28|| `**bold**`, `//italic//`, `**//!WikiCreole style//**` || \
     29|| **bold**, //italic//, **//!WikiCreole style//** ||
    3030|| {{{`monospaced (''other markup ignored'')`}}} || \
    3131|| `monospaced (''other markup ignored'')` ||
    32 || `**bold**`, `//italic//`, `**//!WikiCreole style//**` || \
    33 || **bold**, //italic//, **//!WikiCreole style//** ||
    3432|-----------------------------------------------------------
    3533||= [#Headings Headings] =||\
    36 {{{#!td 
     34{{{#!td
    3735 {{{
    3836 == Level 2
    … …  
    6765   on multiple lines
    6866   1. nested list
    69      a. different numbering 
     67     a. different numbering
    7068        styles
    7169 }}}
    … …  
    9795 {{{
    9896 {{{
    99  multiple lines, ''no wiki''
     97 multiple lines, ''no wiki'',
    10098       white space respected
    10199 }}}
    … …  
    104102{{{#!td
    105103 {{{
    106  multiple lines, ''no wiki''
     104 multiple lines, ''no wiki'',
    107105       white space respected
    108106 }}}
    … …  
    148146[#Links Links]
    149147}}}
    150 || `http://trac.edgewall.org` ||\
    151 || http://trac.edgewall.org ||
     148|| `https://trac.edgewall.org` ||\
     149|| https://trac.edgewall.org ||
    152150|| `WikiFormatting (CamelCase)` ||\
    153151|| WikiFormatting (CamelCase) ||
    … …  
    160158|| `#1 (ticket)`, `[1] (changeset)`, `{1} (report)` ||\
    161159|| #1 (ticket), [1] (changeset), {1} (report) ||
    162 || `ticket:1, ticket:1#comment:1` ||\
    163 || ticket:1, ticket:1#comment:1 ||
     160|| `ticket:1, ticket:1#comment:1, comment:1:ticket:1` ||\
     161|| ticket:1, ticket:1#comment:1, comment:1:ticket:1 ||
    164162|| `Ticket [ticket:1]`, `[ticket:1 ticket one]` ||\
    165163|| Ticket [ticket:1], [ticket:1 ticket one] ||
    … …  
    167165|| Ticket [[ticket:1]], [[ticket:1|ticket one]] ||
    168166|-----------------------------------------------------------
    169 {{{#!th rowspan=2 
     167{{{#!th rowspan=2
    170168[#SettingAnchors Setting Anchors]
    171169}}}
    … …  
    196194{{{#!td
    197195 {{{
    198  {{{
    199  #!div style="font-size: 80%"
     196 {{{#!div style="font-size: 80%"
    200197 Code highlighting:
    201198   {{{#!python
    … …  
    206203}}}
    207204{{{#!td style="padding-left: 2em"
    208  {{{
    209  #!div style="font-size: 80%"
     205 {{{#!div style="font-size: 80%"
    210206 Code highlighting:
    211    {{{#!python 
     207   {{{#!python
    212208   hello = lambda: "world"
    213209   }}}
    … …  
    223219 }}}
    224220}}}
    225 {{{#!td style="padding-left: 2em"
    226  {{{#!comment
    227  Note to Editors: ...
    228  }}}
    229 }}}
     221||  ''(comment is shown in edit mode only)''  ||
    230222|-----------------------------------------------------------
    231223||= [#Miscellaneous Miscellaneous] =||\
    232224{{{#!td
    233225 {{{
    234  Line [[br]] break 
     226 Line [[br]] break
    235227 Line \\ break
    236228 ----
    … …  
    249241{{{#!td
    250242  {{{
    251    * '''bold''', 
    252      ''' triple quotes !''' 
    253      can be bold too if prefixed by ! ''', 
     243   * '''bold''',
     244     ''' triple quotes !'''
     245     can be bold too if prefixed by ! ''',
    254246   * ''italic''
    255247   * '''''bold italic''''' or ''italic and
    … …  
    259251     (hence `{{{` or {{{`}}} quoting)
    260252   * ~~strike-through~~
    261    * ^superscript^ 
     253   * ^superscript^
    262254   * ,,subscript,,
    263    * **also bold**, //italic as well//, 
     255   * **also bold**, //italic as well//,
    264256     and **'' bold italic **'' //(since 0.12)//
    265257   * [[span(style=color: #FF0000, a red text )]]
    … …  
    267259}}}
    268260{{{#!td
    269  * '''bold''', 
    270    ''' triple quotes !''' 
    271    can be bold too if prefixed by ! ''', 
     261 * '''bold''',
     262   ''' triple quotes !'''
     263   can be bold too if prefixed by ! ''',
    272264 * ''italic''
    273265 * '''''bold italic''''' or ''italic and
    … …  
    277269   (hence `{{{` or {{{`}}} quoting)
    278270 * ~~strike-through~~
    279  * ^superscript^ 
     271 * ^superscript^
    280272 * ,,subscript,,
    281  * **also bold**, //italic as well//, 
     273 * **also bold**, //italic as well//,
    282274   and **'' bold italic **'' //(since 0.12)//
    283275 * [[span(style=color: #FF0000, a red text )]]
    … …  
    286278Notes:
    287279 * `{{{...}}}` 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.
    288  * {{{ ! }}} 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.
    289  * all the font styles marks have to be used in opening/closing pairs, 
    290    and they must nest properly; in particular, an `''` italic can't be paired 
     280 * {{{ ! }}} 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.
     281 * all the font styles marks have to be used in opening/closing pairs,
     282   and they must nest properly; in particular, an `''` italic can't be paired
    291283   with a `//` one, and `'''` can't be paired with `**`.
    292284
    293285== Headings
    294286
    295 You can create heading by starting a line with one up to six ''equal'' characters ("=") followed by a single space and the headline text.
     287You can create a heading by starting a line with one up to six ''equal'' characters (`=`) followed by a single space and the headline text.
    296288
    297289[=#hn]
    298 The headline text can be followed by the same number of "=" characters, but this is not mandatory. That is, `=== Section3 ===` is identical to `=== Section3`.
     290The headline text can be followed by the same number of `=` characters, but this is not mandatory. That is, `=== Section3 ===` is identical to `=== Section3`.
    299291
    300292Finally, the heading might optionally be followed by an explicit id. If not, an implicit but nevertheless readable id will be generated.
    … …  
    335327  one
    336328
    337   Paragraph 
     329  Paragraph
    338330  two
    339331  }}}
    … …  
    342334  Line 1[[BR]]Line 2
    343335
    344   Paragraph 
     336  Paragraph
    345337  one
    346338
    347   Paragraph 
     339  Paragraph
    348340  two
    349341}}}
    … …  
    353345The wiki supports both ordered/numbered and unordered lists.
    354346
    355 Example:
    356347||= Wiki Markup =||= Display =||
    357348{{{#!td
    … …  
    359350   * Item 1
    360351     * Item 1.1
    361         * Item 1.1.1   
     352        * Item 1.1.1
    362353        * Item 1.1.2
    363354        * Item 1.1.3
    … …  
    366357  - items can start at the beginning of a line
    367358    and they can span multiple lines
    368     - be careful though to continue the line 
     359    - be careful though to continue the line
    369360    with the appropriate indentation, otherwise
    370361  that will start a new paragraph...
    371  
     362
    372363   1. Item 1
    373364     a. Item 1.a
    … …  
    384375 * Item 1
    385376   * Item 1.1
    386       * Item 1.1.1   
     377      * Item 1.1.1
    387378      * Item 1.1.2
    388379      * Item 1.1.3
    … …  
    391382- items can start at the beginning of a line
    392383  and they can span multiple lines
    393   - be careful though to continue the line 
     384  - be careful though to continue the line
    394385  with the appropriate indentation, otherwise
    395386that will start a new paragraph...
    … …  
    432423
    433424Block 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.
    434  
     425
    435426||= Wiki Markup =||= Display =||
    436427{{{#!td
    … …  
    469460== Discussion Citations
    470461
    471 To delineate a citation in an ongoing discussion thread, such as the ticket comment area, email-like citation marks (">", ">>", etc.) may be used. 
     462To delineate a citation in an ongoing discussion thread, such as the ticket comment area, email-like citation marks (`>`, `>>`, etc.) may be used.
    472463
    473464||= Wiki Markup =||= Display =||
    … …  
    490481=== Simple Tables
    491482
    492 Simple tables can be created like this:
     483Simple tables can be created:
    493484||= Wiki Markup =||= Display =||
    494485{{{#!td
    … …  
    503494}}}
    504495
    505 Cell headings can be specified by wrapping the content in a pair of '=' characters.
    506 Note that the '=' characters have to stick to the cell separators, like this:
     496Cell headings can be specified by wrapping the content in a pair of `=` characters.
     497Note that the `=` characters have to stick to the cell separators:
    507498||= Wiki Markup =||= Display =||
    508499{{{#!td
    … …  
    519510}}}
    520511
    521 Finally, specifying an empty cell means that the next non empty cell will span the empty cells. For example:
     512Finally, specifying an empty cell means that the next non empty cell will span the empty cells:
    522513||= Wiki Markup =||= Display =||
    523514{{{#!td
    … …  
    536527}}}
    537528
    538 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:
     529Note 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:
    539530||= Wiki Markup =||= Display =||
    540531{{{#!td
    … …  
    561552}}}
    562553
    563 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.
     554If 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:
    564555
    565556||= Wiki Markup =||
    566557{{{#!td
    567558  {{{
    568   || this is column 1 [http://trac.edgewall.org/newticket new ticket] || \
    569   || this is column 2 [http://trac.edgewall.org/roadmap the road ahead] || \
     559  || this is column 1 [https://trac.edgewall.org/newticket new ticket] || \
     560  || this is column 2 [https://trac.edgewall.org/roadmap the road ahead] || \
    570561  || that's column 3 and last one ||
    571562  }}}
    … …  
    574565||= Display =||
    575566{{{#!td style="padding: 2em;"
    576 || this is column 1 [http://trac.edgewall.org/newticket new ticket] || \
    577 || this is column 2 [http://trac.edgewall.org/roadmap the road ahead] || \
     567|| this is column 1 [https://trac.edgewall.org/newticket new ticket] || \
     568|| this is column 2 [https://trac.edgewall.org/roadmap the road ahead] || \
    578569|| that's column 3 and last one ||
    579570}}}
    … …  
    581572=== Complex Tables
    582573
    583 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].
     574If 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].
    584575
    585576== Links
    586577
    587 Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark ('!'), such as {{{!WikiPageLink}}}.
    588 
    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. 
     578Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark (`!`), such as `!WikiPageLink`.
     579
     580||= Wiki Markup =||= Display =||
     581{{{#!td
     582  {{{
     583  TitleIndex, https://www.edgewall.com/, !NotAlink
     584  }}}
     585}}}
     586{{{#!td
     587TitleIndex, https://www.edgewall.com/, !NotAlink
     588}}}
     589
     590Links can be given a more descriptive title by writing the link followed by a space and a title and all this inside square brackets.
    600591If 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.
    601592
    … …  
    603594{{{#!td
    604595  {{{
    605    * [http://www.edgewall.com Edgewall Software]
    606    * [wiki:TitleIndex Title Index] 
    607    * [wiki:TitleIndex] 
     596   * [https://www.edgewall.com Edgewall Software]
     597   * [wiki:TitleIndex Title Index]
     598   * [wiki:TitleIndex]
    608599   * [wiki:ISO9000]
    609600  }}}
    610601}}}
    611602{{{#!td
    612    * [http://www.edgewall.com Edgewall Software]
    613    * [wiki:TitleIndex Title Index] 
    614    * [wiki:TitleIndex] 
     603   * [https://www.edgewall.com Edgewall Software]
     604   * [wiki:TitleIndex Title Index]
     605   * [wiki:TitleIndex]
    615606   * [wiki:ISO9000]
    616607}}}
    617608
    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]]
     609Following 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.
     610
     611{{{#!td
     612  {{{
     613   * [[https://www.edgewall.com|Edgewall Software]]
    623614   * [[wiki:TitleIndex|Title Index]]
    624615     or even [[TitleIndex|Title Index]]
    … …  
    629620}}}
    630621{{{#!td
    631    * [[http://www.edgewall.com|Edgewall Software]]
     622   * [[https://www.edgewall.com|Edgewall Software]]
    632623   * [[wiki:TitleIndex|Title Index]]
    633624     or even [[TitleIndex|Title Index]]
    … …  
    651642   * Changesets: r1, [1] or changeset:1
    652643   * ...
    653    * targeting other Trac instances, 
     644   * targeting other Trac instances,
    654645     so called InterTrac links:
    655646     - Tickets: #Trac1 or Trac:ticket:1
    … …  
    661652 * Reports: {1} or report:1
    662653 * Changesets: r1, [1] or changeset:1
    663  * ... 
    664  * targeting other Trac instances, 
     654 * ...
     655 * targeting other Trac instances,
    665656   so called InterTrac links:
    666657   - Tickets: #Trac1 or Trac:ticket:1
    … …  
    672663== Setting Anchors
    673664
    674 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:
     665An 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:
    675666
    676667{{{
    … …  
    678669}}}
    679670
    680 This syntax was chosen to match the format for explicitly naming the header id [#Headings documented above]. For example:
     671This syntax was chosen to match the format for explicitly naming the header id [#Headings documented above]:
    681672{{{
    682673== Long title == #title
    … …  
    690681Optionally, a label can be given to the anchor:
    691682{{{
    692 [[=#point1 '''Point 1''']]
     683[=#point1 '''Point 1''']
    693684}}}
    694685
    … …  
    716707== Escaping Links, WikiPageNames and other Markup == #Escaping
    717708
    718 You may avoid making hyperlinks out of TracLinks by preceding an expression with a single exclamation mark ('!').
     709You may avoid making hyperlinks out of TracLinks by preceding an expression with a single exclamation mark (`!`).
    719710
    720711||= Wiki Markup =||= Display =||
    … …  
    767758== Macros
    768759
    769 Macros are ''custom functions'' to insert dynamic content in a page.
     760Macros are ''custom functions'' that insert dynamic content in a page.
    770761
    771762||= Wiki Markup =||= Display =||
    … …  
    781772See WikiMacros for more information, and a list of installed macros.
    782773
    783 The detailed help for a specific macro can also be obtained more directly by appending a "?" to the macro name.
     774The detailed help for a specific macro can also be obtained more directly by appending a `?` to the macro name.
    784775
    785776||= Wiki Markup =||= Display =||
    … …  
    795786== Processors
    796787
    797 Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in 
    798 [wiki:WikiRestructuredText reStructuredText] or [wiki:WikiHtml HTML]. 
     788Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in
     789[wiki:WikiRestructuredText reStructuredText] or [wiki:WikiHtml HTML].
    799790
    800791||= Wiki Markup =||= Display =||
    … …  
    808799{{{#!td style="border: 0px"
    809800  {{{
    810   {{{
    811   #!html
     801  {{{#!html
    812802  <h1 style="text-align: right; color: blue">
    813803   HTML Test
    … …  
    818808{{{#!td valign="top"  style="border: 0px"
    819809
    820 {{{
    821 #!html
     810{{{#!html
    822811<h1 style="text-align: right; color: blue">HTML Test</h1>
    823812}}}
    … …  
    833822{{{#!td style="border: 0px"
    834823  {{{
    835   {{{
    836   #!python
     824  {{{#!python
    837825  class Test:
    838  
     826
    839827      def __init__(self):
    840828          print "Hello World"
    … …  
    844832  }}}
    845833}}}
    846 {{{
    847 #!td valign="top"  style="border: 0px"
    848 
    849 {{{
    850 #!python
     834{{{#!td valign="top"  style="border: 0px"
     835
     836{{{#!python
    851837class Test:
    852838    def __init__(self):
    … …  
    878864  |----------------
    879865  {{{#!td
    880   As processors can be easily nested, 
     866  As processors can be easily nested,
    881867  so can be tables:
    882868    {{{#!th
    … …  
    895881  }}}
    896882}}}
    897 {{{
    898 #!td  valign="top"  style="border: 0px"
     883{{{#!td  valign="top"  style="border: 0px"
    899884
    900885  {{{#!th rowspan=4 align=justify
    … …  
    910895  |----------------
    911896  {{{#!td
    912   As processors can be easily nested, 
     897  As processors can be easily nested,
    913898  so can be tables:
    914899    {{{#!th
    … …  
    938923  {{{
    939924  Nothing to
    940   {{{
    941   #!comment
     925  {{{#!comment
    942926  Your comment for editors here
    943927  }}}
    … …  
    947931{{{#!td
    948932  Nothing to
    949   {{{
    950   #!comment
     933  {{{#!comment
    951934  Your comment for editors here
    952935  }}}
    … …  
    960943  Horizontal line:
    961944  {{{
    962   Four or more dashes will be replaced 
     945  Four or more dashes will be replaced
    963946  by a horizontal line (<HR>)
    964947  ----