Changes between Version 1 and Version 2 of TracIni
- Timestamp:
- Jul 30, 2013, 8:39:06 PM (11 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracIni
v1 v2 1 = Trac 設定ファイル = #TheTracConfigurationFile 1 = The Trac Configuration File = 2 3 ''[Note To Editors] Please discuss documentation changes in the [#Discussion] section. Even better, send us [TracDev/SubmittingPatches documentation patches] against the ''code'' (i.e. where the configuration entries are documented), either on Trac-dev or on new tickets. '' 4 2 5 [[TracGuideToc]] 6 [[PageOutline]] 3 7 4 Trac の設定は `<projectenv>/conf/` にある '''`trac.ini`''' というファイルを編集して行います。変更した内容は通常、即座に反映されますが、 `[components]` セクションや `[logging]` セクションへの変更では Web サーバを再起動する必要があります。また、グローバルな設定ファイルを新しく作成した直後も Web サーバを再起動しなければなりません。8 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. 5 9 6 == グローバルな設定 == #GlobalConfiguration 10 The `trac.ini` configuration file and its parent directory should be writable by the web server, as Trac currently relies on the possibility to trigger a complete environment reload to flush its caches. 7 11 8 0.11 より前のバージョンでは、グローバルな設定は `$prefix/share/trac/conf/trac.ini` か、ディストリビューションによっては `/etc/trac/trac.ini` がデフォルトの位置として配置されていました。アップグレードする場合は、設定を継承するファイルを明示しなければなりません。 9 以前のバージョンから 0.11 にアップグレードした場合、プロジェクトの `trac.ini` ファイルに `inherit` セクションを追加しなければなりません。カスタマイズしたテンプレートや画像のファイルは `$prefix/share/trac/...` から他の場所に移動することもできます。 12 == Global Configuration == 10 13 11 グローバルな設定は Environment 固有の設定とマージされます。ローカルの設定はグローバルの設定を上書きます。グローバルな設定ファイルは以下のように指定します: 14 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. 15 16 Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows: 12 17 {{{ 13 18 [inherit] 14 file = / usr/share/trac/conf/trac.ini19 file = /path/to/global/trac.ini 15 20 }}} 21 Multiple files can be specified using a comma-separated list. 16 22 17 Note: 新しいプロジェクトを作る時に [TracAdmin trac-admin] の `initenv` コマンドに 18 `--inherit=/path/to/global/options` オプションを追加することで、グローバル設定ファイルを指定することができます。 19 オプションを追加せずにプロジェクトを作成した場合でも、新しい Environment でグローバル設定ファイルを使用することができます。 20 新しく作成された conf/trac.ini ファイルを編集して、グローバルファイルの設定で上書きしたいエントリを削除すれば、 21 新しい Environment でグローバル設定ファイルを使用することができます。 23 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. 22 24 25 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. 23 26 24 == リファレンス == #Reference 27 Note 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). 25 28 26 現在利用できる設定項目のリファレンスです。 29 == Reference for settings 27 30 28 [[TracIni()]] 31 This is a brief reference of available configuration options, and their default settings. 29 32 30 31 == [components] == #components-section 32 このセクションは Trac 本体も含めて、プラグインによって提供されるコンポーネントの有効/無効を設定するために使います。有効/無効を設定するコンポーネントは、オプションの名前 (`name`) を使って特定します。コンポーネントが有効かどうかはオプションの値 (`value`) によって決定されます; コンポーネントを有効にするには、値を `enabled` または `on` に設定します。他の値 (一般的には `disabled` または `off`) の場合、コンポーネントは無効になります。 33 34 オプションの名前はコンポーネントの完全修飾名、もしくは、コンポーネントのモジュール/パッケージ プレフィックスとなっています。前者は 特定のコンポーネントの有効/無効を設定し、後者は特定のパッケージ/モジュール内のコンポーネントの有効/無効を設定します。 35 36 以下の設定ファイルの抜粋を見てください: 37 {{{ 38 [components] 39 trac.ticket.report.ReportModule = disabled 40 webadmin.* = enabled 41 }}} 42 43 最初のオプションは [wiki:TracReports レポートモジュール] を使用しないように Trac を設定しています。二つ目のオプションは `webadmin` パッケージのすべてのコンポーネントを使用できるように設定しています。末尾のワイルドカードはモジュール/パッケージのマッチを行う場合、必須です。 44 45 アクティブなコンポーネントの一覧を取得するには、 ''Trac について'' (訳注: 英語版では ''About Trac'') の ''Plugins'' ページを参照してください。 (`CONFIG_VIEW` [wiki:TracPermissions パーミッション] が必要となります。) 46 47 See also: TracPlugins 48 49 == [ticket-custom] == #ticket-custom-section 50 51 このセクションでは、チケットに追加フィールドを定義することができます。詳しくは TracTicketsCustomFields を参照してください。 52 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 しか持たない場合): 70 {{{ 71 closed = closed 72 closed.order = 0 # プログレスバーでの表示順序 73 closed.query_args = group=resolution # カスタムクエリへのリンクに渡すパラメータ (非必須) 74 closed.overall_completion = true # このグループのチケット数をマイルストーンの完了パーセンテージに計上する 75 76 new = new 77 new.order = 1 78 new.css_class = new 79 new.label = new 80 81 active = * # キャッチオールグループを 1 つ許容 82 active.order = 1 83 active.css_class = open # このグループに付与する CSS のクラス 84 active.label = in progress # このグループを表示するときに使用するラベル 85 }}} 86 87 グループの定義は、含めるステータスをカンマ区切りのリストにして構成します。 88 また、 '*' はあらゆるステータスを意味し、残りのすべてのステータスをキャッチオールグループに 89 関連付けます。 90 91 CSS クラスは次のいずれかを設定します: new (黄色), open (無色), closed (緑色)。 92 新しくスタイルを追加するには、以下のセレクタを使用します: 93 `table.progress td.<class>` 94 95 == [svn:externals] == #svn:externals-section 96 ''(0.11 以降)'' 97 98 Subversion 向けの TracBrowser は、フォルダの `svn:externals` 属性を解釈できます。 99 しかしながら、外部リソースが `http:` プロトコルを使用して ''いない'' 場合や、リンクを異なるリポジトリブラウザ (別の Trac や [http://www.viewvc.org/ ViewVC] のような) に向けたい場合、 Trac に external のプレフィックスと外部の URL のマップを設定しなければなりません。 100 101 このマッピングは TracIni の `[svn:externals]` セクションで設定します。 102 103 例: 104 {{{ 105 [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 108 3 = 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 110 }}} 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] を参照してください) 。 112 113 Note: 番号はセクション内でのキー項目としてだけ使用されます。 URL 自身はキー項目として扱うことが出来ないという、設定ファイルのパーサの制限事項を回避するためです。 33 [[TracIni]] 114 34 115 35 ----