Changes between Version 1 and Version 2 of Wiki Formatting


Ignore:
Timestamp:
Jul 4, 2008, 2:09:43 PM (16 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • Wiki Formatting

    v1 v2  
    11= WikiFormatting =
    2 
    3 Wiki serves as the core component of Trac, which tightly integrates all the other parts of Trac into flexible and powerful system.
    4 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://moin.sf.net/ MoinWiki].
    5 
    6 This page demonstrates some of the formatting commands available in the Trac Wiki.
    7 
    8 == Font styles ==
    9 
    10 The Trac wiki support the following font styles: '''bold''', ''italic''
    11 and __underline__.
    12 
    13 {{{
    14 The Trac wiki support the following font styles: '''bold''', ''italic''
    15 and __underline__.
    16 }}}
    17 
    18 == Heading ==
    19 
    20 You can create heading by starting a line with one up to five equal signs
    21 followed by a space and the headline text. The line should end with a space
    22 followed by the same number of equal signs.
    23 
    24 === Example: ===
     2[[TracGuideToc]]
     3
     4Wiki markup is a core feature in Trac, tightly integrating all the other parts of Trac into a flexible and powerful whole.
     5
     6Trac 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,
     7especially [http://moinmoin.wikiwikiweb.de/ MoinMoin].
     8
     9
     10This page demonstrates the formatting syntax available anywhere WikiFormatting is allowed.
     11
     12
     13== Font Styles ==
     14
     15The Trac wiki supports the following font styles:
     16{{{
     17 * '''bold''', '''!''' can be bold too''', and '''! '''
     18 * ''italic''
     19 * '''''bold italic'''''
     20 * __underline__
     21 * {{{monospace}}} or `monospace`
     22 * ~~strike-through~~
     23 * ^superscript^
     24 * ,,subscript,,
     25}}}
     26
     27Display:
     28 * '''bold''', '''!''' can be bold too''', and '''! '''
     29 * ''italic''
     30 * '''''bold italic'''''
     31 * __underline__
     32 * {{{monospace}}} or `monospace`
     33 * ~~strike-through~~
     34 * ^superscript^
     35 * ,,subscript,,
     36
     37Notes:
     38 * `{{{...}}}` 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.
     39 * {{{ ! }}} 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.
     40
     41== Headings ==
     42
     43You can create heading by starting a line with one up to five ''equal'' characters ("=")
     44followed by a single space and the headline text. The line should end with a space
     45followed by the same number of ''='' characters.
     46The heading might optionally be followed by an explicit id. If not, an implicit but nevertheless readable id will be generated.
     47
     48Example:
    2549{{{
    2650= Heading =
    2751== Subheading ==
    28 }}}
    29 
     52=== About ''this'' ===
     53=== Explicit id === #using-explicit-id-in-heading
     54}}}
     55
     56Display:
     57= Heading =
     58== Subheading ==
     59=== About ''this'' ===
     60=== Explicit id === #using-explicit-id-in-heading
    3061
    3162== Paragraphs ==
    3263
    33 A new text paragraph is created whenever two blocks of text are separated
    34 by an empty line. A newline can also be inserted like this:
     64A new text paragraph is created whenever two blocks of text are separated by one or more empty lines.
     65
     66A forced line break can also be inserted, using:
    3567{{{
    3668Line 1[[BR]]Line 2
    … …  
    4072Line 1[[BR]]Line 2
    4173
    42  Text paragraphs can also be indented by starting the lines with a few spaces.
     74
    4375== Lists ==
     76
     77The wiki supports both ordered/numbered and unordered lists.
     78
    4479Example:
    4580{{{
    4681 * Item 1
    4782   * Item 1.1
     83      * Item 1.1.1   
     84      * Item 1.1.2
     85      * Item 1.1.3
     86   * Item 1.2
    4887 * Item 2
    4988
    5089 1. Item 1
    51    1. Item 1.1
     90   a. Item 1.a
     91   a. Item 1.b
     92      i. Item 1.b.i
     93      i. Item 1.b.ii
    5294 1. Item 2
    53 }}}
     95And numbered lists can also be given an explicit number:
     96 3. Item 3
     97}}}
     98
    5499Display:
    55100 * Item 1
    56101   * Item 1.1
     102      * Item 1.1.1
     103      * Item 1.1.2
     104      * Item 1.1.3
     105   * Item 1.2
    57106 * Item 2
    58107
    59108 1. Item 1
    60    1. Item 1.1
     109   a. Item 1.a
     110   a. Item 1.b
     111      i. Item 1.b.i
     112      i. Item 1.b.ii
    61113 1. Item 2
    62 
    63 == Preformatted text ==
    64 Block quotes, also know as preformatted text, is suitable for source code snippets, notes and examples. Use three ''curly braces'' wrapped around the text:
     114And numbered lists can also be given an explicit number:
     115 3. Item 3
     116
     117Note that there must be one or more spaces preceding the list item markers, otherwise the list will be treated as a normal paragraph.
     118
     119
     120== Definition Lists ==
     121
     122
     123The wiki also supports definition lists.
     124
     125Example:
     126{{{
     127 llama::
     128   some kind of mammal, with hair
     129 ppython::
     130   some kind of reptile, without hair
     131   (can you spot the typo?)
     132}}}
     133
     134Display:
     135 llama::
     136   some kind of mammal, with hair
     137 ppython::
     138   some kind of reptile, without hair
     139   (can you spot the typo?)
     140
     141Note that you need a space in front of the defined term.
     142
     143
     144== Preformatted Text ==
     145
     146Block 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.
    65147 
     148Example:
    66149{{{
    67150 {{{
    68   def HelloWorld()
     151  def HelloWorld():
    69152      print "Hello World"
    70153 }}}
    … …  
    73156Display:
    74157{{{
    75  def HelloWorld()
     158 def HelloWorld():
    76159     print "Hello World"
    77160}}}
     161
     162
     163== Blockquotes ==
     164
     165In order to mark a paragraph as blockquote, indent that paragraph with two spaces.
     166
     167Example:
     168{{{
     169  This text is a quote from someone else.
     170}}}
     171
     172Display:
     173  This text is a quote from someone else.
     174
     175== Discussion Citations ==
     176
     177To delineate a citation in an ongoing discussion thread, such as the ticket comment area, e-mail-like citation marks (">", ">>", etc.) may be used. 
     178
     179Example:
     180{{{
     181>> Someone's original text
     182> Someone else's reply text
     183My reply text
     184}}}
     185
     186Display:
     187>> Someone's original text
     188> Someone else's reply text
     189My reply text
     190
     191''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.''
    78192
    79193== Tables ==
    … …  
    84198||Cell 4||Cell 5||Cell 6||
    85199}}}
     200
    86201Display:
    87202||Cell 1||Cell 2||Cell 3||
    88203||Cell 4||Cell 5||Cell 6||
    89204
     205Note that more complex tables can be created using
     206[wiki:WikiRestructuredText#BiggerReSTExample reStructuredText].
     207
     208
    90209== Links ==
    91210
    92 Hyperlinks are automatically created for WikiPageNames and urls. !WikiPageLinks can be disabled by
    93 prepending a bang (!) character like this {{{!WikiPageLink}}}.
    94 
    95 For example:
    96 
    97  TitleIndex, http://www.edgewall.com/.
    98 
    99 Links can be given a more descriptive title by writing the link followed by
    100 a space and a title and all this inside two square brackets. Like this:
     211Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark "!" character, such as {{{!WikiPageLink}}}.
     212
     213Example:
     214{{{
     215 TitleIndex, http://www.edgewall.com/, !NotAlink
     216}}}
     217
     218Display:
     219 TitleIndex, http://www.edgewall.com/, !NotAlink
     220
     221Links 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.
     222
     223Example:
    101224{{{
    102225 * [http://www.edgewall.com/ Edgewall Software]
    103226 * [wiki:TitleIndex Title Index]
    104 }}}
    105 Display:
    106 
     227 * [wiki:ISO9000]
     228}}}
     229
     230Display:
    107231 * [http://www.edgewall.com/ Edgewall Software]
    108232 * [wiki:TitleIndex Title Index]
    109 
    110 === Intra Trac Links ===
    111 
    112 Trac allows wiki pages to link directly to other parts of the Trac system.
    113 Pages can refer to tickets, reports and changesets by simply writing the
    114 ticket, report and changeset numbers in the following notation:
    115 {{{
    116  * Ticket #1
    117  * Report {1}
    118  * Changeset [1]
    119  * File source:trunk/COPYING.
    120  * A specific file revision: source:/trunk/COPYING#200
    121 }}}
    122 Display:
    123  * Ticket #1
    124  * Report {1}
    125  * Changeset [1]
    126  * File source:trunk/COPYING.
    127  * A specific file revision: source:/trunk/COPYING#200
    128 
    129 See TracLinks for more information about intra-trac linking.
     233 * [wiki:ISO9000]
     234
     235== Trac Links ==
     236
     237Wiki 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:
     238{{{
     239 * Tickets: #1 or ticket:1
     240 * Reports: {1} or report:1
     241 * Changesets: r1, [1] or changeset:1
     242 * ...
     243}}}
     244
     245Display:
     246 * Tickets: #1 or ticket:1
     247 * Reports: {1} or report:1
     248 * Changesets: r1, [1] or changeset:1
     249 * ...
     250
     251There are many more flavors of Trac links, see TracLinks for more in-depth information.
     252
     253
     254== Escaping Links and WikiPageNames ==
     255
     256You may avoid making hyperlinks out of TracLinks by preceding an expression with a single "!" (exclamation mark).
     257
     258Example:
     259{{{
     260 !NoHyperLink
     261 !#42 is not a link
     262}}}
     263
     264Display:
     265 !NoHyperLink
     266 !#42 is not a link
     267
    130268
    131269== Images ==
    132270
    133 Urls ending with .png, .gif or .jpg will be converted to an IMG-tag.
    134 
    135 Example:
    136 {{{
    137 http://www.edgewall.com/gfx/trac_example_image.png
    138 }}}
    139 Display:
    140 
    141 http://www.edgewall.com/gfx/trac_example_image.png
     271Urls ending with `.png`, `.gif` or `.jpg` are no longer automatically interpreted as image links, and converted to `<img>` tags.
     272
     273You 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)]]`.
     274
     275In addition to the current page, it is possible to refer to other resources:
     276 * `[[Image(wiki:WikiFormatting:picture.gif)]]` (referring to attachment on another page)
     277 * `[[Image(ticket:1:picture.gif)]]` (file attached to a ticket)
     278 * `[[Image(htdocs:picture.gif)]]` (referring to a file inside project htdocs)
     279 * `[[Image(source:/trunk/trac/htdocs/trac_logo_mini.png)]]` (a file in repository)
     280
     281Example display: [[Image(htdocs:../common/trac_logo_mini.png)]]
     282
     283
     284See WikiMacros for further documentation on the `[[Image()]]` macro.
     285
    142286
    143287== Macros ==
    144 Macros are ''custom functions'' to insert dynamic content in a page. See WikiMacros for usage.
    145 
    146 Example:
    147 {{{
    148  [[Timestamp]]
    149 }}}
    150 Display:
    151  [[Timestamp]]
     288
     289Macros are ''custom functions'' to insert dynamic content in a page.
     290
     291Example:
     292{{{
     293 [[RecentChanges(Trac,3)]]
     294}}}
     295
     296Display:
     297 [[RecentChanges(Trac,3)]]
     298
     299See WikiMacros for more information, and a list of installed macros.
     300
    152301
    153302== Processors ==
    154 Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in [wiki:WikiRestructuredText reStructuredText] or [wiki:WikiHtml HTML]. See WikiProcessors for documentation.
    155 
    156 '''Example 1:'''
     303
     304Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in
     305[wiki:WikiRestructuredText reStructuredText] or [wiki:WikiHtml HTML].
     306
     307Example 1:
    157308{{{
    158309#!html
    … …  
    162313}}}</pre>
    163314}}}
     315
    164316Display:
    165317{{{
    … …  
    168320}}}
    169321
    170 '''Example 2:'''
     322Example:
    171323{{{
    172324#!html
    173325<pre class="wiki">{{{
     326#!python
     327class Test:
     328
     329    def __init__(self):
     330        print "Hello World"
     331if __name__ == '__main__':
     332   Test()
     333}}}</pre>
     334}}}
     335
     336Display:
     337{{{
    174338#!python
    175339class Test:
    … …  
    178342if __name__ == '__main__':
    179343   Test()
    180 }}}</pre>
    181 }}}
    182 Display:
    183 {{{
    184 #!python
    185 class Test:
    186     def __init__(self):
    187         print "Hello World"
    188 if __name__ == '__main__':
    189    Test()
    190 }}}
     344}}}
     345
     346Perl:
     347{{{
     348#!perl
     349my ($test) = 0;
     350if ($test > 0) {
     351    print "hello";
     352}
     353}}}
     354
     355See WikiProcessors for more information.
     356
     357
     358== Comments ==
     359
     360Comments can be added to the plain text. These will not be rendered and will not display in any other format than plain text.
     361{{{
     362{{{
     363#!comment
     364Your comment here
     365}}}
     366}}}
     367
     368
    191369== Miscellaneous ==
    192370
    193371Four or more dashes will be replaced by a horizontal line (<HR>)
    194372
     373Example:
    195374{{{
    196375 ----
    … …  
    201380
    202381
     382
    203383----
    204 See also: TracLinks, TracGuide, WikiMacros, WikiProcessors, TracSyntaxColoring.
     384See also: TracLinks, TracGuide, WikiHtml, WikiMacros, WikiProcessors, TracSyntaxColoring.