# Changes between Version 4 and Version 5 of TracIni

Ignore:
Timestamp:
Apr 18, 2013 10:02:31 AM (9 years ago)
Comment:

--

### Legend:

Unmodified
 v4 = The Trac Configuration File = ''[Note To Editors] Please discuss documentation changes in the [#Discussion] section. Even better, send us [TracDev/SubmittingPatches documentation patches] against the ''code'' (i.e. where the configuration entries are documented), either on Trac-dev or on new tickets. '' [[TracGuideToc]] [[TracIni]] == Reference for special sections [[PageOutline(3,,inline)]] === [components] === #components-section This section is used to enable or disable components provided by plugins, as well as by Trac itself. The component to enable/disable is specified via the name of the option. Whether its enabled is determined by the option value; setting the value to enabled or on will enable the component, any other value (typically disabled or off) will disable the component. The option name is either the fully qualified name of the components or the module/package prefix of the component. The former enables/disables a specific component, while the latter enables/disables any component in the specified package/module. Consider the following configuration snippet: {{{ [components] trac.ticket.report.ReportModule = disabled webadmin.* = enabled }}} The first option tells Trac to disable the [wiki:TracReports report module]. The second option instructs Trac to enable all components in the webadmin package. Note that the trailing wildcard is required for module/package matching. See the ''Plugins'' page on ''About Trac'' to get the list of active components (requires CONFIG_VIEW [wiki:TracPermissions permissions].) See also: TracPlugins === [extra-permissions] === #extra-permissions-section ''(since 0.12)'' Custom additional permissions can be defined in this section when [wiki:ExtraPermissionsProvider] is enabled. === [milestone-groups] === #milestone-groups-section ''(since 0.11)'' As the workflow for tickets is now configurable, there can be many ticket states, and simply displaying closed tickets vs. all the others is maybe not appropriate in all cases. This section enables one to easily create ''groups'' of states that will be shown in different colors in the milestone progress bar. Example configuration (the default only has closed and active): {{{ closed = closed # sequence number in the progress bar closed.order = 0 # optional extra param for the query (two additional columns: created and modified and sort on created) closed.query_args = group=resolution,order=time,col=id,col=summary,col=owner,col=type,col=priority,col=component,col=severity,col=time,col=changetime # indicates groups that count for overall completion percentage closed.overall_completion = true new = new new.order = 1 new.css_class = new new.label = new # one catch-all group is allowed active = * active.order = 2 # CSS class for this interval active.css_class = open # Displayed label for this group active.label = in progress }}} The definition consists in a comma-separated list of accepted status. Also, '*' means any status and could be used to associate all remaining states to one catch-all group. The CSS class can be one of: new (yellow), open (no color) or closed (green). New styles can easily be added using the following selector:  table.progress td. === [repositories] === #repositories-section (''since 0.12'' multirepos) One of the alternatives for registering new repositories is to populate the [repositories] section of the trac.ini. This is especially suited for setting up convenience aliases, short-lived repositories, or during the initial phases of an installation. See [TracRepositoryAdmin#Intrac.ini TracRepositoryAdmin] for details about the format adopted for this section and the rest of that page for the other alternatives. === [svn:externals] === #svn:externals-section ''(since 0.11)'' The TracBrowser for Subversion can interpret the svn:externals property of folders. By default, it only turns the URLs into links as Trac can't browse remote repositories. However, if you have another Trac instance (or an other repository browser like [http://www.viewvc.org/ ViewVC]) configured to browse the target repository, then you can instruct Trac which other repository browser to use for which external URL. This mapping is done in the [svn:externals] section of the TracIni Example: {{{ [svn:externals] 1 = svn://server/repos1                       http://trac/proj1/browser/$path?rev=$rev 2 = svn://server/repos2                       http://trac/proj2/browser/$path?rev=$rev 3 = http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914 4 = svn://anotherserver.com/tools_repository http://ourserver/tracs/tools/browser/$path?rev=\$rev }}} With the above, the svn://anotherserver.com/tools_repository/tags/1.1/tools external will be mapped to http://ourserver/tracs/tools/browser/tags/1.1/tools?rev= (and rev will be set to the appropriate revision number if the external additionally specifies a revision, see the [http://svnbook.red-bean.com/en/1.4/svn.advanced.externals.html SVN Book on externals] for more details). Note that the number used as a key in the above section is purely used as a place holder, as the URLs themselves can't be used as a key due to various limitations in the configuration file parser. Finally, the relative URLs introduced in [http://subversion.tigris.org/svn_1.5_releasenotes.html#externals Subversion 1.5] are not yet supported. === [ticket-custom] === #ticket-custom-section In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details. === [ticket-workflow] === #ticket-workflow-section ''(since 0.11)'' The workflow for tickets is controlled by plugins. By default, there's only a ConfigurableTicketWorkflow component in charge. That component allows the workflow to be configured via this section in the trac.ini file. See TracWorkflow for more details. ---- See also: TracGuide, TracAdmin, TracEnvironment