Changes between Version 1 and Version 2 of WikiFormatting


Ignore:
Timestamp:
Mar 7, 2018, 4:17:24 PM (7 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • WikiFormatting

    v1 v2  
    1 = WikiFormatting =
     1= WikiFormatting
     2
    23[[TracGuideToc]]
    34
    45Wiki markup is a core feature in Trac, tightly integrating all the other parts of Trac into a flexible and powerful whole.
    56
    6 Trac 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://moinmo.in/ MoinMoin] and [trac:WikiCreole].
    8 
     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].
    98
    109This page will give you an in-depth explanation of the wiki markup available anywhere WikiFormatting is allowed.
    1110
    12 The ''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.
     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.
    1312
    1413A 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 ==
     14 - TracLinks covers all the possible ways to refer precisely to any Trac resource or parts thereof.
     15 - WikiPageNames covers the various names a wiki page can take, whether in CamelCase or not.
     16 - WikiMacros lists the macros available for generating dynamic content.
     17 - WikiProcessors and WikiHtml details how parts of the wiki text can be processed in special ways.
     18 - [trac:wiki:TracDev/Proposals/AdvancedWikiOperations AdvancedWikiOperations] provides some operations in uncommon or administrative scenarios.
     19
     20== Common wiki markup
    2221
    2322||= '''Category''' =||= '''Wiki Markup''' =||= '''Display''' =||
    … …  
    2827|| `'''bold'''`, `''italic''`, `'''''Wikipedia style'''''` || \
    2928|| '''bold''', ''italic'', '''''Wikipedia style''''' ||
    30 || {{{`monospaced and ''nowiki''`}}} || \
    31 || `monospaced and nowiki` ||
     29|| {{{`monospaced (''other markup ignored'')`}}} || \
     30|| `monospaced (''other markup ignored'')` ||
    3231|| `**bold**`, `//italic//`, `**//!WikiCreole style//**` || \
    3332|| **bold**, //italic//, **//!WikiCreole style//** ||
    … …  
    3635{{{#!td
    3736 {{{
    38  == Level 2 ==
     37 == Level 2
    3938 === Level 3 ^([#hn note])^
    4039 }}}
    … …  
    6463{{{#!td
    6564 {{{
    66  * bullets list
    67    on multiple paragraphs
     65 * bullet list
     66   on multiple lines
    6867   1. nested list
    6968     a. different numbering
    … …  
    7271}}}
    7372{{{#!td
    74 * bullets list
    75   on multiple paragraphs
     73* bullet list
     74  on multiple lines
    7675  1. nested list
    7776    a. different numbering
    … …  
    8584 {{{
    8685  term:: definition on
    87          multiple paragraphs
     86         multiple lines
    8887 }}}
    8988}}}
    9089{{{#!td
    9190 term:: definition on
    92         multiple paragraphs
     91        multiple lines
    9392}}}
    9493|-----------------------------------------------------------
    … …  
    175174|| see [#point1 (1)] ||
    176175|-----------------------------------------------------------
    177 {{{#!th rowspan=2
    178 [#EscapingLinksandWikiPageNames Escaping Markup]
     176{{{#!th rowspan=3
     177[#Escaping Escaping Markup]
    179178}}}
    180179|| `!'' doubled quotes` ||\
    … …  
    182181|| `!wiki:WikiFormatting`, `!WikiFormatting` ||\
    183182|| !wiki:WikiFormatting, !WikiFormatting ||
     183|| [[html(<code>`{{{-}}}` triple curly brackets</code>)]] ||\
     184|| `{{{-}}}` triple curly brackets ||
    184185|-----------------------------------------------------------
    185186||= [#Images Images] =|| `[[Image(`''link''`)]]` || [[Image(htdocs:../common/trac_logo_mini.png)]] ||
    … …  
    241242}}}
    242243
    243 
    244 == Font Styles ==
     244== Font Styles
    245245
    246246The Trac wiki supports the following font styles:
    … …  
    262262   * **also bold**, //italic as well//,
    263263     and **'' bold italic **'' //(since 0.12)//
     264   * [[span(style=color: #FF0000, a red text )]]
    264265  }}}
    265266}}}
    … …  
    279280 * **also bold**, //italic as well//,
    280281   and **'' bold italic **'' //(since 0.12)//
     282 * [[span(style=color: #FF0000, a red text )]]
    281283}}}
    282284
    … …  
    285287 * {{{ ! }}} 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.
    286288 * 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 
    290 
    291 == Headings ==
    292 
    293 You can create heading by starting a line with one up to six ''equal'' characters ("=")
    294 followed 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.
     289   and they must nest properly; in particular, an `''` italic can't be paired
     290   with a `//` one, and `'''` can't be paired with `**`.
     291
     292== Headings
     293
     294You can create heading by starting a line with one up to six ''equal'' characters ("=") followed 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 not mandatory. That is, `=== Section3 ===` is identical to `=== Section3`.
    297298
    298299Finally, the heading might optionally be followed by an explicit id. If not, an implicit but nevertheless readable id will be generated.
    … …  
    311312  {{{
    312313  #!div
     314  = Heading =
    313315  == Subheading
    314316  === About ''this'' ===
    … …  
    318320}}}
    319321
    320 == Paragraphs ==
     322== Paragraphs
    321323
    322324A new text paragraph is created whenever two blocks of text are separated by one or more empty lines.
    … …  
    346348}}}
    347349
    348 == Lists ==
     350== Lists
    349351
    350352The wiki supports both ordered/numbered and unordered lists.
    … …  
    402404}}}
    403405
    404 
    405 == Definition Lists ==
     406== Definition Lists
    406407
    407408The wiki also supports definition lists.
    … …  
    427428Note that you need a space in front of the defined term.
    428429
    429 
    430 == Preformatted Text ==
     430== Preformatted Text
    431431
    432432Block 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.
    … …  
    450450Note that this kind of block is also used for selecting lines that should be processed through WikiProcessors.
    451451
    452 == Blockquotes ==
     452== Blockquotes
    453453
    454454In order to mark a paragraph as blockquote, indent that paragraph with two spaces.
    … …  
    466466}}}
    467467
    468 == Discussion Citations ==
    469 
    470 To delineate a citation in an ongoing discussion thread, such as the ticket comment area, e-mail-like citation marks (">", ">>", etc.) may be used. 
     468== Discussion Citations
     469
     470To delineate a citation in an ongoing discussion thread, such as the ticket comment area, email-like citation marks (">", ">>", etc.) may be used. 
    471471
    472472||= Wiki Markup =||= Display =||
    … …  
    486486}}}
    487487
    488 
    489 == Tables ==
    490 === Simple Tables ===
     488== Tables
     489=== Simple Tables
     490
    491491Simple tables can be created like this:
    492492||= Wiki Markup =||= Display =||
    … …  
    578578}}}
    579579
    580 === Complex Tables ===
    581 
    582 If 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].
    583 
    584 
    585 == Links ==
    586 
    587 Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark "!" character, such as {{{!WikiPageLink}}}.
     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 elaborate tables by using [#Processors-example-tables WikiProcessor based tables].
     583
     584== Links
     585
     586Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark ('!'), such as {{{!WikiPageLink}}}.
    588587
    589588||= Wiki Markup =||= Display =||
    … …  
    637636}}}
    638637
    639 '''Note''': the [trac:WikiCreole] style for links is quick to type and
    640 certainly looks familiar as it's the one used on Wikipedia and in many
    641 other wikis. Unfortunately it conflicts with the syntax for [#Macros macros].
    642 So in the rare case when you need to refer to a page which is named after
    643 a macro (typical examples being TitleIndex, InterTrac and InterWiki),
    644 by writing `[[TitleIndex]]` you will actually call the macro instead of linking
    645 to the page.
    646 
    647 == Trac Links ==
     638'''Note''': the [trac:WikiCreole] style for links is quick to type and certainly looks familiar as it is the one used on Wikipedia and in many other wikis. Unfortunately it conflicts with the syntax for [#Macros macros].
     639So in the rare case when you need to refer to a page which is named after a macro (typical examples being TitleIndex, InterTrac and InterWiki), by writing `[[TitleIndex]]` you will actually call the macro instead of linking to the page.
     640
     641== Trac Links
    648642
    649643Wiki 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:
    … …  
    675669There are many more flavors of Trac links, see TracLinks for more in-depth information and a reference for all the default link resolvers.
    676670
    677 
    678 == Setting Anchors ==
     671== Setting Anchors
    679672
    680673An 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:
    … …  
    689682}}}
    690683
    691 It's also very close to the syntax for the corresponding link to that anchor:
     684It is also very close to the syntax for the corresponding link to that anchor:
    692685{{{
    693686[#point1]
    … …  
    696689Optionally, a label can be given to the anchor:
    697690{{{
    698 [[=#point1 '''Point 1''']]
     691[=#point1 '''Point 1''']
    699692}}}
    700693
    … …  
    718711}}}
    719712
    720 For 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)^)]]`.
    721 
    722 
    723 == Escaping Links and WikiPageNames ==
    724 
    725 You may avoid making hyperlinks out of TracLinks by preceding an expression with a single "!" (exclamation mark).
     713For more complex anchors (eg when a custom title is wanted), you can use the Span macro: `[[span(id=point2, class=wikianchor, title=Point 2, ^(2)^)]]`.
     714
     715== Escaping Links, WikiPageNames and other Markup == #Escaping
     716
     717You may avoid making hyperlinks out of TracLinks by preceding an expression with a single exclamation mark ('!').
    726718
    727719||= Wiki Markup =||= Display =||
    … …  
    731723   !#42 is not a link
    732724  }}}
     725  {{{
     726Various forms of escaping for list markup:
     727 ^^- escaped minus sign \\
     728 ^^1. escaped number  \\
     729 ^^* escaped asterisk sign
     730  }}}
    733731}}}
    734732{{{#!td
    735733 !NoHyperLink
    736734 !#42 is not a link
    737 }}}
    738 
    739 == Images ==
     735
     736Various forms of escaping for list markup:
     737 ^^- escaped minus sign \\
     738 ^^1. escaped number  \\
     739 ^^* escaped asterisk sign
     740}}}
     741
     742== Images
    740743
    741744Urls ending with `.png`, `.gif` or `.jpg` are no longer automatically interpreted as image links, and converted to `<img>` tags.
    … …  
    746749 * `[[Image(wiki:WikiFormatting:picture.gif)]]` (referring to attachment on another page)
    747750 * `[[Image(ticket:1:picture.gif)]]` (file attached to a ticket)
    748  * `[[Image(htdocs:picture.gif)]]` (referring to a file inside project htdocs)
     751 * `[[Image(htdocs:picture.gif)]]` (referring to a file inside the [TracEnvironment environment] `htdocs` directory)
    749752 * `[[Image(source:/trunk/trac/htdocs/trac_logo_mini.png)]]` (a file in repository)
    750753
    … …  
    759762}}}
    760763
    761 See WikiMacros for further documentation on the `[[Image()]]` macro.
    762 
    763 
    764 == Macros ==
     764See WikiMacros for further documentation on the `[[Image()]]` macro, which has several useful options (`title=`, `link=`, etc.)
     765
     766== Macros
    765767
    766768Macros are ''custom functions'' to insert dynamic content in a page.
    … …  
    790792}}}
    791793
    792 
    793 == Processors ==
     794== Processors
    794795
    795796Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in
    … …  
    928929See WikiProcessors for more information.
    929930
    930 
    931 == Comments ==
     931== Comments
    932932
    933933Comments can be added to the plain text. These will not be rendered and will not display in any other format than plain text.
    … …  
    941941  Your comment for editors here
    942942  }}}
    943   see ;-)
     943  see.
    944944  }}}
    945945}}}
    … …  
    950950  Your comment for editors here
    951951  }}}
    952   see ;-)
    953 }}}
    954 
    955 == Miscellaneous ==
    956 
    957 An horizontal line can be used to separated different parts of your page:
    958 
    959 ||= Wiki Markup =||= Display =||
    960 {{{#!td
     952  see.
     953}}}
     954
     955== Miscellaneous
     956
     957||= Wiki Markup =||= Display =||
     958{{{#!td
     959  Horizontal line:
    961960  {{{
    962961  Four or more dashes will be replaced
    963   by an horizontal line (<HR>)
     962  by a horizontal line (<HR>)
    964963  ----
    965964  See?
    … …  
    968967{{{#!td
    969968Four or more dashes will be replaced
    970 by an horizontal line (<HR>)
     969by a horizontal line (<HR>)
    971970----
    972971See?
    … …  
    974973|----------------------------------
    975974{{{#!td
    976   {{{
    977   "macro" style [[br]] line break
    978   }}}
    979 }}}
    980 {{{#!td
    981 "macro" style [[br]] line break
     975  Two examples of line breaks:
     976  {{{
     977  "macro" style [[BR]] line break
     978  }}}
     979  or:
     980  {{{
     981  !WikiCreole style \\ line\\break
     982  }}}
     983}}}
     984{{{#!td
     985"macro" style [[BR]] line break
     986
     987!WikiCreole style \\ line\\break
    982988}}}
    983989|----------------------------------
    984 {{{#!td
    985   {{{
    986   !WikiCreole style \\ line\\break
    987   }}}
    988 }}}
    989 {{{#!td
    990 !WikiCreole style \\ line\\break
    991 }}}