XPressME Integration Kit

Trac

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

差分発生行の前後
Ignore:
Timestamp:
Nov 29, 2010, 3:25:29 PM (10 years 前)
Author:
trac (IP: 127.0.0.1)
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracIni

    v1 v2  
    1 = Trac 設定ファイル = #TheTracConfigurationFile 
    2  
     1= The Trac Configuration File = 
    32[[TracGuideToc]] 
    43 
    5 == グローバルな設定 == #GlobalConfiguration 
     4Trac 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. 
    65 
    7 0.11 より前のバージョンでは、グローバルな設定は `$prefix/share/trac/conf/trac.ini` か、ディストリビューションによっては `/etc/trac/trac.ini` がデフォルトの位置として配置されていました。アップグレードする場合は、設定を継承するファイルを明示しなければなりません。 
     6The `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. 
    87 
    9 グローバルな設定は Environment 固有の設定とマージされます。ローカルの設定はグローバルの設定を上書きます。グローバルな設定ファイルは以下の通り指定します: 
     8== Global Configuration == 
     9 
     10In 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. 
     11 
     12Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows: 
    1013{{{ 
    1114[inherit] 
    12 file = /usr/share/trac/conf/trac.ini 
     15file = /path/to/global/trac.ini 
    1316}}} 
     17Multiple files can be specified using a comma-separated list. 
    1418 
    15 Note: 新しいプロジェクトを作る時に [TracAdmin trac-admin] の `initenv` コマンドに 
    16 `--inherit=/path/to/global/options` オプションを追加することで、グローバル設定ファイルを指定することができます。 
    17 オプションを追加せずにプロジェクトを作成した場合でも、新しい Environment でグローバル設定ファイルを使用することができます。 
    18 新しく作成された conf/trac.ini ファイルを編集して、グローバルファイルの設定で上書きしたいエントリを削除すれば、 
    19 新しい Environment でグローバル設定ファイルを使用することができます。 
     19Note 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. 
    2020 
     21There 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. 
    2122 
    22 == リファレンス == #Reference 
     23== Reference for settings 
    2324 
    24 現在利用できる設定項目のリファレンスです。 
     25This is a brief reference of available configuration options. 
    2526 
    26 [[TracIni()]] 
     27[[TracIni]] 
    2728 
     29== Reference for special sections 
     30[[PageOutline(3,,inline)]] 
    2831 
    29 == [components] == #components-section 
    30 このセクションは Trac 本体も含めて、プラグインによって提供されるコンポーネントの有効/無効を設定するために使います。有効/無効を設定するコンポーネントは、オプションの名前 (`name`) を使って特定します。コンポーネントが有効かどうかはオプションの値 (`value`) によって決定されます; コンポーネントを有効にするには、値を `enabled` または `on` に設定します。他の値 (一般的には `disabled` または `off`) の場合、コンポーネントは無効になります。 
     32=== [components] === #components-section 
     33This 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. 
    3134 
    32 オプションの名前はコンポーネントの完全修飾名、もしくは、コンポーネントのモジュール/パッケージ プレフィックスとなっています。前者は 特定のコンポーネントの有効/無効を設定し、後者は特定のパッケージ/モジュール内のコンポーネントの有効/無効を設定します。 
     35The 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. 
    3336 
    34 以下の設定ファイルの抜粋を見てください: 
     37Consider the following configuration snippet: 
    3538{{{ 
    3639[components] 
     
    3942}}} 
    4043 
    41 最初のオプションは [wiki:TracReports レポートモジュール] を使用しないように Trac を設定しています。二つ目のオプションは `webadmin` パッケージのすべてのコンポーネントを使用できるように設定しています。末尾のワイルドカードはモジュール/パッケージのマッチを行う場合、必須です。 
     44The 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. 
    4245 
    43 アクティブなコンポーネントの一覧を取得するには、 ''Trac について'' (訳注: 英語版では ''About Trac'') の ''Plugins'' ページを参照してください。 (`CONFIG_VIEW` [wiki:TracPermissions パーミッション] が必要となります。) 
     46See the ''Plugins'' page on ''About Trac'' to get the list of active components (requires `CONFIG_VIEW` [wiki:TracPermissions permissions].) 
    4447 
    4548See also: TracPlugins 
    4649 
    47 == [ticket-custom] == #ticket-custom-section 
     50=== [milestone-groups] === #milestone-groups-section 
     51''(since 0.11)'' 
    4852 
    49 このセクションでは、チケットに追加フィールドを定義することができます。詳しくは TracTicketsCustomFields を参照してください。 
     53As the workflow for tickets is now configurable, there can be many ticket states, 
     54and simply displaying closed tickets vs. all the others is maybe not appropriate  
     55in all cases. This section enables one to easily create ''groups'' of states  
     56that will be shown in different colors in the milestone progress bar. 
    5057 
    51 == [ticket-workflow] == #ticket-workflow-section 
    52 ''(0.11 以降)'' 
    53  
    54 チケットのワークフローはプラグインで制御します。 
    55 デフォルトでは `ConfigurableTicketWorkflow` コンポーネントが制御を行います。 
    56 このコンポーネントでは、 trac.ini ファイルのこのセクションでワークフローを設定することが可能です。 
    57 詳細は TracWorkflow を参照してください。 
    58  
    59 == [milestone-groups] == #milestone-groups-section 
    60 ''(0.11 以降)'' 
    61  
    62 今やチケットのワークフローは変更可能です。チケットステータスを数多く持つことができます。 
    63 単に解決した (closed) チケットと、その他のチケットを対比して表示することが、すべてのケースで 
    64 適切とは言えなくなりました。このセクションでは、簡単にステータスの ''グループ'' を作成ができます。 
    65 グループはマイルストーンのプログレスバーで異なった色で表示させることができます。 
    66  
    67 設定の例 (デフォルトの場合): 
     58Example configuration (the default only has closed and active): 
    6859{{{ 
    6960closed = closed 
    70 closed.order = 0                     # プログレスバーでの表示順序 
    71 closed.query_args = group=resolution # カスタムクエリへのリンクに渡すパラメータ (非必須) 
    72 closed.overall_completion = true     # マイルストーンの進捗の計上に含めるか否か 
     61# sequence number in the progress bar 
     62closed.order = 0 
     63# optional extra param for the query (two additional columns: created and modified and sort on created) 
     64closed.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  
     66closed.overall_completion = truepercentage 
    7367 
    74 active = *                           # キャッチオールグループを 1 つ許容 
    75 active.order = 1 
    76 active.css_class = open              # このグループに付与する CSS のクラス 
    77 active.label = in progress           # このグループを表示するときに使用するラベル 
     68new = new 
     69new.order = 1 
     70new.css_class = new 
     71new.label = new 
     72 
     73# one catch-all group is allowed 
     74active = * 
     75active.order = 2 
     76# CSS class for this interval 
     77active.css_class = open 
     78# Displayed label for this group 
     79active.label = in progress 
    7880}}} 
    7981 
    80 グループの定義は、含めるステータスをカンマ区切りのリストにして構成します。 
    81 また、 '*' はあらゆるステータスを意味し、残りのすべてのステータスをキャッチオールグループに 
    82 関連付けます。 
     82The definition consists in a comma-separated list of accepted status. 
     83Also, '*' means any status and could be used to associate all remaining 
     84states to one catch-all group. 
    8385 
    84 CSS クラスは次のいずれかを設定します: new (黄色), open (無色), closed (緑色)。 
    85 新しくスタイルを追加するには、以下のセレクタを使用します: 
    86 `table.progress td.<class>` 
     86The CSS class can be one of: new (yellow), open (no color) or 
     87closed (green). New styles can easily be added using the following 
     88selector:  `table.progress td.<class>` 
    8789 
    88 == [svn:externals] == #svn:externals-section 
    89 ''(0.11 以降)'' 
     90=== [repositories] === #repositories-section 
    9091 
    91 Subversion 向けの TracBrowser は、フォルダの `svn:externals` 属性を解釈できます。 
    92 しかしながら、外部リソースが `http:` プロトコルを使用して ''いない'' 場合や、リンクを異なるリポジトリブラウザ (別の Trac や [http://www.viewvc.org/ ViewVC] のような) に向けたい場合、 Trac に external のプレフィックスと外部の URL のマップを設定しなければなりません。 
     92(''since 0.12'' multirepos) 
    9393 
    94 このマッピングは TracIni の `[svn:externals]` セクションで設定します。 
     94One of the alternatives for registering new repositories is to populate the `[repositories]` section of the trac.ini. 
    9595 
    96 例: 
     96This is especially suited for setting up convenience aliases, short-lived repositories, or during the initial phases of an installation. 
     97 
     98See [TracRepositoryAdmin#Intrac.ini TracRepositoryAdmin] for details about the format adopted for this section and the rest of that page for the other alternatives. 
     99 
     100=== [svn:externals] === #svn:externals-section 
     101''(since 0.11)'' 
     102 
     103The TracBrowser for Subversion can interpret the `svn:externals` property of folders. 
     104By default, it only turns the URLs into links as Trac can't browse remote repositories. 
     105 
     106However, 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. 
     107 
     108This mapping is done in the `[svn:externals]` section of the TracIni 
     109 
     110Example: 
    97111{{{ 
    98112[svn:externals] 
    99 1 = svn://server/repos1 http://trac/proj1/browser/$path?rev=$rev 
    100 2 = svn://server/repos2 http://trac/proj2/browser/$path?rev=$rev 
     1131 = svn://server/repos1                       http://trac/proj1/browser/$path?rev=$rev 
     1142 = svn://server/repos2                       http://trac/proj2/browser/$path?rev=$rev 
    1011153 = http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914 
    102 4 = svn://anotherserver.com/tools_repository  http://ourserver/trac/support/browser/$path?rev=$rev 
     1164 = svn://anotherserver.com/tools_repository  http://ourserver/tracs/tools/browser/$path?rev=$rev 
    103117}}} 
    104 上記では、 `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] を参照してください) 。 
     118With 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). 
    105119 
    106 Note: 番号はセクション内でのキー項目としてだけ使用されます。 URL 自身はキー項目として扱うことが出来ないという、設定ファイルのパーサの制限事項を回避するためです。 
     120Note 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. 
     121 
     122Finally, the relative URLs introduced in [http://subversion.tigris.org/svn_1.5_releasenotes.html#externals Subversion 1.5] are not yet supported. 
     123 
     124=== [ticket-custom] === #ticket-custom-section 
     125 
     126In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details. 
     127 
     128=== [ticket-workflow] === #ticket-workflow-section 
     129''(since 0.11)'' 
     130 
     131The workflow for tickets is controlled by plugins.  
     132By default, there's only a `ConfigurableTicketWorkflow` component in charge.  
     133That component allows the workflow to be configured via this section in the trac.ini file. 
     134See TracWorkflow for more details. 
     135 
    107136 
    108137----