Context Navigation

Changes between Version 3 and Version 4 of WikiFormatting

Timestamp:: Jan 13, 2020, 11:45:55 PM (5 years ago)
Author:: trac
Comment:: --

Legend:

: Unmodified
: Added
: Removed
: Modified

WikiFormatting

-              v3
+              v4
+= WikiFormatting =
+= WikiFormatting
 [[TracGuideToc]]
+Wiki markup is a core feature in Trac, tightly integrating all the other parts of Trac into a flexible and powerful whole.
+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].
+This page will give you an in-depth explanation of the wiki markup available anywhere WikiFormatting is allowed.
+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.
+A few other wiki pages present the advanced features of the Trac wiki markup in more depth:
+ - TracLinks covers all the possible ways to refer precisely to any Trac resource or parts thereof,
+ - WikiPageNames talks about the various names a wiki page can take, CamelCase or not
+ - WikiMacros lists the macros available for generating dynamic content,
+ - WikiProcessors and WikiHtml details how parts of the wiki text can be processed in special ways
+== Cheat sheet ==
+Wiki markup is a core feature in Trac, tightly integrating all the other parts of Trac into a flexible and unified whole.
+Trac has a powerful wiki rendering engine that implements a subset of the commands from other popular Wikis, such as [http://moinmo.in/ MoinMoin] and [trac:WikiCreole].
+The sections below provide an overview for the most common syntax, each link in the ''Category'' column leads you to the more detailed explanation later in this page.
+The following wiki pages present the advanced features of the Trac wiki markup in more depth:
+ - TracLinks covers all the possible ways to refer to any Trac resource or parts thereof.
+ - WikiPageNames covers the various names a wiki page can take, whether in CamelCase or not.
+ - WikiMacros lists the macros available for generating dynamic content.
+ - WikiProcessors and WikiHtml details how parts of the wiki text can be processed in special ways.
+ - [trac:wiki:TracDev/Proposals/AdvancedWikiOperations AdvancedWikiOperations] provides some operations in uncommon or administrative scenarios.
+== Common wiki markup
 ||= '''Category''' =||= '''Wiki Markup''' =||= '''Display''' =||
 …
 || `'''bold'''`, `''italic''`, `'''''Wikipedia style'''''` || \
 || '''bold''', ''italic'', '''''Wikipedia style''''' ||
+|| `**bold**`, `//italic//`, `**//!WikiCreole style//**` || \
+|| **bold**, //italic//, **//!WikiCreole style//** ||
 || {{{`monospaced (''other markup ignored'')`}}} || \
 || `monospaced (''other markup ignored'')` ||
-|| `**bold**`, `//italic//`, `**//!WikiCreole style//**` || \
-|| **bold**, //italic//, **//!WikiCreole style//** ||
 |-----------------------------------------------------------
 ||= [#Headings Headings] =||\
 {{{#!td
  {{{
  == Level 2 ==
+ == Level 2
  === Level 3 ^([#hn note])^
  }}}
 }}}
 {{{#!td style="padding-left: 2em"
 == Level 2 ==
+== Level 2
 === Level 3 ^([#hn note])^
 }}}
 …
 {{{#!td
  {{{
  * bullets list
+ * bullet list
    on multiple lines
 . nested list
 …
 }}}
 {{{#!td
 * bullets list
+* bullet list
   on multiple lines
 . nested list
 …
  {{{
  {{{
  multiple lines, ''no wiki''
+ multiple lines, ''no wiki'',
        white space respected
  }}}
 …
 {{{#!td
  {{{
  multiple lines, ''no wiki''
+ multiple lines, ''no wiki'',
        white space respected
  }}}
 …
 || `#1 (ticket)`, `[1] (changeset)`, `{1} (report)` ||\
 || #1 (ticket), [1] (changeset), {1} (report) ||
 || `ticket:1, ticket:1#comment:1` ||\
 || ticket:1, ticket:1#comment:1 ||
+|| `ticket:1, ticket:1#comment:1, comment:1:ticket:1` ||\
+|| ticket:1, ticket:1#comment:1, comment:1:ticket:1 ||
 || `Ticket [ticket:1]`, `[ticket:1 ticket one]` ||\
 || Ticket [ticket:1], [ticket:1 ticket one] ||
 …
 || `!wiki:WikiFormatting`, `!WikiFormatting` ||\
 || !wiki:WikiFormatting, !WikiFormatting ||
 || {{{`}}}`{{{-}}}`{{{`}}}` triple curly brackets` ||\
+|| [[html(<code>`{{{-}}}` triple curly brackets</code>)]] ||\
 || `{{{-}}}` triple curly brackets ||
 |-----------------------------------------------------------
 …
 {{{#!td
  {{{
+ {{{
+ #!div style="font-size: 80%"
+ {{{#!div style="font-size: 80%"
  Code highlighting:
    {{{#!python
 …
 }}}
 {{{#!td style="padding-left: 2em"
+ {{{
+ #!div style="font-size: 80%"
+ {{{#!div style="font-size: 80%"
  Code highlighting:
    {{{#!python
 …
  }}}
 }}}
+{{{#!td style="padding-left: 2em"
+ {{{#!comment
+ Note to Editors: ...
+ }}}
+}}}
+||  ''(comment is shown in edit mode only)''  ||
 |-----------------------------------------------------------
 ||= [#Miscellaneous Miscellaneous] =||\
 …
 }}}
+== Font Styles ==
+== Font Styles
 The Trac wiki supports the following font styles:
 …
    * **also bold**, //italic as well//,
      and **'' bold italic **'' //(since 0.12)//
+   * [[span(style=color: #FF0000, a red text )]]
   }}}
 }}}
 …
  * **also bold**, //italic as well//,
    and **'' bold italic **'' //(since 0.12)//
+ * [[span(style=color: #FF0000, a red text )]]
 }}}
 Notes:
  * `{{{...}}}` 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.
  * {{{ ! }}} 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.
+ * {{{ ! }}} 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.
  * all the font styles marks have to be used in opening/closing pairs,
+   and they must nest properly (in particular, an `''` italic can't be paired
+   with a `//` one, and `'''` can't be paired with `**`)
+== Headings ==
+You can create heading by starting a line with one up to six ''equal'' characters ("=")
+followed by a single space and the headline text.
+   and they must nest properly; in particular, an `''` italic can't be paired
+   with a `//` one, and `'''` can't be paired with `**`.
+== Headings
+You can create a heading by starting a line with one up to six ''equal'' characters (`=`) followed by a single space and the headline text.
 [=#hn]
 The headline text can be followed by the same number of "=" characters, but this is no longer mandatory.
+The headline text can be followed by the same number of `=` characters, but this is not mandatory. That is, `=== Section3 ===` is identical to `=== Section3`.
 Finally, the heading might optionally be followed by an explicit id. If not, an implicit but nevertheless readable id will be generated.
 …
 }}}
 == Paragraphs ==
+== Paragraphs
 A new text paragraph is created whenever two blocks of text are separated by one or more empty lines.
 …
 }}}
 == Lists ==
+== Lists
 The wiki supports both ordered/numbered and unordered lists.
-Example:
 ||= Wiki Markup =||= Display =||
 {{{#!td
 …
 }}}
+== Definition Lists ==
+== Definition Lists
 The wiki also supports definition lists.
 …
 Note that you need a space in front of the defined term.
+== Preformatted Text ==
+== Preformatted Text
 Block 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.
 …
 Note that this kind of block is also used for selecting lines that should be processed through WikiProcessors.
 == Blockquotes ==
+== Blockquotes
 In order to mark a paragraph as blockquote, indent that paragraph with two spaces.
 …
 }}}
 == Discussion Citations ==
 To delineate a citation in an ongoing discussion thread, such as the ticket comment area, e-mail-like citation marks (">", ">>", etc.) may be used.
+== Discussion Citations
+To delineate a citation in an ongoing discussion thread, such as the ticket comment area, email-like citation marks (`>`, `>>`, etc.) may be used.
 ||= Wiki Markup =||= Display =||
 …
 }}}
 == Tables ==
+=== Simple Tables ===
 Simple tables can be created like this:
+== Tables
+=== Simple Tables
+Simple tables can be created:
 ||= Wiki Markup =||= Display =||
 {{{#!td
 …
 }}}
 Cell headings can be specified by wrapping the content in a pair of '=' characters.
 Note that the '=' characters have to stick to the cell separators, like this:
+Cell headings can be specified by wrapping the content in a pair of `=` characters.
+Note that the `=` characters have to stick to the cell separators:
 ||= Wiki Markup =||= Display =||
 {{{#!td
 …
 }}}
 Finally, specifying an empty cell means that the next non empty cell will span the empty cells. For example:
+Finally, specifying an empty cell means that the next non empty cell will span the empty cells:
 ||= Wiki Markup =||= Display =||
 {{{#!td
 …
 }}}
 Note 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:
+Note 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:
 ||= Wiki Markup =||= Display =||
 {{{#!td
 …
 }}}
 If 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.
+If 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:
 ||= Wiki Markup =||
 …
 }}}
+=== Complex Tables ===
+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].
+== Links ==
+Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark "!" character, such as {{{!WikiPageLink}}}.
+=== Complex Tables
+If 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].
+== Links
+Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark (`!`), such as `!WikiPageLink`.
 ||= Wiki Markup =||= Display =||
 …
 }}}
 Following 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.
+Following 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.
 {{{#!td
 …
 }}}
+'''Note''': the [trac:WikiCreole] style for links is quick to type and
+certainly looks familiar as it's the one used on Wikipedia and in many
+other wikis. Unfortunately it conflicts with the syntax for [#Macros macros].
+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.
+== Trac Links ==
+'''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].
+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.
+== Trac Links
 Wiki 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:
 …
 There are many more flavors of Trac links, see TracLinks for more in-depth information and a reference for all the default link resolvers.
+== Setting Anchors ==
+An 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:
+== Setting Anchors
+An 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, to uniquely identify a position in the document:
 {{{
 …
 }}}
 This syntax was chosen to match the format for explicitly naming the header id [#Headings documented above]. For example:
+This syntax was chosen to match the format for explicitly naming the header id [#Headings documented above]:
 {{{
 == Long title == #title
 }}}
 It's also very close to the syntax for the corresponding link to that anchor:
+It is also very close to the syntax for the corresponding link to that anchor:
 {{{
 [#point1]
 …
 Optionally, a label can be given to the anchor:
 {{{
 [[=#point1 '''Point 1''']]
+[=#point1 '''Point 1''']
 }}}
 …
 }}}
+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)^)]]`.
+For 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)^)]]`.
 == Escaping Links, WikiPageNames and other Markup == #Escaping
 You may avoid making hyperlinks out of TracLinks by preceding an expression with a single "!" (exclamation mark).
+You may avoid making hyperlinks out of TracLinks by preceding an expression with a single exclamation mark (`!`).
 ||= Wiki Markup =||= Display =||
 …
   {{{
 Various forms of escaping for list markup:
  `-` escaped minus sign \\
  ``1. escaped number  \\
  {{{*}}} escaped asterisk sign
+ ^^- escaped minus sign \\
+ ^^1. escaped number  \\
+ ^^* escaped asterisk sign
   }}}
 }}}
 …
 Various forms of escaping for list markup:
  `-` escaped minus sign \\
  ``1. escaped number  \\
  {{{*}}} escaped asterisk sign
 }}}
 == Images ==
+ ^^- escaped minus sign \\
+ ^^1. escaped number  \\
+ ^^* escaped asterisk sign
+}}}
+== Images
 Urls ending with `.png`, `.gif` or `.jpg` are no longer automatically interpreted as image links, and converted to `<img>` tags.
 …
 See WikiMacros for further documentation on the `[[Image()]]` macro, which has several useful options (`title=`, `link=`, etc.)
+== Macros ==
+Macros are ''custom functions'' to insert dynamic content in a page.
+== Macros
+Macros are ''custom functions'' that insert dynamic content in a page.
 ||= Wiki Markup =||= Display =||
 …
 See WikiMacros for more information, and a list of installed macros.
 The detailed help for a specific macro can also be obtained more directly by appending a "?" to the macro name.
+The detailed help for a specific macro can also be obtained more directly by appending a `?` to the macro name.
 ||= Wiki Markup =||= Display =||
 …
 }}}
+== Processors ==
+== Processors
 Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in
 …
 {{{#!td style="border: 0px"
   {{{
+  {{{
+  #!html
+  {{{#!html
   <h1 style="text-align: right; color: blue">
    HTML Test
 …
 {{{#!td valign="top"  style="border: 0px"
+{{{
+#!html
+{{{#!html
 <h1 style="text-align: right; color: blue">HTML Test</h1>
 }}}
 …
 {{{#!td style="border: 0px"
   {{{
+  {{{
+  #!python
+  {{{#!python
   class Test:
 …
   }}}
 }}}
+{{{
+#!td valign="top"  style="border: 0px"
+{{{
+#!python
+{{{#!td valign="top"  style="border: 0px"
+{{{#!python
 class Test:
     def __init__(self):
 …
   }}}
 }}}
+{{{
+#!td  valign="top"  style="border: 0px"
+{{{#!td  valign="top"  style="border: 0px"
   {{{#!th rowspan=4 align=justify
 …
 See WikiProcessors for more information.
+== Comments ==
+== Comments
 Comments can be added to the plain text. These will not be rendered and will not display in any other format than plain text.
 …
   {{{
   Nothing to
+  {{{
+  #!comment
+  {{{#!comment
   Your comment for editors here
   }}}
   see ;-)
+  see.
   }}}
 }}}
 {{{#!td
   Nothing to
+  {{{
+  #!comment
+  {{{#!comment
   Your comment for editors here
   }}}
+  see ;-)
+}}}
+== Miscellaneous ==
+An horizontal line can be used to separated different parts of your page:
+||= Wiki Markup =||= Display =||
+{{{#!td
+  see.
+}}}
+== Miscellaneous
+||= Wiki Markup =||= Display =||
+{{{#!td
+  Horizontal line:
   {{{
   Four or more dashes will be replaced
   by an horizontal line (<HR>)
+  by a horizontal line (<HR>)
   ----
   See?
 …
 {{{#!td
 Four or more dashes will be replaced
 by an horizontal line (<HR>)
+by a horizontal line (<HR>)
 ----
 See?
 …
 |----------------------------------
 {{{#!td
+  {{{
+  "macro" style [[br]] line break
+  }}}
+}}}
+{{{#!td
+"macro" style [[br]] line break
+  Two examples of line breaks:
+  {{{
+  "macro" style [[BR]] line break
+  }}}
+  or:
+  {{{
+  !WikiCreole style \\ line\\break
+  }}}
+}}}
+{{{#!td
+"macro" style [[BR]] line break
+!WikiCreole style \\ line\\break
 }}}
 |----------------------------------
-{{{#!td
-  {{{
-  !WikiCreole style \\ line\\break
-  }}}
-}}}
-{{{#!td
-!WikiCreole style \\ line\\break
-}}}