Changes between Version 3 and Version 4 of TracTicketsCustomFields


Ignore:
Timestamp:
Sep 3, 2019, 8:57:48 PM (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracTicketsCustomFields

    v3 v4  
    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]`.
     6Configuring 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
    18 A 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 
    20 The 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 
    5217=== Available Field Types and Options
    5318
    … …  
    5520   * label: Descriptive label.
    5621   * value: Default value.
    57    * order: Sort order placement; this determines relative placement in forms with respect to other custom fields.
     22   * order: Sort order placement relative to other custom fields.
     23   * max_size: Maximum allowed size in characters (//Since 1.3.2//).
    5824   * format: One of:
    5925     * `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'')
     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
    6329 * '''checkbox''': A boolean value check box.
    6430   * label: Descriptive label.
    … …  
    7844   * label: Descriptive label.
    7945   * value: Default text.
    80    * cols: Width in columns. //(Removed in 1.1.2)//
    8146   * rows: Height in lines.
    8247   * order: Sort order placement.
     48   * max_size: Maximum allowed size in characters (//Since 1.3.2//).
    8349   * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting.
    84  * '''time''': Date and time picker. (''Since 1.1.1.'')
     50 * '''time''': Date and time picker. (//Since 1.1.1//)
    8551   * label: Descriptive label.
    8652   * value: Default date.
    … …  
    11985test_five = radio
    12086test_five.label = Radio buttons are fun
    121 test_five.options = uno|dos|tres|cuatro|cinco
     87test_five.options = |uno|dos|tres|cuatro|cinco
    12288test_five.value = dos
    12389
    … …  
    144110}}}
    145111
    146 '''Note''': To make a `select` type field optional, specify a leading `|` in the `fieldname.options` option.
     112'''Note''': To make a `select` type field optional, specify a leading `|` in `fieldname.options` (e.g. `test_five`).
    147113
    148114=== Reports Involving Custom Fields
    … …  
    178144Note in particular the `LEFT OUTER JOIN` statement here.
    179145
    180 Note that if your config file uses an '''uppercase''' name:
     146Note that option names in trac.ini are case-insensitive, so even if your option name includes uppercase characters:
    181147{{{#!ini
    182148[ticket-custom]
    183 
    184149Progress_Type = text
    185150}}}
    186 you would use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.
     151you must use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.
    187152
    188153----