Changes between Version 1 and Version 2 of WikiFormatting


Ignore:
Timestamp:
06/12/10 12:12:07 (4 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiFormatting

    v1 v2  
    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== Cheatsheet == 
     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] The headline text can be followed by the same number of "=" characters, but this is no longer mandatory. 
     297 
     298Finally, the heading might optionally be followed by an explicit id. If not, an implicit but nevertheless readable id will be generated. 
     299 
     300||= Wiki Markup =||= Display =|| 
     301{{{#!td 
     302  {{{ 
     303  = Heading = 
     304  == Subheading 
     305  === About ''this'' === 
     306  === Explicit id === #using-explicit-id-in-heading 
     307  == Subheading #sub2 
     308}}} 
     309}}} 
     310{{{#!td style="padding: 1em;" 
     311  {{{ 
     312  #!div 
     313  == Subheading 
     314  === About ''this'' === 
     315  === Explicit id === #using-explicit-id-in-heading 
     316  == Subheading #sub2 
     317  }}} 
     318}}} 
     319 
     320== Paragraphs == 
     321 
     322A new text paragraph is created whenever two blocks of text are separated by one or more empty lines. 
     323 
     324A forced line break can also be inserted, using: 
     325||= Wiki Markup =||= Display =|| 
     326{{{#!td 
     327  {{{ 
     328  Line 1[[BR]]Line 2 
     329  }}} 
     330  {{{ 
     331  Paragraph 
     332  one 
     333 
     334  Paragraph  
     335  two 
     336  }}} 
     337}}} 
     338{{{#!td 
     339  Line 1[[BR]]Line 2 
     340 
     341  Paragraph  
     342  one 
     343 
     344  Paragraph  
     345  two 
     346}}} 
     347 
     348== Lists == 
     349 
     350The wiki supports both ordered/numbered and unordered lists. 
    47351 
    48352Example: 
    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 {{{ 
     353||= Wiki Markup =||= Display =|| 
     354{{{#!td 
     355  {{{ 
     356   * Item 1 
     357     * Item 1.1 
     358        * Item 1.1.1    
     359        * Item 1.1.2 
     360        * Item 1.1.3 
     361     * Item 1.2 
     362   * Item 2 
     363  - items can start at the beginning of a line 
     364    and they can span multiple lines 
     365    - be careful though to continue the line  
     366    with the appropriate indentation, otherwise 
     367  that will start a new paragraph... 
     368   
     369   1. Item 1 
     370     a. Item 1.a 
     371     a. Item 1.b 
     372        i. Item 1.b.i 
     373        i. Item 1.b.ii 
     374   1. Item 2 
     375  And numbered lists can also be restarted 
     376  with an explicit number: 
     377   3. Item 3 
     378  }}} 
     379}}} 
     380{{{#!td 
    81381 * Item 1 
    82382   * Item 1.1 
     
    86386   * Item 1.2 
    87387 * Item 2 
     388- items can start at the beginning of a line 
     389  and they can span multiple lines 
     390  - be careful though to continue the line  
     391  with the appropriate indentation, otherwise 
     392that will start a new paragraph... 
    88393 
    89394 1. Item 1 
     
    93398      i. Item 1.b.ii 
    94399 1. Item 2 
    95 And numbered lists can also be given an explicit number: 
     400And numbered lists can also be restarted with an explicit number: 
    96401 3. Item 3 
    97402}}} 
    98403 
    99 Display: 
    100  * Item 1 
    101    * Item 1.1 
    102       * Item 1.1.1 
    103       * Item 1.1.2 
    104       * Item 1.1.3 
    105    * Item 1.2 
    106  * Item 2 
    107  
    108  1. Item 1 
    109    a. Item 1.a 
    110    a. Item 1.b 
    111       i. Item 1.b.i 
    112       i. Item 1.b.ii 
    113  1. Item 2 
    114 And numbered lists can also be given an explicit number: 
    115  3. Item 3 
    116  
    117 Note that there must be one or more spaces preceding the list item markers, otherwise the list will be treated as a normal paragraph. 
    118  
    119404 
    120405== Definition Lists == 
    121406 
    122  
    123407The wiki also supports definition lists. 
    124408 
    125 Example: 
    126 {{{ 
     409||= Wiki Markup =||= Display =|| 
     410{{{#!td 
     411  {{{ 
     412   llama:: 
     413     some kind of mammal, with hair 
     414   ppython:: 
     415     some kind of reptile, without hair 
     416     (can you spot the typo?) 
     417  }}} 
     418}}} 
     419{{{#!td 
    127420 llama:: 
    128421   some kind of mammal, with hair 
     
    132425}}} 
    133426 
    134 Display: 
    135  llama:: 
    136    some kind of mammal, with hair 
    137  ppython:: 
    138    some kind of reptile, without hair 
    139    (can you spot the typo?) 
    140  
    141427Note that you need a space in front of the defined term. 
    142428 
     
    146432Block 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. 
    147433   
    148 Example: 
     434||= Wiki Markup =||= Display =|| 
     435{{{#!td 
     436  {{{ 
     437  {{{ 
     438  def HelloWorld(): 
     439      print '''Hello World''' 
     440  }}} 
     441  }}} 
     442}}} 
     443{{{#!td 
     444  {{{ 
     445  def HelloWorld(): 
     446      print '''Hello World''' 
     447  }}} 
     448}}} 
     449 
     450Note that this kind of block is also used for selecting lines that should be processed through WikiProcessors. 
     451 
     452== Blockquotes == 
     453 
     454In order to mark a paragraph as blockquote, indent that paragraph with two spaces. 
     455 
     456||= Wiki Markup =||= Display =|| 
     457{{{#!td 
    149458{{{ 
    150  {{{ 
    151   def HelloWorld(): 
    152       print "Hello World" 
    153  }}} 
    154 }}} 
    155  
    156 Display: 
    157 {{{ 
    158  def HelloWorld(): 
    159      print "Hello World" 
    160 }}} 
    161  
    162  
    163 == Blockquotes == 
    164  
    165 In order to mark a paragraph as blockquote, indent that paragraph with two spaces. 
    166  
    167 Example: 
    168 {{{ 
     459Paragraph 
    169460  This text is a quote from someone else. 
    170461}}} 
    171  
    172 Display: 
     462}}} 
     463{{{#!td 
     464Paragraph 
    173465  This text is a quote from someone else. 
     466}}} 
    174467 
    175468== Discussion Citations == 
     
    177470To delineate a citation in an ongoing discussion thread, such as the ticket comment area, e-mail-like citation marks (">", ">>", etc.) may be used.   
    178471 
    179 Example: 
    180 {{{ 
     472||= Wiki Markup =||= Display =|| 
     473{{{#!td 
     474  {{{ 
     475  >> Someone's original text 
     476  > Someone else's reply text 
     477  >  - which can be any kind of Wiki markup 
     478  My reply text 
     479  }}} 
     480}}} 
     481{{{#!td 
    181482>> Someone's original text 
    182483> Someone else's reply text 
     484>  - which can be any kind of Wiki markup 
    183485My reply text 
    184486}}} 
    185487 
    186 Display: 
    187 >> Someone's original text 
    188 > Someone else's reply text 
    189 My reply text 
    190  
    191 ''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.'' 
    192488 
    193489== Tables == 
    194  
     490=== Simple Tables === 
    195491Simple tables can be created like this: 
    196 {{{ 
     492||= Wiki Markup =||= Display =|| 
     493{{{#!td 
     494  {{{ 
     495  ||Cell 1||Cell 2||Cell 3|| 
     496  ||Cell 4||Cell 5||Cell 6|| 
     497  }}} 
     498}}} 
     499{{{#!td style="padding: 2em;" 
    197500||Cell 1||Cell 2||Cell 3|| 
    198501||Cell 4||Cell 5||Cell 6|| 
    199502}}} 
    200503 
    201 Display: 
    202 ||Cell 1||Cell 2||Cell 3|| 
    203 ||Cell 4||Cell 5||Cell 6|| 
    204  
    205 Note that more complex tables can be created using 
    206 [wiki:WikiRestructuredText#BiggerReSTExample reStructuredText]. 
     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: 
     506||= Wiki Markup =||= Display =|| 
     507{{{#!td 
     508  {{{ 
     509  ||        ||= stable =||= latest =|| 
     510  ||= 0.10 =||  0.10.5  || 0.10.6dev|| 
     511  ||= 0.11 =||  0.11.6  || 0.11.7dev|| 
     512  }}} 
     513}}} 
     514{{{#!td style="padding: 2em;" 
     515||        ||= stable =||= latest =|| 
     516||= 0.10 =||  0.10.5  || 0.10.6dev|| 
     517||= 0.11 =||  0.11.6  || 0.11.7dev|| 
     518}}} 
     519 
     520Finally, specifying an empty cell means that the next non empty cell will span the empty cells. For example: 
     521||= Wiki Markup =||= Display =|| 
     522{{{#!td 
     523  {{{ 
     524  || 1 || 2 || 3 || 
     525  |||| 1-2 || 3 || 
     526  || 1 |||| 2-3 || 
     527  |||||| 1-2-3 || 
     528  }}} 
     529}}} 
     530{{{#!td style="padding: 2em;" 
     531|| 1 || 2 || 3 || 
     532|||| 1-2 || 3 || 
     533|| 1 |||| 2-3 || 
     534|||||| 1-2-3 || 
     535}}} 
     536 
     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: 
     538||= Wiki Markup =||= Display =|| 
     539{{{#!td 
     540  {{{ 
     541  ||=Text =||= Numbers =|| 
     542  ||left align    ||        1.0|| 
     543  ||  center      ||        4.5|| 
     544  ||      right align||     4.5|| 
     545  || default alignment ||   2.5|| 
     546  ||default||         2.5|| 
     547  ||  default ||      2.5|| 
     548  || default ||       2.5|| 
     549  }}} 
     550}}} 
     551{{{#!td style="padding: 2em;" 
     552||=Text =||= Numbers =|| 
     553||left align    ||        1.0|| 
     554||  center      ||        4.5|| 
     555||      right align||     4.5|| 
     556|| default alignment ||   2.5|| 
     557||default||         2.5|| 
     558||  default ||      2.5|| 
     559|| default ||       2.5|| 
     560}}} 
     561 
     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. 
     563 
     564||= Wiki Markup =|| 
     565{{{#!td 
     566  {{{ 
     567  || this is column 1 [http://trac.edgewall.org/newticket new ticket] || \ 
     568  || this is column 2 [http://trac.edgewall.org/roadmap the road ahead] || \ 
     569  || that's column 3 and last one || 
     570  }}} 
     571}}} 
     572|------------- 
     573||= Display =|| 
     574{{{#!td style="padding: 2em;" 
     575|| this is column 1 [http://trac.edgewall.org/newticket new ticket] || \ 
     576|| this is column 2 [http://trac.edgewall.org/roadmap the road ahead] || \ 
     577|| that's column 3 and last one || 
     578}}} 
     579 
     580=== Complex Tables === 
     581 
     582If 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]. 
    207583 
    208584 
     
    211587Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark "!" character, such as {{{!WikiPageLink}}}. 
    212588 
    213 Example: 
    214 {{{ 
    215  TitleIndex, http://www.edgewall.com/, !NotAlink 
    216 }}} 
    217  
    218 Display: 
    219  TitleIndex, http://www.edgewall.com/, !NotAlink 
    220  
    221 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. 
    222  
    223 Example: 
    224 {{{ 
    225  * [http://www.edgewall.com/ Edgewall Software] 
    226  * [wiki:TitleIndex Title Index] 
    227  * [wiki:ISO9000] 
    228 }}} 
    229  
    230 Display: 
    231  * [http://www.edgewall.com/ Edgewall Software] 
    232  * [wiki:TitleIndex Title Index] 
    233  * [wiki:ISO9000] 
     589||= Wiki Markup =||= Display =|| 
     590{{{#!td 
     591  {{{ 
     592  TitleIndex, http://www.edgewall.com/, !NotAlink 
     593  }}} 
     594}}} 
     595{{{#!td 
     596TitleIndex, http://www.edgewall.com/, !NotAlink 
     597}}} 
     598 
     599Links can be given a more descriptive title by writing the link followed by a space and a title and all this inside square brackets.  
     600If 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. 
     601 
     602||= Wiki Markup =||= Display =|| 
     603{{{#!td 
     604  {{{ 
     605   * [http://www.edgewall.com Edgewall Software] 
     606   * [wiki:TitleIndex Title Index]  
     607   * [wiki:TitleIndex]  
     608   * [wiki:ISO9000] 
     609  }}} 
     610}}} 
     611{{{#!td 
     612   * [http://www.edgewall.com Edgewall Software] 
     613   * [wiki:TitleIndex Title Index]  
     614   * [wiki:TitleIndex]  
     615   * [wiki:ISO9000] 
     616}}} 
     617 
     618Following 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]] 
     623   * [[wiki:TitleIndex|Title Index]] 
     624     or even [[TitleIndex|Title Index]] 
     625   * [[wiki:TitleIndex]] 
     626     ''' but not ![[TitleIndex]]! ''' 
     627   * [[ISO9000]] 
     628  }}} 
     629}}} 
     630{{{#!td 
     631   * [[http://www.edgewall.com|Edgewall Software]] 
     632   * [[wiki:TitleIndex|Title Index]] 
     633     or even [[TitleIndex|Title Index]] 
     634   * [[wiki:TitleIndex]] 
     635     ''' but not ![[TitleIndex]]! ''' 
     636   * [[ISO9000]] 
     637}}} 
     638 
     639'''Note''': the [trac:WikiCreole] style for links is quick to type and 
     640certainly looks familiar as it's the one used on Wikipedia and in many 
     641other wikis. Unfortunately it conflicts with the syntax for [#Macros macros]. 
     642So in the rare case when you need to refer to a page which is named after 
     643a macro (typical examples being TitleIndex, InterTrac and InterWiki),  
     644by writing `[[TitleIndex]]` you will actually call the macro instead of linking 
     645to the page. 
    234646 
    235647== Trac Links == 
    236648 
    237649Wiki 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: 
    238 {{{ 
    239  * Tickets: #1 or ticket:1 
    240  * Reports: {1} or report:1 
    241  * Changesets: r1, [1] or changeset:1 
    242  * ... 
    243 }}} 
    244  
    245 Display: 
     650 
     651||= Wiki Markup =||= Display =|| 
     652{{{#!td 
     653  {{{ 
     654   * Tickets: #1 or ticket:1 
     655   * Reports: {1} or report:1 
     656   * Changesets: r1, [1] or changeset:1 
     657   * ... 
     658   * targeting other Trac instances,  
     659     so called InterTrac links: 
     660     - Tickets: #Trac1 or Trac:ticket:1 
     661     - Changesets: [Trac1] or Trac:changeset:1 
     662  }}} 
     663}}} 
     664{{{#!td 
    246665 * Tickets: #1 or ticket:1 
    247666 * Reports: {1} or report:1 
    248667 * Changesets: r1, [1] or changeset:1 
    249668 * ...  
    250  
    251 There are many more flavors of Trac links, see TracLinks for more in-depth information. 
     669 * targeting other Trac instances,  
     670   so called InterTrac links: 
     671   - Tickets: #Trac1 or Trac:ticket:1 
     672   - Changesets: [Trac1] or Trac:changeset:1 
     673}}} 
     674 
     675There are many more flavors of Trac links, see TracLinks for more in-depth information and a reference for all the default link resolvers. 
     676 
     677 
     678== Setting Anchors == 
     679 
     680An 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: 
     681 
     682{{{ 
     683[=#point1] 
     684}}} 
     685 
     686This sytax was chosen to match the format for explicitly naming the header id [#Headings documented above]. For example: 
     687{{{ 
     688== Long title == #title 
     689}}} 
     690 
     691It's also very close to the syntax for the corresponding link to that anchor: 
     692{{{ 
     693[#point1] 
     694}}} 
     695 
     696Optionally, a label can be given to the anchor: 
     697{{{ 
     698[[=#point1 '''Point 1''']] 
     699}}} 
     700 
     701||= Wiki Markup =||= Display =|| 
     702|---------------------------------- 
     703{{{#!td 
     704  {{{ 
     705  [#point2 jump to the second point] 
     706 
     707  ... 
     708 
     709  Point2:  [=#point2] Jump here 
     710  }}} 
     711}}} 
     712{{{#!td 
     713  [#point2 jump to the second point] 
     714 
     715  ... 
     716 
     717  Point2:  [=#point2] Jump here 
     718}}} 
     719 
     720For 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)^)]]`. 
    252721 
    253722 
     
    256725You may avoid making hyperlinks out of TracLinks by preceding an expression with a single "!" (exclamation mark). 
    257726 
    258 Example: 
    259 {{{ 
     727||= Wiki Markup =||= Display =|| 
     728{{{#!td 
     729  {{{ 
     730   !NoHyperLink 
     731   !#42 is not a link 
     732  }}} 
     733}}} 
     734{{{#!td 
    260735 !NoHyperLink 
    261736 !#42 is not a link 
    262737}}} 
    263  
    264 Display: 
    265  !NoHyperLink 
    266  !#42 is not a link 
    267  
    268738 
    269739== Images == 
     
    279749 * `[[Image(source:/trunk/trac/htdocs/trac_logo_mini.png)]]` (a file in repository) 
    280750 
    281 Example display: [[Image(htdocs:../common/trac_logo_mini.png)]] 
    282  
     751||= Wiki Markup =||= Display =|| 
     752{{{#!td 
     753  {{{ 
     754  [[Image(htdocs:../common/trac_logo_mini.png)]] 
     755  }}} 
     756}}} 
     757{{{#!td 
     758[[Image(htdocs:../common/trac_logo_mini.png)]] 
     759}}} 
    283760 
    284761See WikiMacros for further documentation on the `[[Image()]]` macro. 
     
    289766Macros are ''custom functions'' to insert dynamic content in a page. 
    290767 
    291 Example: 
    292 {{{ 
    293  [[RecentChanges(Trac,3)]] 
    294 }}} 
    295  
    296 Display: 
    297  [[RecentChanges(Trac,3)]] 
     768||= Wiki Markup =||= Display =|| 
     769{{{#!td 
     770  {{{ 
     771  [[RecentChanges(Trac,3)]] 
     772  }}} 
     773}}} 
     774{{{#!td style="padding-left: 2em" 
     775[[RecentChanges(Trac,3)]] 
     776}}} 
    298777 
    299778See WikiMacros for more information, and a list of installed macros. 
     779 
     780The detailed help for a specific macro can also be obtained more directly by appending a "?" to the macro name. 
     781 
     782||= Wiki Markup =||= Display =|| 
     783{{{#!td 
     784  {{{ 
     785  [[MacroList?]] 
     786  }}} 
     787}}} 
     788{{{#!td style="padding-left: 2em" 
     789[[MacroList?]] 
     790}}} 
    300791 
    301792 
     
    305796[wiki:WikiRestructuredText reStructuredText] or [wiki:WikiHtml HTML].  
    306797 
    307 Example 1: 
    308 {{{ 
    309 #!html 
    310 <pre class="wiki">{{{ 
    311 #!html 
    312 &lt;h1 style="text-align: right; color: blue"&gt;HTML Test&lt;/h1&gt; 
    313 }}}</pre> 
    314 }}} 
    315  
    316 Display: 
     798||= Wiki Markup =||= Display =|| 
     799|-------------------------------------------------------- 
     800{{{#!td align="center" colspan=2 style="border: 0px; font-size: 90%" 
     801 
     802   [=#Processors-example-html Example 1:] HTML 
     803 
     804}}} 
     805|-------------------------------------------------------- 
     806{{{#!td style="border: 0px" 
     807  {{{ 
     808  {{{ 
     809  #!html 
     810  <h1 style="text-align: right; color: blue"> 
     811   HTML Test 
     812  </h1> 
     813  }}} 
     814  }}} 
     815}}} 
     816{{{#!td valign="top"  style="border: 0px" 
     817 
    317818{{{ 
    318819#!html 
     
    320821}}} 
    321822 
    322 Example: 
     823}}} 
     824|-------------------------------------------------------- 
     825{{{#!td align="center" colspan=2 style="border: 0px; font-size: 90%" 
     826 
     827   [=#Processors-example-highlight Example 2:] Code Highlighting 
     828 
     829}}} 
     830|-------------------------------------------------------- 
     831{{{#!td style="border: 0px" 
     832  {{{ 
     833  {{{ 
     834  #!python 
     835  class Test: 
     836   
     837      def __init__(self): 
     838          print "Hello World" 
     839  if __name__ == '__main__': 
     840     Test() 
     841  }}} 
     842  }}} 
     843}}} 
    323844{{{ 
    324 #!html 
    325 <pre class="wiki">{{{ 
    326 #!python 
    327 class Test: 
    328  
    329     def __init__(self): 
    330         print "Hello World" 
    331 if __name__ == '__main__': 
    332    Test() 
    333 }}}</pre> 
    334 }}} 
    335  
    336 Display: 
     845#!td valign="top"  style="border: 0px" 
     846 
    337847{{{ 
    338848#!python 
     
    344854}}} 
    345855 
    346 Perl: 
     856}}} 
     857|-------------------------------------------------------- 
     858{{{#!td align="center" colspan=2 style="border: 0px; font-size: 90%" 
     859 
     860       [=#Processors-example-tables Example 3:] Complex Tables 
     861 
     862}}} 
     863|-------------------------------------------------------- 
     864{{{#!td style="border: 0px" 
     865  {{{ 
     866  {{{#!th rowspan=4 align=justify 
     867  With the `#td` and `#th` processors, 
     868  table cells can contain any content: 
     869  }}} 
     870  |---------------- 
     871  {{{#!td 
     872    - lists 
     873    - embedded tables 
     874    - simple multiline content 
     875  }}} 
     876  |---------------- 
     877  {{{#!td 
     878  As processors can be easily nested,  
     879  so can be tables: 
     880    {{{#!th 
     881    Example: 
     882    }}} 
     883    {{{#!td style="background: #eef" 
     884    || must be at the third level now... || 
     885    }}} 
     886  }}} 
     887  |---------------- 
     888  {{{#!td 
     889  Even when you don't have complex markup, 
     890  this form of table cells can be convenient 
     891  to write content on multiple lines. 
     892  }}} 
     893  }}} 
     894}}} 
    347895{{{ 
    348 #!perl 
    349 my ($test) = 0; 
    350 if ($test > 0) { 
    351     print "hello"; 
    352 } 
     896#!td  valign="top"  style="border: 0px" 
     897 
     898  {{{#!th rowspan=4 align=justify 
     899  With the `#td` and `#th` processors, 
     900  table cells can contain any content: 
     901  }}} 
     902  |---------------- 
     903  {{{#!td 
     904    - lists 
     905    - embedded tables 
     906    - simple multiline content 
     907  }}} 
     908  |---------------- 
     909  {{{#!td 
     910  As processors can be easily nested,  
     911  so can be tables: 
     912    {{{#!th 
     913    Example: 
     914    }}} 
     915    {{{#!td style="background: #eef" 
     916    || must be at the third level now... || 
     917    }}} 
     918  }}} 
     919  |---------------- 
     920  {{{#!td 
     921  Even when you don't have complex markup, 
     922  this form of table cells can be convenient 
     923  to write content on multiple lines. 
     924  }}} 
     925 
    353926}}} 
    354927 
     
    359932 
    360933Comments can be added to the plain text. These will not be rendered and will not display in any other format than plain text. 
    361 {{{ 
    362 {{{ 
    363 #!comment 
    364 Your comment here 
    365 }}} 
    366 }}} 
    367  
     934 
     935||= Wiki Markup =||= Display =|| 
     936{{{#!td 
     937  {{{ 
     938  Nothing to 
     939  {{{ 
     940  #!comment 
     941  Your comment for editors here 
     942  }}} 
     943  see ;-) 
     944  }}} 
     945}}} 
     946{{{#!td 
     947  Nothing to 
     948  {{{ 
     949  #!comment 
     950  Your comment for editors here 
     951  }}} 
     952  see ;-) 
     953}}} 
    368954 
    369955== Miscellaneous == 
    370956 
    371 Four or more dashes will be replaced by a horizontal line (<HR>) 
    372  
    373 Example: 
    374 {{{ 
    375  ---- 
    376 }}} 
    377  
    378 Display: 
     957An horizontal line can be used to separated different parts of your page: 
     958 
     959||= Wiki Markup =||= Display =|| 
     960{{{#!td 
     961  {{{ 
     962  Four or more dashes will be replaced  
     963  by an horizontal line (<HR>) 
     964  ---- 
     965  See? 
     966  }}} 
     967}}} 
     968{{{#!td 
     969Four or more dashes will be replaced 
     970by an horizontal line (<HR>) 
    379971---- 
    380  
    381  
    382  
    383 ---- 
    384 See also: TracLinks, TracGuide, WikiHtml, WikiMacros, WikiProcessors, TracSyntaxColoring. 
     972See? 
     973}}} 
     974|---------------------------------- 
     975{{{#!td 
     976  {{{ 
     977  "macro" style [[br]] line break 
     978  }}} 
     979}}} 
     980{{{#!td 
     981"macro" style [[br]] line break 
     982}}} 
     983|---------------------------------- 
     984{{{#!td 
     985  {{{ 
     986  !WikiCreole style \\ line\\break 
     987  }}} 
     988}}} 
     989{{{#!td 
     990!WikiCreole style \\ line\\break 
     991}}}