Changes between Version 1 and Version 2 of TracTicketsCustomFields

Timestamp:

12/14/10 02:51:48 (13 years ago)

Author:

trac

Comment:

--

TracTicketsCustomFields

@@ -1 @@
-= カスタムチケット属性 =
-Trac ではチケットにユーザ定義の属性を追加できます。カスタムチケット属性を使用すると、定型で、プロジェクト特有のプロパティをチケットに持たせることができます。
+= Custom Ticket Fields =
+Trac supports adding custom, user-defined fields to the ticket module. Using custom fields, you can add typed, site-specific properties to tickets.
 
-== 設定方法 ==
-カスタムチケット属性を設定するためには、 [wiki:TracIni trac.ini] ファイルを変更します。カスタムフィールドは、 trac.ini ファイルの `[ticket-custom]` セクションに書く必要があります。
+== Configuration ==
+Configuring custom ticket fields is done in the [wiki:TracIni trac.ini] file. All field definitions should be under a section named `[ticket-custom]`.
 
-各属性の定義は以下のように記述します:
+The syntax of each field definition is:
 {{{
- 属性名 = タイプ
- (属性名.オプション = 値)
+ FIELD_NAME = TYPE
+ (FIELD_NAME.OPTION = VALUE)
  ...
 }}}
-構文の詳細は以下の例を見てください。
+The example below should help to explain the syntax.
 
-=== 属性のタイプとオプション ===
- * '''text''': シンプルな(1行の)テキスト。
-   * label: 説明となるラベル
-   * value: デフォルト値
-   * order: ソート時の並び順 (フォーム内での相対的位置を決定します。)
- * '''checkbox''': ブーリアン値をもつチェックボックス。
-   * label: 説明となるラベル。
-   * value: デフォルト値 (0 または 1).
-   * order: ソート時の並び順
- * '''select''': ドロップダウンするリストボックス。
-   * options: リストに表示する値を '''|''' (vertical pipe) 区切りで記述。
-   * value: デフォルト値 (0から始まるリスト内での番号) 。
-   * order: ソート時の並び順
- * '''radio''': ラジオボタン。HTMLの '''select''' 要素と同じ。
-   * label: 説明となるラベル。
-   * options: リストに表示する値を '''|''' (vertical pipe) 区切りで記述。
-   * value: デフォルト値 (0から始まるリスト内での番号) 。
-   * order: ソート時の並び順
- * '''textarea''': 複数行のテキストエリア。
-   * label: 説明となるラベル。
-   * value: デフォルトで設定されるテキスト。
-   * cols: 入力領域のカラム幅。
-   * rows: 入力領域の行数。
-   * order: ソート時の並び順
+=== Available Field Types and Options ===
+ * '''text''': A simple (one line) text field.
+   * label: Descriptive label.
+   * value: Default value.
+   * order: Sort order placement. (Determines relative placement in forms with respect to other custom fields.)
+   * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting. (''since 0.11.3'')
+ * '''checkbox''': A boolean value check box.
+   * label: Descriptive label.
+   * value: Default value (0 or 1).
+   * order: Sort order placement.
+ * '''select''': Drop-down select box. Uses a list of values.
+   * label: Descriptive label.
+   * options: List of values, separated by '''|''' (vertical pipe).
+   * value: Default value (one of the values from options).
+   * order: Sort order placement.
+ * '''radio''': Radio buttons. Essentially the same as '''select'''.
+   * label: Descriptive label.
+   * options: List of values, separated by '''|''' (vertical pipe).
+   * value: Default value (one of the values from options).
+   * order: Sort order placement.
+ * '''textarea''': Multi-line text area.
+   * label: Descriptive label.
+   * value: Default text.
+   * cols: Width in columns.
+   * rows: Height in lines.
+   * order: Sort order placement.
+   * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting. (''since 0.11.3'')
 
-=== サンプル ===
+=== Sample Config ===
 {{{
 [ticket-custom]
@@ -47 +50 @@
 test_two = text
 test_two.label = Another text-box
-test_two.value = Just a default value
+test_two.value = Default [mailto:joe@nospam.com owner]
+test_two.format = wiki
 
 test_three = checkbox
@@ -56 +60 @@
 test_four.label = My selectbox
 test_four.options = one|two|third option|four
-test_four.value = 2
+test_four.value = two
 
 test_five = radio
 test_five.label = Radio buttons are fun
 test_five.options = uno|dos|tres|cuatro|cinco
-test_five.value = 1
+test_five.value = dos
 
 test_six = textarea
@@ -70 +74 @@
 }}}
 
-''Note: `select` タイプのフィールドを非必須(optional)にしたい場合、 `フィールド名.options` オプションの先頭に `バーティカルパイプ (|)` を設定してください。''
+''Note: To make entering an option for a `select` type field optional, specify a leading `|` in the `fieldname.options` option.''
 
-=== カスタム属性を含むレポート ===
+=== Reports Involving Custom Fields ===
 
-カスタム属性を含む TracReports では比較的 SQL を間違えやすいです。 `ticket_custom` 表の `JOIN` はカスタム属性ごとにそれぞれ必要です。
+Custom 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`.
 
-以下の例は `progress` という名前のカスタム属性を含むレポートです:
+{{{
+#!sql
+SELECT p.value AS __color__,
+   id AS ticket, summary, owner, c.value AS progress
+  FROM ticket t, enum p, ticket_custom c
+  WHERE status IN ('assigned') AND t.id = c.ticket AND c.name = 'progress'
+AND p.name = t.priority AND p.type = 'priority'
+  ORDER BY p.value
+}}}
+'''Note''' that this will only show tickets that have progress set in them, which 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. If that's all you want, you're set.
+
+However, 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.
 {{{
 #!sql
@@ -93 +108 @@
 }}}
 
-この `LEFT OUTER JOIN` ステートメントに特に注意してください。
+Note in particular the `LEFT OUTER JOIN` statement here.
+
+=== Updating the database ===
+
+As noted above, any tickets created before a custom field has been defined will not have a value for that field. Here's a bit of SQL (tested with SQLite) that you can run directly on the Trac database to set an initial value for custom ticket fields. Inserts the default value of 'None' into a custom field called 'request_source' for all tickets that have no existing value:
+
+{{{
+#!sql
+INSERT INTO ticket_custom
+   (ticket, name, value)
+   SELECT 
+      id AS ticket,
+      'request_source' AS name,
+      'None' AS value
+   FROM ticket 
+   WHERE id NOT IN (
+      SELECT ticket FROM ticket_custom
+   );
+}}}
+
+If you added multiple custom fields at different points in time, you should be more specific in the subquery on table {{{ticket}}} by adding the exact custom field name to the query:
+
+{{{
+#!sql
+INSERT INTO ticket_custom
+   (ticket, name, value)
+   SELECT 
+      id AS ticket,
+      'request_source' AS name,
+      'None' AS value
+   FROM ticket 
+   WHERE id NOT IN (
+      SELECT ticket FROM ticket_custom WHERE name = 'request_source'
+   );
+}}}
 
 ----