Edgewall Software

Changes between Version 5 and Version 6 of 0.12/TracWiki


Ignore:
Timestamp:
Mar 26, 2010, 6:13:20 PM (14 years ago)
Author:
mark.m.mcmahon@…
Comment:

Reference other places where WikiFormatting can be used; Mention the editing toolbar; linkify the Style Guide Root

Legend:

Unmodified
Added
Removed
Modified
  • 0.12/TracWiki

    v5 v6  
    22[[TracGuideToc]]
    33
    4 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] and [wiki:TracChangeset check-in log messages].  This allows for formatted text and hyperlinks in and between all Trac modules.
     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.
    55
    66Editing 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
    8 The main goal of the wiki is to make editing text easier and ''encourage'' people to contribute and annotate text content for a project.
     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.
    99
    1010The 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.
    1111As contributing to a wiki is essentially building an hypertext,
    1212general advice regarding HTML authoring apply here as well.
    13 For example, the ''Style Guide for online hypertext'' explains how to think about the
     13For example, the ''[http://www.w3.org/Provider/Style Style Guide for online hypertext]'' explains how to think about the
    1414[http://www.w3.org/Provider/Style/Structure.html Overall structure of a work]
    1515and how to organize information [http://www.w3.org/Provider/Style/WithinDocument.html 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.”