Changes between Version 4 and Version 5 of TracIni


Ignore:
Timestamp:
18/06/2010 11:33:50 (14 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracIni

    v4 v5  
    1313{{{
    1414[inherit]
    15 file = /usr/share/trac/conf/trac.ini
     15file = /path/to/global/trac.ini
    1616}}}
     17Multiple files can be specified using a comma-separated list.
    1718
    18 Note that you can also specify a global option file when creating a new project,  by adding the option `--inherit=/path/to/global/options` to [TracAdmin trac-admin]'s `initenv` command.  If do not do this but nevertheless intend to use a global option file with your new environment, you will have to go through the newly generated conf/trac.ini file and delete the entries that will otherwise override those set in the global file.
     19Note that you can also specify a global option file when creating a new project,  by adding the option `--inherit=/path/to/global/trac.ini` to [TracAdmin#initenv trac-admin]'s `initenv` command.  If you do not do this but nevertheless intend to use a global option file with your new environment, you will have to go through the newly generated `conf/trac.ini` file and delete the entries that will otherwise override those set in the global file.
    1920
     21There are two more entries in the [[#inherit-section| [inherit] ]] section, `templates_dir` for sharing global templates and `plugins_dir`, for sharing plugins. Those entries can themselves be specified in the shared configuration file, and in fact, configuration files can even be chained if you specify another `[inherit] file` there.
    2022
    21 == Reference ==
     23== Reference for settings
    2224
    2325This is a brief reference of available configuration options.
    2426
    25  ''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.''
     27[[TracIni]]
    2628
    27 [[TracIni()]]
     29== Reference for special sections
     30[[PageOutline(3,,inline)]]
    2831
    29 
    30 == [components] == #components-section
     32=== [components] === #components-section
    3133This 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.
    3234
     
    4648See also: TracPlugins
    4749
    48 == [ticket-custom] == #ticket-custom-section
    49 
    50 In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details.
    51 
    52 == [ticket-workflow] == #ticket-workflow-section
    53 ''(since 0.11)''
    54 
    55 The workflow for tickets is controlled by plugins.
    56 By default, there's only a `ConfigurableTicketWorkflow` component in charge.
    57 That component allows the workflow to be configured via this section in the trac.ini file.
    58 See TracWorkflow for more details.
    59 
    60 == [milestone-groups] == #milestone-groups-section
     50=== [milestone-groups] === #milestone-groups-section
    6151''(since 0.11)''
    6252
     
    7262closed.order = 0
    7363# optional extra param for the query (two additional columns: created and modified and sort on created)
    74 group=resolution,order=time,col=id,col=summary,col=owner,col=type,col=priority,col=component,col=severity,col=time,col=changetime
     64closed.query_args = group=resolution,order=time,col=id,col=summary,col=owner,col=type,col=priority,col=component,col=severity,col=time,col=changetime
    7565# indicates groups that count for overall completion
    7666closed.overall_completion = truepercentage
     
    9888selector:  `table.progress td.<class>`
    9989
    100 == [svn:externals] == #svn:externals-section
     90=== [repositories] === #repositories-section
     91
     92(''since 0.12'' multirepos)
     93
     94One of the alternatives for registering new repositories is to populate the `[repositories]` section of the trac.ini.
     95
     96This is especially suited for setting up convenience aliases, short-lived repositories, or during the initial phases of an installation.
     97
     98See [TracRepositoryAdmin#Intrac.ini TracRepositoryAdmin] for details about the format adopted for this section and the rest of that page for the other alternatives.
     99
     100=== [svn:externals] === #svn:externals-section
    101101''(since 0.11)''
    102102
    103 The TracBrowser for Subversion can interpret the `svn:externals` property of folders out of the box.
    104 However, if those externals are ''not'' using the `http:` or `https:` protocol, or if a link to a different repository browser such as another Trac or [http://www.viewvc.org/ ViewVC] is desired, then Trac needs to be able to map an external prefix to this other URL.
     103The TracBrowser for Subversion can interpret the `svn:externals` property of folders.
     104By default, it only turns the URLs into links as Trac can't browse remote repositories.
     105
     106However, 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.
    105107
    106108This mapping is done in the `[svn:externals]` section of the TracIni
     
    109111{{{
    110112[svn:externals]
    111 1 = svn://server/repos1 http://trac/proj1/browser/$path?rev=$rev
    112 2 = svn://server/repos2 http://trac/proj2/browser/$path?rev=$rev
     1131 = svn://server/repos1                       http://trac/proj1/browser/$path?rev=$rev
     1142 = svn://server/repos2                       http://trac/proj2/browser/$path?rev=$rev
    1131153 = http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914
    1141164 = svn://anotherserver.com/tools_repository  http://ourserver/tracs/tools/browser/$path?rev=$rev
     
    120122Finally, the relative URLs introduced in [http://subversion.tigris.org/svn_1.5_releasenotes.html#externals Subversion 1.5] are not yet supported.
    121123
     124=== [ticket-custom] === #ticket-custom-section
     125
     126In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details.
     127
     128=== [ticket-workflow] === #ticket-workflow-section
     129''(since 0.11)''
     130
     131The workflow for tickets is controlled by plugins.
     132By default, there's only a `ConfigurableTicketWorkflow` component in charge.
     133That component allows the workflow to be configured via this section in the trac.ini file.
     134See TracWorkflow for more details.
     135
     136
    122137----
    123138See also: TracGuide, TracAdmin, TracEnvironment