-= LiflForge =-

Changes between Version 3 and Version 4 of TracIni


Ignore:
Timestamp:
01/09/13 14:59:44 (7 years ago)
Author:
trac
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • TracIni

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