Changes between Version 9 and Version 10 of WorkFlow

Timestamp:

Jan 27, 2006, 4:31:09 PM (18 years ago)

Author:

Alec Thomas

Comment:

Document ticket options

WorkFlow

@@ -18 +18 @@
  * ~~Need a clean way to differentiate between fields that should not be displayed in the summary and those that should not be displayed at all. eg. `summary` should be hidden in the ticket summary (as it is used for the title), and should only be editable by users with `TICKET_ADMIN` privileges. Perhaps the logic should be that if a field is `hidden` it is not displayed anywhere, unless it is also `editable`, in which case it is only displayed in the ticket properties.~~ [2837]
  * There are a number of locations in the ticket code where permissions are hard coded. As an example, the `TICKET_CREATE` permission is required to create a new ticket. Should this be overridable by `ITicketWorkflow` implementors?
+
+== Available Field Types and Options ==
+Common options:
+ * label: Descriptive label.
+ * value: Default value.
+ * order: Sort order placement. (Determines relative placement in forms.)
+ * hidden: Field is not displayed. Useful for storing extra ticket attributes programmatically (false by default).
+ * fullrow: Field spans a full row when displayed in the ticket properties.
+ * editable: Field is editable (true by default). If a field is hidden but editable, it will not display in the ticket summary but will be displayed and editable in the ticket properties.
+
+Types and type-specific options:
+ * '''text''': A simple (one line) text field.
+   * size: Size of text field.
+ * '''checkbox''': A boolean value check box.
+   * value: Default value (0 or 1).
+ * '''select''': Drop-down select box. Uses a list of values.
+   * options: List of values, separated by '''|''' (vertical pipe).
+   * value: Default value (Item #, starting at 0).
+ * '''radio''': Radio buttons. Essentially the same as '''select'''.
+   * options: List of values, separated by '''|''' (vertical pipe).
+   * value: Default value (Item #, starting at 0).
+ * '''textarea''': Multi-line text area.
+   * cols: Width in columns.
+   * rows: Height in lines.