Edgewall Software

Changes between Version 23 and Version 35 of TracWiki


Ignore:
Timestamp:
(multiple changes)
Author:
(multiple changes)
Comment:
(multiple changes)

Legend:

Unmodified
Added
Removed
Modified

  • TracWiki

    v23 v35  
    1 ** Note: this page documents the 0.12 version of Trac, see [[0.11/TracWiki]] if you need the previous version **
    2 
    3 = The Trac Wiki Engine =
     1= The Trac Wiki System =
    42[[TracGuideToc]]
    53[[TranslatedPages]]
    64
    7 Trac has a built-in wiki engine, used for text and documentation throughout the system. WikiFormatting is used in [wiki:TitleIndex wiki pages], [wiki:TracTickets tickets], [wiki:TracChangeset check-in log messages], [wiki:TracRoadmap milestone] and [wiki:TracReports report] descriptions.  It allows for formatted text and hyperlinks in and between all Trac modules.
     5Trac has a built-in wiki system which you can use for organizing knowledge and information in a very flexible way by [WikiNewPage creating pages] containing an intuitive and easy to learn textual markup. The wiki markup is used throughout Trac, so not only in [wiki:TitleIndex wiki pages], but also in [TracTickets ticket] description and comments, [TracChangeset version control] log messages, [TracRoadmap milestone] descriptions, [TracReports report] descriptions  and even in third-party extensions.
     6It allows for formatted text and hyperlinks in and between all Trac modules.
    87
    9 Editing wiki text is easy, using any web browser and a simple [WikiFormatting formatting system], rather than more complex markup languages like HTML.  The reasoning behind its design is that HTML, with its large collection of nestable tags, is too complicated to allow fast-paced editing, and distracts from the actual content of the pages. Note though that Trac also supports [WikiHtml HTML], [WikiRestructuredText reStructuredText] and [http://www.textism.com/tools/textile/ Textile] as alternative markup formats.
     8Editing wiki text is easy, as compared to complex markup languages like HTML, using any web browser and simple [WikiFormatting formatting]. The motivation for wiki markup is that HTML, with its large collection of nestable tags, is too complicated to allow fast-paced editing, and distracts from the actual content of the pages. Note that Trac also supports [WikiHtml HTML], [WikiRestructuredText reStructuredText] and [https://txstyle.org Textile] as alternative markup formats, which can be used in parts of a page, so called wiki blocks.
    109
    11 The main goal of the wiki is to make editing text easier and ''encourage'' people to contribute and annotate text content for a project. Trac also provides a simple toolbar to make formatting text even easier, and supports the [http://universaleditbutton.org/Universal_Edit_Button universal edit button] of your browser.
     10The main goal of the wiki is to make editing text easy in order to ''encourage'' people to contribute to a project. Trac also provides a simple toolbar to make formatting text even easier, and supports the [http://universaleditbutton.org/Universal_Edit_Button universal edit button] of your browser.
    1211
    13 The wiki itself does not enforce any structure, but rather resembles a stack of empty sheets of paper, where you can organize information and documentation as you see fit, and later reorganize if necessary.
    14 As contributing to a wiki is essentially building an hypertext,
    15 general advice regarding HTML authoring apply here as well.
    16 For example, the ''[http://www.w3.org/Provider/Style Style Guide for online hypertext]'' explains how to think about the
    17 [http://www.w3.org/Provider/Style/Structure.html overall structure of a work]
    18 and how to organize information [http://www.w3.org/Provider/Style/WithinDocument.html within each document]. One of the most important tip is “make your HTML page such that you can read it even if you don't follow any links.”
     12The wiki itself does not enforce any structure, but rather resembles a stack of empty sheets of paper, where you can organize information and documentation as you see fit, and later reorganize if necessary.
     13As contributing to a wiki is essentially building hypertext, general advice regarding HTML authoring apply here as well.
     14For example, the ''[https://www.w3.org/Provider/Style Style Guide for online hypertext]'' explains how to think about the [https://www.w3.org/Provider/Style/Structure.html overall structure of a work] and how to organize information [https://www.w3.org/Provider/Style/WithinDocument.html within each document]. One of the most important tips is to "make your HTML page such that you can read it, even if you don't follow any links".
    1915
    2016Learn more about:
    21  * WikiNewPage creation, which can be configured to start from a [PageTemplates page template]
    22  * WikiFormatting rules, including advanced topics like WikiMacros and WikiProcessors
    23  * How to use WikiPageNames and other forms of TracLinks which are used to refer in a precise way to any resource within Trac
     17 * WikiFormatting rules, including advanced topics like WikiMacros and WikiProcessors.
     18 * How to use WikiPageNames and other forms of TracLinks which are used to refer to any resource within Trac.
    2419
    25 If you want to practice editing, please use the SandBox.
     20If you want to practice editing, please use the SandBox. Note that not all Trac wiki pages are editable by anyone, this depends on the local policy; check with your Trac administrators.
    2621
    27 Before saving your changes, you can ''Preview'' the page or ''Review the Changes'' you've made.
    28 You can get an automatic preview of the formatting as you type when you activate the ''Edit Side-by-side'' mode. '' There is a [wiki:/TracIni#trac-section configurable delay] between when you make your edit and when the automatic preview will update.''
     22Before saving your changes, you can ''Preview'' the page or ''Review Changes'' you have made.
     23You can get an automatic preview of the formatting as you type when you activate the ''Edit Side-by-side'' mode. There is a [wiki:TracIni#/auto_preview_timeout configurable delay] between when you make your edit and when the automatic preview will update.
    2924
    3025Some more information about wikis on the web:
    31  * A definition of [http://wikipedia.org/wiki/Wiki Wiki], in a famous  wiki encyclopedia
    32  * The [http://c2.com/cgi/wiki?WikiHistory History] of the original wiki
    33  * A wiki page explaining [http://www.usemod.com/cgi-bin/mb.pl?WhyWikiWorks why wiki works]
     26 * A definition of [https://wikipedia.org/wiki/Wiki Wiki] according to Wikipedia.
     27 * The [http://c2.com/cgi/wiki?WikiHistory history] behind the original wiki.
     28 * A wiki page explaining [http://www.usemod.com/cgi-bin/mb.pl?WhyWikiWorks why wiki works].
    3429
    3530----