Changes between Version 1 and Version 2 of TracTicketsCustomFields


Ignore:
Timestamp:
Sep 2, 2019, 4:56:56 PM (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracTicketsCustomFields

    v1 v2  
    1 = カスタムチケット属性 = #CustomTicketFields
    2 Trac ではチケットにユーザ定義の属性を追加できます。カスタムチケット属性を使用すると、型付けされた、プロジェクト特有のプロパティをチケットに持たせることができます。
     1= Custom Ticket Fields
     2Trac supports adding custom, user-defined fields to the ticket module. With custom fields you can add typed, site-specific properties to tickets.
    33
    4 == 設定方法 == #Configuration
    5 カスタムチケット属性を設定するためには、 [wiki:TracIni trac.ini] ファイルを変更します。カスタムフィールドは、 trac.ini ファイルの `[ticket-custom]` セクションに書く必要があります。
     4== Configuration
    65
    7 各属性の定義は以下のように記述します:
     6Configuring custom ticket fields in the [TracIni#ticket-custom-section "[ticket-custom]"] section of trac.ini.
     7
     8The syntax of each field definition is:
    89{{{
    9  属性名 = タイプ
    10  (属性名.オプション = 値)
     10 FIELD_NAME = TYPE
     11 (FIELD_NAME.OPTION = VALUE)
    1112 ...
    1213}}}
    13 構文の詳細は以下の例を見てください。
    1414
    15 === 属性のタイプとオプション === #AvailableFieldTypesandOptions
    16   * '''text''': シンプルな(1行の)テキスト
    17    * label: 説明となるラベル
    18    * value: デフォルト値
    19    * order: ソート時の並び順 (全てのカスタムフィールドで共通するソートの並び順)
    20    * format:
    21      * 通常のテキストを指す `plain`
    22      * WikiFormatting として整形を行う `wiki` (''0.11.3 以降'')
    23      * 参照可能な値として整形を行う `reference` (''1.0 以降'')
    24      * スペースで区切られた参照可能なリストとして整形を行う `list` のいずれかを指定する(''1.0 以降'')
    25  * '''checkbox''': ブーリアン値をもつチェックボックス
    26    * label: 説明となるラベル
    27    * value: デフォルト値 (0 または 1)
    28    * order: ソート時の並び順
    29  * '''select''': ドロップダウンするリストボックス
    30    * label: 説明となるラベル
    31    * options: リストに表示する値を '''|''' (vertical pipe) 区切りで記述
    32    * value: デフォルト値 (options の値から一つを指定)
    33    * order: ソート時の並び順
    34  * '''radio''': ラジオボタン。 HTML の '''select''' 要素と同じ
    35    * label: 説明となるラベル
    36    * options: リストに表示する値を '''|''' (vertical pipe) 区切りで記述
    37    * value: デフォルト値 (options の値から一つを指定)
    38    * order: ソート時の並び順
    39  * '''textarea''': 複数行のテキストエリア
    40    * label: 説明となるラベル
    41    * value: デフォルトで設定されるテキスト
    42    * cols: 入力領域のカラム幅
    43    * rows: 入力領域の行数
    44    * order: ソート時の並び順
    45    * format: 通常のテキストを指す `plain` もしくは WikiFormatting として整形を行う `wiki` のいずれかを指定する (''0.11.3 以降'')
     15The example below should help to explain the syntax.
    4616
    47 === サンプル === #SampleConfig
    48 {{{
     17=== Available Field Types and Options
     18
     19 * '''text''': A simple (one line) text field.
     20   * label: Descriptive label.
     21   * value: Default value.
     22   * order: Sort order placement relative to other custom fields.
     23   * max_size: Maximum allowed size in characters (//Since 1.3.2//).
     24   * format: One of:
     25     * `plain` for plain text
     26     * `wiki` for [WikiFormatting wiki formatted] content
     27     * `reference` to treat the content as a queryable value
     28     * `list` to interpret the content as a list of queryable values, separated by whitespace
     29 * '''checkbox''': A boolean value check box.
     30   * label: Descriptive label.
     31   * value: Default value, 0 or 1.
     32   * order: Sort order placement.
     33 * '''select''': Drop-down select box. Uses a list of values.
     34   * label: Descriptive label.
     35   * options: List of values, separated by '''|''' (vertical pipe).
     36   * value: Default value (one of the values from options).
     37   * order: Sort order placement.
     38 * '''radio''': Radio buttons. Essentially the same as '''select'''.
     39   * label: Descriptive label.
     40   * options: List of values, separated by '''|''' (vertical pipe).
     41   * value: Default value, one of the values from options.
     42   * order: Sort order placement.
     43 * '''textarea''': Multi-line text area.
     44   * label: Descriptive label.
     45   * value: Default text.
     46   * rows: Height in lines.
     47   * order: Sort order placement.
     48   * max_size: Maximum allowed size in characters (//Since 1.3.2//).
     49   * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting.
     50 * '''time''': Date and time picker. (//Since 1.1.1//)
     51   * label: Descriptive label.
     52   * value: Default date.
     53   * order: Sort order placement.
     54   * format: One of:
     55     * `relative` for relative dates.
     56     * `date` for absolute dates.
     57     * `datetime` for absolute date and time values.
     58
     59If the `label` is not specified, it will be created by capitalizing the custom field name and replacing underscores with whitespaces.
     60
     61Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`.
     62
     63=== Sample Configuration
     64
     65{{{#!ini
    4966[ticket-custom]
    5067
     
    6885test_five = radio
    6986test_five.label = Radio buttons are fun
    70 test_five.options = uno|dos|tres|cuatro|cinco
     87test_five.options = |uno|dos|tres|cuatro|cinco
    7188test_five.value = dos
    7289
     
    7693test_six.cols = 60
    7794test_six.rows = 30
     95
     96test_seven = time
     97test_seven.label = A relative date
     98test_seven.format = relative
     99test_seven.value = now
     100
     101test_eight = time
     102test_eight.label = An absolute date
     103test_eight.format = date
     104test_eight.value = yesterday
     105
     106test_nine = time
     107test_nine.label = A date and time
     108test_nine.format = datetime
     109test_nine.value = in 2 hours
    78110}}}
    79111
    80 ''Note: `select` タイプのフィールドを非必須 (optional) にしたい場合、 `フィールド名.options` オプションの先頭に `バーティカルパイプ (|)` を設定してください。''
     112'''Note''': To make a `select` type field optional, specify a leading `|` in `fieldname.options` (e.g. `test_five`).
    81113
    82 === カスタム属性を含むレポート === #ReportsInvolvingCustomFields
     114=== Reports Involving Custom Fields
    83115
    84 カスタムチケット属性は `ticket` テーブルに保存されるのではなく、 `ticket_custom` テーブルに保存されます。したがって、レポートのカスタム属性を表示するためには `ticket` と `ticket_custom` の 2 テーブルを join する必要があります。 `progress` と設定されたカスタムチケット属性の使用例を示します。
     116Custom ticket fields are stored in the `ticket_custom` table, not in the `ticket` table. So to display the values from custom fields in a report, you will need a join on the 2 tables. Let's use an example with a custom ticket field called `progress`.
    85117
    86 {{{
    87 #!sql
     118{{{#!sql
    88119SELECT p.value AS __color__,
    89120   id AS ticket, summary, owner, c.value AS progress
     
    93124  ORDER BY p.value
    94125}}}
    95 '''Note''' この例は progress が設定されたチケットだけを表示します。'''すべてのチケットを表示するのではありません。'''既にいくつかのチケットを作成した''後で''カスタムチケット属性を定義した場合、既に作成されたチケットにはカスタムチケット属性が定義されません。そのため上記のクエリではチケットが表示されないでしょう。既に作成されたチケットにカスタム属性を設定し直せば、カスタムチケット属性は定義されます。そして、上記のクエリによって表示されるでしょう。
     126'''Note''': This will only show tickets that have progress set in them. This is '''not the same as showing all tickets'''. If you created this custom ticket field ''after'' you have already created some tickets, they will not have that field defined, and thus they will never show up on this ticket query. If you go back and modify those tickets, the field will be defined, and they will appear in the query.
    96127
    97 しかし、すべてのチケットエントリを ( progress が定義されていないエントリーも一緒に ) 表示したいのであれば、クエリにおいてあらゆるカスタムフィールドに `JOIN` を使用する必要があります。
    98 {{{
    99 #!sql
     128However, if you want to show all ticket entries (with progress defined and without), you need to use a `JOIN` for every custom field that is in the query:
     129{{{#!sql
    100130SELECT p.value AS __color__,
    101131   id AS ticket, summary, component, version, milestone, severity,
     
    104134   changetime AS _changetime, description AS _description,
    105135   reporter AS _reporter,
    106   (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
     136   (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
    107137  FROM ticket t
    108138     LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress')
     
    112142}}}
    113143
    114 この `LEFT OUTER JOIN` ステートメントに特に注意してください。
     144Note in particular the `LEFT OUTER JOIN` statement here.
    115145
    116 === データベースを更新する === #Updatingthedatabase
    117 
    118 上記に記述したとおり、カスタムフィールド設定以前に作成されたチケットには、該当するフィールドの値が定義されていない状態になります。以下のような SQL を Trac のデータベースで直接実行することで、カスタムフィールドの初期値を設定することができます (SQLite 向けの SQL ですので、 DBMS に応じて調整してください)。カスタムフィールド 'request_source' が存在しない、全てのチケットにデフォルト値 'None' が挿入されます:
    119 
    120 {{{
    121 #!sql
    122 INSERT INTO ticket_custom
    123    (ticket, name, value)
    124    SELECT
    125       id AS ticket,
    126       'request_source' AS name,
    127       'None' AS value
    128    FROM ticket
    129    WHERE id NOT IN (
    130       SELECT ticket FROM ticket_custom
    131    );
     146Note that option names in trac.ini are case-insensitive, so even if your option name includes uppercase characters:
     147{{{#!ini
     148[ticket-custom]
     149Progress_Type = text
    132150}}}
    133 
    134 複数のカスタムフィールドを追加している場合、 {{{ticket}}} 表への副問合わせで対象となるカスタムフィールドの名前を指定しなければなりません (訳注: 通常は上記の例ではなく、こちらを使うといいでしょう):
    135 
    136 {{{
    137 #!sql
    138 INSERT INTO ticket_custom
    139    (ticket, name, value)
    140    SELECT
    141       id AS ticket,
    142       'request_source' AS name,
    143       'None' AS value
    144    FROM ticket
    145    WHERE id NOT IN (
    146       SELECT ticket FROM ticket_custom WHERE name = 'request_source'
    147    );
    148 }}}
     151you must use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.
    149152
    150153----