Edgewall Software

Changes between Version 192 and Version 193 of TracIni


Ignore:
Timestamp:
Aug 21, 2012, 3:28:52 PM (12 years ago)
Author:
Jun Omae
Comment:

Removed special sections defined by ConfigSection. [[TracIni]] macro shows these sections, however [extra-permissions] section isn't defiend.

Legend:

Unmodified
Added
Removed
Modified
  • TracIni

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