Changes between Version 1 and Version 2 of WikiFormatting


Ignore:
Timestamp:
Jan 30, 2006, 11:09:12 PM (16 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiFormatting

    v1 v2  
    1111
    1212
    13 == Font styles ==
     13== Font Styles ==
    1414
    1515The Trac wiki supports the following font styles:
     
    2222 * ~~strike-through~~
    2323 * ^superscript^
    24  * ,,subscript,,.
     24 * ,,subscript,,
    2525}}}
    2626
     
    3333 * ~~strike-through~~
    3434 * ^superscript^
    35  * ,,subscript,,.
    36 
    37 
    38 
    39 == Heading ==
    40 
    41 You can create heading by starting a line with one up to five ''equal'' "=" characters
     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 ("=")
    4242followed by a single space and the headline text. The line should end with a space
    43 followed by the same number of ''equal'' characters.
     43followed by the same number of ''='' characters.
    4444
    4545Example:
     
    5858== Paragraphs ==
    5959
    60 A new text paragraph is created whenever two blocks of text are separated
    61 by one or more empty lines.
     60A new text paragraph is created whenever two blocks of text are separated by one or more empty lines.
    6261
    6362A forced line break can also be inserted, using:
     
    6968Line 1[[BR]]Line 2
    7069
    71   Text paragraphs can be indented by starting the lines with two or more spaces.
    72 
    7370
    7471== Lists ==
    7572
    7673The wiki supports both ordered/numbered and unordered lists.
    77 There must be a space preceding the star "*" or number "1.", or nothing will happen.
    7874
    7975Example:
     
    9793 1. Item 2
    9894
    99 
    100 == Definition lists ==
     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 ==
    10199
    102100The wiki also supports definition lists.
     
    121119
    122120
    123 == Preformatted text ==
    124 
    125 Block quotes, preformatted text, are suitable for source code snippets, notes and examples. Use three ''curly braces'' wrapped around the text to define a block quote.
     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.
    126124 
    127125Example:
    128126{{{
    129127 {{{
    130   def HelloWorld()
     128  def HelloWorld():
    131129      print "Hello World"
    132130 }}}
     
    135133Display:
    136134{{{
    137  def HelloWorld()
     135 def HelloWorld():
    138136     print "Hello World"
    139137}}}
    140138
     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.
    141151
    142152== Tables ==
     
    155165[wiki:WikiRestructuredText#BiggerReSTExample reStructuredText].
    156166
     167
    157168== Links ==
    158169
    159 Hyperlinks are automatically created for WikiPageNames and urls.
    160 !WikiPageLinks can be disabled by
    161 prepending an exclamation mark "!" character, such as {{{!WikiPageLink}}}.
     170Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark "!" character, such as {{{!WikiPageLink}}}.
    162171
    163172Example:
     
    169178 TitleIndex, http://www.edgewall.com/, !NotAlink
    170179
    171 Links can be given a more descriptive title by writing the link followed by
    172 a space and a title and all this inside square brackets.
    173 If the descriptive title is omitted, then the explicit prefix is disguarded,
    174 unless the link is an external link. This can be useful for wiki pages
    175 not adhering to the WikiPageNames convention.
    176 
    177 Like this:
     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:
    178183{{{
    179184 * [http://www.edgewall.com/ Edgewall Software]
     
    190195=== Trac Links ===
    191196
    192 Wiki pages can link directly to other parts of the Trac system.
    193 Pages can refer to tickets, reports, changesets, milestones, source files and
    194 other Wiki pages using the following notation:
     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:
    195198{{{
    196199 * Tickets: #1 or ticket:1
    197200 * Reports: {1} or report:1
    198201 * Changesets: r1, [1] or changeset:1
    199  * Revision Logs: r1:3, [1:3] or log:branches/0.9-stable#1:3
     202 * Revision Logs: r1:3, [1:3] or log:branches/0.8-stable#1:3
    200203 * Wiki pages: CamelCase or wiki:CamelCase
    201204 * Milestones: milestone:1.0 or milestone:"End-of-days Release"
    202205 * Files: source:trunk/COPYING
     206 * Attachments: attachment:"file name.doc"
    203207 * A specific file revision: source:/trunk/COPYING#200
    204208 * A filename with embedded space: source:"/trunk/README FIRST"
     
    209213 * Reports: {1} or report:1
    210214 * Changesets: r1, [1] or changeset:1
    211  * Revision Logs: r1:3, [1:3] or log:branches/0.8-stable#1000:2000
     215 * Revision Logs: r1:3, [1:3] or log:branches/0.8-stable#1:3
    212216 * Wiki pages: CamelCase or wiki:CamelCase
    213217 * Milestones: milestone:1.0 or milestone:"End-of-days Release"
    214218 * Files: source:trunk/COPYING
     219 * Attachments: attachment:"file name.doc"
    215220 * A specific file revision: source:/trunk/COPYING#200
    216221 * A filename with embedded space: source:"/trunk/README FIRST"
     
    223228You may avoid making hyperlinks out of TracLinks by preceding an expression with a single "!" (exclamation mark).
    224229
     230Example:
    225231{{{
    226232 !NoHyperLink
     
    246252http://www.edgewall.com/gfx/trac_example_image.png
    247253
     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
    248256
    249257== Macros ==
    250258
    251 Macros are ''custom functions'' to insert dynamic content in a page.
    252 See WikiMacros for usage.
     259Macros are ''custom functions'' to insert dynamic content in a page.
    253260
    254261Example:
     
    260267 [[Timestamp]]
    261268
     269See WikiMacros for more information, and a list of installed macros.
     270
    262271
    263272== Processors ==
    264273
    265 Trac supports alternative markup formats using WikiProcessors.
    266 For example, processors are used to write pages in
     274Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in
    267275[wiki:WikiRestructuredText reStructuredText] or [wiki:WikiHtml HTML].
    268276
    269 See WikiProcessors for more information.
    270 
    271 '''Example 1:'''
     277Example 1:
    272278{{{
    273279#!html
     
    284290}}}
    285291
    286 '''Example 2:'''
     292Example:
    287293{{{
    288294#!html
     
    307313}}}
    308314
     315Perl:
     316{{{
     317#!perl
     318my ($test) = 0;
     319if ($test > 0) {
     320echo "hello";
     321}
     322}}}
     323
     324See WikiProcessors for more information.
     325
    309326
    310327== Miscellaneous ==
     
    322339
    323340----
    324 
    325341See also: TracLinks, TracGuide, WikiHtml, WikiMacros, WikiProcessors, TracSyntaxColoring.
    326 
    327 ----