Changes between Version 2 and Version 3 of WikiFormatting


Ignore:
Timestamp:
Apr 16, 2016, 7:07:22 PM (9 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiFormatting

    v2 v3  
    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 an ever 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,
     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
    1817 - WikiProcessors and WikiHtml details how parts of the wiki text can be processed in special ways
    19 
    20 
    21 == Cheat sheet ==
     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''' =||
     
    182181|| `!wiki:WikiFormatting`, `!WikiFormatting` ||\
    183182|| !wiki:WikiFormatting, !WikiFormatting ||
    184 || {{{`}}}`{{{-}}}`{{{`}}}` triple curly brackets` ||\
     183|| [[html(<code>`{{{-}}}` triple curly brackets</code>)]] ||\
    185184|| `{{{-}}}` triple curly brackets ||
    186185|-----------------------------------------------------------
     
    243242}}}
    244243
    245 
    246 == Font Styles ==
     244== Font Styles
    247245
    248246The Trac wiki supports the following font styles:
     
    292290   with a `//` one, and `'''` can't be paired with `**`)
    293291
    294 
    295 == Headings ==
    296 
    297 You can create heading by starting a line with one up to six ''equal'' characters ("=")
    298 followed by a single space and the headline text.
     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.
    299295
    300296[=#hn]
     
    324320}}}
    325321
    326 == Paragraphs ==
     322== Paragraphs
    327323
    328324A new text paragraph is created whenever two blocks of text are separated by one or more empty lines.
     
    352348}}}
    353349
    354 == Lists ==
     350== Lists
    355351
    356352The wiki supports both ordered/numbered and unordered lists.
     
    408404}}}
    409405
    410 
    411 == Definition Lists ==
     406== Definition Lists
    412407
    413408The wiki also supports definition lists.
     
    433428Note that you need a space in front of the defined term.
    434429
    435 
    436 == Preformatted Text ==
     430== Preformatted Text
    437431
    438432Block 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.
     
    456450Note that this kind of block is also used for selecting lines that should be processed through WikiProcessors.
    457451
    458 == Blockquotes ==
     452== Blockquotes
    459453
    460454In order to mark a paragraph as blockquote, indent that paragraph with two spaces.
     
    472466}}}
    473467
    474 == Discussion Citations ==
     468== Discussion Citations
    475469
    476470To delineate a citation in an ongoing discussion thread, such as the ticket comment area, e-mail-like citation marks (">", ">>", etc.) may be used. 
     
    492486}}}
    493487
    494 
    495 == Tables ==
    496 === Simple Tables ===
     488== Tables
     489=== Simple Tables
     490
    497491Simple tables can be created like this:
    498492||= Wiki Markup =||= Display =||
     
    584578}}}
    585579
    586 === Complex Tables ===
     580=== Complex Tables
    587581
    588582If 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].
    589583
    590 
    591 == Links ==
     584== Links
    592585
    593586Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark "!" character, such as {{{!WikiPageLink}}}.
     
    643636}}}
    644637
    645 '''Note''': the [trac:WikiCreole] style for links is quick to type and
    646 certainly looks familiar as it's the one used on Wikipedia and in many
    647 other wikis. Unfortunately it conflicts with the syntax for [#Macros macros].
    648 So in the rare case when you need to refer to a page which is named after
    649 a macro (typical examples being TitleIndex, InterTrac and InterWiki),
    650 by writing `[[TitleIndex]]` you will actually call the macro instead of linking
    651 to the page.
    652 
    653 == 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
    654642
    655643Wiki 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:
     
    681669There are many more flavors of Trac links, see TracLinks for more in-depth information and a reference for all the default link resolvers.
    682670
    683 
    684 == Setting Anchors ==
     671== Setting Anchors
    685672
    686673An 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:
     
    725712
    726713For 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)^)]]`.
    727 
    728714
    729715== Escaping Links, WikiPageNames and other Markup == #Escaping
     
    754740}}}
    755741
    756 == Images ==
     742== Images
    757743
    758744Urls ending with `.png`, `.gif` or `.jpg` are no longer automatically interpreted as image links, and converted to `<img>` tags.
     
    778764See WikiMacros for further documentation on the `[[Image()]]` macro, which has several useful options (`title=`, `link=`, etc.)
    779765
    780 
    781 == Macros ==
     766== Macros
    782767
    783768Macros are ''custom functions'' to insert dynamic content in a page.
     
    807792}}}
    808793
    809 
    810 == Processors ==
     794== Processors
    811795
    812796Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in
     
    945929See WikiProcessors for more information.
    946930
    947 
    948 == Comments ==
     931== Comments
    949932
    950933Comments can be added to the plain text. These will not be rendered and will not display in any other format than plain text.
     
    970953}}}
    971954
    972 == Miscellaneous ==
     955== Miscellaneous
    973956
    974957An horizontal line can be used to separated different parts of your page: