Changes between Version 5 and Version 6 of WikiFormatting

Timestamp:

Feb 24, 2024, 4:07:16 PM (9 months ago)

Author:

trac

Comment:

--

WikiFormatting

@@ -3 +3 @@
 [[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 a 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.
+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.
@@ -27 +25 @@
 || `'''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 
+{{{#!td
  {{{
  == Level 2
@@ -66 +64 @@
    on multiple lines
    1. nested list
-     a. different numbering 
+     a. different numbering
         styles
  }}}
@@ -96 +94 @@
  {{{
  {{{
- multiple lines, ''no wiki''
+ multiple lines, ''no wiki'',
        white space respected
  }}}
@@ -103 +101 @@
 {{{#!td
  {{{
- multiple lines, ''no wiki''
+ multiple lines, ''no wiki'',
        white space respected
  }}}
@@ -147 +145 @@
 [#Links Links]
 }}}
-|| `http://trac.edgewall.org` ||\
-|| http://trac.edgewall.org ||
+|| `https://trac.edgewall.org` ||\
+|| https://trac.edgewall.org ||
 || `WikiFormatting (CamelCase)` ||\
 || WikiFormatting (CamelCase) ||
@@ -159 +157 @@
 || `#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] ||
@@ -166 +164 @@
 || Ticket [[ticket:1]], [[ticket:1|ticket one]] ||
 |-----------------------------------------------------------
-{{{#!th rowspan=2 
+{{{#!th rowspan=2
 [#SettingAnchors Setting Anchors]
 }}}
@@ -195 +193 @@
 {{{#!td
  {{{
- {{{
- #!div style="font-size: 80%"
+ {{{#!div style="font-size: 80%"
  Code highlighting:
    {{{#!python
@@ -205 +202 @@
 }}}
 {{{#!td style="padding-left: 2em"
- {{{
- #!div style="font-size: 80%"
+ {{{#!div style="font-size: 80%"
  Code highlighting:
-   {{{#!python 
+   {{{#!python
    hello = lambda: "world"
    }}}
@@ -222 +218 @@
  }}}
 }}}
-{{{#!td style="padding-left: 2em"
- {{{#!comment
- Note to Editors: ...
- }}}
-}}}
+||  ''(comment is shown in edit mode only)''  ||
 |-----------------------------------------------------------
 ||= [#Miscellaneous Miscellaneous] =||\
 {{{#!td
  {{{
- Line [[br]] break 
+ Line [[br]] break
  Line \\ break
  ----
@@ -248 +240 @@
 {{{#!td
   {{{
-   * '''bold''', 
-     ''' triple quotes !''' 
-     can be bold too if prefixed by ! ''', 
+   * '''bold''',
+     ''' triple quotes !'''
+     can be bold too if prefixed by ! ''',
    * ''italic''
    * '''''bold italic''''' or ''italic and
@@ -258 +250 @@
      (hence `{{{` or {{{`}}} quoting)
    * ~~strike-through~~
-   * ^superscript^ 
+   * ^superscript^
    * ,,subscript,,
-   * **also bold**, //italic as well//, 
+   * **also bold**, //italic as well//,
      and **'' bold italic **'' //(since 0.12)//
    * [[span(style=color: #FF0000, a red text )]]
@@ -266 +258 @@
 }}}
 {{{#!td
- * '''bold''', 
-   ''' triple quotes !''' 
-   can be bold too if prefixed by ! ''', 
+ * '''bold''',
+   ''' triple quotes !'''
+   can be bold too if prefixed by ! ''',
  * ''italic''
  * '''''bold italic''''' or ''italic and
@@ -276 +268 @@
    (hence `{{{` or {{{`}}} quoting)
  * ~~strike-through~~
- * ^superscript^ 
+ * ^superscript^
  * ,,subscript,,
- * **also bold**, //italic as well//, 
+ * **also bold**, //italic as well//,
    and **'' bold italic **'' //(since 0.12)//
  * [[span(style=color: #FF0000, a red text )]]
@@ -285 +277 @@
 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.
- * 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 
+ * {{{ ! }}} 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. 
+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 not mandatory. That is, `=== Section3 ===` is identical to `=== Section3`.
+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.
@@ -334 +326 @@
   one
 
-  Paragraph 
+  Paragraph
   two
   }}}
@@ -341 +333 @@
   Line 1[[BR]]Line 2
 
-  Paragraph 
+  Paragraph
   one
 
-  Paragraph 
+  Paragraph
   two
 }}}
@@ -352 +344 @@
 The wiki supports both ordered/numbered and unordered lists.
 
-Example:
 ||= Wiki Markup =||= Display =||
 {{{#!td
@@ -358 +349 @@
    * Item 1
      * Item 1.1
-        * Item 1.1.1   
+        * Item 1.1.1
         * Item 1.1.2
         * Item 1.1.3
@@ -365 +356 @@
   - items can start at the beginning of a line
     and they can span multiple lines
-    - be careful though to continue the line 
+    - be careful though to continue the line
     with the appropriate indentation, otherwise
   that will start a new paragraph...
-  
+
    1. Item 1
      a. Item 1.a
@@ -383 +374 @@
  * Item 1
    * Item 1.1
-      * Item 1.1.1   
+      * Item 1.1.1
       * Item 1.1.2
       * Item 1.1.3
@@ -390 +381 @@
 - items can start at the beginning of a line
   and they can span multiple lines
-  - be careful though to continue the line 
+  - be careful though to continue the line
   with the appropriate indentation, otherwise
 that will start a new paragraph...
@@ -431 +422 @@
 
 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.
-  
+
 ||= Wiki Markup =||= Display =||
 {{{#!td
@@ -468 +459 @@
 == 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.  
+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 =||
@@ -489 +480 @@
 === Simple Tables
 
-Simple tables can be created like this:
+Simple tables can be created:
 ||= Wiki Markup =||= Display =||
 {{{#!td
@@ -502 +493 @@
 }}}
 
-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
@@ -518 +509 @@
 }}}
 
-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
@@ -535 +526 @@
 }}}
 
-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
@@ -560 +551 @@
 }}}
 
-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 ||
   }}}
@@ -573 +564 @@
 ||= 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 ||
 }}}
@@ -580 +571 @@
 === 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].
+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 =||
-{{{#!td
-  {{{
-  TitleIndex, http://www.edgewall.com/, !NotAlink
-  }}}
-}}}
-{{{#!td
-TitleIndex, http://www.edgewall.com/, !NotAlink
-}}}
-
-Links can be given a more descriptive title by writing the link followed by a space and a title and all this inside square brackets. 
+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
+}}}
+
+Links can be given a more descriptive title by writing the link followed by a space and a title and all this inside square brackets.
 If the descriptive title is omitted, then the explicit prefix is discarded, unless the link is an external link. This can be useful for wiki pages not adhering to the WikiPageNames convention.
 
@@ -602 +593 @@
 {{{#!td
   {{{
-   * [http://www.edgewall.com Edgewall Software]
-   * [wiki:TitleIndex Title Index] 
-   * [wiki:TitleIndex] 
+   * [https://www.edgewall.com Edgewall Software]
+   * [wiki:TitleIndex Title Index]
+   * [wiki:TitleIndex]
    * [wiki:ISO9000]
   }}}
 }}}
 {{{#!td
-   * [http://www.edgewall.com Edgewall Software]
-   * [wiki:TitleIndex Title Index] 
-   * [wiki:TitleIndex] 
+   * [https://www.edgewall.com Edgewall Software]
+   * [wiki:TitleIndex Title Index]
+   * [wiki:TitleIndex]
    * [wiki:ISO9000]
 }}}
 
-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]]
@@ -628 +619 @@
 }}}
 {{{#!td
-   * [[http://www.edgewall.com|Edgewall Software]]
+   * [[https://www.edgewall.com|Edgewall Software]]
    * [[wiki:TitleIndex|Title Index]]
      or even [[TitleIndex|Title Index]]
@@ -650 +641 @@
    * Changesets: r1, [1] or changeset:1
    * ...
-   * targeting other Trac instances, 
+   * targeting other Trac instances,
      so called InterTrac links:
      - Tickets: #Trac1 or Trac:ticket:1
@@ -660 +651 @@
  * Reports: {1} or report:1
  * Changesets: r1, [1] or changeset:1
- * ... 
- * targeting other Trac instances, 
+ * ...
+ * targeting other Trac instances,
    so called InterTrac links:
    - Tickets: #Trac1 or Trac:ticket:1
@@ -671 +662 @@
 == 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:
 
 {{{
@@ -677 +668 @@
 }}}
 
-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
@@ -689 +680 @@
 Optionally, a label can be given to the anchor:
 {{{
-[[=#point1 '''Point 1''']]
+[=#point1 '''Point 1''']
 }}}
 
@@ -715 +706 @@
 == 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 =||
@@ -766 +757 @@
 == 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 =||
@@ -780 +771 @@
 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 =||
@@ -794 +785 @@
 == Processors
 
-Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in 
-[wiki:WikiRestructuredText reStructuredText] or [wiki:WikiHtml HTML]. 
+Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in
+[wiki:WikiRestructuredText reStructuredText] or [wiki:WikiHtml HTML].
 
 ||= Wiki Markup =||= Display =||
@@ -807 +798 @@
 {{{#!td style="border: 0px"
   {{{
-  {{{
-  #!html
+  {{{#!html
   <h1 style="text-align: right; color: blue">
    HTML Test
@@ -817 +807 @@
 {{{#!td valign="top"  style="border: 0px"
 
-{{{
-#!html
+{{{#!html
 <h1 style="text-align: right; color: blue">HTML Test</h1>
 }}}
@@ -832 +821 @@
 {{{#!td style="border: 0px"
   {{{
-  {{{
-  #!python
+  {{{#!python
   class Test:
-  
+
       def __init__(self):
           print "Hello World"
@@ -843 +831 @@
   }}}
 }}}
-{{{
-#!td valign="top"  style="border: 0px"
-
-{{{
-#!python
+{{{#!td valign="top"  style="border: 0px"
+
+{{{#!python
 class Test:
     def __init__(self):
@@ -877 +863 @@
   |----------------
   {{{#!td
-  As processors can be easily nested, 
+  As processors can be easily nested,
   so can be tables:
     {{{#!th
@@ -894 +880 @@
   }}}
 }}}
-{{{
-#!td  valign="top"  style="border: 0px"
+{{{#!td  valign="top"  style="border: 0px"
 
   {{{#!th rowspan=4 align=justify
@@ -909 +894 @@
   |----------------
   {{{#!td
-  As processors can be easily nested, 
+  As processors can be easily nested,
   so can be tables:
     {{{#!th
@@ -937 +922 @@
   {{{
   Nothing to
-  {{{
-  #!comment
+  {{{#!comment
   Your comment for editors here
   }}}
@@ -946 +930 @@
 {{{#!td
   Nothing to
-  {{{
-  #!comment
+  {{{#!comment
   Your comment for editors here
   }}}
@@ -959 +942 @@
   Horizontal line:
   {{{
-  Four or more dashes will be replaced 
+  Four or more dashes will be replaced
   by a horizontal line (<HR>)
   ----