Changes between Initial Version and Version 1 of TracWiki

06/08/12 10:47:01 (11 years ago)



  • TracWiki

    v1 v1  
     1= The Trac Wiki Engine =
     4Trac 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.
     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 [ Textile] as alternative markup formats.
     8The 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.
     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 advice regarding HTML authoring apply here as well.
     13For example, the ''[ Style Guide for online hypertext]'' explains how to think about the
     14[ overall structure of a work]
     15and how to organize information [ within each document]. One of the most important is “make your HTML page such that you can read it even if you don't follow any links.”
     17Learn more about:
     18 * WikiNewPage creation, which can be configured to start from a [PageTemplates page template]
     19 * WikiFormatting rules, including advanced topics like WikiMacros and WikiProcessors
     20 * How to use WikiPageNames and other forms of TracLinks which are used to refer in a precise way to any resource within Trac
     22If you want to practice editing, please use the SandBox.
     24Before saving your changes, you can ''Preview'' the page or ''Review the Changes'' you've made.
     25You 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.''
     27Some more information about wikis on the web:
     28 * A definition of [ Wiki], in a famous  wiki encyclopedia
     29 * The [ History] of the original wiki
     30 * A wiki page explaining [ why wiki works]
     33See also: TracGuide