Changes between Version 2 and Version 3 of WikiFormatting

Timestamp:

01/10/10 10:55:08 (3 years ago)

Author:

trac

Comment:

--

WikiFormatting

@@ -1 +1 @@
 = WikiFormatting =
 [[TracGuideToc]]
-[[PageOutline(2-5,,inline)]]
 
 Wiki markup is a core feature in Trac, tightly integrating all the other parts of Trac into a flexible and powerful whole.
@@ -16 +15 @@
 The Trac wiki supports the following font styles:
 {{{
- * '''bold'''
+ * '''bold''', '''!''' can be bold too''', and '''! '''
  * ''italic''
  * '''''bold italic'''''
@@ -27 +26 @@
 
 Display:
- * '''bold'''
+ * '''bold''', '''!''' can be bold too''', and '''! '''
  * ''italic''
  * '''''bold italic'''''
@@ -36 +35 @@
  * ,,subscript,,
 
-Note that the `{{{...}}}` 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.
+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.
 
 == Headings ==
@@ -43 +44 @@
 followed by a single space and the headline text. The line should end with a space 
 followed by the same number of ''='' characters.
+The heading might optionally be followed by an explicit id. If not, an implicit but nevertheless readable id will be generated.
 
 Example:
@@ -49 +51 @@
 == Subheading ==
 === About ''this'' ===
+=== Explicit id === #using-explicit-id-in-heading
 }}}
 
@@ -55 +58 @@
 == Subheading ==
 === About ''this'' ===
-
+=== Explicit id === #using-explicit-id-in-heading
 
 == Paragraphs ==
@@ -78 +81 @@
  * Item 1
    * Item 1.1
+      * Item 1.1.1   
+      * Item 1.1.2
+      * Item 1.1.3
+   * Item 1.2
  * Item 2
 
  1. Item 1
-   1. Item 1.1
+   a. Item 1.a
+   a. Item 1.b
+      i. Item 1.b.i
+      i. Item 1.b.ii
  1. Item 2
+And numbered lists can also be given an explicit number:
+ 3. Item 3
 }}}
 
@@ -88 +100 @@
  * Item 1
    * Item 1.1
+      * Item 1.1.1
+      * Item 1.1.2
+      * Item 1.1.3
+   * Item 1.2
  * Item 2
 
  1. Item 1
-   1. Item 1.1
+   a. Item 1.a
+   a. Item 1.b
+      i. Item 1.b.i
+      i. Item 1.b.ii
  1. Item 2
+And numbered lists can also be given an explicit number:
+ 3. Item 3
 
 Note that there must be one or more spaces preceding the list item markers, otherwise the list will be treated as a normal paragraph.
@@ -98 +119 @@
 
 == Definition Lists ==
+
 
 The wiki also supports definition lists.
@@ -151 +173 @@
   This text is a quote from someone else.
 
+== 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.  
+
+Example:
+{{{
+>> Someone's original text
+> Someone else's reply text
+My reply text
+}}}
+
+Display:
+>> Someone's original text
+> Someone else's reply text
+My reply text
+
+''Note: Some WikiFormatting elements, such as lists and preformatted text, are  lost in the citation area.  Some reformatting may be necessary to create a clear citation.''
+
 == Tables ==
 
@@ -179 +219 @@
  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.  If the descriptive title is omitted, then the explicit prefix is disguarded, unless the link is an external link. This can be useful for wiki pages not adhering to the WikiPageNames convention.
+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.
 
 Example:
@@ -193 +233 @@
  * [wiki:ISO9000]
 
-
-=== Trac Links ===
+== Trac Links ==
 
 Wiki pages can link directly to other parts of the Trac system. Pages can refer to tickets, reports, changesets, milestones, source files and other Wiki pages using the following notations:
@@ -201 +240 @@
  * Reports: {1} or report:1
  * Changesets: r1, [1] or changeset:1
- * Revision Logs: r1:3, [1:3] or log:branches/0.8-stable#1:3
- * Wiki pages: CamelCase or wiki:CamelCase
- * Milestones: milestone:1.0 or milestone:"End-of-days Release"
- * Files: source:trunk/COPYING
- * Attachments: attachment:"file name.doc"
- * A specific file revision: source:/trunk/COPYING#200
- * A filename with embedded space: source:"/trunk/README FIRST"
+ * ...
 }}}
 
@@ -214 +247 @@
  * Reports: {1} or report:1
  * Changesets: r1, [1] or changeset:1
- * Revision Logs: r1:3, [1:3] or log:branches/0.8-stable#1:3
- * Wiki pages: CamelCase or wiki:CamelCase
- * Milestones: milestone:1.0 or milestone:"End-of-days Release"
- * Files: source:trunk/COPYING
- * Attachments: attachment:"file name.doc"
- * A specific file revision: source:/trunk/COPYING#200
- * A filename with embedded space: source:"/trunk/README FIRST"
-
-See TracLinks for more in-depth information.
+ * ... 
+
+There are many more flavors of Trac links, see TracLinks for more in-depth information.
 
 
@@ -242 +269 @@
 == Images ==
 
-Urls ending with `.png`, `.gif` or `.jpg` are automatically interpreted as image links, and converted to `<img>` tags.
-
-Example:
-{{{
-http://www.edgewall.com/gfx/trac_example_image.png
-}}}
-
-Display:
-
-http://www.edgewall.com/gfx/trac_example_image.png
-
-However, this doesn't give much control over the display mode. This way of inserting images is deprecated in favor of the more powerful `Image` macro (see WikiMacros).
+Urls ending with `.png`, `.gif` or `.jpg` are no longer automatically interpreted as image links, and converted to `<img>` tags.
+
+You now have to use the ![[Image]] macro. The simplest way to include an image is to upload it as attachment to the current page, and put the filename in a macro call like `[[Image(picture.gif)]]`.
+
+In addition to the current page, it is possible to refer to other resources:
+ * `[[Image(wiki:WikiFormatting:picture.gif)]]` (referring to attachment on another page)
+ * `[[Image(ticket:1:picture.gif)]]` (file attached to a ticket)
+ * `[[Image(htdocs:picture.gif)]]` (referring to a file inside project htdocs)
+ * `[[Image(source:/trunk/trac/htdocs/trac_logo_mini.png)]]` (a file in repository)
+
+Example display: [[Image(htdocs:../common/trac_logo_mini.png)]]
+
+See WikiMacros for further documentation on the `[[Image()]]` macro.
 
 
@@ -262 +290 @@
 Example:
 {{{
- [[Timestamp]]
-}}}
-
-Display:
- [[Timestamp]]
+ [[RecentChanges(Trac,3)]]
+}}}
+
+Display:
+ [[RecentChanges(Trac,3)]]
 
 See WikiMacros for more information, and a list of installed macros.
@@ -295 +323 @@
 #!html
 <pre class="wiki">{{{
+#!python
+class Test:
+
+    def __init__(self):
+        print "Hello World"
+if __name__ == '__main__':
+   Test()
+}}}</pre>
+}}}
+
+Display:
+{{{
 #!python
 class Test:
@@ -301 +341 @@
 if __name__ == '__main__':
    Test()
-}}}</pre>
-}}}
-
-Display:
-{{{
-#!python
-class Test:
-    def __init__(self):
-        print "Hello World"
-if __name__ == '__main__':
-   Test()
 }}}
 
@@ -319 +348 @@
 my ($test) = 0;
 if ($test > 0) {
-echo "hello";
+    print "hello";
 }
 }}}
@@ -326 +355 @@
 
 
+== Comments ==
+
+Comments can be added to the plain text. These will not be rendered and will not display in any other format than plain text.
+{{{
+{{{
+#!comment
+Your comment here
+}}}
+}}}
+
+
 == Miscellaneous ==
 
@@ -337 +377 @@
 Display:
 ----
+