Changes between Version 7 and Version 8 of WikiFormatting


Ignore:
Timestamp:
Jul 25, 2015, 7:08:55 PM (4 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiFormatting

    v7 v8  
    1 = WikiFormatting
    2 
     1= WikiFormatting =
    32[[TracGuideToc]]
    43
    54Wiki markup is a core feature in Trac, tightly integrating all the other parts of Trac into a flexible and powerful whole.
    65
    7 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://moinmo.in/ MoinMoin] and [trac:WikiCreole].
     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://moinmo.in/ MoinMoin] and [trac:WikiCreole].
     8
    89
    910This page will give you an in-depth explanation of the wiki markup available anywhere WikiFormatting is allowed.
    1011
    11 The sections below provide an overview for the most common syntax, each link in the ''Category'' column will lead you to the more detailed explanation later in this page.
     12The ''Cheat sheet'' below gives you a quick overview for the most common syntax, each link in the ''Category'' column will lead you to the more detailed explanation later in this page.
    1213
    1314A few other wiki pages present the advanced features of the Trac wiki markup in more depth:
    14  - TracLinks covers all the possible ways to refer precisely to any Trac resource or parts thereof
    15  - WikiPageNames covers the various names a wiki page can take, CamelCase or not
    16  - WikiMacros lists the macros available for generating dynamic content
     15 - TracLinks covers all the possible ways to refer precisely to any Trac resource or parts thereof,
     16 - WikiPageNames talks about the various names a wiki page can take, CamelCase or not
     17 - WikiMacros lists the macros available for generating dynamic content,
    1718 - WikiProcessors and WikiHtml details how parts of the wiki text can be processed in special ways
    18  - [trac:wiki:TracDev/Proposals/AdvancedWikiOperations AdvancedWikiOperations] provides some operations in uncommon or administrative scenarios
    19 
    20 == Common wiki markup
     19
     20
     21== Cheat sheet ==
    2122
    2223||= '''Category''' =||= '''Wiki Markup''' =||= '''Display''' =||
     
    242243}}}
    243244
    244 == Font Styles
     245
     246== Font Styles ==
    245247
    246248The Trac wiki supports the following font styles:
     
    290292   with a `//` one, and `'''` can't be paired with `**`)
    291293
    292 == Headings
    293 
    294 You can create heading by starting a line with one up to six ''equal'' characters ("=") followed by a single space and the headline text.
     294
     295== Headings ==
     296
     297You can create heading by starting a line with one up to six ''equal'' characters ("=")
     298followed by a single space and the headline text.
    295299
    296300[=#hn]
     
    320324}}}
    321325
    322 == Paragraphs
     326== Paragraphs ==
    323327
    324328A new text paragraph is created whenever two blocks of text are separated by one or more empty lines.
     
    348352}}}
    349353
    350 == Lists
     354== Lists ==
    351355
    352356The wiki supports both ordered/numbered and unordered lists.
     
    404408}}}
    405409
    406 == Definition Lists
     410
     411== Definition Lists ==
    407412
    408413The wiki also supports definition lists.
     
    428433Note that you need a space in front of the defined term.
    429434
    430 == Preformatted Text
     435
     436== Preformatted Text ==
    431437
    432438Block 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.
     
    450456Note that this kind of block is also used for selecting lines that should be processed through WikiProcessors.
    451457
    452 == Blockquotes
     458== Blockquotes ==
    453459
    454460In order to mark a paragraph as blockquote, indent that paragraph with two spaces.
     
    466472}}}
    467473
    468 == Discussion Citations
     474== Discussion Citations ==
    469475
    470476To delineate a citation in an ongoing discussion thread, such as the ticket comment area, e-mail-like citation marks (">", ">>", etc.) may be used. 
     
    486492}}}
    487493
    488 == Tables
    489 === Simple Tables
    490 
     494
     495== Tables ==
     496=== Simple Tables ===
    491497Simple tables can be created like this:
    492498||= Wiki Markup =||= Display =||
     
    578584}}}
    579585
    580 === Complex Tables
     586=== Complex Tables ===
    581587
    582588If the possibilities offered by the simple "pipe"-based markup for tables described above are not enough for your needs, you can create more elaborated tables by using [#Processors-example-tables WikiProcessor based tables].
    583589
    584 == Links
     590
     591== Links ==
    585592
    586593Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark "!" character, such as {{{!WikiPageLink}}}.
     
    636643}}}
    637644
    638 '''Note''': the [trac:WikiCreole] style for links is quick to type and certainly looks familiar as it is the one used on Wikipedia and in many other wikis. Unfortunately it conflicts with the syntax for [#Macros macros].
    639 So in the rare case when you need to refer to a page which is named after a macro (typical examples being TitleIndex, InterTrac and InterWiki), by writing `[[TitleIndex]]` you will actually call the macro instead of linking to the page.
    640 
    641 == Trac Links
     645'''Note''': the [trac:WikiCreole] style for links is quick to type and
     646certainly looks familiar as it's the one used on Wikipedia and in many
     647other wikis. Unfortunately it conflicts with the syntax for [#Macros macros].
     648So in the rare case when you need to refer to a page which is named after
     649a macro (typical examples being TitleIndex, InterTrac and InterWiki),
     650by writing `[[TitleIndex]]` you will actually call the macro instead of linking
     651to the page.
     652
     653== Trac Links ==
    642654
    643655Wiki 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:
     
    669681There are many more flavors of Trac links, see TracLinks for more in-depth information and a reference for all the default link resolvers.
    670682
    671 == Setting Anchors
     683
     684== Setting Anchors ==
    672685
    673686An anchor, or more correctly speaking, an [http://www.w3.org/TR/REC-html40/struct/links.html#h-12.2.1 anchor name] can be added explicitly at any place in the Wiki page, in order to uniquely identify a position in the document:
     
    712725
    713726For more complex anchors (e.g. when a custom title is wanted), one can use the Span macro, e.g. `[[span(id=point2, class=wikianchor, title=Point 2, ^(2)^)]]`.
     727
    714728
    715729== Escaping Links, WikiPageNames and other Markup == #Escaping
     
    740754}}}
    741755
    742 == Images
     756== Images ==
    743757
    744758Urls ending with `.png`, `.gif` or `.jpg` are no longer automatically interpreted as image links, and converted to `<img>` tags.
     
    764778See WikiMacros for further documentation on the `[[Image()]]` macro, which has several useful options (`title=`, `link=`, etc.)
    765779
    766 == Macros
     780
     781== Macros ==
    767782
    768783Macros are ''custom functions'' to insert dynamic content in a page.
     
    792807}}}
    793808
    794 == Processors
     809
     810== Processors ==
    795811
    796812Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in
     
    929945See WikiProcessors for more information.
    930946
    931 == Comments
     947
     948== Comments ==
    932949
    933950Comments can be added to the plain text. These will not be rendered and will not display in any other format than plain text.
     
    953970}}}
    954971
    955 == Miscellaneous
     972== Miscellaneous ==
    956973
    957974An horizontal line can be used to separated different parts of your page:

Search

Context Navigation

ZOO Sponsors

http://www.zoo-project.org/trac/chrome/site/img/geolabs-logo.pnghttp://www.zoo-project.org/trac/chrome/site/img/neogeo-logo.png http://www.zoo-project.org/trac/chrome/site/img/apptech-logo.png http://www.zoo-project.org/trac/chrome/site/img/3liz-logo.png http://www.zoo-project.org/trac/chrome/site/img/gateway-logo.png

Become a sponsor !

Knowledge partners

http://www.zoo-project.org/trac/chrome/site/img/ocu-logo.png http://www.zoo-project.org/trac/chrome/site/img/gucas-logo.png http://www.zoo-project.org/trac/chrome/site/img/polimi-logo.png http://www.zoo-project.org/trac/chrome/site/img/fem-logo.png http://www.zoo-project.org/trac/chrome/site/img/supsi-logo.png http://www.zoo-project.org/trac/chrome/site/img/cumtb-logo.png

Become a knowledge partner

Related links

http://zoo-project.org/img/ogclogo.png http://zoo-project.org/img/osgeologo.png