Edgewall Software

Changes between Initial Version and Version 1 of WikiFormatting

Show
Ignore:
Timestamp:
06/03/06 08:37:54 (8 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''' 
     18 * ''italic'' 
     19 * '''''bold italic''''' 
     20 * __underline__ 
     21 * {{{monospace}}} or `monospace` 
     22 * ~~strike-through~~ 
     23 * ^superscript^  
     24 * ,,subscript,, 
     25}}} 
     26 
     27Display: 
     28 * '''bold''' 
     29 * ''italic'' 
     30 * '''''bold italic''''' 
     31 * __underline__ 
     32 * {{{monospace}}} or `monospace` 
     33 * ~~strike-through~~ 
     34 * ^superscript^  
     35 * ,,subscript,, 
     36 
     37Note 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. 
     38 
     39== Headings == 
     40 
     41You can create heading by starting a line with one up to five ''equal'' characters ("=") 
     42followed by a single space and the headline text. The line should end with a space  
     43followed by the same number of ''='' characters. 
     44 
     45Example: 
     46{{{ 
     47= Heading = 
     48== Subheading == 
     49=== About ''this'' === 
     50}}} 
     51 
     52Display: 
     53= Heading = 
     54== Subheading == 
     55=== About ''this'' === 
     56 
     57 
     58== Paragraphs == 
     59 
     60A new text paragraph is created whenever two blocks of text are separated by one or more empty lines. 
     61 
     62A forced line break can also be inserted, using: 
     63{{{ 
     64Line 1[[BR]]Line 2 
     65}}} 
     66Display: 
     67 
     68Line 1[[BR]]Line 2 
     69 
     70 
     71== Lists == 
     72 
     73The wiki supports both ordered/numbered and unordered lists. 
     74 
     75Example: 
     76{{{ 
     77 * Item 1 
     78   * Item 1.1 
     79 * Item 2 
     80 
     81 1. Item 1 
     82   1. Item 1.1 
     83 1. Item 2 
     84}}} 
     85 
     86Display: 
     87 * Item 1 
     88   * Item 1.1 
     89 * Item 2 
     90 
     91 1. Item 1 
     92   1. Item 1.1 
     93 1. Item 2 
     94 
     95Note that there must be one or more spaces preceding the list item markers, otherwise the list will be treated as a normal paragraph. 
     96 
     97 
     98== Definition Lists == 
     99 
     100The wiki also supports definition lists. 
     101 
     102Example: 
     103{{{ 
     104 llama:: 
     105   some kind of mammal, with hair 
     106 ppython:: 
     107   some kind of reptile, without hair 
     108   (can you spot the typo?) 
     109}}} 
     110 
     111Display: 
     112 llama:: 
     113   some kind of mammal, with hair 
     114 ppython:: 
     115   some kind of reptile, without hair 
     116   (can you spot the typo?) 
     117 
     118Note that you need a space in front of the defined term. 
     119 
     120 
     121== Preformatted Text == 
     122 
     123Block 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. 
     124   
     125Example: 
     126{{{ 
     127 {{{ 
     128  def HelloWorld(): 
     129      print "Hello World" 
     130 }}} 
     131}}} 
     132 
     133Display: 
     134{{{ 
     135 def HelloWorld(): 
     136     print "Hello World" 
     137}}} 
     138 
     139 
     140== Blockquotes == 
     141 
     142In order to mark a paragraph as blockquote, indent that paragraph with two spaces. 
     143 
     144Example: 
     145{{{ 
     146  This text is a quote from someone else. 
     147}}} 
     148 
     149Display: 
     150  This text is a quote from someone else. 
     151 
     152== Tables == 
     153 
     154Simple tables can be created like this: 
     155{{{ 
     156||Cell 1||Cell 2||Cell 3|| 
     157||Cell 4||Cell 5||Cell 6|| 
     158}}} 
     159 
     160Display: 
     161||Cell 1||Cell 2||Cell 3|| 
     162||Cell 4||Cell 5||Cell 6|| 
     163 
     164Note that more complex tables can be created using 
     165[wiki:WikiRestructuredText#BiggerReSTExample reStructuredText]. 
     166 
     167 
     168== Links == 
     169 
     170Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark "!" character, such as {{{!WikiPageLink}}}. 
     171 
     172Example: 
     173{{{ 
     174 TitleIndex, http://www.edgewall.com/, !NotAlink 
     175}}} 
     176 
     177Display: 
     178 TitleIndex, http://www.edgewall.com/, !NotAlink 
     179 
     180Links 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. 
     181 
     182Example: 
     183{{{ 
     184 * [http://www.edgewall.com/ Edgewall Software] 
     185 * [wiki:TitleIndex Title Index] 
     186 * [wiki:ISO9000] 
     187}}} 
     188 
     189Display: 
     190 * [http://www.edgewall.com/ Edgewall Software] 
     191 * [wiki:TitleIndex Title Index] 
     192 * [wiki:ISO9000] 
     193 
     194 
     195=== Trac Links === 
     196 
     197Wiki 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: 
     198{{{ 
     199 * Tickets: #1 or ticket:1 
     200 * Reports: {1} or report:1 
     201 * Changesets: r1, [1] or changeset:1 
     202 * Revision Logs: r1:3, [1:3] or log:branches/0.8-stable#1:3 
     203 * Wiki pages: CamelCase or wiki:CamelCase 
     204 * Milestones: milestone:1.0 or milestone:"End-of-days Release" 
     205 * Files: source:trunk/COPYING 
     206 * Attachments: attachment:"file name.doc" 
     207 * A specific file revision: source:/trunk/COPYING#200 
     208 * A filename with embedded space: source:"/trunk/README FIRST" 
     209}}} 
     210 
     211Display: 
     212 * Tickets: #1 or ticket:1 
     213 * Reports: {1} or report:1 
     214 * Changesets: r1, [1] or changeset:1 
     215 * Revision Logs: r1:3, [1:3] or log:branches/0.8-stable#1:3 
     216 * Wiki pages: CamelCase or wiki:CamelCase 
     217 * Milestones: milestone:1.0 or milestone:"End-of-days Release" 
     218 * Files: source:trunk/COPYING 
     219 * Attachments: attachment:"file name.doc" 
     220 * A specific file revision: source:/trunk/COPYING#200 
     221 * A filename with embedded space: source:"/trunk/README FIRST" 
     222 
     223See TracLinks for more in-depth information. 
     224 
     225 
     226== Escaping Links and WikiPageNames == 
     227 
     228You may avoid making hyperlinks out of TracLinks by preceding an expression with a single "!" (exclamation mark). 
     229 
     230Example: 
     231{{{ 
     232 !NoHyperLink 
     233 !#42 is not a link 
     234}}} 
     235 
     236Display: 
     237 !NoHyperLink 
     238 !#42 is not a link 
     239 
     240 
     241== Images == 
     242 
     243Urls ending with `.png`, `.gif` or `.jpg` are automatically interpreted as image links, and converted to `<img>` tags. 
     244 
     245Example: 
     246{{{ 
     247http://www.edgewall.com/gfx/trac_example_image.png 
     248}}} 
     249 
     250Display: 
     251 
     252http://www.edgewall.com/gfx/trac_example_image.png 
     253 
     254However, 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). 
     255 
     256 
     257== Macros == 
     258 
     259Macros are ''custom functions'' to insert dynamic content in a page. 
     260 
     261Example: 
     262{{{ 
     263 [[Timestamp]] 
     264}}} 
     265 
     266Display: 
     267 [[Timestamp]] 
     268 
     269See WikiMacros for more information, and a list of installed macros. 
     270 
     271 
     272== Processors == 
     273 
     274Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in  
     275[wiki:WikiRestructuredText reStructuredText] or [wiki:WikiHtml HTML].  
     276 
     277Example 1: 
     278{{{ 
     279#!html 
     280<pre class="wiki">{{{ 
     281#!html 
     282&lt;h1 style="text-align: right; color: blue"&gt;HTML Test&lt;/h1&gt; 
     283}}}</pre> 
     284}}} 
     285 
     286Display: 
     287{{{ 
     288#!html 
     289<h1 style="text-align: right; color: blue">HTML Test</h1> 
     290}}} 
     291 
     292Example: 
     293{{{ 
     294#!html 
     295<pre class="wiki">{{{ 
     296#!python 
     297class Test: 
     298    def __init__(self): 
     299        print "Hello World" 
     300if __name__ == '__main__': 
     301   Test() 
     302}}}</pre> 
     303}}} 
     304 
     305Display: 
     306{{{ 
     307#!python 
     308class Test: 
     309    def __init__(self): 
     310        print "Hello World" 
     311if __name__ == '__main__': 
     312   Test() 
     313}}} 
     314 
     315Perl: 
     316{{{ 
     317#!perl 
     318my ($test) = 0; 
     319if ($test > 0) { 
     320echo "hello"; 
     321} 
     322}}} 
     323 
     324See WikiProcessors for more information. 
     325 
     326 
     327== Miscellaneous == 
     328 
     329Four or more dashes will be replaced by a horizontal line (<HR>) 
     330 
     331Example: 
     332{{{ 
     333 ---- 
     334}}} 
     335 
     336Display: 
     337---- 
     338 
     339 
     340---- 
     341See also: TracLinks, TracGuide, WikiHtml, WikiMacros, WikiProcessors, TracSyntaxColoring.