Changes between Version 8 and Version 9 of WikiFormatting


Ignore:
Timestamp:
Jan 12, 2016, 11:21:52 PM (6 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • WikiFormatting

    v8 v9  
    1 = WikiFormatting
    2 
     1= WikiFormatting =
    32[[TracGuideToc]]
    43
    54Wiki markup is a core feature in Trac, tightly integrating all the other parts of Trac into a flexible and powerful whole.
    65
    7 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, especially [http://moinmo.in/ MoinMoin] and [trac:WikiCreole].
     6Trac 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,
     7especially [http://moinmo.in/ MoinMoin] and [trac:WikiCreole].
     8
    89
    910This page will give you an in-depth explanation of the wiki markup available anywhere WikiFormatting is allowed.
    1011
    11 The sections below provide an overview for the most common syntax, each link in the ''Category'' column will lead you to the more detailed explanation later in this page.
     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.
    1213
    1314A few other wiki pages present the advanced features of the Trac wiki markup in more depth:
    14  - TracLinks covers all the possible ways to refer precisely to any Trac resource or parts thereof
    15  - WikiPageNames covers the various names a wiki page can take, CamelCase or not
    16  - WikiMacros lists the macros available for generating dynamic content
     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,
    1718 - 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
     19
     20
     21== Cheat sheet ==
    2122
    2223||= '''Category''' =||= '''Wiki Markup''' =||= '''Display''' =||
    … …  
    181182|| `!wiki:WikiFormatting`, `!WikiFormatting` ||\
    182183|| !wiki:WikiFormatting, !WikiFormatting ||
    183 || [[html(<code>`{{{-}}}` triple curly brackets</code>)]] ||\
     184|| {{{`}}}`{{{-}}}`{{{`}}}` triple curly brackets` ||\
    184185|| `{{{-}}}` triple curly brackets ||
    185186|-----------------------------------------------------------
    … …  
    242243}}}
    243244
    244 == Font Styles
     245
     246== Font Styles ==
    245247
    246248The Trac wiki supports the following font styles:
    … …  
    262264   * **also bold**, //italic as well//,
    263265     and **'' bold italic **'' //(since 0.12)//
    264    * [[span(style=color: #FF0000, a red text )]]
    265266  }}}
    266267}}}
    … …  
    280281 * **also bold**, //italic as well//,
    281282   and **'' bold italic **'' //(since 0.12)//
    282  * [[span(style=color: #FF0000, a red text )]]
    283283}}}
    284284
    … …  
    290290   with a `//` one, and `'''` can't be paired with `**`)
    291291
    292 == Headings
    293 
    294 You can create heading by starting a line with one up to six ''equal'' characters ("=") followed by a single space and the headline text.
     292
     293== Headings ==
     294
     295You can create heading by starting a line with one up to six ''equal'' characters ("=")
     296followed by a single space and the headline text.
    295297
    296298[=#hn]
    … …  
    320322}}}
    321323
    322 == Paragraphs
     324== Paragraphs ==
    323325
    324326A new text paragraph is created whenever two blocks of text are separated by one or more empty lines.
    … …  
    348350}}}
    349351
    350 == Lists
     352== Lists ==
    351353
    352354The wiki supports both ordered/numbered and unordered lists.
    … …  
    404406}}}
    405407
    406 == Definition Lists
     408
     409== Definition Lists ==
    407410
    408411The wiki also supports definition lists.
    … …  
    428431Note that you need a space in front of the defined term.
    429432
    430 == Preformatted Text
     433
     434== Preformatted Text ==
    431435
    432436Block 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.
    … …  
    450454Note that this kind of block is also used for selecting lines that should be processed through WikiProcessors.
    451455
    452 == Blockquotes
     456== Blockquotes ==
    453457
    454458In order to mark a paragraph as blockquote, indent that paragraph with two spaces.
    … …  
    466470}}}
    467471
    468 == Discussion Citations
     472== Discussion Citations ==
    469473
    470474To delineate a citation in an ongoing discussion thread, such as the ticket comment area, e-mail-like citation marks (">", ">>", etc.) may be used. 
    … …  
    486490}}}
    487491
    488 == Tables
    489 === Simple Tables
    490 
     492
     493== Tables ==
     494=== Simple Tables ===
    491495Simple tables can be created like this:
    492496||= Wiki Markup =||= Display =||
    … …  
    578582}}}
    579583
    580 === Complex Tables
     584=== Complex Tables ===
    581585
    582586If 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].
    583587
    584 == Links
     588
     589== Links ==
    585590
    586591Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark "!" character, such as {{{!WikiPageLink}}}.
    … …  
    636641}}}
    637642
    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].
    639 So 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
     643'''Note''': the [trac:WikiCreole] style for links is quick to type and
     644certainly looks familiar as it's the one used on Wikipedia and in many
     645other wikis. Unfortunately it conflicts with the syntax for [#Macros macros].
     646So in the rare case when you need to refer to a page which is named after
     647a macro (typical examples being TitleIndex, InterTrac and InterWiki),
     648by writing `[[TitleIndex]]` you will actually call the macro instead of linking
     649to the page.
     650
     651== Trac Links ==
    642652
    643653Wiki 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:
    … …  
    669679There are many more flavors of Trac links, see TracLinks for more in-depth information and a reference for all the default link resolvers.
    670680
    671 == Setting Anchors
     681
     682== Setting Anchors ==
    672683
    673684An 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:
    … …  
    713724For 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)^)]]`.
    714725
     726
    715727== Escaping Links, WikiPageNames and other Markup == #Escaping
    716728
    … …  
    725737  {{{
    726738Various forms of escaping for list markup:
    727  ^^- escaped minus sign \\
    728  ^^1. escaped number  \\
    729  ^^* escaped asterisk sign
     739 `-` escaped minus sign \\
     740 ``1. escaped number  \\
     741 {{{*}}} escaped asterisk sign
    730742  }}}
    731743}}}
    … …  
    735747
    736748Various forms of escaping for list markup:
    737  ^^- escaped minus sign \\
    738  ^^1. escaped number  \\
    739  ^^* escaped asterisk sign
    740 }}}
    741 
    742 == Images
     749 `-` escaped minus sign \\
     750 ``1. escaped number  \\
     751 {{{*}}} escaped asterisk sign
     752}}}
     753
     754== Images ==
    743755
    744756Urls ending with `.png`, `.gif` or `.jpg` are no longer automatically interpreted as image links, and converted to `<img>` tags.
    … …  
    764776See WikiMacros for further documentation on the `[[Image()]]` macro, which has several useful options (`title=`, `link=`, etc.)
    765777
    766 == Macros
     778
     779== Macros ==
    767780
    768781Macros are ''custom functions'' to insert dynamic content in a page.
    … …  
    792805}}}
    793806
    794 == Processors
     807
     808== Processors ==
    795809
    796810Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in
    … …  
    929943See WikiProcessors for more information.
    930944
    931 == Comments
     945
     946== Comments ==
    932947
    933948Comments can be added to the plain text. These will not be rendered and will not display in any other format than plain text.
    … …  
    953968}}}
    954969
    955 == Miscellaneous
     970== Miscellaneous ==
    956971
    957972An horizontal line can be used to separated different parts of your page:
    … …  
    9901005!WikiCreole style \\ line\\break
    9911006}}}
     1007