source: wiki/pages/TracWiki @ 37412

Last change on this file since 37412 was 37343, checked in by aafsvn, 8 years ago

[titan] autoupdate wiki files

File size: 3.4 KB
1= The Trac Wiki System =
4Trac 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. This text markup is also used in all other parts of the system, not only in [wiki:TitleIndex wiki pages], but also in [wiki:TracTickets ticket] description and comments, [wiki:TracChangeset check-in log messages], [wiki:TracRoadmap milestone] descriptions and [wiki:TracReports report] descriptions, even in third-party extensions.
5It allows for formatted text and hyperlinks in and between all Trac modules.
7Editing 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, which can eventually be used in parts of a page (so called wiki “blocks”).
9The 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 [ universal edit button] of your browser.
11The 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.
12As contributing to a wiki is essentially building hypertext,
13general advice regarding HTML authoring apply here as well.
14For example, the ''[ Style Guide for online hypertext]'' explains how to think about the
15[ overall structure of a work]
16and how to organize information [ within each document]. One of the most important tips is “make your HTML page such that you can read it even if you don't follow any links.”
18Learn more about:
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. Note that not all Trac wikis are editable by anyone, this depends on the local policy; check with your Trac administrators.
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 (you have to Preview the page for the setting to take effect). '' 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
Note: See TracBrowser for help on using the repository browser.