close Warning:

Changes between Initial Version and Version 1 of WikiFormatting


Ignore:
Timestamp:
Feb 4, 2007, 2:20:12 PM (11 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiFormatting

    v1 v1  
     1= WikiFormatting =
     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:
     49{{{
     50= Heading =
     51== Subheading ==
     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
     61
     62== Paragraphs ==
     63
     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:
     67{{{
     68Line 1[[BR]]Line 2
     69}}}
     70Display:
     71
     72Line 1[[BR]]Line 2
     73
     74
     75== Lists ==
     76
     77The wiki supports both ordered/numbered and unordered lists.
     78
     79Example:
     80{{{
     81 * Item 1
     82   * Item 1.1
     83 * Item 2
     84
     85 1. Item 1
     86   a. Item 1.a
     87   a. Item 1.b
     88      i. Item 1.b.i
     89      i. Item 1.b.ii
     90 1. Item 2
     91And numbered lists can also be given an explicit number:
     92 3. Item 3
     93}}}
     94
     95Display:
     96 * Item 1
     97   * Item 1.1
     98 * Item 2
     99
     100 1. Item 1
     101   a. Item 1.a
     102   a. Item 1.b
     103      i. Item 1.b.i
     104      i. Item 1.b.ii
     105 1. Item 2
     106And numbered lists can also be given an explicit number:
     107 3. Item 3
     108
     109Note that there must be one or more spaces preceding the list item markers, otherwise the list will be treated as a normal paragraph.
     110
     111
     112== Definition Lists ==
     113
     114
     115The wiki also supports definition lists.
     116
     117Example:
     118{{{
     119 llama::
     120   some kind of mammal, with hair
     121 ppython::
     122   some kind of reptile, without hair
     123   (can you spot the typo?)
     124}}}
     125
     126Display:
     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
     133Note that you need a space in front of the defined term.
     134
     135
     136== Preformatted Text ==
     137
     138Block 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.
     139 
     140Example:
     141{{{
     142 {{{
     143  def HelloWorld():
     144      print "Hello World"
     145 }}}
     146}}}
     147
     148Display:
     149{{{
     150 def HelloWorld():
     151     print "Hello World"
     152}}}
     153
     154
     155== Blockquotes ==
     156
     157In order to mark a paragraph as blockquote, indent that paragraph with two spaces.
     158
     159Example:
     160{{{
     161  This text is a quote from someone else.
     162}}}
     163
     164Display:
     165  This text is a quote from someone else.
     166
     167== Discussion Citations ==
     168
     169To delineate a citation in an ongoing discussion thread, such as the ticket comment area, e-mail-like citation marks (">", ">>", etc.) may be used. 
     170
     171Example:
     172{{{
     173>> Someone's original text
     174> Someone else's reply text
     175My reply text
     176}}}
     177
     178Display:
     179>> Someone's original text
     180> Someone else's reply text
     181My reply text
     182
     183''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.''
     184
     185== Tables ==
     186
     187Simple tables can be created like this:
     188{{{
     189||Cell 1||Cell 2||Cell 3||
     190||Cell 4||Cell 5||Cell 6||
     191}}}
     192
     193Display:
     194||Cell 1||Cell 2||Cell 3||
     195||Cell 4||Cell 5||Cell 6||
     196
     197Note that more complex tables can be created using
     198[wiki:WikiRestructuredText#BiggerReSTExample reStructuredText].
     199
     200
     201== Links ==
     202
     203Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark "!" character, such as {{{!WikiPageLink}}}.
     204
     205Example:
     206{{{
     207 TitleIndex, http://www.edgewall.com/, !NotAlink
     208}}}
     209
     210Display:
     211 TitleIndex, http://www.edgewall.com/, !NotAlink
     212
     213Links 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.
     214
     215Example:
     216{{{
     217 * [http://www.edgewall.com/ Edgewall Software]
     218 * [wiki:TitleIndex Title Index]
     219 * [wiki:ISO9000]
     220}}}
     221
     222Display:
     223 * [http://www.edgewall.com/ Edgewall Software]
     224 * [wiki:TitleIndex Title Index]
     225 * [wiki:ISO9000]
     226
     227
     228=== Trac Links ===
     229
     230Wiki 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:
     231{{{
     232 * Tickets: #1 or ticket:1
     233 * Reports: {1} or report:1
     234 * Changesets: r1, [1] or changeset:1
     235 * ...
     236}}}
     237
     238Display:
     239 * Tickets: #1 or ticket:1
     240 * Reports: {1} or report:1
     241 * Changesets: r1, [1] or changeset:1
     242 * ...
     243
     244See TracLinks for more in-depth information.
     245
     246
     247== Escaping Links and WikiPageNames ==
     248
     249You may avoid making hyperlinks out of TracLinks by preceding an expression with a single "!" (exclamation mark).
     250
     251Example:
     252{{{
     253 !NoHyperLink
     254 !#42 is not a link
     255}}}
     256
     257Display:
     258 !NoHyperLink
     259 !#42 is not a link
     260
     261
     262== Images ==
     263
     264Urls ending with `.png`, `.gif` or `.jpg` are no longer automatically interpreted as image links, and converted to `<img>` tags.
     265
     266You now have to use the ![[Image]] macro (see below).
     267
     268
     269== Macros ==
     270
     271Macros are ''custom functions'' to insert dynamic content in a page.
     272
     273Example:
     274{{{
     275 [[Timestamp]]
     276}}}
     277
     278Display:
     279 [[Timestamp]]
     280
     281See WikiMacros for more information, and a list of installed macros.
     282
     283
     284== Processors ==
     285
     286Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in
     287[wiki:WikiRestructuredText reStructuredText] or [wiki:WikiHtml HTML].
     288
     289Example 1:
     290{{{
     291#!html
     292<pre class="wiki">{{{
     293#!html
     294&lt;h1 style="text-align: right; color: blue"&gt;HTML Test&lt;/h1&gt;
     295}}}</pre>
     296}}}
     297
     298Display:
     299{{{
     300#!html
     301<h1 style="text-align: right; color: blue">HTML Test</h1>
     302}}}
     303
     304Example:
     305{{{
     306#!html
     307<pre class="wiki">{{{
     308#!python
     309class Test:
     310
     311    def __init__(self):
     312        print "Hello World"
     313if __name__ == '__main__':
     314   Test()
     315}}}</pre>
     316}}}
     317
     318Display:
     319{{{
     320#!python
     321class Test:
     322    def __init__(self):
     323        print "Hello World"
     324if __name__ == '__main__':
     325   Test()
     326}}}
     327
     328Perl:
     329{{{
     330#!perl
     331my ($test) = 0;
     332if ($test > 0) {
     333    print "hello";
     334}
     335}}}
     336
     337See WikiProcessors for more information.
     338
     339
     340== Miscellaneous ==
     341
     342Four or more dashes will be replaced by a horizontal line (<HR>)
     343
     344Example:
     345{{{
     346 ----
     347}}}
     348
     349Display:
     350----
     351
     352
     353----
     354See also: TracLinks, TracGuide, WikiHtml, WikiMacros, WikiProcessors, TracSyntaxColoring.