| 33 | | |
| 34 | | == Reference for special sections |
| 35 | | [[PageOutline(3,,inline)]] |
| 36 | | |
| 37 | | === [components] === #components-section |
| 38 | | 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. |
| 39 | | |
| 40 | | 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. |
| 41 | | |
| 42 | | Consider the following configuration snippet: |
| 43 | | {{{ |
| 44 | | [components] |
| 45 | | trac.ticket.report.ReportModule = disabled |
| 46 | | webadmin.* = enabled |
| 47 | | }}} |
| 48 | | |
| 49 | | 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. |
| 50 | | |
| 51 | | See the ''Plugins'' page on ''About Trac'' to get the list of active components (requires `CONFIG_VIEW` [wiki:TracPermissions permissions].) |
| 52 | | |
| 53 | | See also: TracPlugins |
| 54 | | |
| 55 | | === [milestone-groups] === #milestone-groups-section |
| 56 | | ''(since 0.11)'' |
| 57 | | |
| 58 | | As the workflow for tickets is now configurable, there can be many ticket states, |
| 59 | | and simply displaying closed tickets vs. all the others is maybe not appropriate |
| 60 | | in all cases. This section enables one to easily create ''groups'' of states |
| 61 | | that will be shown in different colors in the milestone progress bar. |
| 62 | | |
| 63 | | Example configuration (the default only has closed and active): |
| 64 | | {{{ |
| 65 | | closed = closed |
| 66 | | # sequence number in the progress bar |
| 67 | | closed.order = 0 |
| 68 | | # optional extra param for the query (two additional columns: created and modified and sort on created) |
| 69 | | 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 |
| 70 | | # indicates groups that count for overall completion percentage |
| 71 | | closed.overall_completion = true |
| 72 | | |
| 73 | | new = new |
| 74 | | new.order = 1 |
| 75 | | new.css_class = new |
| 76 | | new.label = new |
| 77 | | |
| 78 | | # one catch-all group is allowed |
| 79 | | active = * |
| 80 | | active.order = 2 |
| 81 | | # CSS class for this interval |
| 82 | | active.css_class = open |
| 83 | | # Displayed label for this group |
| 84 | | active.label = in progress |
| 85 | | }}} |
| 86 | | |
| 87 | | The definition consists in a comma-separated list of accepted status. |
| 88 | | Also, '*' means any status and could be used to associate all remaining |
| 89 | | states to one catch-all group. |
| 90 | | |
| 91 | | The CSS class can be one of: new (yellow), open (no color) or |
| 92 | | closed (green). New styles can easily be added using the following |
| 93 | | selector: `table.progress td.<class>` |
| 94 | | |
| 95 | | === [repositories] === #repositories-section |
| 96 | | |
| 97 | | (''since 0.12'' multirepos) |
| 98 | | |
| 99 | | One of the alternatives for registering new repositories is to populate the `[repositories]` section of the trac.ini. |
| 100 | | |
| 101 | | This is especially suited for setting up convenience aliases, short-lived repositories, or during the initial phases of an installation. |
| 102 | | |
| 103 | | See [TracRepositoryAdmin#Intrac.ini TracRepositoryAdmin] for details about the format adopted for this section and the rest of that page for the other alternatives. |
| 104 | | |
| 105 | | === [svn:externals] === #svn:externals-section |
| 106 | | ''(since 0.11)'' |
| 107 | | |
| 108 | | The TracBrowser for Subversion can interpret the `svn:externals` property of folders. |
| 109 | | By default, it only turns the URLs into links as Trac can't browse remote repositories. |
| 110 | | |
| 111 | | 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. |
| 112 | | |
| 113 | | This mapping is done in the `[svn:externals]` section of the TracIni |
| 114 | | |
| 115 | | Example: |
| 116 | | {{{ |
| 117 | | [svn:externals] |
| 118 | | 1 = svn://server/repos1 http://trac/proj1/browser/$path?rev=$rev |
| 119 | | 2 = svn://server/repos2 http://trac/proj2/browser/$path?rev=$rev |
| 120 | | 3 = http://theirserver.org/svn/eng-soft http://ourserver/viewvc/svn/$path/?pathrev=25914 |
| 121 | | 4 = svn://anotherserver.com/tools_repository http://ourserver/tracs/tools/browser/$path?rev=$rev |
| 122 | | }}} |
| 123 | | 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). |
| 124 | | |
| 125 | | 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. |
| 126 | | |
| 127 | | Finally, the relative URLs introduced in [http://subversion.tigris.org/svn_1.5_releasenotes.html#externals Subversion 1.5] are not yet supported. |
| 128 | | |
| 129 | | === [ticket-custom] === #ticket-custom-section |
| 130 | | |
| 131 | | In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details. |
| 132 | | |
| 133 | | === [ticket-workflow] === #ticket-workflow-section |
| 134 | | ''(since 0.11)'' |
| 135 | | |
| 136 | | The workflow for tickets is controlled by plugins. |
| 137 | | By default, there's only a `ConfigurableTicketWorkflow` component in charge. |
| 138 | | That component allows the workflow to be configured via this section in the trac.ini file. |
| 139 | | See TracWorkflow for more details. |
