Changes between Version 4 and Version 5 of WikiFormatting

Timestamp:

2020-07-23T14:06:24-07:00 (5 years 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] =||\
@@ -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) ||
@@ -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 
@@ -222 +218 @@
  }}}
 }}}
-{{{#!td style="padding-left: 2em"
- {{{#!comment
- Note to Editors: ...
- }}}
-}}}
+||  ''(comment is shown in edit mode only)''  ||
 |-----------------------------------------------------------
 ||= [#Miscellaneous Miscellaneous] =||\
@@ -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.
+ * {{{ ! }}} 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 
@@ -292 +284 @@
 == 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.
@@ -352 +344 @@
 The wiki supports both ordered/numbered and unordered lists.
 
-Example:
 ||= 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
+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
 }}}
 
@@ -602 +593 @@
 {{{#!td
   {{{
-   * [http://www.edgewall.com Edgewall Software]
+   * [https://www.edgewall.com Edgewall Software]
    * [wiki:TitleIndex Title Index] 
    * [wiki:TitleIndex] 
@@ -609 +600 @@
 }}}
 {{{#!td
-   * [http://www.edgewall.com Edgewall Software]
+   * [https://www.edgewall.com Edgewall Software]
    * [wiki:TitleIndex Title Index] 
    * [wiki:TitleIndex] 
@@ -615 +606 @@
 }}}
 
-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]]
@@ -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
@@ -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 =||
@@ -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:
   
@@ -843 +831 @@
   }}}
 }}}
-{{{
-#!td valign="top"  style="border: 0px"
-
-{{{
-#!python
+{{{#!td valign="top"  style="border: 0px"
+
+{{{#!python
 class Test:
     def __init__(self):
@@ -894 +880 @@
   }}}
 }}}
-{{{
-#!td  valign="top"  style="border: 0px"
+{{{#!td  valign="top"  style="border: 0px"
 
   {{{#!th rowspan=4 align=justify
@@ -937 +922 @@
   {{{
   Nothing to
-  {{{
-  #!comment
+  {{{#!comment
   Your comment for editors here
   }}}
@@ -946 +930 @@
 {{{#!td
   Nothing to
-  {{{
-  #!comment
+  {{{#!comment
   Your comment for editors here
   }}}