Edgewall Software

Changes between Version 1 and Version 71 of TracGuide


Ignore:
Timestamp:
(multiple changes)
Author:
(multiple changes)
Comment:
(multiple changes)

Legend:

Unmodified
Added
Removed
Modified

  • TracGuide

    v1 v71  
    1 = The Trac User and Administration Guide =
    2 The TracGuide is meant to serve as formal documentation in book form for Trac usage and development. The book (to be) is a free document and a collaborative effort, a part of the TracProject itself. It is and should be based on texts from the main TracProject Wiki, keeping it up-to-date and relevant.
     1= The Trac User and Administration Guide
    32
    4 == Wiki Version of The Guide ==
     3[[TracGuideToc]]
     4[[TranslatedPages]]
     5{{{#!span style="font-size:90%"
     6//The TracGuide is meant to serve as a starting point for all documentation regarding Trac usage and development. The guide is a free document, a collaborative effort, and a part of the [trac: Trac Project] itself.//
     7}}}
    58
    6 === Table of Contents ===
     9== Introduction
    710
    8  * TracGuide (This page)
    9    * TracInstallationGuide
    10    * TracAdmin
    11    * TracWiki
    12    * TracReports
    13    * TracTimeline
     11Trac is an enhanced wiki and issue tracking system for software development projects. Trac uses a minimalistic approach to web-based software project management. It helps developers write great software while staying out of the way. Trac should impose as little as possible on a team's established development process and policies.
    1412
     13It provides an interface to Subversion as well as other version control systems, an integrated Wiki and convenient reporting facilities.
    1514
    16 == Other Versions and Formats ==
     15Trac allows wiki markup in issue descriptions and commit messages, creating links and seamless references between bugs, tasks, changesets, files and wiki pages. A timeline shows all current and past project events in order, making the acquisition of an overview of the project and tracking progress very easy. The roadmap shows the road ahead, listing the upcoming milestones.
    1716
    18 === HTML and PDF Format ===
    19 The latest HTML edition of TracGuide is here:
    20   http://trac.edgewall.com/trac-guide/
     17== User Guide
    2118
    22 -- FIXME: Publish HTML version of trunk XML.
     19   * Using the Wiki subsystem:
     20     * TracWiki — How to use the built-in Wiki.
     21     * WikiFormatting — Reference to the wiki syntax.
     22   * Using the Version Control subsystem:
     23     * TracBrowser — Browsing source code with Trac.
     24     * TracChangeset — Viewing changes to source code.
     25     * TracRevisionLog — Viewing change history.
     26   * Using the Ticket subsystem:
     27     * TracTickets — Using the issue tracker.
     28     * TracRoadmap — Tracking project progress.
     29     * TracReports — Writing and using reports.
     30     * TracQuery — Executing custom ticket queries.
     31     * TracBatchModify - Modifying several tickets in one request.
     32   * Other modules and general topics:
     33     * TracSearch — Full text search in all content.
     34     * TracTimeline — Historic perspective on a project.
     35     * TracRss — RSS content syndication.
     36     * TracAccessibility — Accessibility keys.
    2337
    24 === XML Source ===
    25 The latest DocBook XML version is always in the main Subversion tree:
    26 http://projects.edgewall.com/trac/browser/trunk/doc/trac-guide/
     38== Administrator Guide
    2739
    28 --------------------------
     40   * Installation and upgrade:
     41     * TracInstall — How to install and run Trac.
     42     * TracUpgrade — How to upgrade existing installations.
     43     * TracImport — Importing tickets from other bug databases.
     44     * TracPlugins — Installing and managing Trac extensions.
     45   * Configuration and customization:
     46     * TracIni — Trac configuration file reference.
     47     * TracPermissions — Access control and permissions.
     48     * TracNavigation — Customize main navigation menus.
     49     * TracInterfaceCustomization — Customizing the Trac interface.
     50     * TracLogging — The Trac logging facility.
     51   * Administering the Version Control subsystem:
     52     * TracRepositoryAdmin — Management of Source Code Repositories.
     53   * Administering the Ticket subsystem:
     54     * TracTicketsCustomFields — Expanding tickets with customized fields.
     55     * TracNotification — Email notification.
     56     * TracWorkflow — Configurable Ticket Workflow.
     57   * Reference:
     58     * TracEnvironment — All you need to know about Trac environments.
     59     * TracAdmin — Administering a Trac project via the command-line.
    2960
    30 Next page is TracInstall.
     61== Support and Other Sources of Information
     62
     63 * [trac:TracFaq Trac FAQ] — A collection of Frequently Asked Questions on the project website.
     64 * [trac:TracDev] and [trac:TracDev/ApiDocs API docs] — Trac Developer documentation.
     65 * TracSupport — How to get more information.
     66
     67If you are looking for a good place to ask a question about Trac, see the [trac:MailingList MailingList]. It provides a friendly environment to discuss openly among Trac users and developers.