|Version 5 (modified by 3 months ago) ( diff ),|
The Trac Wiki System
Table of Contents
Trac has a built-in wiki system which you can use for organizing knowledge and information in a very flexible way by creating pages containing an intuitive and easy to learn textual markup. The wiki markup is used throughout Trac, so not only in wiki pages, but also in ticket description and comments, version control log messages, milestone descriptions, report descriptions and even in third-party extensions. It allows for formatted text and hyperlinks in and between all Trac modules.
Editing wiki text is easy, as compared to complex markup languages like HTML, using any web browser and simple 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 HTML, reStructuredText and Textile as alternative markup formats, which can be used in parts of a page, so called wiki blocks.
The 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 universal edit button of your browser.
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. As contributing to a wiki is essentially building hypertext, general advice regarding HTML authoring apply here as well. For example, the Style Guide for online hypertext explains how to think about the overall structure of a work and how to organize information 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".
Learn more about:
- WikiFormatting rules, including advanced topics like WikiMacros and WikiProcessors.
- How to use WikiPageNames and other forms of TracLinks which are used to refer to any resource within Trac.
If 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.
Before saving your changes, you can Preview the page or Review Changes you have made. You can get an automatic preview of the formatting as you type when you activate the Edit Side-by-side mode. There is a configurable delay between when you make your edit and when the automatic preview will update.
Some more information about wikis on the web:
- A definition of Wiki according to Wikipedia.
- The history behind the original wiki.
- A wiki page explaining why wiki works.
See also: TracGuide