TracGuide – The Trac Project

<!DOCTYPE html> <html lang="en-US"> <head>   <title> TracGuide – The Trac Project </title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> <meta http-equiv="X-UA-Compatible" content="IE=edge" />  <link rel="search" href="/search" /> <link rel="help" href="/wiki/TracGuide" /> <link rel="alternate" href="/wiki/TracGuide?format=txt" title="Plain Text" type="text/x-trac-wiki" /> <link rel="start" href="/wiki" /> <link rel="stylesheet" href="/chrome/common/css/trac.css" type="text/css" /> <link rel="stylesheet" href="/chrome/common/css/wiki.css" type="text/css" /> <link rel="stylesheet" href="/chrome/wikiextras/css/phrases.css" type="text/css" /> <link rel="stylesheet" href="/chrome/wikiextras/css/boxes.css" type="text/css" /> <link rel="stylesheet" href="/wikiextras/dynamicboxes.css" type="text/css" /> <link rel="stylesheet" href="/chrome/vote/css/tracvote.css" type="text/css" /> <link rel="icon" href="/favicon.ico" type="image/x-icon" /> <noscript> <style> .trac-noscript { display: none !important } </style> </noscript> <link type="application/opensearchdescription+xml" rel="search" href="/search/opensearch" title="Search The Trac Project"/> <script src="/chrome/common/js/jquery.js"></script> <script src="/chrome/common/js/babel.js"></script> <script src="/chrome/common/js/trac.js"></script> <script src="/chrome/common/js/search.js"></script> <script src="/chrome/common/js/folding.js"></script> <script src="/chrome/common/js/wiki.js"></script> <script> jQuery(function($) { $(".trac-autofocus").focus(); $(".trac-target-new").attr("target", "_blank"); if ($.ui) { /* is jquery-ui added? */ $(".trac-datepicker:not([readonly])") .prop("autocomplete", "off").datepicker(); // Input current date when today is pressed. var _goToToday = $.datepicker._gotoToday; $.datepicker._gotoToday = function(id) { _goToToday.call(this, id); this._selectDate(id) }; $(".trac-datetimepicker:not([readonly])") .prop("autocomplete", "off").datetimepicker(); $("#main").addClass("trac-nodatetimehint"); } $(".trac-disable").disableSubmit(".trac-disable-determinant"); setTimeout(function() { $(".trac-scroll").scrollToTop() }, 1); $(".trac-disable-on-submit").disableOnSubmit(); }); </script>  <link rel="stylesheet" type="text/css" href="//www.edgewall.org/css/projects013.css" /> <script type="text/javascript"></script> <script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/cookieconsent2/1.0.9/cookieconsent.min.js"></script> <script type="text/javascript"> jQuery(function($) { var $ntg = $("#newticketguide"); if ($ntg.length) $("#propertyform").prepend($ntg.detach()); }); </script>   <meta name="ROBOTS" content="NOINDEX, NOFOLLOW" /> <link rel="alternate" type="application/x-wiki" href="/wiki/TracGuide?action=edit&version=" title="Edit this page"/> <script> jQuery(function($) { wikiColumn($("#wikipage")); }); </script>  </head> <body>    <div id="wrapper"> <div id="topbar"> <a id="home-link" href="//www.edgewall.org/">Edgewall Software</a> </div> <div id="ew-header"> <div id="topnav"><ul> <li><a href="//www.edgewall.org/">Home</a></li> <li class="active"> <a class="trac" href="//trac.edgewall.org/">Trac</a> </li> <li> <a href="//trac-hacks.org/">Trac Hacks</a> </li> <li class=""> <a class="genshi" href="//genshi.edgewall.org/">Genshi</a> </li> <li class=""> <a class="babel" href="//babel.edgewall.org/">Babel</a> </li> <li class=""> <a class="bitten" href="//bitten.edgewall.org/">Bitten</a> </li></ul> </div> </div> <div id="ew-main"> <div id="ew-content"> <div> <script src="//www.google-analytics.com/urchin.js" type="text/javascript"></script> <script type="text/javascript">_uacct = "UA-598265-1";urchinTracker();</script> <div id="left"> <div class="block"> <ul> <li><a href="/">Home</a></li> <li><a href="/wiki/TracDownload">Download</a></li> <li><a href="/wiki/TracGuide">Documentation</a></li> <li><a href="/wiki/MailingList">Mailing Lists</a></li> <li><a href="/wiki/TracLicense">License</a></li> <li><a href="/wiki/TracFaq">FAQ</a></li> </ul> </div> </div> </div>  <div id="banner"> <div id="header"> <a id="logo" href="//trac.edgewall.org/"> <img alt="Trac" height="73" src="//www.edgewall.org/gfx/trac_logo.png" width="236" /></a> </div> <form id="search" action="/search" method="get"> <div> <label for="proj-search">Search:</label> <input type="text" id="proj-search" name="q" size="18" value="" /> <input type="submit" value="Search" /> </div> </form> <div id="metanav" class="nav"> <ul><li class="first"><a href="/login">Login</a></li><li ><a href="/prefs">Preferences</a></li><li ><a href="/wiki/TracGuide">Help/Guide</a></li><li class="last"><a href="/about">About Trac</a></li></ul> </div> </div> <div id="mainnav" class="nav"> <ul><li class="active first"><a href="/wiki">Wiki</a></li><li ><a href="/timeline">Timeline</a></li><li ><a href="/roadmap">Roadmap</a></li><li ><a href="/browser">Browse Source</a></li><li ><a href="/report">View Tickets</a></li><li ><a href="/wiki/NewTicket">New Ticket</a></li><li class="last"><a href="/search">Search</a></li></ul> </div> <div id="main" > <div id="pagepath" class="noprint"> <a class="pathentry first" title="View WikiStart" href="/wiki">wiki:</a><a href="/wiki/TracGuide" title="View TracGuide" class="pathentry">TracGuide</a></div> <div id="ctxtnav" class="nav"> <h2>Context Navigation</h2> <ul> <li class="first"><span id="vote" title="Vote count (+5)"><img alt="Up-vote" src="/chrome/vote/aupgray.png" /><span id="votes">+5</span><img alt="Down-vote" src="/chrome/vote/adowngray.png" /></span></li> <li ><a href="/wiki/WikiStart">Start Page</a></li> <li ><a href="/wiki/TitleIndex">Index</a></li> <li class="last"><a href="/wiki/TracGuide?action=history">History</a></li> </ul> <hr /> </div>  <div id="content" class="wiki narrow"> <div class="wikipage searchable"> <div id="wikipage" class="trac-content borderless"><div class="wikiextras box shadow icon information yellow"><p> This page documents the 1.4 (latest stable) release. Documentation for other releases can be found <a class="wiki" href="/wiki/TitleIndex#TracGuide:BackupandTranslations">here</a>. </p> </div><h1 class="section" id="TheTracUserandAdministrationGuide">The Trac User and Administration Guide</h1> <p> </p><div class="wiki-toc"><h4>Table of Contents</h4><ul><li class="active"><a class="False" href="/wiki/TracGuide">Index</a></li><li class="False"><a class="False" href="/wiki/TracInstall">Installation</a></li><li class="False"><a class="False" href="/wiki/TracInterfaceCustomization">Customization</a></li><li class="False"><a class="False" href="/wiki/TracPlugins">Plugins</a></li><li class="False"><a class="False" href="/wiki/TracUpgrade">Upgrading</a></li><li class="False"><a class="False" href="/wiki/TracIni">Configuration</a></li><li class="False"><a class="False" href="/wiki/TracAdmin">Administration</a></li><li class="False"><a class="False" href="/wiki/TracBackup">Backup</a></li><li class="False"><a class="False" href="/wiki/TracLogging">Logging</a></li><li class="False"><a class="False" href="/wiki/TracPermissions">Permissions</a></li><li class="False"><a class="False" href="/wiki/TracWiki">The Wiki</a></li><li class="False"><a class="False" href="/wiki/WikiFormatting">Wiki Formatting</a></li><li class="False"><a class="False" href="/wiki/TracTimeline">Timeline</a></li><li class="False"><a class="False" href="/wiki/TracBrowser">Repository Browser</a></li><li class="False"><a class="False" href="/wiki/TracRevisionLog">Revision Log</a></li><li class="False"><a class="False" href="/wiki/TracChangeset">Changesets</a></li><li class="False"><a class="False" href="/wiki/TracTickets">Tickets</a></li><li class="False"><a class="False" href="/wiki/TracWorkflow">Workflow</a></li><li class="False"><a class="False" href="/wiki/TracRoadmap">Roadmap</a></li><li class="False"><a class="False" href="/wiki/TracQuery">Ticket Queries</a></li><li class="False"><a class="False" href="/wiki/TracBatchModify">Batch Modify</a></li><li class="False"><a class="False" href="/wiki/TracReports">Reports</a></li><li class="False"><a class="False" href="/wiki/TracRss">RSS Support</a></li><li class="False"><a class="False" href="/wiki/TracNotification">Notification</a></li></ul></div><p> </p> <div class="wiki-toc trac-nav" style="clear:both"> <h4>Languages:</h4> <ul><li><a class="wiki" href="/wiki/TranslationDe/TracGuide">Deutsch</a> </li><li><strong>English</strong> </li><li><a class="wiki" href="/wiki/TranslationFr/TracGuide">Français</a> </li><li><a class="wiki" href="/wiki/TranslationRu/TracGuide">Русский</a> </li><li><a class="wiki" href="/wiki/TranslationZh_CN/TracGuide">简体中文</a> </li><li><a class="wiki" href="/wiki/TranslationZh_TW/TracGuide">正體中文</a> </li></ul> </div><p> </p> <span style="font-size:90%"><em>The <a class="wiki" href="/wiki/TracGuide">TracGuide</a> 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 <a href="https://trac.edgewall.org/intertrac/" title="The Trac Project">Trac Project</a> itself.</em></span><h2 class="section" id="Introduction">Introduction</h2> <p> Trac 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. </p> <p> It provides an interface to Subversion as well as other version control systems, an integrated Wiki and convenient reporting facilities. </p> <p> Trac 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. </p> <h2 class="section" id="UserGuide">User Guide</h2> <ul><li>Using the Wiki subsystem: <ul><li><a class="wiki" href="/wiki/TracWiki">TracWiki</a> — How to use the built-in Wiki. </li><li><a class="wiki" href="/wiki/WikiFormatting">WikiFormatting</a> — Reference to the wiki syntax. </li></ul></li><li>Using the Version Control subsystem: <ul><li><a class="wiki" href="/wiki/TracBrowser">TracBrowser</a> — Browsing source code with Trac. </li><li><a class="wiki" href="/wiki/TracChangeset">TracChangeset</a> — Viewing changes to source code. </li><li><a class="wiki" href="/wiki/TracRevisionLog">TracRevisionLog</a> — Viewing change history. </li></ul></li><li>Using the Ticket subsystem: <ul><li><a class="wiki" href="/wiki/TracTickets">TracTickets</a> — Using the issue tracker. </li><li><a class="wiki" href="/wiki/TracRoadmap">TracRoadmap</a> — Tracking project progress. </li><li><a class="wiki" href="/wiki/TracReports">TracReports</a> — Writing and using reports. </li><li><a class="wiki" href="/wiki/TracQuery">TracQuery</a> — Executing custom ticket queries. </li><li><a class="wiki" href="/wiki/TracBatchModify">TracBatchModify</a> - Modifying several tickets in one request. </li></ul></li><li>Other modules and general topics: <ul><li><a class="wiki" href="/wiki/TracSearch">TracSearch</a> — Full text search in all content. </li><li><a class="wiki" href="/wiki/TracTimeline">TracTimeline</a> — Historic perspective on a project. </li><li><a class="wiki" href="/wiki/TracRss">TracRss</a> — RSS content syndication. </li><li><a class="wiki" href="/wiki/TracAccessibility">TracAccessibility</a> — Accessibility keys. </li></ul></li></ul><h2 class="section" id="AdministratorGuide">Administrator Guide</h2> <ul><li>Installation and upgrade: <ul><li><a class="wiki" href="/wiki/TracInstall">TracInstall</a> — How to install and run Trac. </li><li><a class="wiki" href="/wiki/TracUpgrade">TracUpgrade</a> — How to upgrade existing installations. </li><li><a class="wiki" href="/wiki/TracImport">TracImport</a> — Importing tickets from other bug databases. </li><li><a class="wiki" href="/wiki/TracPlugins">TracPlugins</a> — Installing and managing Trac extensions. </li></ul></li><li>Configuration and customization: <ul><li><a class="wiki" href="/wiki/TracIni">TracIni</a> — Trac configuration file reference. </li><li><a class="wiki" href="/wiki/TracPermissions">TracPermissions</a> — Access control and permissions. </li><li><a class="wiki" href="/wiki/TracNavigation">TracNavigation</a> — Customize main navigation menus. </li><li><a class="wiki" href="/wiki/TracInterfaceCustomization">TracInterfaceCustomization</a> — Customizing the Trac interface. </li><li><a class="wiki" href="/wiki/TracLogging">TracLogging</a> — The Trac logging facility. </li></ul></li><li>Administering the Version Control subsystem: <ul><li><a class="wiki" href="/wiki/TracRepositoryAdmin">TracRepositoryAdmin</a> — Management of Source Code Repositories. </li></ul></li><li>Administering the Ticket subsystem: <ul><li><a class="wiki" href="/wiki/TracTicketsCustomFields">TracTicketsCustomFields</a> — Expanding tickets with customized fields. </li><li><a class="wiki" href="/wiki/TracNotification">TracNotification</a> — Email notification. </li><li><a class="wiki" href="/wiki/TracWorkflow">TracWorkflow</a> — Configurable Ticket Workflow. </li></ul></li><li>Reference: <ul><li><a class="wiki" href="/wiki/TracEnvironment">TracEnvironment</a> — All you need to know about Trac environments. </li><li><a class="wiki" href="/wiki/TracAdmin">TracAdmin</a> — Administering a Trac project via the command-line. </li></ul></li></ul><h2 class="section" id="SupportandOtherSourcesofInformation">Support and Other Sources of Information</h2> <ul><li><a href="https://trac.edgewall.org/intertrac/TracFaq" title="TracFaq in The Trac Project">Trac FAQ</a> — A collection of Frequently Asked Questions on the project website. </li><li><a href="https://trac.edgewall.org/intertrac/TracDev" title="TracDev in The Trac Project">TracDev</a> and <a href="https://trac.edgewall.org/intertrac/TracDev/ApiDocs" title="TracDev/ApiDocs in The Trac Project">API docs</a> — Trac Developer documentation. </li><li><a class="wiki" href="/wiki/TracSupport">TracSupport</a> — How to get more information. </li></ul><p> If you are looking for a good place to ask a question about Trac, see the <a href="https://trac.edgewall.org/intertrac/MailingList" title="MailingList in The Trac Project">MailingList</a>. It provides a friendly environment to discuss openly among Trac users and developers. </p> </div> <div class="trac-modifiedby"> <span> <a href="/wiki/TracGuide?action=diff&version=71" title="Version 71 by trac">Last modified</a> <a class="timeline" href="/timeline?from=2019-10-15T06%3A36%3A03%2B02%3A00&precision=second" title="See timeline at Oct 15, 2019, 6:36:03 AM">5 years ago</a> </span> <span class="trac-print"> Last modified on Oct 15, 2019, 6:36:03 AM </span> </div> </div> <div id="attachments"> </div> <div class="buttons"> <form method="get" action="/wiki/TracGuide" id="modifypage"> <div> <input type="hidden" name="action" value="edit" /> <input type="submit" value="Edit this page" /> </div> </form> <form method="get" action="/attachment/wiki/TracGuide/" id="attachfile"> <div> <input type="hidden" name="action" value="new" /> <input type="submit" id="attachfilebutton" value="Attach file"/> </div> </form> </div> <div class="trac-help"> <strong>Note:</strong> See <a href="/wiki/TracWiki">TracWiki</a> for help on using the wiki. </div> </div>  <div id="altlinks"> <h3>Download in other formats:</h3> <ul> <li class="last first"> <a rel="nofollow" href="/wiki/TracGuide?format=txt" class=""> Plain Text</a> </li> </ul> </div>   </div> <div id="footer"><hr/> <a id="tracpowered" href="https://trac.edgewall.org/" ><img src="/chrome/common/trac_logo_mini.png" height="30" width="107" alt="Trac Powered"/></a> <p class="left"> Powered by <a href="/about"><strong>Trac 1.4.3</strong></a> <br /> By <a href="http://www.edgewall.org/">Edgewall Software</a> . </p> <p class="right">Visit the Trac open source project at<br /><a href="//trac.edgewall.org/">https://trac.edgewall.org/</a></p> </div>   </div> </div> </div> <div id="ew-footer"> <p><a href="mailto:info@edgewall.com">info@edgewall.com</a></p> <p>Copyright © 2003-2024 Edgewall Software. All rights reserved.</p> </div> <div id="right"> <div id="ohloh-badge"> <a href="//www.openhub.net/p/trac"> <img src="//www.openhub.net/p/trac/widgets/project_thin_badge.gif" /> </a> </div> <script type="text/javascript"></script> <script type="text/javascript" src="//pagead2.googlesyndication.com/pagead/show_ads.js"> </script> </div>    </body> </html>

CINXE.COM

TracGuide – The Trac Project