close Warning: Can't synchronize with repository "(default)" (/common/SVN/wimax does not appear to be a Subversion repository.). Look in the Trac log for more information.

Changes between Version 3 and Version 4 of WikiFormatting


Ignore:
Timestamp:
Jan 30, 2019, 11:46:28 PM (19 months ago)
Author:
trac
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • WikiFormatting

    v3 v4  
    33[[TracGuideToc]]
    44
    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.
     5Wiki markup is a core feature in Trac, tightly integrating all the other parts of Trac into a flexible and powerful whole.
     6
     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].
     8
     9This page will give you an in-depth explanation of the wiki markup available anywhere WikiFormatting is allowed.
     10
     11The 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
     13A 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.
    1315 - WikiPageNames covers the various names a wiki page can take, whether in CamelCase or not.
    1416 - WikiMacros lists the macros available for generating dynamic content.
     
    2527|| `'''bold'''`, `''italic''`, `'''''Wikipedia style'''''` || \
    2628|| '''bold''', ''italic'', '''''Wikipedia style''''' ||
     29|| {{{`monospaced (''other markup ignored'')`}}} || \
     30|| `monospaced (''other markup ignored'')` ||
    2731|| `**bold**`, `//italic//`, `**//!WikiCreole style//**` || \
    2832|| **bold**, //italic//, **//!WikiCreole style//** ||
    29 || {{{`monospaced (''other markup ignored'')`}}} || \
    30 || `monospaced (''other markup ignored'')` ||
    3133|-----------------------------------------------------------
    3234||= [#Headings Headings] =||\
     
    9496 {{{
    9597 {{{
    96  multiple lines, ''no wiki'',
     98 multiple lines, ''no wiki''
    9799       white space respected
    98100 }}}
     
    101103{{{#!td
    102104 {{{
    103  multiple lines, ''no wiki'',
     105 multiple lines, ''no wiki''
    104106       white space respected
    105107 }}}
     
    157159|| `#1 (ticket)`, `[1] (changeset)`, `{1} (report)` ||\
    158160|| #1 (ticket), [1] (changeset), {1} (report) ||
    159 || `ticket:1, ticket:1#comment:1, comment:1:ticket:1` ||\
    160 || ticket:1, ticket:1#comment:1, comment:1:ticket:1 ||
     161|| `ticket:1, ticket:1#comment:1` ||\
     162|| ticket:1, ticket:1#comment:1 ||
    161163|| `Ticket [ticket:1]`, `[ticket:1 ticket one]` ||\
    162164|| Ticket [ticket:1], [ticket:1 ticket one] ||
     
    193195{{{#!td
    194196 {{{
    195  {{{#!div style="font-size: 80%"
     197 {{{
     198 #!div style="font-size: 80%"
    196199 Code highlighting:
    197200   {{{#!python
     
    202205}}}
    203206{{{#!td style="padding-left: 2em"
    204  {{{#!div style="font-size: 80%"
     207 {{{
     208 #!div style="font-size: 80%"
    205209 Code highlighting:
    206210   {{{#!python
     
    218222 }}}
    219223}}}
    220 ||  ''(comment is shown in edit mode only)''  ||
     224{{{#!td style="padding-left: 2em"
     225 {{{#!comment
     226 Note to Editors: ...
     227 }}}
     228}}}
    221229|-----------------------------------------------------------
    222230||= [#Miscellaneous Miscellaneous] =||\
     
    277285Notes:
    278286 * `{{{...}}}` 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.
    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.
     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.
    280288 * all the font styles marks have to be used in opening/closing pairs,
    281289   and they must nest properly; in particular, an `''` italic can't be paired
     
    284292== Headings
    285293
    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.
     294You can create heading by starting a line with one up to six ''equal'' characters ("=") followed by a single space and the headline text.
    287295
    288296[=#hn]
    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`.
     297The headline text can be followed by the same number of "=" characters, but this is not mandatory. That is, `=== Section3 ===` is identical to `=== Section3`.
    290298
    291299Finally, the heading might optionally be followed by an explicit id. If not, an implicit but nevertheless readable id will be generated.
     
    344352The wiki supports both ordered/numbered and unordered lists.
    345353
     354Example:
    346355||= Wiki Markup =||= Display =||
    347356{{{#!td
     
    459468== Discussion Citations
    460469
    461 To delineate a citation in an ongoing discussion thread, such as the ticket comment area, email-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. 
    462471
    463472||= Wiki Markup =||= Display =||
     
    480489=== Simple Tables
    481490
    482 Simple tables can be created:
     491Simple tables can be created like this:
    483492||= Wiki Markup =||= Display =||
    484493{{{#!td
     
    493502}}}
    494503
    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:
     504Cell headings can be specified by wrapping the content in a pair of '=' characters.
     505Note that the '=' characters have to stick to the cell separators, like this:
    497506||= Wiki Markup =||= Display =||
    498507{{{#!td
     
    509518}}}
    510519
    511 Finally, specifying an empty cell means that the next non empty cell will span the empty cells:
     520Finally, specifying an empty cell means that the next non empty cell will span the empty cells. For example:
    512521||= Wiki Markup =||= Display =||
    513522{{{#!td
     
    526535}}}
    527536
    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:
     537Note 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:
    529538||= Wiki Markup =||= Display =||
    530539{{{#!td
     
    551560}}}
    552561
    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:
     562If 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.
    554563
    555564||= Wiki Markup =||
     
    571580=== Complex Tables
    572581
    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].
     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].
    574583
    575584== Links
    576585
    577 Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark (`!`), such as `!WikiPageLink`.
     586Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark ('!'), such as {{{!WikiPageLink}}}.
    578587
    579588||= Wiki Markup =||= Display =||
     
    606615}}}
    607616
    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.
     617Following 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.
    609618
    610619{{{#!td
     
    662671== Setting Anchors
    663672
    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:
     673An 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:
    665674
    666675{{{
     
    668677}}}
    669678
    670 This syntax was chosen to match the format for explicitly naming the header id [#Headings documented above]:
     679This syntax was chosen to match the format for explicitly naming the header id [#Headings documented above]. For example:
    671680{{{
    672681== Long title == #title
     
    680689Optionally, a label can be given to the anchor:
    681690{{{
    682 [=#point1 '''Point 1''']
     691[[=#point1 '''Point 1''']]
    683692}}}
    684693
     
    706715== Escaping Links, WikiPageNames and other Markup == #Escaping
    707716
    708 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 ('!').
    709718
    710719||= Wiki Markup =||= Display =||
     
    757766== Macros
    758767
    759 Macros are ''custom functions'' that insert dynamic content in a page.
     768Macros are ''custom functions'' to insert dynamic content in a page.
    760769
    761770||= Wiki Markup =||= Display =||
     
    771780See WikiMacros for more information, and a list of installed macros.
    772781
    773 The detailed help for a specific macro can also be obtained more directly by appending a `?` to the macro name.
     782The detailed help for a specific macro can also be obtained more directly by appending a "?" to the macro name.
    774783
    775784||= Wiki Markup =||= Display =||
     
    798807{{{#!td style="border: 0px"
    799808  {{{
    800   {{{#!html
     809  {{{
     810  #!html
    801811  <h1 style="text-align: right; color: blue">
    802812   HTML Test
     
    807817{{{#!td valign="top"  style="border: 0px"
    808818
    809 {{{#!html
     819{{{
     820#!html
    810821<h1 style="text-align: right; color: blue">HTML Test</h1>
    811822}}}
     
    821832{{{#!td style="border: 0px"
    822833  {{{
    823   {{{#!python
     834  {{{
     835  #!python
    824836  class Test:
    825837 
     
    831843  }}}
    832844}}}
    833 {{{#!td valign="top"  style="border: 0px"
    834 
    835 {{{#!python
     845{{{
     846#!td valign="top"  style="border: 0px"
     847
     848{{{
     849#!python
    836850class Test:
    837851    def __init__(self):
     
    880894  }}}
    881895}}}
    882 {{{#!td  valign="top"  style="border: 0px"
     896{{{
     897#!td  valign="top"  style="border: 0px"
    883898
    884899  {{{#!th rowspan=4 align=justify
     
    922937  {{{
    923938  Nothing to
    924   {{{#!comment
     939  {{{
     940  #!comment
    925941  Your comment for editors here
    926942  }}}
     
    930946{{{#!td
    931947  Nothing to
    932   {{{#!comment
     948  {{{
     949  #!comment
    933950  Your comment for editors here
    934951  }}}