Changes between Version 2 and Version 3 of TracIni


Ignore:
Timestamp:
2012/06/16 22:07:38 (6 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracIni

    v2 v3  
    11= Trac 設定ファイル = #TheTracConfigurationFile 
     2 
    23[[TracGuideToc]] 
    34 
    45Trac の設定は `<projectenv>/conf/` にある '''`trac.ini`''' というファイルを編集して行います。変更した内容は通常、即座に反映されますが、 `[components]` セクションや `[logging]` セクションへの変更では Web サーバを再起動する必要があります。また、グローバルな設定ファイルを新しく作成した直後も Web サーバを再起動しなければなりません。 
    56 
     7`trac.ini` 設定ファイルは Web サーバから書き込み可能でなければなりません。 Trac は現在のところ、キャッシュを破棄するために完全に Environment を再読み込みするトリガーとして利用しています。 
     8 
    69== グローバルな設定 == #GlobalConfiguration 
    710 
    8 0.11 より前のバージョンでは、グローバルな設定は `$prefix/share/trac/conf/trac.ini` か、ディストリビューションによっては `/etc/trac/trac.ini` がデフォルトの位置として配置されていました。アップグレードする場合は、設定を継承するファイルを明示しなければなりません。 
    9 以前のバージョンから 0.11 にアップグレードした場合、プロジェクトの `trac.ini` ファイルに `inherit` セクションを追加しなければなりません。カスタマイズしたテンプレートや画像のファイルは `$prefix/share/trac/...` から他の場所に移動することもできます。 
     110.11 より前のバージョンでは、グローバルな設定ファイルは `$prefix/share/trac/conf/trac.ini` や `/etc/trac/trac.ini` などディストリビューションに依存した特定の位置に配置されていました。アップグレードする場合は、設定を継承するファイルを明示しなければなりません。以前のバージョンから 0.11 にアップグレードした場合、プロジェクトの `trac.ini` ファイルに `[inherit]` セクションを追加しなければなりません。カスタマイズしたテンプレートや画像のファイルは `$prefix/share/trac/...` から他の場所に移動することもできます。 
    1012 
    1113グローバルな設定は Environment 固有の設定とマージされます。ローカルの設定はグローバルの設定を上書きます。グローバルな設定ファイルは以下のように指定します: 
    1214{{{ 
    1315[inherit] 
    14 file = /usr/share/trac/conf/trac.ini 
     16file = /path/to/global/trac.ini 
    1517}}} 
     18カンマ区切りにすることで、複数のファイルを指定することができます。 
    1619 
    17 Note: 新しいプロジェクトを作る時に [TracAdmin trac-admin] の `initenv` コマンドに 
    18 `--inherit=/path/to/global/options` オプションを追加することで、グローバル設定ファイルを指定することができます。 
    19 オプションを追加せずにプロジェクトを作成した場合でも、新しい Environment でグローバル設定ファイルを使用することができます。 
    20 新しく作成された conf/trac.ini ファイルを編集して、グローバルファイルの設定で上書きしたいエントリを削除すれば、 
    21 新しい Environment でグローバル設定ファイルを使用することができます。 
     20Note: 新しいプロジェクトを作る時に [TracAdmin#initenv trac-admin] の `initenv` コマンドに `--inherit=/path/to/global/trac.ini` オプションを追加することで、グローバル設定ファイルを指定することができます。オプションを追加せずにプロジェクトを作成した場合でも、新しく作成された `conf/trac.ini` ファイルを編集して、グローバルファイルの設定で上書きしたいエントリを削除すれば、新しい Environment でグローバル設定ファイルを使用することができます。 
    2221 
     22[[#inherit-section| [inherit] ]] セクションには、共有するテンプレートの配置先を指す `templates_dir` と、共有するプラグインを指す `plugins_dir` という二つのエントリもあります。これらがグローバル設定ファイルに指定することができます。この場合、他の `[inherit] file` が指定されていれば、設定ファイルは順次読み込まれます。 
    2323 
    24 == リファレンス == #Reference 
     24Note: TracEnvironment の `templates/` ディレクトリ内のテンプレートは、 `[inherit] templates_dir` で見つかるテンプレートより優先されます。次に、`[inherit] templates_dir` のテンプレートはインストールされているテンプレートより優先されます。これらを設定するには注意が必要です。特に、デフォルトのテンプレートをオーバーライドする場合、 Trac を新しいバージョンにアップデートする際には必ず変更点を再読み込みして下さい。 ( TracInterfaceCustomization を行うために推奨する方法は、適切に `ITemplateStreamFilter` の変更が行えるカスタムプラグインを作成することです。) 
    2525 
    26 現在利用できる設定項目のリファレンスです。 
     26== リファレンス == #Referenceforsettings 
    2727 
    28 [[TracIni()]] 
     28現在利用できる設定項目のリファレンスとデフォルトの設定です。(訳注: 0.12 ではデフォルトの値は表示されません。) 
    2929 
     30[[TracIni]] 
    3031 
    31 == [components] == #components-section 
     32== 特殊なセクションのリファレンス == #Referenceforspecialsections 
     33[[PageOutline(3,,inline)]] 
     34 
     35=== [components] === #components-section 
    3236このセクションは Trac 本体も含めて、プラグインによって提供されるコンポーネントの有効/無効を設定するために使います。有効/無効を設定するコンポーネントは、オプションの名前 (`name`) を使って特定します。コンポーネントが有効かどうかはオプションの値 (`value`) によって決定されます; コンポーネントを有効にするには、値を `enabled` または `on` に設定します。他の値 (一般的には `disabled` または `off`) の場合、コンポーネントは無効になります。 
    3337 
     
    4751See also: TracPlugins 
    4852 
    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 
     53=== [milestone-groups] === #milestone-groups-section 
    6254''(0.11 以降)'' 
    6355 
     
    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 
     
    9391`table.progress td.<class>` 
    9492 
    95 == [svn:externals] == #svn:externals-section 
     93=== [repositories] === #repositories-section 
     94 
     95(''0.12 以降'' のマルチリポジトリ) 
     96 
     97trac.ini の `[repositories]` セクションに設定できることは、新しいリポジトリを登録すること以外にもあります。 
     98 
     99使い勝手を増すエイリアスや、一時的なリポジトリ、インストール時の初期状態などを設定することができます。 
     100 
     101このセクションとその他諸々の書き方についての詳細は [TracRepositoryAdmin#Intrac.ini TracRepositoryAdmin] を参照してください。 
     102 
     103=== [svn:externals] === #svn:externals-section 
    96104''(0.11 以降)'' 
    97105 
    98106Subversion 向けの TracBrowser は、フォルダの `svn:externals` 属性を解釈できます。 
    99 しかしながら、外部リソースが `http:` プロトコルを使用して ''いない'' 場合や、リンクを異なるリポジトリブラウザ (別の Trac や [http://www.viewvc.org/ ViewVC] のような) に向けたい場合、 Trac に external のプレフィックスと外部の URL のマップを設定しなければなりません。 
     107デフォルトでは URL をリンクとして処理できるだけであり、 Trac 自身はリモートとなるリポジトリをブラウズすることはできません。 
     108 
     109しかしながら、別の Trac インスタンス (または [http://www.viewvc.org/ ViewVC] のような別のリポジトリブラウザ) がリンク先のリポジトリにをブラウズできるように設定されていれば、別のリポジトリブラウザを指す外部の URL を Trac に設定しておくことができます。 
    100110 
    101111このマッピングは TracIni の `[svn:externals]` セクションで設定します。 
     
    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] を参照してください)  
     121上記では、 `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] を参照してください) 
    112122 
    113123Note: 番号はセクション内でのキー項目としてだけ使用されます。 URL 自身はキー項目として扱うことが出来ないという、設定ファイルのパーサの制限事項を回避するためです。 
    114124 
     125最後に [http://subversion.tigris.org/svn_1.5_releasenotes.html#externals Subversion 1.5] で導入された相対 URL は、現在のところサポートしていません。 
     126 
     127=== [ticket-custom] === #ticket-custom-section 
     128 
     129このセクションでは、チケットに追加フィールドを定義することができます。詳しくは TracTicketsCustomFields を参照してください。 
     130 
     131=== [ticket-workflow] === #ticket-workflow-section 
     132''(0.11 以降)'' 
     133 
     134チケットのワークフローはプラグインで制御します。 
     135デフォルトでは `ConfigurableTicketWorkflow` コンポーネントが制御を行います。 
     136このコンポーネントでは、 trac.ini ファイルのこのセクションでワークフローを設定することが可能です。 
     137詳細は TracWorkflow を参照してください。 
     138 
    115139---- 
    116140See also: TracGuide, TracAdmin, TracEnvironment