Changes between Version 2 and Version 3 of TracTicketsCustomFields


Ignore:
Timestamp:
Jun 28, 2019, 2:20:16 PM (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracTicketsCustomFields

    v2 v3  
    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 is done in the [wiki:TracIni trac.ini] file. All field definitions should be under a section named `[ticket-custom]`.
     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=== Field Names
     18A field name can only contain lowercase letters a-z, uppercase letters A-Z or digits 0-9, and must not start with a leading digit.
     19
     20The following field names are reserved and can not be used for custom fields:
     21* cc
     22* changetime
     23* col
     24* comment
     25* component
     26* desc
     27* description
     28* format
     29* group
     30* groupdesc
     31* id
     32* keywords
     33* max
     34* milestone
     35* or
     36* order
     37* owner
     38* page
     39* priority
     40* report
     41* reporter
     42* resolution
     43* row
     44* severity
     45* status
     46* summary
     47* time
     48* type
     49* verbose
     50* version
     51
     52=== Available Field Types and Options
     53
     54 * '''text''': A simple (one line) text field.
     55   * label: Descriptive label.
     56   * value: Default value.
     57   * order: Sort order placement; this determines relative placement in forms with respect to other custom fields.
     58   * format: One of:
     59     * `plain` for plain text
     60     * `wiki` to interpret the content as WikiFormatting
     61     * `reference` to treat the content as a queryable value (''since 1.0'')
     62     * `list` to interpret the content as a list of queryable values, separated by whitespace (''since 1.0'')
     63 * '''checkbox''': A boolean value check box.
     64   * label: Descriptive label.
     65   * value: Default value, 0 or 1.
     66   * order: Sort order placement.
     67 * '''select''': Drop-down select box. Uses a list of values.
     68   * label: Descriptive label.
     69   * options: List of values, separated by '''|''' (vertical pipe).
     70   * value: Default value (one of the values from options).
     71   * order: Sort order placement.
     72 * '''radio''': Radio buttons. Essentially the same as '''select'''.
     73   * label: Descriptive label.
     74   * options: List of values, separated by '''|''' (vertical pipe).
     75   * value: Default value, one of the values from options.
     76   * order: Sort order placement.
     77 * '''textarea''': Multi-line text area.
     78   * label: Descriptive label.
     79   * value: Default text.
     80   * cols: Width in columns. //(Removed in 1.1.2)//
     81   * rows: Height in lines.
     82   * order: Sort order placement.
     83   * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting.
     84 * '''time''': Date and time picker. (''Since 1.1.1.'')
     85   * label: Descriptive label.
     86   * value: Default date.
     87   * order: Sort order placement.
     88   * format: One of:
     89     * `relative` for relative dates.
     90     * `date` for absolute dates.
     91     * `datetime` for absolute date and time values.
     92
     93If the `label` is not specified, it will be created by capitalizing the custom field name and replacing underscores with whitespaces.
     94
     95Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`.
     96
     97=== Sample Configuration
     98
     99{{{#!ini
    49100[ticket-custom]
    50101
    … …  
    76127test_six.cols = 60
    77128test_six.rows = 30
     129
     130test_seven = time
     131test_seven.label = A relative date
     132test_seven.format = relative
     133test_seven.value = now
     134
     135test_eight = time
     136test_eight.label = An absolute date
     137test_eight.format = date
     138test_eight.value = yesterday
     139
     140test_nine = time
     141test_nine.label = A date and time
     142test_nine.format = datetime
     143test_nine.value = in 2 hours
    78144}}}
    79145
    80 ''Note: `select` タイプのフィールドを非必須 (optional) にしたい場合、 `フィールド名.options` オプションの先頭に `バーティカルパイプ (|)` を設定してください。''
     146'''Note''': To make a `select` type field optional, specify a leading `|` in the `fieldname.options` option.
    81147
    82 === カスタム属性を含むレポート === #ReportsInvolvingCustomFields
     148=== Reports Involving Custom Fields
    83149
    84 カスタムチケット属性は `ticket` テーブルに保存されるのではなく、 `ticket_custom` テーブルに保存されます。したがって、レポートのカスタム属性を表示するためには `ticket` と `ticket_custom` の 2 テーブルを join する必要があります。 `progress` と設定されたカスタムチケット属性の使用例を示します。
     150Custom 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`.
    85151
    86 {{{
    87 #!sql
     152{{{#!sql
    88153SELECT p.value AS __color__,
    89154   id AS ticket, summary, owner, c.value AS progress
    … …  
    93158  ORDER BY p.value
    94159}}}
    95 '''Note''' この例は progress が設定されたチケットだけを表示します。'''すべてのチケットを表示するのではありません。'''既にいくつかのチケットを作成した''後で''カスタムチケット属性を定義した場合、既に作成されたチケットにはカスタムチケット属性が定義されません。そのため上記のクエリではチケットが表示されないでしょう。既に作成されたチケットにカスタム属性を設定し直せば、カスタムチケット属性は定義されます。そして、上記のクエリによって表示されるでしょう。
     160'''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.
    96161
    97 しかし、すべてのチケットエントリを ( progress が定義されていないエントリーも一緒に ) 表示したいのであれば、クエリにおいてあらゆるカスタムフィールドに `JOIN` を使用する必要があります。
    98 {{{
    99 #!sql
     162However, 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:
     163{{{#!sql
    100164SELECT p.value AS __color__,
    101165   id AS ticket, summary, component, version, milestone, severity,
    … …  
    104168   changetime AS _changetime, description AS _description,
    105169   reporter AS _reporter,
    106   (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
     170   (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
    107171  FROM ticket t
    108172     LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress')
    … …  
    112176}}}
    113177
    114 この `LEFT OUTER JOIN` ステートメントに特に注意してください。
     178Note in particular the `LEFT OUTER JOIN` statement here.
    115179
    116 === データベースを更新する === #Updatingthedatabase
     180Note that if your config file uses an '''uppercase''' name:
     181{{{#!ini
     182[ticket-custom]
    117183
    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    );
     184Progress_Type = text
    132185}}}
    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 }}}
     186you would use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.
    149187
    150188----