Changes between Version 4 and Version 5 of TracTicketsCustomFields


Ignore:
Timestamp:
Aug 3, 2021, 7:27:01 PM (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracTicketsCustomFields

    v4 v5  
    44== Configuration
    55
    6 Configuring custom ticket fields is done in the [wiki:TracIni trac.ini] file. All field definitions should be under a section named `[ticket-custom]`.
     6Configure custom ticket fields in the [TracIni#ticket-custom-section "[ticket-custom]"] section of trac.ini.
    77
    88The syntax of each field definition is:
    … …  
    1515The example below should help to explain the syntax.
    1616
     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
    1752=== Available Field Types and Options
    1853
    … …  
    2055   * label: Descriptive label.
    2156   * value: Default value.
    22    * order: Sort order placement; this determines relative placement in forms with respect to other custom fields.
    23    * format: One of:
    24      * `plain` for plain text
    25      * `wiki` to interpret the content as WikiFormatting
    26      * `reference` to treat the content as a queryable value (''since 1.0'')
    27      * `list` to interpret the content as a list of queryable values, separated by whitespace (''since 1.0'')
     57   * order: Sort order placement relative to other custom fields.
     58   * max_size: Maximum allowed size in characters (//Since 1.3.2//).
     59   * format: One of:
     60     * `plain` for plain text
     61     * `wiki` for [WikiFormatting wiki formatted] content
     62     * `reference` to treat the content as a queryable value
     63     * `list` to interpret the content as a list of queryable values, separated by whitespace
    2864 * '''checkbox''': A boolean value check box.
    2965   * label: Descriptive label.
    … …  
    4379   * label: Descriptive label.
    4480   * value: Default text.
    45    * cols: Width in columns. //(Removed in 1.1.2)//
    4681   * rows: Height in lines.
    4782   * order: Sort order placement.
     83   * max_size: Maximum allowed size in characters (//Since 1.3.2//).
    4884   * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting.
    49  * '''time''': Date and time picker. (''Since 1.1.1.'')
     85 * '''time''': Date and time picker. (//Since 1.1.1//)
    5086   * label: Descriptive label.
    5187   * value: Default date.
    … …  
    84120test_five = radio
    85121test_five.label = Radio buttons are fun
    86 test_five.options = uno|dos|tres|cuatro|cinco
     122test_five.options = |uno|dos|tres|cuatro|cinco
    87123test_five.value = dos
    88124
    … …  
    109145}}}
    110146
    111 '''Note''': To make a `select` type field optional, specify a leading `|` in the `fieldname.options` option.
     147'''Note''': To make a `select` type field optional, specify a leading `|` in `fieldname.options` (e.g. `test_five`).
    112148
    113149=== Reports Involving Custom Fields
    … …  
    143179Note in particular the `LEFT OUTER JOIN` statement here.
    144180
    145 Note that if your config file uses an '''uppercase''' name:
     181Note that option names in trac.ini are case-insensitive, so even if your option name includes uppercase characters:
    146182{{{#!ini
    147183[ticket-custom]
    148 
    149184Progress_Type = text
    150185}}}
    151 you would use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.
     186you must use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.
    152187
    153188----