Changes between Version 3 and Version 4 of WikiFormatting

Timestamp:

Jan 30, 2019, 11:46:21 PM (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 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.
+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.
  - WikiPageNames covers the various names a wiki page can take, whether in CamelCase or not.
  - WikiMacros lists the macros available for generating dynamic content.
@@ -25 +27 @@
 || `'''bold'''`, `''italic''`, `'''''Wikipedia style'''''` || \
 || '''bold''', ''italic'', '''''Wikipedia style''''' ||
+|| {{{`monospaced (''other markup ignored'')`}}} || \
+|| `monospaced (''other markup ignored'')` ||
 || `**bold**`, `//italic//`, `**//!WikiCreole style//**` || \
 || **bold**, //italic//, **//!WikiCreole style//** ||
-|| {{{`monospaced (''other markup ignored'')`}}} || \
-|| `monospaced (''other markup ignored'')` ||
 |-----------------------------------------------------------
 ||= [#Headings Headings] =||\
@@ -94 +96 @@
  {{{
  {{{
- multiple lines, ''no wiki'',
+ multiple lines, ''no wiki''
        white space respected
  }}}
@@ -101 +103 @@
 {{{#!td
  {{{
- multiple lines, ''no wiki'',
+ multiple lines, ''no wiki''
        white space respected
  }}}
@@ -157 +159 @@
 || `#1 (ticket)`, `[1] (changeset)`, `{1} (report)` ||\
 || #1 (ticket), [1] (changeset), {1} (report) ||
-|| `ticket:1, ticket:1#comment:1, comment:1:ticket:1` ||\
-|| ticket:1, ticket:1#comment:1, comment:1:ticket:1 ||
+|| `ticket:1, ticket:1#comment:1` ||\
+|| ticket:1, ticket:1#comment:1 ||
 || `Ticket [ticket:1]`, `[ticket:1 ticket one]` ||\
 || Ticket [ticket:1], [ticket:1 ticket one] ||
@@ -193 +195 @@
 {{{#!td
  {{{
- {{{#!div style="font-size: 80%"
+ {{{
+ #!div style="font-size: 80%"
  Code highlighting:
    {{{#!python
@@ -202 +205 @@
 }}}
 {{{#!td style="padding-left: 2em"
- {{{#!div style="font-size: 80%"
+ {{{
+ #!div style="font-size: 80%"
  Code highlighting:
    {{{#!python 
@@ -218 +222 @@
  }}}
 }}}
-||  ''(comment is shown in edit mode only)''  ||
+{{{#!td style="padding-left: 2em"
+ {{{#!comment
+ Note to Editors: ...
+ }}}
+}}}
 |-----------------------------------------------------------
 ||= [#Miscellaneous Miscellaneous] =||\
@@ -277 +285 @@
 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 
@@ -284 +292 @@
 == 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. 
+You can create 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.
@@ -344 +352 @@
 The wiki supports both ordered/numbered and unordered lists.
 
+Example:
 ||= Wiki Markup =||= Display =||
 {{{#!td
@@ -459 +468 @@
 == 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 =||
@@ -480 +489 @@
 === Simple Tables
 
-Simple tables can be created:
+Simple tables can be created like this:
 ||= Wiki Markup =||= Display =||
 {{{#!td
@@ -493 +502 @@
 }}}
 
-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:
+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:
 ||= Wiki Markup =||= Display =||
 {{{#!td
@@ -509 +518 @@
 }}}
 
-Finally, specifying an empty cell means that the next non empty cell will span the empty cells:
+Finally, specifying an empty cell means that the next non empty cell will span the empty cells. For example:
 ||= Wiki Markup =||= Display =||
 {{{#!td
@@ -526 +535 @@
 }}}
 
-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:
+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:
 ||= Wiki Markup =||= Display =||
 {{{#!td
@@ -551 +560 @@
 }}}
 
-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 =||
@@ -571 +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 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`.
+Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark ('!'), such as {{{!WikiPageLink}}}.
 
 ||= Wiki Markup =||= Display =||
@@ -606 +615 @@
 }}}
 
-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
@@ -662 +671 @@
 == 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:
+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:
 
 {{{
@@ -668 +677 @@
 }}}
 
-This syntax was chosen to match the format for explicitly naming the header id [#Headings documented above]:
+This syntax was chosen to match the format for explicitly naming the header id [#Headings documented above]. For example:
 {{{
 == Long title == #title
@@ -680 +689 @@
 Optionally, a label can be given to the anchor:
 {{{
-[=#point1 '''Point 1''']
+[[=#point1 '''Point 1''']]
 }}}
 
@@ -706 +715 @@
 == 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 =||
@@ -757 +766 @@
 == Macros
 
-Macros are ''custom functions'' that insert dynamic content in a page.
+Macros are ''custom functions'' to insert dynamic content in a page.
 
 ||= Wiki Markup =||= Display =||
@@ -771 +780 @@
 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 =||
@@ -798 +807 @@
 {{{#!td style="border: 0px"
   {{{
-  {{{#!html
+  {{{
+  #!html
   <h1 style="text-align: right; color: blue">
    HTML Test
@@ -807 +817 @@
 {{{#!td valign="top"  style="border: 0px"
 
-{{{#!html
+{{{
+#!html
 <h1 style="text-align: right; color: blue">HTML Test</h1>
 }}}
@@ -821 +832 @@
 {{{#!td style="border: 0px"
   {{{
-  {{{#!python
+  {{{
+  #!python
   class Test:
   
@@ -831 +843 @@
   }}}
 }}}
-{{{#!td valign="top"  style="border: 0px"
-
-{{{#!python
+{{{
+#!td valign="top"  style="border: 0px"
+
+{{{
+#!python
 class Test:
     def __init__(self):
@@ -880 +894 @@
   }}}
 }}}
-{{{#!td  valign="top"  style="border: 0px"
+{{{
+#!td  valign="top"  style="border: 0px"
 
   {{{#!th rowspan=4 align=justify
@@ -922 +937 @@
   {{{
   Nothing to
-  {{{#!comment
+  {{{
+  #!comment
   Your comment for editors here
   }}}
@@ -930 +946 @@
 {{{#!td
   Nothing to
-  {{{#!comment
+  {{{
+  #!comment
   Your comment for editors here
   }}}