Edgewall Software

Changes between Version 1 and Version 2 of 0.12/TracWiki


Ignore:
Timestamp:
Feb 28, 2010, 4:47:47 PM (14 years ago)
Author:
Christian Boos
Comment:

add some general tips about how to build a wiki

Legend:

Unmodified
Added
Removed
Modified
  • 0.12/TracWiki

    v1 v2  
    44Trac 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] and [wiki:TracChangeset check-in log messages].  This allows for formatted text and hyperlinks in and between all Trac modules.
    55
    6 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 [wiki:WikiHtml HTML], [wiki:WikiRestructuredText reStructuredText] and [http://www.textism.com/tools/textile/ Textile] as alternative markup formats.
     6Editing 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.
    77
    88The main goal of the wiki is to make editing text easier and ''encourage'' people to contribute and annotate text content for a project.
    99
    10 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.
     10The 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.
     11As contributing to a wiki is essentially building an hypertext,
     12general advices regarding HTML authoring apply here as well.
     13For example, the ''Style Guide for online hypertext'' explains how to think about the
     14[http://www.w3.org/Provider/Style/Structure.html Overall structure of a work]
     15and how to organize information [http://www.w3.org/Provider/Style/WithinDocument.html Within each document]. One of the most important advice is “make your HTML page such that you can read it even if you don't follow any links.”
    1116
    1217For more help on editing wiki text, see these pages: