Context Navigation

← Previous Change
Wiki History
Next Change →

Changes between Version 5 and Version 6 of WikiFormatting

Timestamp:: 2021-04-21T12:44:16+02:00 (4 years ago)
Author:: trac
Comment:: --

Legend:

: Unmodified
: Added
: Removed
: Modified

WikiFormatting

-                      v5
+                      v6
 [[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 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.
+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 covers 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
+ - [trac:wiki:TracDev/Proposals/AdvancedWikiOperations AdvancedWikiOperations] provides some operations in uncommon or administrative scenarios
+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 [https://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
 …
 || `'''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
  }}}
 …
 [#Links Links]
 }}}
 || `http://trac.edgewall.org` ||\
 || http://trac.edgewall.org ||
+|| `https://trac.edgewall.org` ||\
+|| https://trac.edgewall.org ||
 || `WikiFormatting (CamelCase)` ||\
 || WikiFormatting (CamelCase) ||
 …
 || `#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] ||
 …
 {{{#!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] =||\
 …
 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 `**`)
+   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.
+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.
 …
 The wiki supports both ordered/numbered and unordered lists.
-Example:
 ||= Wiki Markup =||= Display =||
 {{{#!td
 …
 == 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.
+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 =||
 …
 === Simple Tables
 Simple tables can be created like this:
+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 =||
 {{{#!td
   {{{
   || this is column 1 [http://trac.edgewall.org/newticket new ticket] || \
   || this is column 2 [http://trac.edgewall.org/roadmap the road ahead] || \
+  || this is column 1 [https://trac.edgewall.org/newticket new ticket] || \
+  || this is column 2 [https://trac.edgewall.org/roadmap the road ahead] || \
   || that's column 3 and last one ||
   }}}
 …
 ||= Display =||
 {{{#!td style="padding: 2em;"
 || this is column 1 [http://trac.edgewall.org/newticket new ticket] || \
 || this is column 2 [http://trac.edgewall.org/roadmap the road ahead] || \
+|| this is column 1 [https://trac.edgewall.org/newticket new ticket] || \
+|| this is column 2 [https://trac.edgewall.org/roadmap the road ahead] || \
 || that's column 3 and last one ||
 }}}
 …
 === 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].
+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 "!" character, such as {{{!WikiPageLink}}}.
 ||= Wiki Markup =||= Display =||
 {{{#!td
   {{{
   TitleIndex, http://www.edgewall.com/, !NotAlink
   }}}
 }}}
 {{{#!td
 TitleIndex, http://www.edgewall.com/, !NotAlink
+Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark (`!`), such as `!WikiPageLink`.
+||= Wiki Markup =||= Display =||
+{{{#!td
+  {{{
+  TitleIndex, https://www.edgewall.com/, !NotAlink
+  }}}
+}}}
+{{{#!td
+TitleIndex, https://www.edgewall.com/, !NotAlink
 }}}
 …
 {{{#!td
   {{{
    * [http://www.edgewall.com Edgewall Software]
+   * [https://www.edgewall.com Edgewall Software]
    * [wiki:TitleIndex Title Index]
    * [wiki:TitleIndex]
 …
 }}}
 {{{#!td
    * [http://www.edgewall.com Edgewall Software]
+   * [https://www.edgewall.com Edgewall Software]
    * [wiki:TitleIndex Title Index]
    * [wiki:TitleIndex]
 …
 }}}
 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
   {{{
    * [[http://www.edgewall.com|Edgewall Software]]
+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
+  {{{
+   * [[https://www.edgewall.com|Edgewall Software]]
    * [[wiki:TitleIndex|Title Index]]
      or even [[TitleIndex|Title Index]]
 …
 }}}
 {{{#!td
    * [[http://www.edgewall.com|Edgewall Software]]
+   * [[https://www.edgewall.com|Edgewall Software]]
    * [[wiki:TitleIndex|Title Index]]
      or even [[TitleIndex|Title Index]]
 …
 == 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:
+An anchor, or more correctly speaking, an [https://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 =||
 …
 == Macros
 Macros are ''custom functions'' to insert dynamic content in a page.
+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 =||
 …
 {{{#!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
 …
   {{{
   Nothing to
+  {{{
+  #!comment
+  {{{#!comment
   Your comment for editors here
   }}}
   see ;-)
+  see.
   }}}
 }}}
 {{{#!td
   Nothing to
+  {{{
+  #!comment
+  {{{#!comment
   Your comment for editors here
   }}}
   see ;-)
+  see.
 }}}
 == Miscellaneous
+An horizontal line can be used to separated different parts of your page:
+||= Wiki Markup =||= Display =||
+{{{#!td
+||= 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
-}}}