| 1 | = The Trac User and Administration Guide = |
| 2 | [[TracGuideToc]] |
| 3 | |
| 4 | 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 [http://trac.edgewall.org Trac Project] itself. |
| 5 | |
| 6 | == Table of Contents == |
| 7 | Currently available documentation: |
| 8 | * TracGuide (This page) -- Documentation starting point. |
| 9 | * '''Administrator Guide''' |
| 10 | * TracInstall -- How to install and run Trac. |
| 11 | * TracUpgrade -- How to upgrade existing installations. |
| 12 | * TracAdmin -- Administering a Trac project. |
| 13 | * TracImport -- Importing tickets from other bug databases. |
| 14 | * TracIni -- Trac configuration file reference. |
| 15 | * TracPermissions -- Access control and permissions. |
| 16 | * TracInterfaceCustomization -- Customizing the Trac interface. |
| 17 | * TracPlugins -- Installing and managing Trac extensions. |
| 18 | * TracLogging -- The Trac logging facility. |
| 19 | * TracNotification -- Email notification. |
| 20 | * TracWorkflow -- Configurable Ticket Workflow. |
| 21 | * '''User Guide''' |
| 22 | * TracWiki -- How to use the built-in Wiki. |
| 23 | * TracTimeline -- The timeline provides a historic perspective on a project. |
| 24 | * TracRss -- RSS content syndication in Trac. |
| 25 | * ''The Version Control Subsystem'' |
| 26 | * TracBrowser -- Browsing source code with Trac. |
| 27 | * TracChangeset -- Viewing changes to source code. |
| 28 | * TracRevisionLog -- Viewing change history. |
| 29 | * ''The Ticket Subsystem'' |
| 30 | * TracTickets -- Using the issue tracker. |
| 31 | * TracReports -- Writing and using reports. |
| 32 | * TracQuery -- Executing custom ticket queries. |
| 33 | * TracRoadmap -- The roadmap helps tracking project progress. |
| 34 | * [trac:TracFaq Trac FAQ] - A collection of Frequently Asked Questions (on the project website). |
| 35 | |
| 36 | == Support and Other Sources of Information == |
| 37 | If you are looking for a good place to ask a question about Trac, look no further than the [http://trac.edgewall.org/wiki/MailingList MailingList]. It provides a friendly environment to discuss openly among Trac users and developers. |
| 38 | |
| 39 | See also the TracSupport page for more information resources. |
| 40 | |
| 41 | Finally, developer documentation can be found in [trac:TracDev TracDev] and its sub-pages. |
| 42 | |