Edgewall Software

Changes between Version 117 and Version 118 of WikiFormatting


Ignore:
Timestamp:
Feb 22, 2015, 4:25:07 PM (7 years ago)
Author:
figaro
Comment:

Added link with Advanced wiki operations, cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • WikiFormatting

    v117 v118  
    1 = WikiFormatting =
     1= WikiFormatting
     2
    23[[TracGuideToc]]
    34[[TranslatedPages]]
     
    56Wiki markup is a core feature in Trac, tightly integrating all the other parts of Trac into a flexible and powerful whole.
    67
    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,
    8 especially [http://moinmo.in/ MoinMoin] and [trac:WikiCreole].
    9 
     8Trac 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].
    109
    1110This page will give you an in-depth explanation of the wiki markup available anywhere WikiFormatting is allowed.
    1211
    13 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.
     12The 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.
    1413
    1514A few other wiki pages present the advanced features of the Trac wiki markup in more depth:
    16  - TracLinks covers all the possible ways to refer precisely to any Trac resource or parts thereof,
    17  - WikiPageNames talks about the various names a wiki page can take, CamelCase or not
    18  - 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 covers the various names a wiki page can take, CamelCase or not
     17 - WikiMacros lists the macros available for generating dynamic content
    1918 - WikiProcessors and WikiHtml details how parts of the wiki text can be processed in special ways
    20 
    21 
    22 == Cheat sheet ==
     19 - [wiki:TracDev/Proposals/AdvancedWikiOperations] provide some operations in uncommon or administrative scenarios
     20
     21== Common wiki markup
    2322
    2423||= '''Category''' =||= '''Wiki Markup''' =||= '''Display''' =||
     
    244243}}}
    245244
    246 
    247 == Font Styles ==
     245== Font Styles
    248246
    249247The Trac wiki supports the following font styles:
     
    293291   with a `//` one, and `'''` can't be paired with `**`)
    294292
    295 
    296 == Headings ==
    297 
    298 You can create heading by starting a line with one up to six ''equal'' characters ("=")
    299 followed by a single space and the headline text.
     293== Headings
     294
     295You can create heading by starting a line with one up to six ''equal'' characters ("=") followed by a single space and the headline text.
    300296
    301297[=#hn]
     
    325321}}}
    326322
    327 == Paragraphs ==
     323== Paragraphs
    328324
    329325A new text paragraph is created whenever two blocks of text are separated by one or more empty lines.
     
    353349}}}
    354350
    355 == Lists ==
     351== Lists
    356352
    357353The wiki supports both ordered/numbered and unordered lists.
     
    409405}}}
    410406
    411 
    412 == Definition Lists ==
     407== Definition Lists
    413408
    414409The wiki also supports definition lists.
     
    434429Note that you need a space in front of the defined term.
    435430
    436 
    437 == Preformatted Text ==
     431== Preformatted Text
    438432
    439433Block 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.
     
    457451Note that this kind of block is also used for selecting lines that should be processed through WikiProcessors.
    458452
    459 == Blockquotes ==
     453== Blockquotes
    460454
    461455In order to mark a paragraph as blockquote, indent that paragraph with two spaces.
     
    473467}}}
    474468
    475 == Discussion Citations ==
     469== Discussion Citations
    476470
    477471To delineate a citation in an ongoing discussion thread, such as the ticket comment area, e-mail-like citation marks (">", ">>", etc.) may be used. 
     
    493487}}}
    494488
    495 
    496 == Tables ==
    497 === Simple Tables ===
     489== Tables
     490=== Simple Tables
     491
    498492Simple tables can be created like this:
    499493||= Wiki Markup =||= Display =||
     
    585579}}}
    586580
    587 === Complex Tables ===
     581=== Complex Tables
    588582
    589583If 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].
    590584
    591 
    592 == Links ==
     585== Links
    593586
    594587Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark "!" character, such as {{{!WikiPageLink}}}.
     
    644637}}}
    645638
    646 '''Note''': the [trac:WikiCreole] style for links is quick to type and
    647 certainly looks familiar as it's the one used on Wikipedia and in many
    648 other wikis. Unfortunately it conflicts with the syntax for [#Macros macros].
    649 So in the rare case when you need to refer to a page which is named after
    650 a macro (typical examples being TitleIndex, InterTrac and InterWiki),
    651 by writing `[[TitleIndex]]` you will actually call the macro instead of linking
    652 to the page.
    653 
    654 == Trac Links ==
     639'''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].
     640So 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.
     641
     642== Trac Links
    655643
    656644Wiki 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:
     
    682670There are many more flavors of Trac links, see TracLinks for more in-depth information and a reference for all the default link resolvers.
    683671
    684 
    685 == Setting Anchors ==
     672== Setting Anchors
    686673
    687674An 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:
     
    726713
    727714For 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)^)]]`.
    728 
    729715
    730716== Escaping Links, WikiPageNames and other Markup == #Escaping
     
    755741}}}
    756742
    757 == Images ==
     743== Images
    758744
    759745Urls ending with `.png`, `.gif` or `.jpg` are no longer automatically interpreted as image links, and converted to `<img>` tags.
     
    779765See WikiMacros for further documentation on the `[[Image()]]` macro, which has several useful options (`title=`, `link=`, etc.)
    780766
    781 
    782 == Macros ==
     767== Macros
    783768
    784769Macros are ''custom functions'' to insert dynamic content in a page.
     
    808793}}}
    809794
    810 
    811 == Processors ==
     795== Processors
    812796
    813797Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in
     
    946930See WikiProcessors for more information.
    947931
    948 
    949 == Comments ==
     932== Comments
    950933
    951934Comments can be added to the plain text. These will not be rendered and will not display in any other format than plain text.
     
    971954}}}
    972955
    973 == Miscellaneous ==
     956== Miscellaneous
    974957
    975958An horizontal line can be used to separated different parts of your page: