Changes between Version 2 and Version 3 of WikiFormatting


Ignore:
Timestamp:
Feb 22, 2011, 12:40:16 AM (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiFormatting

    v2 v3  
    55
    66Trac 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://moinmoin.wikiwikiweb.de/ MoinMoin].
    8 
    9 
    10 This page demonstrates the formatting syntax available anywhere WikiFormatting is allowed.
     7especially [http://moinmo.in/ MoinMoin] and [trac:WikiCreole].
     8
     9
     10This page will give you an in-depth explanation of the wiki markup available anywhere WikiFormatting is allowed.
     11
     12The ''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
     14A 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 ==
     22
     23||= '''Category''' =||= '''Wiki Markup''' =||= '''Display''' =||
     24|-----------------------------------------------------------
     25{{{#!th rowspan=3
     26[#FontStyles Font Styles]
     27}}}
     28|| `'''bold'''`, `''italic''`, `'''''Wikipedia style'''''` || \
     29|| '''bold''', ''italic'', '''''Wikipedia style''''' ||
     30|| {{{`monospaced and ''nowiki''`}}} || \
     31|| `monospaced and ''nowiki''` ||
     32|| `**bold**`, `//italic//`, `**//!WikiCreole style//**` || \
     33|| **bold**, //italic//, **//!WikiCreole style//** ||
     34|-----------------------------------------------------------
     35||= [#Headings Headings] =||\
     36{{{#!td
     37 {{{
     38 == Level 2 ==
     39 === Level 3 ^([#hn note])^
     40 }}}
     41}}}
     42{{{#!td style="padding-left: 2em"
     43== Level 2
     44=== Level 3 ^([#hn note])^
     45}}}
     46|-----------------------------------------------------------
     47||= [#Paragraphs Paragraphs]  =||\
     48{{{#!td
     49 {{{
     50 First paragraph
     51 on multiple lines.
     52
     53 Second paragraph.
     54 }}}
     55}}}
     56{{{#!td
     57First paragraph
     58on multiple lines.
     59
     60Second paragraph.
     61}}}
     62|-----------------------------------------------------------
     63||= [#Lists Lists] =||\
     64{{{#!td
     65 {{{
     66 * bullets list
     67   on multiple paragraphs
     68   1. nested list
     69     a. different numbering
     70        styles
     71 }}}
     72}}}
     73{{{#!td
     74* bullets list
     75  on multiple paragraphs
     76  1. nested list
     77    a. different numbering
     78       styles
     79}}}
     80|-----------------------------------------------------------
     81{{{#!th
     82[#DefinitionLists Definition Lists]
     83}}}
     84{{{#!td
     85 {{{
     86  term:: definition on
     87         multiple paragraphs
     88 }}}
     89}}}
     90{{{#!td
     91 term:: definition on
     92        multiple paragraphs
     93}}}
     94|-----------------------------------------------------------
     95||= [#PreformattedText Preformatted Text] =||\
     96{{{#!td
     97 {{{
     98 {{{
     99 multiple lines, ''no wiki''
     100       white space respected
     101 }}}
     102 }}}
     103}}}
     104{{{#!td
     105 {{{
     106 multiple lines, ''no wiki''
     107       white space respected
     108 }}}
     109}}}
     110|-----------------------------------------------------------
     111||= [#Blockquotes Blockquotes] =||\
     112{{{#!td
     113 {{{
     114   if there's some leading
     115   space the text is quoted
     116 }}}
     117}}}
     118{{{#!td
     119 if there's some leading
     120 space the text is quoted
     121}}}
     122|-----------------------------------------------------------
     123||= [#DiscussionCitations Discussion Citations] =||\
     124{{{#!td
     125 {{{
     126 >> ... (I said)
     127 > (he replied)
     128 }}}
     129}}}
     130{{{#!td
     131>>... (I said)
     132> (he replied)
     133}}}
     134|-----------------------------------------------------------
     135||= [#Tables Tables] =||\
     136{{{#!td
     137 {{{
     138 ||= Table Header =|| Cell ||
     139 ||||  (details below)  ||
     140 }}}
     141}}}
     142{{{#!td
     143||= Table Header =|| Cell ||
     144||||  (details below)  ||
     145}}}
     146|-----------------------------------------------------------
     147{{{#!th rowspan=2
     148[#Links Links]
     149}}}
     150|| `http://trac.edgewall.org` ||\
     151|| http://trac.edgewall.org ||
     152|| `WikiFormatting (CamelCase)` ||\
     153|| WikiFormatting (CamelCase) ||
     154|-----------------------------------------------------------
     155{{{#!th rowspan=5
     156[#TracLinks TracLinks]
     157}}}
     158|| `wiki:WikiFormatting`, `wiki:"WikiFormatting"` ||\
     159|| wiki:WikiFormatting, wiki:"WikiFormatting" ||
     160|| `#1 (ticket)`, `[1] (changeset)`, `{1} (report)` ||\
     161|| #1 (ticket), [1] (changeset), {1} (report) ||
     162|| `ticket:1, ticket:1#comment:1` ||\
     163|| ticket:1, ticket:1#comment:1 ||
     164|| `Ticket [ticket:1]`, `[ticket:1 ticket one]` ||\
     165|| Ticket [ticket:1], [ticket:1 ticket one] ||
     166|| `Ticket [[ticket:1]]`, `[[ticket:1|ticket one]]` ||\
     167|| Ticket [[ticket:1]], [[ticket:1|ticket one]] ||
     168|-----------------------------------------------------------
     169{{{#!th rowspan=2
     170[#SettingAnchors Setting Anchors]
     171}}}
     172|| `[=#point1 (1)] First...` ||\
     173|| [=#point1 (1)] First... ||
     174|| `see [#point1 (1)]` ||\
     175|| see [#point1 (1)] ||
     176|-----------------------------------------------------------
     177{{{#!th rowspan=2
     178[#EscapingLinksandWikiPageNames Escaping Markup]
     179}}}
     180|| `!'' doubled quotes` ||\
     181|| !'' doubled quotes ||
     182|| `!wiki:WikiFormatting`, `!WikiFormatting` ||\
     183|| !wiki:WikiFormatting, !WikiFormatting ||
     184|-----------------------------------------------------------
     185||= [#Images Images] =|| `[[Image(`''link''`)]]` || [[Image(htdocs:../common/trac_logo_mini.png)]] ||
     186|-----------------------------------------------------------
     187{{{#!th rowspan=2
     188[#Macros Macros]
     189}}}
     190|| `[[MacroList(*)]]` ||  ''(short list of all available macros)''  ||
     191|| `[[Image?]]` ||  ''(help for the Image macro)''  ||
     192|-----------------------------------------------------------
     193||= [#Processors Processors] =||\
     194{{{#!td
     195 {{{
     196 {{{
     197 #!div style="font-size: 80%"
     198 Code highlighting:
     199   {{{#!python
     200   hello = lambda: "world"
     201   }}}
     202 }}}
     203 }}}
     204}}}
     205{{{#!td style="padding-left: 2em"
     206 {{{
     207 #!div style="font-size: 80%"
     208 Code highlighting:
     209   {{{#!python
     210   hello = lambda: "world"
     211   }}}
     212 }}}
     213}}}
     214|-----------------------------------------------------------
     215||= [#Comments Comments] =||\
     216{{{#!td
     217 {{{
     218 {{{#!comment
     219 Note to Editors: ...
     220 }}}
     221 }}}
     222}}}
     223{{{#!td style="padding-left: 2em"
     224 {{{#!comment
     225 Note to Editors: ...
     226 }}}
     227}}}
     228|-----------------------------------------------------------
     229||= [#Miscellaneous Miscellaneous] =||\
     230{{{#!td
     231 {{{
     232 Line [[br]] break
     233 Line \\ break
     234 ----
     235 }}}
     236}}}
     237{{{#!td style="padding-left: 2em"
     238Line [[br]] break
     239Line \\ break
     240----
     241}}}
    11242
    12243
     
    14245
    15246The Trac wiki supports the following font styles:
    16 {{{
    17  * '''bold''', '''!''' can be bold too''', and '''! '''
     247||= Wiki Markup =||= Display =||
     248{{{#!td
     249  {{{
     250   * '''bold''',
     251     ''' triple quotes !'''
     252     can be bold too if prefixed by ! ''',
     253   * ''italic''
     254   * '''''bold italic''''' or ''italic and
     255     ''' italic bold ''' ''
     256   * __underline__
     257   * {{{monospace}}} or `monospace`
     258     (hence `{{{` or {{{`}}} quoting)
     259   * ~~strike-through~~
     260   * ^superscript^
     261   * ,,subscript,,
     262   * **also bold**, //italic as well//,
     263     and **'' bold italic **'' //(since 0.12)//
     264  }}}
     265}}}
     266{{{#!td
     267 * '''bold''',
     268   ''' triple quotes !'''
     269   can be bold too if prefixed by ! ''',
    18270 * ''italic''
    19  * '''''bold italic'''''
     271 * '''''bold italic''''' or ''italic and
     272   ''' italic bold ''' ''
    20273 * __underline__
    21274 * {{{monospace}}} or `monospace`
     275   (hence `{{{` or {{{`}}} quoting)
    22276 * ~~strike-through~~
    23277 * ^superscript^
    24278 * ,,subscript,,
    25 }}}
    26 
    27 Display:
    28  * '''bold''', '''!''' can be bold too''', and '''! '''
    29  * ''italic''
    30  * '''''bold italic'''''
    31  * __underline__
    32  * {{{monospace}}} or `monospace`
    33  * ~~strike-through~~
    34  * ^superscript^
    35  * ,,subscript,,
     279 * **also bold**, //italic as well//,
     280   and **'' bold italic **'' //(since 0.12)//
     281}}}
    36282
    37283Notes:
    38284 * `{{{...}}}` 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.
    39285 * {{{ ! }}} 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.
     286 * all the font styles marks have to be used in opening/closing pairs,
     287   and they must nest properly (in particular, an `''` italic can't be paired
     288   with a `//` one, and `'''` can't be paired with `**`)
     289
    40290
    41291== Headings ==
    42292
    43 You can create heading by starting a line with one up to five ''equal'' characters ("=")
    44 followed by a single space and the headline text. The line should end with a space
    45 followed by the same number of ''='' characters.
    46 The heading might optionally be followed by an explicit id. If not, an implicit but nevertheless readable id will be generated.
     293You can create heading by starting a line with one up to six ''equal'' characters ("=")
     294followed by a single space and the headline text.
     295
     296[=#hn]
     297The headline text can be followed by the same number of "=" characters, but this is no longer mandatory.
     298
     299Finally, the heading might optionally be followed by an explicit id. If not, an implicit but nevertheless readable id will be generated.
     300
     301||= Wiki Markup =||= Display =||
     302{{{#!td
     303  {{{
     304  = Heading =
     305  == Subheading
     306  === About ''this'' ===
     307  === Explicit id === #using-explicit-id-in-heading
     308  == Subheading #sub2
     309}}}
     310}}}
     311{{{#!td style="padding: 1em;"
     312  {{{
     313  #!div
     314  == Subheading
     315  === About ''this'' ===
     316  === Explicit id === #using-explicit-id-in-heading
     317  == Subheading #sub2
     318  }}}
     319}}}
     320
     321== Paragraphs ==
     322
     323A new text paragraph is created whenever two blocks of text are separated by one or more empty lines.
     324
     325A forced line break can also be inserted, using:
     326||= Wiki Markup =||= Display =||
     327{{{#!td
     328  {{{
     329  Line 1[[BR]]Line 2
     330  }}}
     331  {{{
     332  Paragraph
     333  one
     334
     335  Paragraph
     336  two
     337  }}}
     338}}}
     339{{{#!td
     340  Line 1[[BR]]Line 2
     341
     342  Paragraph
     343  one
     344
     345  Paragraph
     346  two
     347}}}
     348
     349== Lists ==
     350
     351The wiki supports both ordered/numbered and unordered lists.
    47352
    48353Example:
    49 {{{
    50 = Heading =
    51 == Subheading ==
    52 === About ''this'' ===
    53 === Explicit id === #using-explicit-id-in-heading
    54 }}}
    55 
    56 Display:
    57 = Heading =
    58 == Subheading ==
    59 === About ''this'' ===
    60 === Explicit id === #using-explicit-id-in-heading
    61 
    62 == Paragraphs ==
    63 
    64 A new text paragraph is created whenever two blocks of text are separated by one or more empty lines.
    65 
    66 A forced line break can also be inserted, using:
    67 {{{
    68 Line 1[[BR]]Line 2
    69 }}}
    70 Display:
    71 
    72 Line 1[[BR]]Line 2
    73 
    74 
    75 == Lists ==
    76 
    77 The wiki supports both ordered/numbered and unordered lists.
    78 
    79 Example:
    80 {{{
     354||= Wiki Markup =||= Display =||
     355{{{#!td
     356  {{{
     357   * Item 1
     358     * Item 1.1
     359        * Item 1.1.1   
     360        * Item 1.1.2
     361        * Item 1.1.3
     362     * Item 1.2
     363   * Item 2
     364  - items can start at the beginning of a line
     365    and they can span multiple lines
     366    - be careful though to continue the line
     367    with the appropriate indentation, otherwise
     368  that will start a new paragraph...
     369 
     370   1. Item 1
     371     a. Item 1.a
     372     a. Item 1.b
     373        i. Item 1.b.i
     374        i. Item 1.b.ii
     375   1. Item 2
     376  And numbered lists can also be restarted
     377  with an explicit number:
     378   3. Item 3
     379  }}}
     380}}}
     381{{{#!td
    81382 * Item 1
    82383   * Item 1.1
     384      * Item 1.1.1   
     385      * Item 1.1.2
     386      * Item 1.1.3
     387   * Item 1.2
    83388 * Item 2
     389- items can start at the beginning of a line
     390  and they can span multiple lines
     391  - be careful though to continue the line
     392  with the appropriate indentation, otherwise
     393that will start a new paragraph...
    84394
    85395 1. Item 1
     
    89399      i. Item 1.b.ii
    90400 1. Item 2
    91 And numbered lists can also be given an explicit number:
     401And numbered lists can also be restarted with an explicit number:
    92402 3. Item 3
    93403}}}
    94404
    95 Display:
    96  * Item 1
    97    * Item 1.1
    98  * Item 2
    99 
    100  1. Item 1
    101    a. Item 1.a
    102    a. Item 1.b
    103       i. Item 1.b.i
    104       i. Item 1.b.ii
    105  1. Item 2
    106 And numbered lists can also be given an explicit number:
    107  3. Item 3
    108 
    109 Note that there must be one or more spaces preceding the list item markers, otherwise the list will be treated as a normal paragraph.
    110 
    111405
    112406== Definition Lists ==
    113407
    114 
    115408The wiki also supports definition lists.
    116409
    117 Example:
    118 {{{
     410||= Wiki Markup =||= Display =||
     411{{{#!td
     412  {{{
     413   llama::
     414     some kind of mammal, with hair
     415   ppython::
     416     some kind of reptile, without hair
     417     (can you spot the typo?)
     418  }}}
     419}}}
     420{{{#!td
    119421 llama::
    120422   some kind of mammal, with hair
     
    124426}}}
    125427
    126 Display:
    127  llama::
    128    some kind of mammal, with hair
    129  ppython::
    130    some kind of reptile, without hair
    131    (can you spot the typo?)
    132 
    133428Note that you need a space in front of the defined term.
    134429
     
    138433Block 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.
    139434 
    140 Example:
     435||= Wiki Markup =||= Display =||
     436{{{#!td
     437  {{{
     438  {{{
     439  def HelloWorld():
     440      print '''Hello World'''
     441  }}}
     442  }}}
     443}}}
     444{{{#!td
     445  {{{
     446  def HelloWorld():
     447      print '''Hello World'''
     448  }}}
     449}}}
     450
     451Note that this kind of block is also used for selecting lines that should be processed through WikiProcessors.
     452
     453== Blockquotes ==
     454
     455In order to mark a paragraph as blockquote, indent that paragraph with two spaces.
     456
     457||= Wiki Markup =||= Display =||
     458{{{#!td
    141459{{{
    142  {{{
    143   def HelloWorld():
    144       print "Hello World"
    145  }}}
    146 }}}
    147 
    148 Display:
    149 {{{
    150  def HelloWorld():
    151      print "Hello World"
    152 }}}
    153 
    154 
    155 == Blockquotes ==
    156 
    157 In order to mark a paragraph as blockquote, indent that paragraph with two spaces.
    158 
    159 Example:
    160 {{{
     460Paragraph
    161461  This text is a quote from someone else.
    162462}}}
    163 
    164 Display:
     463}}}
     464{{{#!td
     465Paragraph
    165466  This text is a quote from someone else.
     467}}}
    166468
    167469== Discussion Citations ==
     
    169471To delineate a citation in an ongoing discussion thread, such as the ticket comment area, e-mail-like citation marks (">", ">>", etc.) may be used. 
    170472
    171 Example:
    172 {{{
     473||= Wiki Markup =||= Display =||
     474{{{#!td
     475  {{{
     476  >> Someone's original text
     477  > Someone else's reply text
     478  >  - which can be any kind of Wiki markup
     479  My reply text
     480  }}}
     481}}}
     482{{{#!td
    173483>> Someone's original text
    174484> Someone else's reply text
     485>  - which can be any kind of Wiki markup
    175486My reply text
    176487}}}
    177488
    178 Display:
    179 >> Someone's original text
    180 > Someone else's reply text
    181 My reply text
    182 
    183 ''Note: Some WikiFormatting elements, such as lists and preformatted text, are  lost in the citation area.  Some reformatting may be necessary to create a clear citation.''
    184489
    185490== Tables ==
    186 
     491=== Simple Tables ===
    187492Simple tables can be created like this:
    188 {{{
     493||= Wiki Markup =||= Display =||
     494{{{#!td
     495  {{{
     496  ||Cell 1||Cell 2||Cell 3||
     497  ||Cell 4||Cell 5||Cell 6||
     498  }}}
     499}}}
     500{{{#!td style="padding: 2em;"
    189501||Cell 1||Cell 2||Cell 3||
    190502||Cell 4||Cell 5||Cell 6||
    191503}}}
    192504
    193 Display:
    194 ||Cell 1||Cell 2||Cell 3||
    195 ||Cell 4||Cell 5||Cell 6||
    196 
    197 Note that more complex tables can be created using
    198 [wiki:WikiRestructuredText#BiggerReSTExample reStructuredText].
     505Cell headings can be specified by wrapping the content in a pair of '=' characters.
     506Note that the '=' characters have to stick to the cell separators, like this:
     507||= Wiki Markup =||= Display =||
     508{{{#!td
     509  {{{
     510  ||        ||= stable =||= latest =||
     511  ||= 0.10 =||  0.10.5  || 0.10.6dev||
     512  ||= 0.11 =||  0.11.6  || 0.11.7dev||
     513  }}}
     514}}}
     515{{{#!td style="padding: 2em;"
     516||        ||= stable =||= latest =||
     517||= 0.10 =||  0.10.5  || 0.10.6dev||
     518||= 0.11 =||  0.11.6  || 0.11.7dev||
     519}}}
     520
     521Finally, specifying an empty cell means that the next non empty cell will span the empty cells. For example:
     522||= Wiki Markup =||= Display =||
     523{{{#!td
     524  {{{
     525  || 1 || 2 || 3 ||
     526  |||| 1-2 || 3 ||
     527  || 1 |||| 2-3 ||
     528  |||||| 1-2-3 ||
     529  }}}
     530}}}
     531{{{#!td style="padding: 2em;"
     532|| 1 || 2 || 3 ||
     533|||| 1-2 || 3 ||
     534|| 1 |||| 2-3 ||
     535|||||| 1-2-3 ||
     536}}}
     537
     538Note 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:
     539||= Wiki Markup =||= Display =||
     540{{{#!td
     541  {{{
     542  ||=Text =||= Numbers =||
     543  ||left align    ||        1.0||
     544  ||  center      ||        4.5||
     545  ||      right align||     4.5||
     546  || default alignment ||   2.5||
     547  ||default||         2.5||
     548  ||  default ||      2.5||
     549  || default ||       2.5||
     550  }}}
     551}}}
     552{{{#!td style="padding: 2em;"
     553||=Text =||= Numbers =||
     554||left align    ||        1.0||
     555||  center      ||        4.5||
     556||      right align||     4.5||
     557|| default alignment ||   2.5||
     558||default||         2.5||
     559||  default ||      2.5||
     560|| default ||       2.5||
     561}}}
     562
     563If 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.
     564
     565||= Wiki Markup =||
     566{{{#!td
     567  {{{
     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] || \
     570  || that's column 3 and last one ||
     571  }}}
     572}}}
     573|-------------
     574||= Display =||
     575{{{#!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] || \
     578|| that's column 3 and last one ||
     579}}}
     580
     581=== Complex Tables ===
     582
     583If 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].
    199584
    200585
     
    203588Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark "!" character, such as {{{!WikiPageLink}}}.
    204589
    205 Example:
    206 {{{
    207  TitleIndex, http://www.edgewall.com/, !NotAlink
    208 }}}
    209 
    210 Display:
    211  TitleIndex, http://www.edgewall.com/, !NotAlink
    212 
    213 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.  If 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.
    214 
    215 Example:
    216 {{{
    217  * [http://www.edgewall.com/ Edgewall Software]
    218  * [wiki:TitleIndex Title Index]
    219  * [wiki:ISO9000]
    220 }}}
    221 
    222 Display:
    223  * [http://www.edgewall.com/ Edgewall Software]
    224  * [wiki:TitleIndex Title Index]
    225  * [wiki:ISO9000]
    226 
    227 
    228 === Trac Links ===
     590||= Wiki Markup =||= Display =||
     591{{{#!td
     592  {{{
     593  TitleIndex, http://www.edgewall.com/, !NotAlink
     594  }}}
     595}}}
     596{{{#!td
     597TitleIndex, http://www.edgewall.com/, !NotAlink
     598}}}
     599
     600Links can be given a more descriptive title by writing the link followed by a space and a title and all this inside square brackets.
     601If 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.
     602
     603||= Wiki Markup =||= Display =||
     604{{{#!td
     605  {{{
     606   * [http://www.edgewall.com Edgewall Software]
     607   * [wiki:TitleIndex Title Index]
     608   * [wiki:TitleIndex]
     609   * [wiki:ISO9000]
     610  }}}
     611}}}
     612{{{#!td
     613   * [http://www.edgewall.com Edgewall Software]
     614   * [wiki:TitleIndex Title Index]
     615   * [wiki:TitleIndex]
     616   * [wiki:ISO9000]
     617}}}
     618
     619Following 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.
     620
     621{{{#!td
     622  {{{
     623   * [[http://www.edgewall.com|Edgewall Software]]
     624   * [[wiki:TitleIndex|Title Index]]
     625     or even [[TitleIndex|Title Index]]
     626   * [[wiki:TitleIndex]]
     627     ''' but not ![[TitleIndex]]! '''
     628   * [[ISO9000]]
     629  }}}
     630}}}
     631{{{#!td
     632   * [[http://www.edgewall.com|Edgewall Software]]
     633   * [[wiki:TitleIndex|Title Index]]
     634     or even [[TitleIndex|Title Index]]
     635   * [[wiki:TitleIndex]]
     636     ''' but not ![[TitleIndex]]! '''
     637   * [[ISO9000]]
     638}}}
     639
     640'''Note''': the [trac:WikiCreole] style for links is quick to type and
     641certainly looks familiar as it's the one used on Wikipedia and in many
     642other wikis. Unfortunately it conflicts with the syntax for [#Macros macros].
     643So in the rare case when you need to refer to a page which is named after
     644a macro (typical examples being TitleIndex, InterTrac and InterWiki),
     645by writing `[[TitleIndex]]` you will actually call the macro instead of linking
     646to the page.
     647
     648== Trac Links ==
    229649
    230650Wiki 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:
    231 {{{
    232  * Tickets: #1 or ticket:1
    233  * Reports: {1} or report:1
    234  * Changesets: r1, [1] or changeset:1
    235  * ...
    236 }}}
    237 
    238 Display:
     651
     652||= Wiki Markup =||= Display =||
     653{{{#!td
     654  {{{
     655   * Tickets: #1 or ticket:1
     656   * Reports: {1} or report:1
     657   * Changesets: r1, [1] or changeset:1
     658   * ...
     659   * targeting other Trac instances,
     660     so called InterTrac links:
     661     - Tickets: #Trac1 or Trac:ticket:1
     662     - Changesets: [Trac1] or Trac:changeset:1
     663  }}}
     664}}}
     665{{{#!td
    239666 * Tickets: #1 or ticket:1
    240667 * Reports: {1} or report:1
    241668 * Changesets: r1, [1] or changeset:1
    242669 * ...
    243 
    244 See TracLinks for more in-depth information.
     670 * targeting other Trac instances,
     671   so called InterTrac links:
     672   - Tickets: #Trac1 or Trac:ticket:1
     673   - Changesets: [Trac1] or Trac:changeset:1
     674}}}
     675
     676There are many more flavors of Trac links, see TracLinks for more in-depth information and a reference for all the default link resolvers.
     677
     678
     679== Setting Anchors ==
     680
     681An 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:
     682
     683{{{
     684[=#point1]
     685}}}
     686
     687This syntax was chosen to match the format for explicitly naming the header id [#Headings documented above]. For example:
     688{{{
     689== Long title == #title
     690}}}
     691
     692It's also very close to the syntax for the corresponding link to that anchor:
     693{{{
     694[#point1]
     695}}}
     696
     697Optionally, a label can be given to the anchor:
     698{{{
     699[[=#point1 '''Point 1''']]
     700}}}
     701
     702||= Wiki Markup =||= Display =||
     703|----------------------------------
     704{{{#!td
     705  {{{
     706  [#point2 jump to the second point]
     707
     708  ...
     709
     710  Point2:  [=#point2] Jump here
     711  }}}
     712}}}
     713{{{#!td
     714  [#point2 jump to the second point]
     715
     716  ...
     717
     718  Point2:  [=#point2] Jump here
     719}}}
     720
     721For 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)^)]]`.
    245722
    246723
     
    249726You may avoid making hyperlinks out of TracLinks by preceding an expression with a single "!" (exclamation mark).
    250727
    251 Example:
    252 {{{
     728||= Wiki Markup =||= Display =||
     729{{{#!td
     730  {{{
     731   !NoHyperLink
     732   !#42 is not a link
     733  }}}
     734}}}
     735{{{#!td
    253736 !NoHyperLink
    254737 !#42 is not a link
    255738}}}
    256739
    257 Display:
    258  !NoHyperLink
    259  !#42 is not a link
    260 
    261 
    262740== Images ==
    263741
    264742Urls ending with `.png`, `.gif` or `.jpg` are no longer automatically interpreted as image links, and converted to `<img>` tags.
    265743
    266 You now have to use the ![[Image]] macro (see below).
     744You now have to use the ![[Image]] macro. The simplest way to include an image is to upload it as attachment to the current page, and put the filename in a macro call like `[[Image(picture.gif)]]`.
     745
     746In addition to the current page, it is possible to refer to other resources:
     747 * `[[Image(wiki:WikiFormatting:picture.gif)]]` (referring to attachment on another page)
     748 * `[[Image(ticket:1:picture.gif)]]` (file attached to a ticket)
     749 * `[[Image(htdocs:picture.gif)]]` (referring to a file inside the [TracEnvironment environment] `htdocs` directory)
     750 * `[[Image(source:/trunk/trac/htdocs/trac_logo_mini.png)]]` (a file in repository)
     751
     752||= Wiki Markup =||= Display =||
     753{{{#!td
     754  {{{
     755  [[Image(htdocs:../common/trac_logo_mini.png)]]
     756  }}}
     757}}}
     758{{{#!td
     759[[Image(htdocs:../common/trac_logo_mini.png)]]
     760}}}
     761
     762See WikiMacros for further documentation on the `[[Image()]]` macro, which has several useful options (`title=`, `link=`, etc.)
    267763
    268764
     
    271767Macros are ''custom functions'' to insert dynamic content in a page.
    272768
    273 Example:
    274 {{{
    275  [[Timestamp]]
    276 }}}
    277 
    278 Display:
    279  [[Timestamp]]
     769||= Wiki Markup =||= Display =||
     770{{{#!td
     771  {{{
     772  [[RecentChanges(Trac,3)]]
     773  }}}
     774}}}
     775{{{#!td style="padding-left: 2em"
     776[[RecentChanges(Trac,3)]]
     777}}}
    280778
    281779See WikiMacros for more information, and a list of installed macros.
     780
     781The detailed help for a specific macro can also be obtained more directly by appending a "?" to the macro name.
     782
     783||= Wiki Markup =||= Display =||
     784{{{#!td
     785  {{{
     786  [[MacroList?]]
     787  }}}
     788}}}
     789{{{#!td style="padding-left: 2em"
     790[[MacroList?]]
     791}}}
    282792
    283793
     
    287797[wiki:WikiRestructuredText reStructuredText] or [wiki:WikiHtml HTML].
    288798
    289 Example 1:
    290 {{{
    291 #!html
    292 <pre class="wiki">{{{
    293 #!html
    294 &lt;h1 style="text-align: right; color: blue"&gt;HTML Test&lt;/h1&gt;
    295 }}}</pre>
    296 }}}
    297 
    298 Display:
     799||= Wiki Markup =||= Display =||
     800|--------------------------------------------------------
     801{{{#!td align="center" colspan=2 style="border: 0px; font-size: 90%"
     802
     803   [=#Processors-example-html Example 1:] HTML
     804
     805}}}
     806|--------------------------------------------------------
     807{{{#!td style="border: 0px"
     808  {{{
     809  {{{
     810  #!html
     811  <h1 style="text-align: right; color: blue">
     812   HTML Test
     813  </h1>
     814  }}}
     815  }}}
     816}}}
     817{{{#!td valign="top"  style="border: 0px"
     818
    299819{{{
    300820#!html
     
    302822}}}
    303823
    304 Example:
     824}}}
     825|--------------------------------------------------------
     826{{{#!td align="center" colspan=2 style="border: 0px; font-size: 90%"
     827
     828   [=#Processors-example-highlight Example 2:] Code Highlighting
     829
     830}}}
     831|--------------------------------------------------------
     832{{{#!td style="border: 0px"
     833  {{{
     834  {{{
     835  #!python
     836  class Test:
     837 
     838      def __init__(self):
     839          print "Hello World"
     840  if __name__ == '__main__':
     841     Test()
     842  }}}
     843  }}}
     844}}}
    305845{{{
    306 #!html
    307 <pre class="wiki">{{{
    308 #!python
    309 class Test:
    310 
    311     def __init__(self):
    312         print "Hello World"
    313 if __name__ == '__main__':
    314    Test()
    315 }}}</pre>
    316 }}}
    317 
    318 Display:
     846#!td valign="top"  style="border: 0px"
     847
    319848{{{
    320849#!python
     
    326855}}}
    327856
    328 Perl:
     857}}}
     858|--------------------------------------------------------
     859{{{#!td align="center" colspan=2 style="border: 0px; font-size: 90%"
     860
     861       [=#Processors-example-tables Example 3:] Complex Tables
     862
     863}}}
     864|--------------------------------------------------------
     865{{{#!td style="border: 0px"
     866  {{{
     867  {{{#!th rowspan=4 align=justify
     868  With the `#td` and `#th` processors,
     869  table cells can contain any content:
     870  }}}
     871  |----------------
     872  {{{#!td
     873    - lists
     874    - embedded tables
     875    - simple multiline content
     876  }}}
     877  |----------------
     878  {{{#!td
     879  As processors can be easily nested,
     880  so can be tables:
     881    {{{#!th
     882    Example:
     883    }}}
     884    {{{#!td style="background: #eef"
     885    || must be at the third level now... ||
     886    }}}
     887  }}}
     888  |----------------
     889  {{{#!td
     890  Even when you don't have complex markup,
     891  this form of table cells can be convenient
     892  to write content on multiple lines.
     893  }}}
     894  }}}
     895}}}
    329896{{{
    330 #!perl
    331 my ($test) = 0;
    332 if ($test > 0) {
    333     print "hello";
    334 }
     897#!td  valign="top"  style="border: 0px"
     898
     899  {{{#!th rowspan=4 align=justify
     900  With the `#td` and `#th` processors,
     901  table cells can contain any content:
     902  }}}
     903  |----------------
     904  {{{#!td
     905    - lists
     906    - embedded tables
     907    - simple multiline content
     908  }}}
     909  |----------------
     910  {{{#!td
     911  As processors can be easily nested,
     912  so can be tables:
     913    {{{#!th
     914    Example:
     915    }}}
     916    {{{#!td style="background: #eef"
     917    || must be at the third level now... ||
     918    }}}
     919  }}}
     920  |----------------
     921  {{{#!td
     922  Even when you don't have complex markup,
     923  this form of table cells can be convenient
     924  to write content on multiple lines.
     925  }}}
     926
    335927}}}
    336928
     
    338930
    339931
     932== Comments ==
     933
     934Comments can be added to the plain text. These will not be rendered and will not display in any other format than plain text.
     935
     936||= Wiki Markup =||= Display =||
     937{{{#!td
     938  {{{
     939  Nothing to
     940  {{{
     941  #!comment
     942  Your comment for editors here
     943  }}}
     944  see ;-)
     945  }}}
     946}}}
     947{{{#!td
     948  Nothing to
     949  {{{
     950  #!comment
     951  Your comment for editors here
     952  }}}
     953  see ;-)
     954}}}
     955
    340956== Miscellaneous ==
    341957
    342 Four or more dashes will be replaced by a horizontal line (<HR>)
    343 
    344 Example:
    345 {{{
    346  ----
    347 }}}
    348 
    349 Display:
     958An horizontal line can be used to separated different parts of your page:
     959
     960||= Wiki Markup =||= Display =||
     961{{{#!td
     962  {{{
     963  Four or more dashes will be replaced
     964  by an horizontal line (<HR>)
     965  ----
     966  See?
     967  }}}
     968}}}
     969{{{#!td
     970Four or more dashes will be replaced
     971by an horizontal line (<HR>)
    350972----
    351 
    352 
    353 ----
    354 See also: TracLinks, TracGuide, WikiHtml, WikiMacros, WikiProcessors, TracSyntaxColoring.
     973See?
     974}}}
     975|----------------------------------
     976{{{#!td
     977  {{{
     978  "macro" style [[br]] line break
     979  }}}
     980}}}
     981{{{#!td
     982"macro" style [[br]] line break
     983}}}
     984|----------------------------------
     985{{{#!td
     986  {{{
     987  !WikiCreole style \\ line\\break
     988  }}}
     989}}}
     990{{{#!td
     991!WikiCreole style \\ line\\break
     992}}}
     993