Changes between Version 1 and Version 2 of TracIni


Ignore:
Timestamp:
Jan 5, 2015 9:18:11 PM (10 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracIni

    v1 v2  
    1 = Trac 設定ファイル = #TheTracConfigurationFile 
     1= The Trac Configuration File = 
     2 
    23[[TracGuideToc]] 
    34 
    4 Trac の設定は `<projectenv>/conf/` にある '''`trac.ini`''' というファイルを編集して行います。変更した内容は通常、即座に反映されますが、 `[components]` セクションや `[logging]` セクションへの変更では Web サーバを再起動する必要があります。また、グローバルな設定ファイルを新しく作成した直後も Web サーバを再起動しなければなりません。 
     5Trac configuration is done by editing the '''`trac.ini`''' config file, located in `<projectenv>/conf/trac.ini`.  Changes to the configuration are usually reflected immediately, though changes to the `[components]` or `[logging]` sections will require restarting the web server. You may also need to restart the web server after creating a global configuration file when none was previously present. 
    56 
    6 == グローバルな設定 == #GlobalConfiguration 
     7The `trac.ini` configuration file should be writable by the web server, as Trac currently relies on the possibility to trigger a complete environment reload to flush its caches. 
    78 
    8 0.11 より前のバージョンでは、グローバルな設定は `$prefix/share/trac/conf/trac.ini` か、ディストリビューションによっては `/etc/trac/trac.ini` がデフォルトの位置として配置されていました。アップグレードする場合は、設定を継承するファイルを明示しなければなりません。 
    9 以前のバージョンから 0.11 にアップグレードした場合、プロジェクトの `trac.ini` ファイルに `inherit` セクションを追加しなければなりません。カスタマイズしたテンプレートや画像のファイルは `$prefix/share/trac/...` から他の場所に移動することもできます。 
     9== Global Configuration == 
    1010 
    11 グローバルな設定は Environment 固有の設定とマージされます。ローカルの設定はグローバルの設定を上書きます。グローバルな設定ファイルは以下のように指定します: 
     11In versions prior to 0.11, the global configuration was by default located in `$prefix/share/trac/conf/trac.ini` or /etc/trac/trac.ini, depending on the distribution. If you're upgrading, you may want to specify that file to inherit from.  Literally, when you're upgrading to 0.11, you have to add an `[inherit]` section to your project's `trac.ini` file. Additionally, you have to move your customized templates and common images from `$prefix/share/trac/...` to the new location. 
     12 
     13Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows: 
    1214{{{ 
    1315[inherit] 
    14 file = /usr/share/trac/conf/trac.ini 
     16file = /path/to/global/trac.ini 
    1517}}} 
     18Multiple files can be specified using a comma-separated list. 
    1619 
    17 Note: 新しいプロジェクトを作る時に [TracAdmin trac-admin] の `initenv` コマンドに 
    18 `--inherit=/path/to/global/options` オプションを追加することで、グローバル設定ファイルを指定することができます。 
    19 オプションを追加せずにプロジェクトを作成した場合でも、新しい Environment でグローバル設定ファイルを使用することができます。 
    20 新しく作成された conf/trac.ini ファイルを編集して、グローバルファイルの設定で上書きしたいエントリを削除すれば、 
    21 新しい Environment でグローバル設定ファイルを使用することができます。 
     20Note 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. 
    2221 
     22There 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. 
    2323 
    24 == リファレンス == #Reference 
     24Note that the templates found in the `templates/` directory of the TracEnvironment have precedence over those found in `[inherit] templates_dir`. In turn, the latter have precedence over the installed templates, so be careful about what you put there, notably if you override a default template be sure to refresh your modifications when you upgrade to a new version of Trac (the preferred way to perform TracInterfaceCustomization being still to write a custom plugin doing an appropriate `ITemplateStreamFilter` transformation). 
    2525 
    26 現在利用できる設定項目のリファレンスです。 
     26== Reference for settings 
    2727 
    28 [[TracIni()]] 
     28This is a brief reference of available configuration options, and their default settings. 
    2929 
     30[[TracIni]] 
    3031 
    31 == [components] == #components-section 
    32 このセクションは Trac 本体も含めて、プラグインによって提供されるコンポーネントの有効/無効を設定するために使います。有効/無効を設定するコンポーネントは、オプションの名前 (`name`) を使って特定します。コンポーネントが有効かどうかはオプションの値 (`value`) によって決定されます; コンポーネントを有効にするには、値を `enabled` または `on` に設定します。他の値 (一般的には `disabled` または `off`) の場合、コンポーネントは無効になります。 
     32== Reference for special sections 
     33[[PageOutline(3,,inline)]] 
    3334 
    34 オプションの名前はコンポーネントの完全修飾名、もしくは、コンポーネントのモジュール/パッケージ プレフィックスとなっています。前者は 特定のコンポーネントの有効/無効を設定し、後者は特定のパッケージ/モジュール内のコンポーネントの有効/無効を設定します。 
     35=== [components] === #components-section 
     36This 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. 
    3537 
    36 以下の設定ファイルの抜粋を見てください: 
     38The 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. 
     39 
     40Consider the following configuration snippet: 
    3741{{{ 
    3842[components] 
    … …  
    4145}}} 
    4246 
    43 最初のオプションは [wiki:TracReports レポートモジュール] を使用しないように Trac を設定しています。二つ目のオプションは `webadmin` パッケージのすべてのコンポーネントを使用できるように設定しています。末尾のワイルドカードはモジュール/パッケージのマッチを行う場合、必須です。 
     47The 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. 
    4448 
    45 アクティブなコンポーネントの一覧を取得するには、 ''Trac について'' (訳注: 英語版では ''About Trac'') の ''Plugins'' ページを参照してください。 (`CONFIG_VIEW` [wiki:TracPermissions パーミッション] が必要となります。) 
     49See the ''Plugins'' page on ''About Trac'' to get the list of active components (requires `CONFIG_VIEW` [wiki:TracPermissions permissions].) 
    4650 
    4751See also: TracPlugins 
    4852 
    49 == [ticket-custom] == #ticket-custom-section 
     53=== [milestone-groups] === #milestone-groups-section 
     54''(since 0.11)'' 
    5055 
    51 このセクションでは、チケットに追加フィールドを定義することができます。詳しくは TracTicketsCustomFields を参照してください。 
     56As the workflow for tickets is now configurable, there can be many ticket states, 
     57and simply displaying closed tickets vs. all the others is maybe not appropriate  
     58in all cases. This section enables one to easily create ''groups'' of states  
     59that will be shown in different colors in the milestone progress bar. 
    5260 
    53 == [ticket-workflow] == #ticket-workflow-section 
    54 ''(0.11 以降)'' 
    55  
    56 チケットのワークフローはプラグインで制御します。 
    57 デフォルトでは `ConfigurableTicketWorkflow` コンポーネントが制御を行います。 
    58 このコンポーネントでは、 trac.ini ファイルのこのセクションでワークフローを設定することが可能です。 
    59 詳細は TracWorkflow を参照してください。 
    60  
    61 == [milestone-groups] == #milestone-groups-section 
    62 ''(0.11 以降)'' 
    63  
    64 今やチケットのワークフローは変更可能です。チケットステータスを数多く持つことができます。 
    65 単に解決した (closed) チケットと、その他のチケットを対比して表示することが、すべてのケースで 
    66 適切とは言えなくなりました。このセクションでは、簡単にステータスの ''グループ'' を作成ができます。 
    67 グループはマイルストーンのプログレスバーで異なった色で表示させることができます。 
    68  
    69 設定の例 (closed と active しか持たない場合): 
     61Example configuration (the default only has closed and active): 
    7062{{{ 
    7163closed = closed 
    72 closed.order = 0                     # プログレスバーでの表示順序 
    73 closed.query_args = group=resolution # カスタムクエリへのリンクに渡すパラメータ (非必須) 
    74 closed.overall_completion = true     # このグループのチケット数をマイルストーンの完了パーセンテージに計上する 
     64# sequence number in the progress bar 
     65closed.order = 0 
     66# optional extra param for the query (two additional columns: created and modified and sort on created) 
     67closed.query_args = group=resolution,order=time,col=id,col=summary,col=owner,col=type,col=priority,col=component,col=severity,col=time,col=changetime 
     68# indicates groups that count for overall completion percentage 
     69closed.overall_completion = true 
    7570 
    7671new = new 
    … …  
    7974new.label = new 
    8075 
    81 active = *                           # キャッチオールグループを 1 つ許容 
    82 active.order = 1 
    83 active.css_class = open              # このグループに付与する CSS のクラス 
    84 active.label = in progress           # このグループを表示するときに使用するラベル 
     76# one catch-all group is allowed 
     77active = * 
     78active.order = 2 
     79# CSS class for this interval 
     80active.css_class = open 
     81# Displayed label for this group 
     82active.label = in progress 
    8583}}} 
    8684 
    87 グループの定義は、含めるステータスをカンマ区切りのリストにして構成します。 
    88 また、 '*' はあらゆるステータスを意味し、残りのすべてのステータスをキャッチオールグループに 
    89 関連付けます。 
     85The definition consists in a comma-separated list of accepted status. 
     86Also, '*' means any status and could be used to associate all remaining 
     87states to one catch-all group. 
    9088 
    91 CSS クラスは次のいずれかを設定します: new (黄色), open (無色), closed (緑色)。 
    92 新しくスタイルを追加するには、以下のセレクタを使用します: 
    93 `table.progress td.<class>` 
     89The CSS class can be one of: new (yellow), open (no color) or 
     90closed (green). New styles can easily be added using the following 
     91selector:  `table.progress td.<class>` 
    9492 
    95 == [svn:externals] == #svn:externals-section 
    96 ''(0.11 以降)'' 
     93=== [repositories] === #repositories-section 
    9794 
    98 Subversion 向けの TracBrowser は、フォルダの `svn:externals` 属性を解釈できます。 
    99 しかしながら、外部リソースが `http:` プロトコルを使用して ''いない'' 場合や、リンクを異なるリポジトリブラウザ (別の Trac や [http://www.viewvc.org/ ViewVC] のような) に向けたい場合、 Trac に external のプレフィックスと外部の URL のマップを設定しなければなりません。 
     95(''since 0.12'' multirepos) 
    10096 
    101 このマッピングは TracIni の `[svn:externals]` セクションで設定します。 
     97One of the alternatives for registering new repositories is to populate the `[repositories]` section of the trac.ini. 
    10298 
    103 例: 
     99This is especially suited for setting up convenience aliases, short-lived repositories, or during the initial phases of an installation. 
     100 
     101See [TracRepositoryAdmin#Intrac.ini TracRepositoryAdmin] for details about the format adopted for this section and the rest of that page for the other alternatives. 
     102 
     103=== [svn:externals] === #svn:externals-section 
     104''(since 0.11)'' 
     105 
     106The TracBrowser for Subversion can interpret the `svn:externals` property of folders. 
     107By default, it only turns the URLs into links as Trac can't browse remote repositories. 
     108 
     109However, 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. 
     110 
     111This mapping is done in the `[svn:externals]` section of the TracIni 
     112 
     113Example: 
    104114{{{ 
    105115[svn:externals] 
    106 1 = svn://server/repos1 http://trac/proj1/browser/$path?rev=$rev 
    107 2 = svn://server/repos2 http://trac/proj2/browser/$path?rev=$rev 
     1161 = svn://server/repos1                       http://trac/proj1/browser/$path?rev=$rev 
     1172 = svn://server/repos2                       http://trac/proj2/browser/$path?rev=$rev 
    1081183 = http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914 
    109 4 = svn://anotherserver.com/tools_repository  http://ourserver/trac/support/browser/$path?rev=$rev 
     1194 = svn://anotherserver.com/tools_repository  http://ourserver/tracs/tools/browser/$path?rev=$rev 
    110120}}} 
    111 上記では、 `svn://anotherserver.com/tools_repository/tags/1.1/tools` という external は `http://ourserver/trac/support/browser/tags/1.1/tools?rev=` にマップされます (`rev` は、 external にリビジョンが指定された場合、適切なリビジョン番号に設定されます。詳細は [http://svnbook.red-bean.com/en/1.4/svn.advanced.externals.html SVN Book の externals] を参照してください) 。 
     121With 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). 
    112122 
    113 Note: 番号はセクション内でのキー項目としてだけ使用されます。 URL 自身はキー項目として扱うことが出来ないという、設定ファイルのパーサの制限事項を回避するためです。 
     123Note 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. 
     124 
     125Finally, the relative URLs introduced in [http://subversion.tigris.org/svn_1.5_releasenotes.html#externals Subversion 1.5] are not yet supported. 
     126 
     127=== [ticket-custom] === #ticket-custom-section 
     128 
     129In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details. 
     130 
     131=== [ticket-workflow] === #ticket-workflow-section 
     132''(since 0.11)'' 
     133 
     134The workflow for tickets is controlled by plugins.  
     135By default, there's only a `ConfigurableTicketWorkflow` component in charge.  
     136That component allows the workflow to be configured via this section in the trac.ini file. 
     137See TracWorkflow for more details. 
    114138 
    115139----