Changes between Version 2 and Version 3 of TracIni


Ignore:
Timestamp:
Jun 17, 2013, 1:35:49 PM (11 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracIni

    v2 v3  
    22
    33[[TracGuideToc]]
     4[[PageOutline]]
    45
    56Trac の設定は `<projectenv>/conf/` にある '''`trac.ini`''' というファイルを編集して行います。変更した内容は通常、即座に反映されますが、 `[components]` セクションや `[logging]` セクションへの変更では Web サーバを再起動する必要があります。また、グローバルな設定ファイルを新しく作成した直後も Web サーバを再起動しなければなりません。
    67
    7 `trac.ini` 設定ファイルは Web サーバから書き込み可能でなければなりません。 Trac は現在のところ、キャッシュを破棄するために完全に Environment を再読み込みするトリガーとして利用しています。
     8`trac.ini` 設定ファイルとそのファイルのあるディレクトリは Web サーバから書き込み可能でなければなりません。 Trac は現在のところ、キャッシュを破棄するために完全に Environment を再読み込みするトリガーとして利用しています。
    89
    910== グローバルな設定 == #GlobalConfiguration
     
    2021Note: 新しいプロジェクトを作る時に [TracAdmin#initenv trac-admin] の `initenv` コマンドに `--inherit=/path/to/global/trac.ini` オプションを追加することで、グローバル設定ファイルを指定することができます。オプションを追加せずにプロジェクトを作成した場合でも、新しく作成された `conf/trac.ini` ファイルを編集して、グローバルファイルの設定で上書きしたいエントリを削除すれば、新しい Environment でグローバル設定ファイルを使用することができます。
    2122
    22 [[#inherit-section| [inherit] ]] セクションには、共有するテンプレートの配置先を指す `templates_dir` と、共有するプラグインを指す `plugins_dir` という二つのエントリもあります。これらがグローバル設定ファイルに指定することができます。この場合、他の `[inherit] file` が指定されていれば、設定ファイルは順次読み込まれます。
     23[#inherit-section| [inherit]] セクションには、共有するテンプレートの配置先を指す `templates_dir` と、共有するプラグインを指す `plugins_dir` という二つのエントリもあります。これらがグローバル設定ファイルに指定することができます。この場合、他の `[inherit] file` が指定されていれば、設定ファイルは順次読み込まれます。
    2324
    24 Note: TracEnvironment の `templates/` ディレクトリ内のテンプレートは、 `[inherit] templates_dir` で見つかるテンプレートより優先されます。次に、`[inherit] templates_dir` のテンプレートはインストールされているテンプレートより優先されます。これらを設定するには注意が必要です。特に、デフォルトのテンプレートをオーバーライドする場合、 Trac を新しいバージョンにアップデートする際には必ず変更点を再読み込みして下さい。 ( TracInterfaceCustomization を行うために推奨する方法は、適切に `ITemplateStreamFilter` の変更が行えるカスタムプラグインを作成することです。)
     25TracEnvironment の `templates/` ディレクトリ内のテンプレートは、 `[inherit] templates_dir` で見つかるテンプレートより優先されます。次に、`[inherit] templates_dir` のテンプレートはインストールされているテンプレートより優先されます。これらを設定するには注意が必要です。特に、デフォルトのテンプレートをオーバーライドする場合、 Trac を新しいバージョンにアップデートする際には必ず変更点を再読み込みして下さい。 ( TracInterfaceCustomization を行うために推奨する方法は、適切に `ITemplateStreamFilter` の変更が行えるカスタムプラグインを作成することです。)
    2526
    2627== リファレンス == #Referenceforsettings
     
    3031[[TracIni]]
    3132
    32 == 特殊なセクションのリファレンス == #Referenceforspecialsections
    33 [[PageOutline(3,,inline)]]
    34 
    35 === [components] === #components-section
    36 このセクションは Trac 本体も含めて、プラグインによって提供されるコンポーネントの有効/無効を設定するために使います。有効/無効を設定するコンポーネントは、オプションの名前 (`name`) を使って特定します。コンポーネントが有効かどうかはオプションの値 (`value`) によって決定されます; コンポーネントを有効にするには、値を `enabled` または `on` に設定します。他の値 (一般的には `disabled` または `off`) の場合、コンポーネントは無効になります。
    37 
    38 オプションの名前はコンポーネントの完全修飾名、もしくは、コンポーネントのモジュール/パッケージ プレフィックスとなっています。前者は 特定のコンポーネントの有効/無効を設定し、後者は特定のパッケージ/モジュール内のコンポーネントの有効/無効を設定します。
    39 
    40 以下の設定ファイルの抜粋を見てください:
    41 {{{
    42 [components]
    43 trac.ticket.report.ReportModule = disabled
    44 webadmin.* = enabled
    45 }}}
    46 
    47 最初のオプションは [wiki:TracReports レポートモジュール] を使用しないように Trac を設定しています。二つ目のオプションは `webadmin` パッケージのすべてのコンポーネントを使用できるように設定しています。末尾のワイルドカードはモジュール/パッケージのマッチを行う場合、必須です。
    48 
    49 アクティブなコンポーネントの一覧を取得するには、 ''Trac について'' (訳注: 英語版では ''About Trac'') の ''Plugins'' ページを参照してください。 (`CONFIG_VIEW` [wiki:TracPermissions パーミッション] が必要となります。)
    50 
    51 See also: TracPlugins
    52 
    53 === [milestone-groups] === #milestone-groups-section
    54 ''(0.11 以降)''
    55 
    56 今やチケットのワークフローは変更可能です。チケットステータスを数多く持つことができます。
    57 単に解決した (closed) チケットと、その他のチケットを対比して表示することが、すべてのケースで
    58 適切とは言えなくなりました。このセクションでは、簡単にステータスの ''グループ'' を作成ができます。
    59 グループはマイルストーンのプログレスバーで異なった色で表示させることができます。
    60 
    61 設定の例 (closed と active しか持たない場合):
    62 {{{
    63 closed = closed
    64 # sequence number in the progress bar
    65 closed.order = 0
    66 # optional extra param for the query (two additional columns: created and modified and sort on created)
    67 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
    68 # indicates groups that count for overall completion percentage
    69 closed.overall_completion = true
    70 
    71 new = new
    72 new.order = 1
    73 new.css_class = new
    74 new.label = new
    75 
    76 # one catch-all group is allowed
    77 active = *
    78 active.order = 2
    79 # CSS class for this interval
    80 active.css_class = open
    81 # Displayed label for this group
    82 active.label = in progress
    83 }}}
    84 
    85 グループの定義は、含めるステータスをカンマ区切りのリストにして構成します。
    86 また、 '*' はあらゆるステータスを意味し、残りのすべてのステータスをキャッチオールグループに
    87 関連付けます。
    88 
    89 CSS クラスは次のいずれかを設定します: new (黄色), open (無色), closed (緑色)。
    90 新しくスタイルを追加するには、以下のセレクタを使用します:
    91 `table.progress td.<class>`
    92 
    93 === [repositories] === #repositories-section
    94 
    95 (''0.12 以降'' のマルチリポジトリ)
    96 
    97 trac.ini の `[repositories]` セクションに設定できることは、新しいリポジトリを登録すること以外にもあります。
    98 
    99 使い勝手を増すエイリアスや、一時的なリポジトリ、インストール時の初期状態などを設定することができます。
    100 
    101 このセクションとその他諸々の書き方についての詳細は [TracRepositoryAdmin#Intrac.ini TracRepositoryAdmin] を参照してください。
    102 
    103 === [svn:externals] === #svn:externals-section
    104 ''(0.11 以降)''
    105 
    106 Subversion 向けの TracBrowser は、フォルダの `svn:externals` 属性を解釈できます。
    107 デフォルトでは URL をリンクとして処理できるだけであり、 Trac 自身はリモートとなるリポジトリをブラウズすることはできません。
    108 
    109 しかしながら、別の Trac インスタンス (または [http://www.viewvc.org/ ViewVC] のような別のリポジトリブラウザ) がリンク先のリポジトリにをブラウズできるように設定されていれば、別のリポジトリブラウザを指す外部の URL を Trac に設定しておくことができます。
    110 
    111 このマッピングは TracIni の `[svn:externals]` セクションで設定します。
    112 
    113 例:
    114 {{{
    115 [svn:externals]
    116 1 = svn://server/repos1                       http://trac/proj1/browser/$path?rev=$rev
    117 2 = svn://server/repos2                       http://trac/proj2/browser/$path?rev=$rev
    118 3 = http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914
    119 4 = svn://anotherserver.com/tools_repository  http://ourserver/tracs/tools/browser/$path?rev=$rev
    120 }}}
    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] を参照してください)。
    122 
    123 Note: 番号はセクション内でのキー項目としてだけ使用されます。 URL 自身はキー項目として扱うことが出来ないという、設定ファイルのパーサの制限事項を回避するためです。
    124 
    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 
    13933----
    14034See also: TracGuide, TracAdmin, TracEnvironment