Changes between Version 2 and Version 3 of TracTicketsCustomFields


Ignore:
Timestamp:
Apr 1, 2017, 10:40:26 PM (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracTicketsCustomFields

    v2 v3  
    11= Custom Ticket Fields
    2 
    3 Trac supports adding custom, user-defined fields to the ticket module. Using custom fields, you can add typed, site-specific properties to tickets.
     2Trac supports adding custom, user-defined fields to the ticket module. With custom fields you can add typed, site-specific properties to tickets.
    43
    54== Configuration
     
    2120   * label: Descriptive label.
    2221   * value: Default value.
    23    * order: Sort order placement. Determines relative placement in forms with respect to other custom fields.
     22   * order: Sort order placement; this determines relative placement in forms with respect to other custom fields.
    2423   * format: One of:
    2524     * `plain` for plain text
     
    2928 * '''checkbox''': A boolean value check box.
    3029   * label: Descriptive label.
    31    * value: Default value: 0 or 1.
     30   * value: Default value, 0 or 1.
    3231   * order: Sort order placement.
    3332 * '''select''': Drop-down select box. Uses a list of values.
     
    3938   * label: Descriptive label.
    4039   * options: List of values, separated by '''|''' (vertical pipe).
    41    * value: Default value (one of the values from options).
     40   * value: Default value, one of the values from options.
    4241   * order: Sort order placement.
    4342 * '''textarea''': Multi-line text area.
    4443   * label: Descriptive label.
    4544   * value: Default text.
    46    * cols: Width in columns
     45   * cols: Width in columns. //(Removed in 1.1.2)//
    4746   * rows: Height in lines.
    4847   * order: Sort order placement.
    4948   * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting.
     49 * '''time''': Date and time picker. (''Since 1.1.1.'')
     50   * label: Descriptive label.
     51   * value: Default date.
     52   * order: Sort order placement.
     53   * format: One of:
     54     * `relative` for relative dates.
     55     * `date` for absolute dates.
     56     * `datetime` for absolute date and time values.
     57
     58If the `label` is not specified, it will be created by capitalizing the custom field name and replacing underscores with whitespaces.
    5059
    5160Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`.
     
    8392test_six.cols = 60
    8493test_six.rows = 30
     94
     95test_seven = time
     96test_seven.label = A relative date
     97test_seven.format = relative
     98test_seven.value = now
     99
     100test_eight = time
     101test_eight.label = An absolute date
     102test_eight.format = date
     103test_eight.value = yesterday
     104
     105test_nine = time
     106test_nine.label = A date and time
     107test_nine.format = datetime
     108test_nine.value = in 2 hours
    85109}}}
    86110
    87 '''Note''': To make entering an option for a `select` type field optional, specify a leading `|` in the `fieldname.options` option.
     111'''Note''': To make a `select` type field optional, specify a leading `|` in the `fieldname.options` option.
    88112
    89113=== Reports Involving Custom Fields
     
    99123  ORDER BY p.value
    100124}}}
    101 
    102 '''Note''': 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 is all that is required, you're set.
     125'''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.
    103126
    104127However, 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: