Changes between Version 2 and Version 3 of TracIni


Ignore:
Timestamp:
Oct 1, 2012 9:35:34 AM (12 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracIni

    v2 v3  
    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 
    25[[TracGuideToc]] 
     6[[PageOutline]] 
    37 
    4 Trac の設定は `<projectenv>/conf/` にある '''`trac.ini`''' というファイルを編集して行います。変更した内容は通常、即座に反映されますが、 `[components]` セクションや `[logging]` セクションへの変更では Web サーバを再起動する必要があります。また、グローバルな設定ファイルを新しく作成した直後も Web サーバを再起動しなければなりません。 
     8Trac 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. 
    59 
    6 `trac.ini` 設定ファイルは Web サーバから書き込み可能でなければなりません。 Trac は現在のところ、キャッシュを破棄するために完全に Environment を再読み込みするトリガーとして利用しています。 
     10The `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. 
    711 
    8 == グローバルな設定 == #GlobalConfiguration 
     12== Global Configuration == 
    913 
    10 0.11 より前のバージョンでは、グローバルな設定ファイルは `$prefix/share/trac/conf/trac.ini` や `/etc/trac/trac.ini` などディストリビューションに依存した特定の位置に配置されていました。アップグレードする場合は、設定を継承するファイルを明示しなければなりません。以前のバージョンから 0.11 にアップグレードした場合、プロジェクトの `trac.ini` ファイルに `[inherit]` セクションを追加しなければなりません。カスタマイズしたテンプレートや画像のファイルは `$prefix/share/trac/...` から他の場所に移動することもできます。 
     14In 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. 
    1115 
    12 グローバルな設定は Environment 固有の設定とマージされます。ローカルの設定はグローバルの設定を上書きます。グローバルな設定ファイルは以下のように指定します: 
     16Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows: 
    1317{{{ 
    1418[inherit] 
    1519file = /path/to/global/trac.ini 
    1620}}} 
    17 カンマ区切りにすることで、複数のファイルを指定することができます。 
     21Multiple files can be specified using a comma-separated list. 
    1822 
    19 Note: 新しいプロジェクトを作る時に [TracAdmin#initenv trac-admin] の `initenv` コマンドに `--inherit=/path/to/global/trac.ini` オプションを追加することで、グローバル設定ファイルを指定することができます。オプションを追加せずにプロジェクトを作成した場合でも、新しく作成された `conf/trac.ini` ファイルを編集して、グローバルファイルの設定で上書きしたいエントリを削除すれば、新しい Environment でグローバル設定ファイルを使用することができます。 
     23Note 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. 
    2024 
    21 [[#inherit-section| [inherit] ]] セクションには、共有するテンプレートの配置先を指す `templates_dir` と、共有するプラグインを指す `plugins_dir` という二つのエントリもあります。これらがグローバル設定ファイルに指定することができます。この場合、他の `[inherit] file` が指定されていれば、設定ファイルは順次読み込まれます。 
     25There 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. 
    2226 
    23 == リファレンス == #Referenceforsettings 
     27Note 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). 
    2428 
    25 現在利用できる設定項目のリファレンスです。 
     29== Reference for settings 
     30 
     31This is a brief reference of available configuration options, and their default settings. 
    2632 
    2733[[TracIni]] 
    2834 
    29 == 特殊なセクションのリファレンス == #Referenceforspecialsections 
    30 [[PageOutline(3,,inline)]] 
    31  
    32 === [components] === #components-section 
    33 このセクションは Trac 本体も含めて、プラグインによって提供されるコンポーネントの有効/無効を設定するために使います。有効/無効を設定するコンポーネントは、オプションの名前 (`name`) を使って特定します。コンポーネントが有効かどうかはオプションの値 (`value`) によって決定されます; コンポーネントを有効にするには、値を `enabled` または `on` に設定します。他の値 (一般的には `disabled` または `off`) の場合、コンポーネントは無効になります。 
    34  
    35 オプションの名前はコンポーネントの完全修飾名、もしくは、コンポーネントのモジュール/パッケージ プレフィックスとなっています。前者は 特定のコンポーネントの有効/無効を設定し、後者は特定のパッケージ/モジュール内のコンポーネントの有効/無効を設定します。 
    36  
    37 以下の設定ファイルの抜粋を見てください: 
    38 {{{ 
    39 [components] 
    40 trac.ticket.report.ReportModule = disabled 
    41 webadmin.* = enabled 
    42 }}} 
    43  
    44 最初のオプションは [wiki:TracReports レポートモジュール] を使用しないように Trac を設定しています。二つ目のオプションは `webadmin` パッケージのすべてのコンポーネントを使用できるように設定しています。末尾のワイルドカードはモジュール/パッケージのマッチを行う場合、必須です。 
    45  
    46 アクティブなコンポーネントの一覧を取得するには、 ''Trac について'' (訳注: 英語版では ''About Trac'') の ''Plugins'' ページを参照してください。 (`CONFIG_VIEW` [wiki:TracPermissions パーミッション] が必要となります。) 
    47  
    48 See also: TracPlugins 
    49  
    50 === [milestone-groups] === #milestone-groups-section 
    51 ''(0.11 以降)'' 
    52  
    53 今やチケットのワークフローは変更可能です。チケットステータスを数多く持つことができます。 
    54 単に解決した (closed) チケットと、その他のチケットを対比して表示することが、すべてのケースで 
    55 適切とは言えなくなりました。このセクションでは、簡単にステータスの ''グループ'' を作成ができます。 
    56 グループはマイルストーンのプログレスバーで異なった色で表示させることができます。 
    57  
    58 設定の例 (closed と active しか持たない場合): 
    59 {{{ 
    60 closed = closed 
    61 # sequence number in the progress bar 
    62 closed.order = 0 
    63 # optional extra param for the query (two additional columns: created and modified and sort on created) 
    64 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 
    65 # indicates groups that count for overall completion  
    66 closed.overall_completion = truepercentage 
    67  
    68 new = new 
    69 new.order = 1 
    70 new.css_class = new 
    71 new.label = new 
    72  
    73 # one catch-all group is allowed 
    74 active = * 
    75 active.order = 2 
    76 # CSS class for this interval 
    77 active.css_class = open 
    78 # Displayed label for this group 
    79 active.label = in progress 
    80 }}} 
    81  
    82 グループの定義は、含めるステータスをカンマ区切りのリストにして構成します。 
    83 また、 '*' はあらゆるステータスを意味し、残りのすべてのステータスをキャッチオールグループに 
    84 関連付けます。 
    85  
    86 CSS クラスは次のいずれかを設定します: new (黄色), open (無色), closed (緑色)。 
    87 新しくスタイルを追加するには、以下のセレクタを使用します: 
    88 `table.progress td.<class>` 
    89  
    90 === [repositories] === #repositories-section 
    91  
    92 (''0.12 以降'' のマルチリポジトリ) 
    93  
    94 trac.ini の `[repositories]` セクションに設定できることは、新しいリポジトリを登録すること以外にもあります。 
    95  
    96 使い勝手を増すエイリアスや、一時的なリポジトリ、インストール時の初期状態などを設定することができます。 
    97  
    98 このセクションとその他諸々の書き方についての詳細は [TracRepositoryAdmin#Intrac.ini TracRepositoryAdmin] を参照してください。 
    99  
    100 === [svn:externals] === #svn:externals-section 
    101 ''(0.11 以降)'' 
    102  
    103 Subversion 向けの TracBrowser は、フォルダの `svn:externals` 属性を解釈できます。 
    104 デフォルトでは URL をリンクとして処理できるだけであり、 Trac 自身はリモートとなるリポジトリをブラウズすることはできません。 
    105  
    106 しかしながら、別の Trac インスタンス (または [http://www.viewvc.org/ ViewVC] のような別のリポジトリブラウザ) がリンク先のリポジトリにをブラウズできるように設定されていれば、別のリポジトリブラウザを指す外部の URL を Trac に設定しておくことができます。 
    107  
    108 このマッピングは TracIni の `[svn:externals]` セクションで設定します。 
    109  
    110 例: 
    111 {{{ 
    112 [svn:externals] 
    113 1 = svn://server/repos1                       http://trac/proj1/browser/$path?rev=$rev 
    114 2 = svn://server/repos2                       http://trac/proj2/browser/$path?rev=$rev 
    115 3 = http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914 
    116 4 = svn://anotherserver.com/tools_repository  http://ourserver/tracs/tools/browser/$path?rev=$rev 
    117 }}} 
    118 上記では、 `svn://anotherserver.com/tools_repository/tags/1.1/tools` という external は `http://ourserver/tracs/tools/browser/tags/1.1/tools?rev=` にマップされます (`rev` は external にリビジョンが指定された場合、適切なリビジョン番号に設定されます。詳細は [http://svnbook.red-bean.com/en/1.4/svn.advanced.externals.html SVN Book の externals] を参照してください)。 
    119  
    120 Note: 番号はセクション内でのキー項目としてだけ使用されます。 URL 自身はキー項目として扱うことが出来ないという、設定ファイルのパーサの制限事項を回避するためです。 
    121  
    122 最後に [http://subversion.tigris.org/svn_1.5_releasenotes.html#externals Subversion 1.5] で導入された相対 URL は、現在のところサポートしていません。 
    123  
    124 === [ticket-custom] === #ticket-custom-section 
    125  
    126 このセクションでは、チケットに追加フィールドを定義することができます。詳しくは TracTicketsCustomFields を参照してください。 
    127  
    128 === [ticket-workflow] === #ticket-workflow-section 
    129 ''(0.11 以降)'' 
    130  
    131 チケットのワークフローはプラグインで制御します。 
    132 デフォルトでは `ConfigurableTicketWorkflow` コンポーネントが制御を行います。 
    133 このコンポーネントでは、 trac.ini ファイルのこのセクションでワークフローを設定することが可能です。 
    134 詳細は TracWorkflow を参照してください。 
    135  
    136  
    13735---- 
    13836See also: TracGuide, TracAdmin, TracEnvironment