Changes between Version 1 and Version 2 of WikiFormatting

Timestamp:

Jul 17, 2018, 2:11:51 PM (6 years ago)

Author:

trac

Comment:

--

WikiFormatting

@@ -5 +5 @@
 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].
+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.
@@ -12 +12 @@
 
 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
+ - 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, 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
@@ -35 +35 @@
 {{{#!td 
  {{{
- == Level 2 ==
+ == Level 2
  === Level 3 ^([#hn note])^
  }}}
 }}}
 {{{#!td style="padding-left: 2em"
-== Level 2 ==
+== Level 2
 === Level 3 ^([#hn note])^
 }}}
@@ -63 +63 @@
 {{{#!td
  {{{
- * bullets list
+ * bullet list
    on multiple lines
    1. nested list
@@ -71 +71 @@
 }}}
 {{{#!td
-* bullets list
+* bullet list
   on multiple lines
   1. nested list
@@ -159 +159 @@
 || `#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] ||
@@ -287 +287 @@
  * {{{ ! }}} 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
@@ -295 +295 @@
 
 [=#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.
@@ -468 +468 @@
 == 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 =||
@@ -580 +580 @@
 === 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}}}.
+Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark ('!'), such as {{{!WikiPageLink}}}.
 
 ||= Wiki Markup =||= Display =||
@@ -682 +682 @@
 }}}
 
-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]
@@ -689 +689 @@
 Optionally, a label can be given to the anchor:
 {{{
-[[=#point1 '''Point 1''']]
+[=#point1 '''Point 1''']
 }}}
 
@@ -711 +711 @@
 }}}
 
-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 =||
@@ -941 +941 @@
   Your comment for editors here
   }}}
-  see ;-)
+  see.
   }}}
 }}}
@@ -950 +950 @@
   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?
@@ -968 +967 @@
 {{{#!td
 Four or more dashes will be replaced
-by an horizontal line (<HR>)
+by a horizontal line (<HR>)
 ----
 See?
@@ -974 +973 @@
 |----------------------------------
 {{{#!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
-}}}