Version 1 から Version 2 における更新: TracIni

Timestamp:

Nov 29, 2010, 3:25:29 PM (13 years 前)

Author:

trac (IP: 127.0.0.1)

Comment:

--

TracIni

@@ -1 @@
-= Trac 設定ファイル = #TheTracConfigurationFile
-
+= The Trac Configuration File =
 [[TracGuideToc]]
 
-== グローバルな設定 == #GlobalConfiguration
+Trac 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.
 
-0.11 より前のバージョンでは、グローバルな設定は `$prefix/share/trac/conf/trac.ini` か、ディストリビューションによっては `/etc/trac/trac.ini` がデフォルトの位置として配置されていました。アップグレードする場合は、設定を継承するファイルを明示しなければなりません。
+The `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.
 
-グローバルな設定は Environment 固有の設定とマージされます。ローカルの設定はグローバルの設定を上書きます。グローバルな設定ファイルは以下の通り指定します:
+== Global Configuration ==
+
+In 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.
+
+Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows:
 {{{
 [inherit]
-file = /usr/share/trac/conf/trac.ini
+file = /path/to/global/trac.ini
 }}}
+Multiple files can be specified using a comma-separated list.
 
-Note: 新しいプロジェクトを作る時に [TracAdmin trac-admin] の `initenv` コマンドに
-`--inherit=/path/to/global/options` オプションを追加することで、グローバル設定ファイルを指定することができます。
-オプションを追加せずにプロジェクトを作成した場合でも、新しい Environment でグローバル設定ファイルを使用することができます。
-新しく作成された conf/trac.ini ファイルを編集して、グローバルファイルの設定で上書きしたいエントリを削除すれば、
-新しい Environment でグローバル設定ファイルを使用することができます。
+Note 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.
 
+There 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.
 
-== リファレンス == #Reference
+== Reference for settings
 
-現在利用できる設定項目のリファレンスです。
+This is a brief reference of available configuration options.
 
-[[TracIni()]]
+[[TracIni]]
 
+== Reference for special sections
+[[PageOutline(3,,inline)]]
 
-== [components] == #components-section
-このセクションは Trac 本体も含めて、プラグインによって提供されるコンポーネントの有効/無効を設定するために使います。有効/無効を設定するコンポーネントは、オプションの名前 (`name`) を使って特定します。コンポーネントが有効かどうかはオプションの値 (`value`) によって決定されます; コンポーネントを有効にするには、値を `enabled` または `on` に設定します。他の値 (一般的には `disabled` または `off`) の場合、コンポーネントは無効になります。
+=== [components] === #components-section
+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.
 
-オプションの名前はコンポーネントの完全修飾名、もしくは、コンポーネントのモジュール/パッケージ プレフィックスとなっています。前者は 特定のコンポーネントの有効/無効を設定し、後者は特定のパッケージ/モジュール内のコンポーネントの有効/無効を設定します。
+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.
 
-以下の設定ファイルの抜粋を見てください:
+Consider the following configuration snippet:
 {{{
 [components]
@@ -39 +42 @@
 }}}
 
-最初のオプションは [wiki:TracReports レポートモジュール] を使用しないように Trac を設定しています。二つ目のオプションは `webadmin` パッケージのすべてのコンポーネントを使用できるように設定しています。末尾のワイルドカードはモジュール/パッケージのマッチを行う場合、必須です。
+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.
 
-アクティブなコンポーネントの一覧を取得するには、 ''Trac について'' (訳注: 英語版では ''About Trac'') の ''Plugins'' ページを参照してください。 (`CONFIG_VIEW` [wiki:TracPermissions パーミッション] が必要となります。)
+See the ''Plugins'' page on ''About Trac'' to get the list of active components (requires `CONFIG_VIEW` [wiki:TracPermissions permissions].)
 
 See also: TracPlugins
 
-== [ticket-custom] == #ticket-custom-section
+=== [milestone-groups] === #milestone-groups-section
+''(since 0.11)''
 
-このセクションでは、チケットに追加フィールドを定義することができます。詳しくは TracTicketsCustomFields を参照してください。
+As the workflow for tickets is now configurable, there can be many ticket states,
+and simply displaying closed tickets vs. all the others is maybe not appropriate 
+in all cases. This section enables one to easily create ''groups'' of states 
+that will be shown in different colors in the milestone progress bar.
 
-== [ticket-workflow] == #ticket-workflow-section
-''(0.11 以降)''
-
-チケットのワークフローはプラグインで制御します。
-デフォルトでは `ConfigurableTicketWorkflow` コンポーネントが制御を行います。
-このコンポーネントでは、 trac.ini ファイルのこのセクションでワークフローを設定することが可能です。
-詳細は TracWorkflow を参照してください。
-
-== [milestone-groups] == #milestone-groups-section
-''(0.11 以降)''
-
-今やチケットのワークフローは変更可能です。チケットステータスを数多く持つことができます。
-単に解決した (closed) チケットと、その他のチケットを対比して表示することが、すべてのケースで
-適切とは言えなくなりました。このセクションでは、簡単にステータスの ''グループ'' を作成ができます。
-グループはマイルストーンのプログレスバーで異なった色で表示させることができます。
-
-設定の例 (デフォルトの場合):
+Example configuration (the default only has closed and active):
 {{{
 closed = closed
-closed.order = 0                     # プログレスバーでの表示順序
-closed.query_args = group=resolution # カスタムクエリへのリンクに渡すパラメータ (非必須)
-closed.overall_completion = true     # マイルストーンの進捗の計上に含めるか否か
+# sequence number in the progress bar
+closed.order = 0
+# optional extra param for the query (two additional columns: created and modified and sort on created)
+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
+# indicates groups that count for overall completion 
+closed.overall_completion = truepercentage
 
-active = *                           # キャッチオールグループを 1 つ許容
-active.order = 1
-active.css_class = open              # このグループに付与する CSS のクラス
-active.label = in progress           # このグループを表示するときに使用するラベル
+new = new
+new.order = 1
+new.css_class = new
+new.label = new
+
+# one catch-all group is allowed
+active = *
+active.order = 2
+# CSS class for this interval
+active.css_class = open
+# Displayed label for this group
+active.label = in progress
 }}}
 
-グループの定義は、含めるステータスをカンマ区切りのリストにして構成します。
-また、 '*' はあらゆるステータスを意味し、残りのすべてのステータスをキャッチオールグループに
-関連付けます。
+The definition consists in a comma-separated list of accepted status.
+Also, '*' means any status and could be used to associate all remaining
+states to one catch-all group.
 
-CSS クラスは次のいずれかを設定します: new (黄色), open (無色), closed (緑色)。
-新しくスタイルを追加するには、以下のセレクタを使用します:
-`table.progress td.<class>`
+The CSS class can be one of: new (yellow), open (no color) or
+closed (green). New styles can easily be added using the following
+selector:  `table.progress td.<class>`
 
-== [svn:externals] == #svn:externals-section
-''(0.11 以降)''
+=== [repositories] === #repositories-section
 
-Subversion 向けの TracBrowser は、フォルダの `svn:externals` 属性を解釈できます。
-しかしながら、外部リソースが `http:` プロトコルを使用して ''いない'' 場合や、リンクを異なるリポジトリブラウザ (別の Trac や [http://www.viewvc.org/ ViewVC] のような) に向けたい場合、 Trac に external のプレフィックスと外部の URL のマップを設定しなければなりません。
+(''since 0.12'' multirepos)
 
-このマッピングは TracIni の `[svn:externals]` セクションで設定します。
+One of the alternatives for registering new repositories is to populate the `[repositories]` section of the trac.ini.
 
-例:
+This is especially suited for setting up convenience aliases, short-lived repositories, or during the initial phases of an installation.
+
+See [TracRepositoryAdmin#Intrac.ini TracRepositoryAdmin] for details about the format adopted for this section and the rest of that page for the other alternatives.
+
+=== [svn:externals] === #svn:externals-section
+''(since 0.11)''
+
+The TracBrowser for Subversion can interpret the `svn:externals` property of folders.
+By default, it only turns the URLs into links as Trac can't browse remote repositories.
+
+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.
+
+This mapping is done in the `[svn:externals]` section of the TracIni
+
+Example:
 {{{
 [svn:externals]
-1 = svn://server/repos1 http://trac/proj1/browser/$path?rev=$rev
-2 = svn://server/repos2 http://trac/proj2/browser/$path?rev=$rev
+1 = svn://server/repos1                       http://trac/proj1/browser/$path?rev=$rev
+2 = svn://server/repos2                       http://trac/proj2/browser/$path?rev=$rev
 3 = http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914
-4 = svn://anotherserver.com/tools_repository  http://ourserver/trac/support/browser/$path?rev=$rev
+4 = svn://anotherserver.com/tools_repository  http://ourserver/tracs/tools/browser/$path?rev=$rev
 }}}
-上記では、 `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] を参照してください) 。
+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).
 
-Note: 番号はセクション内でのキー項目としてだけ使用されます。 URL 自身はキー項目として扱うことが出来ないという、設定ファイルのパーサの制限事項を回避するためです。
+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.
+
+Finally, the relative URLs introduced in [http://subversion.tigris.org/svn_1.5_releasenotes.html#externals Subversion 1.5] are not yet supported.
+
+=== [ticket-custom] === #ticket-custom-section
+
+In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details.
+
+=== [ticket-workflow] === #ticket-workflow-section
+''(since 0.11)''
+
+The workflow for tickets is controlled by plugins. 
+By default, there's only a `ConfigurableTicketWorkflow` component in charge. 
+That component allows the workflow to be configured via this section in the trac.ini file.
+See TracWorkflow for more details.
+
 
 ----