Changes between Version 1 and Version 2 of TracTicketsCustomFields

Timestamp:

05/10/20 17:24:38 (5 years ago)

Author:

trac

Comment:

--

TracTicketsCustomFields

@@ -4 +4 @@
 == 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]`.
+Configuring custom ticket fields in the [TracIni#ticket-custom-section "[ticket-custom]"] section of trac.ini.
 
 The syntax of each field definition is:
@@ -20 +20 @@
    * label: Descriptive label.
    * value: Default value.
-   * order: Sort order placement; this determines relative placement in forms with respect to other custom fields.
+   * order: Sort order placement relative to other custom fields.
+   * max_size: Maximum allowed size in characters (//Since 1.3.2//).
    * format: One of: 
      * `plain` for plain text 
-     * `wiki` to interpret the content as WikiFormatting
-     * `reference` to treat the content as a queryable value (''since 1.0'') 
-     * `list` to interpret the content as a list of queryable values, separated by whitespace (''since 1.0'')
+     * `wiki` for [WikiFormatting wiki formatted] content
+     * `reference` to treat the content as a queryable value
+     * `list` to interpret the content as a list of queryable values, separated by whitespace
  * '''checkbox''': A boolean value check box.
    * label: Descriptive label.
@@ -43 +44 @@
    * label: Descriptive label.
    * value: Default text.
-   * cols: Width in columns. //(Removed in 1.1.2)//
    * rows: Height in lines.
    * order: Sort order placement.
+   * max_size: Maximum allowed size in characters (//Since 1.3.2//).
    * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting.
- * '''time''': Date and time picker. (''Since 1.1.1.'')
+ * '''time''': Date and time picker. (//Since 1.1.1//)
    * label: Descriptive label.
    * value: Default date.
@@ -84 +85 @@
 test_five = radio
 test_five.label = Radio buttons are fun
-test_five.options = uno|dos|tres|cuatro|cinco
+test_five.options = |uno|dos|tres|cuatro|cinco
 test_five.value = dos
 
@@ -109 +110 @@
 }}}
 
-'''Note''': To make a `select` type field optional, specify a leading `|` in the `fieldname.options` option.
+'''Note''': To make a `select` type field optional, specify a leading `|` in `fieldname.options` (e.g. `test_five`).
 
 === Reports Involving Custom Fields
@@ -143 +144 @@
 Note in particular the `LEFT OUTER JOIN` statement here.
 
-Note that if your config file uses an '''uppercase''' name:
+Note that option names in trac.ini are case-insensitive, so even if your option name includes uppercase characters:
 {{{#!ini
 [ticket-custom]
-
 Progress_Type = text
 }}}
-you would use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.
+you must use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.
 
 ----