TWiki Forms - Foundation of TWiki Applications

Tooltip message column: The Tooltip message will be displayed when the cursor is hovered over the field in edit view.

Changed:

<<

Attributes column:Attributes specifies special attributes for the field. Multiple attributes can be entered, separated by spaces.

An attribute H indicates that this field is hidden, e.g. not shown in view mode. However, the field is available for editing and storing information.

>>

Attributes column:Attributes may contain additional key="value" form field attributes, separated by space.

A hidden="1" attribute indicates that this field is hidden, e.g. not shown in view mode. However, the field is available for editing and storing information. The deprecated H attribute has the same function, it is still supported but might be removed in a future TWiki release.

Tip: The TWiki form header is suppressed in view mode if all fields of the form are hidden. For better usability it is good to hide the whole form if the display and interaction of all form fields is done externally. For example, the display and modification of form field values can be done in a header topic that is included in each page.

Changed:

<<

An attribute M indicates that this field is mandatory. The topic cannot be saved unless a value is provided for this field. If the field is found empty during topic save, an error is raised and the user is redirected to an oops page. Mandatory fields are indicated by an asterisks next to the field name.

>>

An mandatory="1" attribute indicates that this field is mandatory. The topic cannot be saved unless a value is provided for this field. If the field is found empty during topic save, an error is raised and the user is redirected to an oops page. Mandatory fields are indicated by an asterisks next to the field name. The deprecated M attribute has the same function, it is still supported but might be removed in a future TWiki release.

Additional form field type specific attributes can be used, such as onfocus="..." and spellcheck="..".

For example, a simple form just supporting entry of a name and a date would look as follows:

Line: 187 to 188

Name

Type

Size

Values

Tooltip message

Attributes

Changed:

<<

Many types of form fields are available. Some are TWiki internal, some are provided by extensions. Find more TWiki form field extensions on TWiki.org. The Size and Value depend on the Type used. Form field types:

>>

Many types of form fields are available. Some are TWiki internal, some are provided by extensions. Find more TWiki form field extensions on TWiki.org. The Size, Value and Attributes depend on the Type used. Form field types:

Single-line text box and a color picker to pick a color. The color can also be typed into the text box, such as #123456. An attribute of type="popup" shows a button that, when clicked, opens a color picker popup. See details.

Text box width in number of characters

Initial (default) color

date

Text input field and a button next to it to pick a date from a pop-up calendar. The date can also be typed into the text box. See details.

TWiki Forms - Foundation of TWiki Applications

Text field & select combination box, rendered as a text input field and a button to open up a selector box

Text box width in number of characters

Comma-space-separated list of options of the select box - can be a dynamic SEARCH

select

Select box, rendered as a picklist or a multi-row selector box depending on the size value

• 1: Show a picklist • Number > 1: Multi-row selector box of specified size • Range e.g. 3..10: Multi-row selector box with variable size - the box will never be smaller than 3 items, never larger than 10, and will be 5 high if there are only 5 options

Comma-space-separated list of options of the select box - can be a dynamic SEARCH

Like select, allowing definition of values that are different to the displayed text. For example:| Field 9 | select+values | 3 | One, Two=2, Three=III | Various values formats | shows but the values of options Two and Three are 2 and III, respectively.

>>

select+values

Like select, allowing definition of values that are different to the displayed text. An option is defined as value: title, where the value is the value passed on form submit, and title is the option text shown to the user. For example:| Field 9 | select+values | 3 | One, 2: Two, III: Three | Various values formats | shows but the values of options Two and Three are 2 and III, respectively. A legacy title=value syntax is supported as well, for example: One, Two=2, Three=III.

select+multi+values

Combination of select+multi and select+values

color

Single-line text box and a color picker to pick a color. The color can also be typed into the text box, such as #123456. An attribute of type="popup" shows a button that, when clicked, opens a color picker popup. See details.

Text box width in number of characters

Initial (default) color

date

Text input field and a button next to it to pick a date from a pop-up calendar. The date can also be typed into the text box. See details.

For each field, fill in a new line; for the type of field, select from the list.

Changed:

<<

Save the topic (you can later choose to enable/disable individual forms).

>>

Save the topic

Example:

Line: 79 to 80

When used in the value field of the form definition, this will find all topic names in the Main web which end in "Office" and use them as the legal field values.

Changed:

<<

Enabling Forms by Web

>>

Adding a Form to a Topic

Changed:

<<

Forms have to be enabled for each individual web. The WEBFORMS variable in WebPreferences is optional and defines a list of possible form templates.

Example:

Set WEBFORMS = BugForm, FeatureForm, Books.BookLoanForm

With WEBFORMS enabled, an extra button is added to the edit view. If the topic doesn't have a Form, an Add Form button appears at the end of the topic. If a Form is present, a Change button appears in the top row of the Form. The buttons open a screen that enables selection of a form specified in WEBFORMS, or the No form option.

You have to list the available form topics explicitly. You cannot use a SEARCH to define WEBFORMS.

Adding a form to a topic

Edit the topic and follow the "Add form" button to add a Form. This is typically done to a template topic, either to the WebTopicEditTemplate topic in a web, or a new topic that serves as an application specific template topic. Initial Form values can be set there.

>>

To add a Form, follow the "More topic actions" link at the bottom of a topic, select "Add or Replace Form".

Select a Form Template topic. These are topics with names ending in Form that contain a Form Template table.

A Form is typically added to a template topic, either to the WebTopicEditTemplate topic in a web, or a new topic that serves as an application specific template topic.

Modify the template topic to set the initial Form values.

Additionally a new topic can be given a Form using the formtemplate parameter in the (edit or save) URL. Initial values can then be provided in the URLs or as form values:

other than checkboxes: name, ex: ?BugPriority=1

Line: 105 to 100

Changed:

<<

Note: You can create a topic in one step, without going through the edit screen. To do that, specify the save script instead of the edit script in the form action. When you specify the save script you have to use the "post" method. Example:

>>

Note: You can create a topic in one step, without going through the edit screen. To do that, specify the save script instead of the edit script in the form action. When you specify the save script you have to use the "post" method. Example:

Note: Initial values will not be set in the form of a new topic if you only use the formtemplate parameter.

>>

Note: Initial values will not be set in the form of a new topic if you only use the formtemplate parameter.

Changed:

<<

Changing a form

>>

Changing a Form

Changed:

<<

You can change a form definition, and TWiki will try to make sure you don't lose any data from the topics that use that form.

>>

To change a Form, follow the "More topic actions" link at the bottom of a topic, select "Add or Replace Form", and select a new Form.

Changed:

<<

If you change the form definition, the changes will not take affect in a topic that uses that form until you edit and save it.

>>

You can change a form definition, and TWiki will try to make sure you don't lose any data from the topics that use that form.

If you add a new field to the form, then it will appear next time you edit a topic that uses the form.

Line: 200 to 196

checkbox

One or more checkboxes that can be toggled individually

Number of checkboxes shown per line

Comma-space-separated list of item labels - can be a dynamic SEARCH

checkbox+buttons

Like checkbox, adding [Set] and [Clear] buttons

radio

Radio buttons, mutually exclusive; only one can be selected

Number of radio buttons shown per line

Comma-space-separated list of item labels - can be a dynamic SEARCH

Added:

>>

combobox

Text field & select combination box, rendered as a text input field and a button to open up a selector box

Text box width in number of characters

Comma-space-separated list of options of the select box - can be a dynamic SEARCH

select

Select box, rendered as a picklist or a multi-row selector box depending on the size value

• 1: Show a picklist • Number > 1: Multi-row selector box of specified size • Range e.g. 3..10: Multi-row selector box with variable size - the box will never be smaller than 3 items, never larger than 10, and will be 5 high if there are only 5 options

Comma-space-separated list of options of the select box - can be a dynamic SEARCH

Like select, allowing definition of values that are different to the displayed text. For example:| Field 9 | select+values | 3 | One, Two=2, Three=III | Various values formats | shows but the values of options Two and Three are 2 and III, respectively.

Line: 228 to 225

Notes:

The Values column must be empty in the referring form definition.

Added:

>>

Using a form template on a different web

You can use a form template on a different web by specifying a form template in the WEB.TOPIC format.

In addition, you can put a comma separated list of webs in the TWIKIFORMPATH variable.
It's referred to only when a form template is spcified without a web (TOPIC instead of WEB.TOPIC).
The webs in TWIKIFORMPATH are examined in the listed order until the specified template is found.

TWIKIFORMPATH may contain TWiki variables. For example:

* Set TWIKIFORMPATH = %APPLICATION_WEB%, %WEB%

If TWIKIFORMPATH is defined, the current web is examined only if all the webs listed in it don't have the form template.

Extending the range of form data types

You can extend the range of data types accepted by forms by using TWikiPlugins. All such extended data types are single-valued (can only have one value) with the following exceptions:

Line: 244 to 256

To display only the form whenever you edit a topic, set the preference variable EDITACTION to value form (see details).

To change the edit action in a URL, add a action=form parameter to the edit URL string, such as%SCRIPTURL{edit}%/%BASEWEB%/%BASETOPIC%?t=%SERVERTIME{$epoch}%;action=form (see details).

Added:

>>

Build an HTML Form to Create New Form-based Topics

New topics with a form are created by simple HTML forms asking for a topic name. For example, you can have a SubmitExpenseReport topic where you can create new expense reports, a SubmitVacationRequest topic, and so on. These can specify the required template topic with its associated form. Template topics has more.

A Form Template specifies the fields in a form. A Form Template is simply a page containing a TWiki table, where each row of the table specifies one form field.

Added:

>>

Update Specific Form Fields

All the form fields are shown and can be updated when editing a topic that has a form. It is possible to have more control over the layout of a form, or update just a subset of the form fields by using a custom HTML form. For example, in a bug tracker, each topic would include a header topic that shows a form with some fields to update specific form fields of the bug item. Use the EDITFORMFIELD variable to easily create this form in the header topic. Example:

Assuming the base topic has a BugForm with Priority and Status fields of type select, a LastUpdate field of type text, and some other fields. Above form shows a table with selectors for Priority and Status, and an Update button. On form submit, the Priority, Status and LastUpdate fields are updated in the base topic.

Select box, rendered as a picklist or a multi-row selector box depending on the size value

• 1: Show a picklist • Number > 1: Multi-row selector box of specified size • Range e.g. 3..10: Multi-row selector box with variable size - the box will never be smaller than 3 items, never larger than 10, and will be 5 high if there are only 5 options

Comma-space-separated list of options of the select box - can be a dynamic SEARCH

Like select, allowing definition of values that are different to the displayed text. For example:| Field 9 | select+values | 3 | One, Two=2, Three=III | Various values formats | shows but the values of options Two and Three are 2 and III, respectively.

select+multi+values

Combination of select+multi and select+values

color

Single-line text box and a color picker to pick a color. The color can also be typed into the text box, such as #123456. An attribute of type="popup" shows a button that, when clicked, opens a color picker popup. See details.

Text box width in number of characters

Initial (default) color

date

Text input field and a button next to it to pick a date from a pop-up calendar. The date can also be typed into the text box. See details.

Text box width in number of characters

Initial (default) date

>>

The Name, Type and Size columns are required. Other columns are optional. The form template must have a header row, e.g. at least | *Name* | *Type* | *Size* | is required. Columns:

Changed:

<<

Tooltip message column: The Tooltip message will be displayed when the cursor is hovered over the field in edit view.

>>

Name column:Name is the name of the form field.

Changed:

<<

Attributes column:Attributes specifies special attributes for the field. Multiple attributes can be entered, separated by spaces.

>>

Type, Size, Value columns:Type, Size and Value describe the type, size and initial value of this form field. Type text, checkbox, select and more are described in the Form Field Types section below.

Changed:

<<

An attribute H indicates that this field is hidden, e.g. not shown in view mode. However, the field is available for editing and storing information.

>>

Tooltip message column: The Tooltip message will be displayed when the cursor is hovered over the field in edit view.

Changed:

<<

An attribute M indicates that this field is mandatory. The topic cannot be saved unless a value is provided for this field. If the field is found empty during topic save, an error is raised and the user is redirected to an oops page. Mandatory fields are indicated by an asterisks next to the field name.

>>

Attributes column:Attributes specifies special attributes for the field. Multiple attributes can be entered, separated by spaces.

An attribute H indicates that this field is hidden, e.g. not shown in view mode. However, the field is available for editing and storing information. Tip: The TWiki form header is suppressed in view mode if all fields of the form are hidden. For better usability it is good to hide the whole form if the display and interaction of all form fields is done externally. For example, the display and modification of form field values can be done in a header topic that is included in each page.

An attribute M indicates that this field is mandatory. The topic cannot be saved unless a value is provided for this field. If the field is found empty during topic save, an error is raised and the user is redirected to an oops page. Mandatory fields are indicated by an asterisks next to the field name.

For example, a simple form just supporting entry of a name and a date would look as follows:

Line: 194 to 183

The topic definition is not read when a topic is viewed.

Form definition topics can be protected in the usual manner, using TWikiAccessControl, to limit who can change the form template and/or individual value lists. Note that view access is required to be able to edit topics that use the form definition, though view access to the form definition is not required to view a topic where the form has been used.

Added:

>>

Form Field Types

Each table row of a form template defines one element of an input field:

Name

Type

Size

Values

Tooltip message

Attributes

Many types of form fields are available. Some are TWiki internal, some are provided by extensions. Find more TWiki form field extensions on TWiki.org. The Size and Value depend on the Type used. Form field types:

Select box, rendered as a picklist or a multi-row selector box depending on the size value

• 1: Show a picklist • Number > 1: Multi-row selector box of specified size • Range e.g. 3..10: Multi-row selector box with variable size - the box will never be smaller than 3 items, never larger than 10, and will be 5 high if there are only 5 options

Comma-space-separated list of options of the select box - can be a dynamic SEARCH

Like select, allowing definition of values that are different to the displayed text. For example:| Field 9 | select+values | 3 | One, Two=2, Three=III | Various values formats | shows but the values of options Two and Three are 2 and III, respectively.

select+multi+values

Combination of select+multi and select+values

color

Single-line text box and a color picker to pick a color. The color can also be typed into the text box, such as #123456. An attribute of type="popup" shows a button that, when clicked, opens a color picker popup. See details.

Text box width in number of characters

Initial (default) color

date

Text input field and a button next to it to pick a date from a pop-up calendar. The date can also be typed into the text box. See details.

Text box width in number of characters

Initial (default) date

Values in Other Topics

As described above, you can also retrieve possible values for select, checkbox or radio types from other topics. For example, if you have a rows defined like this:

Defining a Form

A Form Template specifies the fields in a form. A Form Template is simply a page containing a TWiki table, where each row of the table specifies one form field.

Line: 157 to 159

Attributes column:Attributes specifies special attributes for the field. Multiple attributes can be entered, separated by spaces.

Changed:

<<

An attribute H indicates that this field should not be shown in view mode. However, the field is available for editing and storing information.

>>

An attribute H indicates that this field is hidden, e.g. not shown in view mode. However, the field is available for editing and storing information.

An attribute M indicates that this field is mandatory. The topic cannot be saved unless a value is provided for this field. If the field is found empty during topic save, an error is raised and the user is redirected to an oops page. Mandatory fields are indicated by an asterisks next to the field name.

For example, a simple form just supporting entry of a name and a date would look as follows:

Select box, rendered as a picklist or a multi-row selector box depending on the size value

• 1: Show a picklist • Number > 1: Multi-row selector box of specified size • Range e.g. 3..10: Multi-row selector box with variable size - the box will never be smaller than 3 items, never larger than 10, and will be 5 high if there are only 5 options

Comma-space-separated list of options of the select box - can be a dynamic SEARCH

color

Single-line text box and a color picker to pick a color. The color can also be typed into the text box, such as #123456. An attribute of type="popup" shows a button that, when clicked, opens a color picker popup. See details.

Text box width in number of characters

Initial (default) color

text

One-line text field

Text box width in number of characters

Initial (default) content

textarea

Multi-line text box

Columns x rows, such as 80x6; default is 40x5

Initial (default) content

date

Text input field and a button next to it to pick a date from a pop-up calendar. The date can also be typed into the text box. See details.

Text box width in number of characters

Initial (default) date

checkbox+buttons

Like checkbox, adding [Set] and [Clear] buttons

select+values

Like select, allowing definition of values that are different to the displayed text. For example:| Field 9 | select+values | 3 | One, Two=2, Three=III | Various values formats | shows but the values of options Two and Three are 2 and III, respectively.

The Type, Size and Value fields describe the legal values for this field, and how to display them.

Typecheckbox specifies one or more checkboxes. The Size field specifies how many checkboxes will be displayed on each line. The Value field should be a comma-separated list of item labels.

Typecheckbox+buttons will add Set and Clear buttons to the basic checkbox type.

Typeradio is like checkbox except that radio buttons are mutually exclusive; only one can be selected.

Typelabel specifies read-only label text. The Value field should contain the text of the label.

Typeselect specifies a select box. The Value field should contain a comma-separated list of options for the box. The Size field can specify a fixed size for the box (e.g. 1, or a range e.g. 3..10. If you specify a range, then the box will never be smaller than 3 items, never larger than 10, and will be 5 high if there are only 5 options.

There are two modifiers that can be applied to the select type:

select+multi turns multiselect on for the select, to allow Shift+Click and Ctrl+Click to select (or deselect) multiple items.

select+values allows the definition of values that are different to the displayed text. For example:

shows but the values or options Two and Three are 2 and III respectively. You can combine these modifiers e.g. select+multi+values

Typetext specifies a one-line text field. Size specifies the text box width in number of characters. Value is the initial (default) content when a new topic is created with this form template.

Typetextarea specifies a multi-line text box. The Size field should specify columns x rows, e.g. 80x6; default size is 40x5. As for text, the Value field specifies the initial text

Typedate specifies a single-line text box and a button next to it; clicking on the button will bring up a calendar from which the user can select a date. The date can also be typed into the text box. Size specifies the text box width in characters. As for text, the Value field specifies the initial text

>>

Tooltip message column: The Tooltip message will be displayed when the cursor is hovered over the field in edit view.

Changed:

<<

Tooltip message is a message that will be displayed when the cursor is hovered over the field in edit view.

>>

Attributes column:Attributes specifies special attributes for the field. Multiple attributes can be entered, separated by spaces.

Deleted:

<<

Attributes specifies special attributes for the field. Multiple attributes can be entered, separated by spaces.

An attribute H indicates that this field should not be shown in view mode. However, the field is available for editing and storing information.

An attribute M indicates that this field is mandatory. The topic cannot be saved unless a value is provided for this field. If the field is found empty during topic save, an error is raised and the user is redirected to an oops page. Mandatory fields are indicated by an asterisks next to the field name.

Line: 208 to 221

Types with names like this can both take multiple values.

Hints and Tips

Changed:

<<

Build an HTML form to create new Form-based topics

New topics with a form are created by simple HTML forms asking for a topic name. For example, you can have a SubmitExpenseReport topic where you can create new expense reports, a SubmitVacationRequest topic, and so on. These can specify the required template topic with its associated form. Template topics has more.

>>

Editing Just Form Data, Without Topic Text

In some cases you want to change only the form data. You have the option of hiding the topic text with two methods:

To display only the form whenever you edit a topic, set the preference variable EDITACTION to value form (see details).

To change the edit action in a URL, add a action=form parameter to the edit URL string, such as%SCRIPTURL{edit}%/%BASEWEB%/%BASETOPIC%?t=%SERVERTIME{$epoch}%;action=form (see details).

Build an HTML Form to Create New Form-based Topics

New topics with a form are created by simple HTML forms asking for a topic name. For example, you can have a SubmitExpenseReport topic where you can create new expense reports, a SubmitVacationRequest topic, and so on. These can specify the required template topic with its associated form. Template topics has more.

A Form Template specifies the fields in a form. A Form Template is simply a page containing a TWiki table, where each row of the table specifies one form field.

TWiki Forms

Line: 100 to 100

Added:

>>

Note: You can create a topic in one step, without going through the edit screen. To do that, specify the save script instead of the edit script in the form action. When you specify the save script you have to use the "post" method. Example:

Overview

Changed:

<<

By adding form-based input to freeform content, you can structure topics with unlimited, easily searchable categories. A form is enabled for a web and can be added to a topic. The form data is shown in tabular format when the topic is viewed, and can be changed in edit mode using edit fields, radio buttons, check boxes and list boxes. Many different form types can be defined in a web, though a topic can only have only form attached to it at a time.

>>

By adding form-based input to freeform content, you can structure topics with unlimited, easily searchable categories. A form is enabled for a web and can be added to a topic. The form data is shown in tabular format when the topic is viewed, and can be changed in edit mode using edit fields, radio buttons, check boxes and list boxes. Many different form types can be defined in a web, though a topic can only have one form attached to it at a time.

Typical steps to build an application based on TWiki forms:

Define a form template

Line: 64 to 65

Public FAQ

Changed:

<<

Field values can also be obtained as the result of a FormattedSearch. For example,

>>

Field values can also be set using the result of expanding other TWiki variables. For example,

Enabling Forms by Web

Note: Initial values will not be submitted to the form of a new topic if you only use the formtemplate parameter.

>>

Note: Initial values will not be set in the form of a new topic if you only use the formtemplate parameter.

Changing a form

You can change a form definition, and TWiki will try to make sure you don't lose any data from the topics that use that form.

Line: 129 to 130

Typecheckbox specifies one or more checkboxes. The Size field specifies how many checkboxes will be displayed on each line. The Value field should be a comma-separated list of item labels.

Typecheckbox+buttons will add Set and Clear buttons to the basic checkbox type.

Typeradio is like checkbox except that radio buttons are mutually exclusive; only one can be selected.

Changed:

<<

Typelabel specifies read-only label text, The Value field should contian the text of the label.

>>

Typelabel specifies read-only label text. The Value field should contain the text of the label.

Typeselect specifies a select box. The Value field should contain a comma-separated list of options for the box. The Size field can specify a fixed size for the box (e.g. 1, or a range e.g. 3..10. If you specify a range, then the box will never be smaller than 3 items, never larger than 10, and will be 5 high if there are only 5 options.

There are two modifiers that can be applied to the select type:

select+multi turns multiselect on for the select, to allow Shift+Click and Ctrl+Click to select (or deselect) multiple items.

Line: 162 to 163

Field Value Notes:

The field value will be used to initialize a field when a form is created, unless specific values are given by the topic template or query parameters. The first item in the list for a select or radio type is the default item. For label, text, and textarea fields the value may also contain commas. checkbox fields cannot be initialized through the form template.

Leading and trailing spaces are not significant.

Changed:

<<

Field values can also be generated through a FormattedSearch, which must yield a suitable table as the result.

Variables in the initial values of a form definition get expanded when form values are initialized from the form definition. The escape words $quot ("), $percnt (%), $dollar ($), $n (newline), and $nop can be used to prevent expansion.

>>

Field values can also be generated through a FormattedSearch, which must yield a suitable table as the result.

Variables in the initial values of a form definition get expanded when the form definition is loaded.

If you want to use a | character in the initial values field, you have to precede it with a backslash, thus: \|.

You can use <nop> to prevent TWiki variables from being expanded.

The FormatTokens can be used to prevent expansion of other characters.

General Notes:

The topic definition is not read when a topic is viewed.

Form definition topics can be protected in the usual manner, using TWikiAccessControl, to limit who can change the form template and/or individual value lists. Note that view access is required to be able to edit topics that use the form definition, though view access to the form definition is not required to view a topic where the form has been used.

Line: 208 to 212

TWiki users often want to have an overview of topics they contributed to. With the $formfield parameter it is easy to display the value of a classification field next to the topic link:

when used in the value field of the form definition, will take the set of field values to be all topic names in the Main web which end in "Office".

Notes:

A very few field names are reserved. If you try to use one of these names, TWiki will automatically append an underscore to the name when the form is used.

The field value will be used to initialize a field when a form is created, unless specific values are given by the topic template or query parameters. The first item in the list for a select or radio type is the default item. For label, text, and textarea fields the value may also contain commas. checkbox fields cannot be initialized through the form template.

If a label field has no name (blank first column in the form definition) it will not be shown when the form is viewed, only when it is edited.

The topic definition is not read when a topic is viewed.

Field names can include any text, but you should stick to alphanumeric characters. If you want to use a non-wikiname for a select, checkbox or radio field, and want to get the values from another topic, you can use [[...]] links. This notation can also be used when referencing another topic to obtain field values, but a name other than the topic name is required as the name of the field.

Field names have to be unique. If the same name is necessary (as when the field values for several fields are obtained from the same topic), an alternative name must be assigned using the [[...]] notation.

The topic defining field values can also be generated through a FormattedSearch, which must yield a suitable table as the result.

Form definition topics can be protected in the usual manner, using TWikiAccessControl, to limit who can change the form template and/or individual value lists. Note that view access is required to be able to edit topics that use the form definition, though view access to the form definition is not required to view a topic where the form has been used.

The Tooltip message column is used as a tooltip for the field name (only if field name is a WikiName) - you only see the tooltip in edit view.

The Attributes column is used to define special behavior for that form field (multiple attributes can be entered, with or without separators):

An attribute H indicates that this field should not be shown in view mode. However, the field is available for editing and storing information.

An attribute M indicates that this field is mandatory. The topic cannot be saved unless a value is provided for this field. If the field is found empty during topic save, an error is raised and the user is redirected to an oops page. Mandatory fields are indicated by an asterisks next to the field name.

>>

when used in the value field of the form definition, this will find all topic names in the Main web which end in "Office" and use them as the legal field values.

Enabling Forms by Web

Forms have to be enabled for each individual web. The WEBFORMS variable in WebPreferences is optional and defines a list of possible form templates.

Changed:

<<

>>

Example:

Set WEBFORMS = BugForm, FeatureForm, Books.BookLoanForm

With WEBFORMS enabled, an extra button is added to the edit view. If the topic doesn't have a Form, an Add Form button appears at the end of the topic. If a Form is present, a Change button appears in the top row of the Form. The buttons open a screen that enables selection of a form specified in WEBFORMS, or the No form option.

Added:

>>

You have to list the available form topics explicitly. You cannot use a SEARCH to define WEBFORMS.

Changed:

<<

Add a form to a topic

>>

Adding a form to a topic

Changed:

<<

Edit a topic and follow the "Add form" button to add a Form to the topic. This is typically done to a template topic, either to the WebTopicEditTemplate topic in a web, or a new topic that serves as an application specific template topic. Initial Form values can be set there.

>>

Edit the topic and follow the "Add form" button to add a Form. This is typically done to a template topic, either to the WebTopicEditTemplate topic in a web, or a new topic that serves as an application specific template topic. Initial Form values can be set there.

Additionally a new topic can be given a Form using the formtemplate parameter in the (edit or save) URL. Initial values can then be provided in the URLs or as form values:

Note: Initial values will not be submitted to the form of a new topic if you only use the formtemplate parameter.

Deleted:

<<

Build an HTML form to create new Form-based topics

New topics with a form are created by simple HTML forms asking for a topic name. For example, you can have a SubmitExpenseReport topic where you can create new expense reports, a SubmitVacationRequest topic, and so on. These can specify the required template topic with its associated form. Template topics has more.

Changing a form

You can change a form definition, and TWiki will try to make sure you don't lose any data from the topics that use that form.

Line: 147 to 112

If you delete a field from the form, or change a field name, then the data will not be visible when you edit the topic (the changed form definition will be used). If you save the topic, the old data will be lost (though thanks to revision control, you can always see it in older versions of the topic)

Added:

>>

If two people edit the same topic containing a form at exactly the same time, and both change fields in the form, TWiki will try to merge the changes so that no data is lost.

Structure of a Form Template

A Form Template specifies the fields in a form. A Form Template is simply a page containing a TWiki table, where each row of the table specifies one form field.

Each column of the table is one element of an entry field: Name, Type, Size, Values, Tooltip message, and Attributes.

The Name, Type and Size columns are required. Other columns are optional. The form must have a header row (e.g. | *Name* | *Type* | *Size* |).

Name is the name of the form field.

The Type, Size and Value fields describe the legal values for this field, and how to display them.

Typecheckbox specifies one or more checkboxes. The Size field specifies how many checkboxes will be displayed on each line. The Value field should be a comma-separated list of item labels.

Typecheckbox+buttons will add Set and Clear buttons to the basic checkbox type.

Typeradio is like checkbox except that radio buttons are mutually exclusive; only one can be selected.

Typelabel specifies read-only label text, The Value field should contian the text of the label.

Typeselect specifies a select box. The Value field should contain a comma-separated list of options for the box. The Size field can specify a fixed size for the box (e.g. 1, or a range e.g. 3..10. If you specify a range, then the box will never be smaller than 3 items, never larger than 10, and will be 5 high if there are only 5 options.

There are two modifiers that can be applied to the select type:

select+multi turns multiselect on for the select, to allow Shift+Click and Ctrl+Click to select (or deselect) multiple items.

select+values allows the definition of values that are different to the displayed text. For example:

shows but the values or options Two and Three are 2 and III respectively. You can combine these modifiers e.g. select+multi+values

Typetext specifies a one-line text field. Size specifies the text box width in number of characters. Value is the initial (default) content when a new topic is created with this form template.

Typetextarea specifies a multi-line text box. The Size field should specify columns x rows, e.g. 80x6; default size is 40x5. As for text, the Value field specifies the initial text

Typedate specifies a single-line text box and a button next to it; clicking on the button will bring up a calendar from which the user can select a date. The date can also be typed into the text box. Size specifies the text box width in characters. As for text, the Value field specifies the initial text

Tooltip message is a message that will be displayed when the cursor is hovered over the field in edit view.

Attributes specifies special attributes for the field. Multiple attributes can be entered, separated by spaces.

An attribute H indicates that this field should not be shown in view mode. However, the field is available for editing and storing information.

An attribute M indicates that this field is mandatory. The topic cannot be saved unless a value is provided for this field. If the field is found empty during topic save, an error is raised and the user is redirected to an oops page. Mandatory fields are indicated by an asterisks next to the field name.

For example, a simple form just supporting entry of a name and a date would look as follows:

A very few field names are reserved. If you try to use one of these names, TWiki will automatically append an underscore to the name when the form is used.

You can space out the title of the field, and it will still find the topic e.g. Aeroplane Manufacturers is equivalent to AeroplaneManufacturers.

If a label field has no name, it will not be shown when the form is viewed, only when it is edited.

Field names can in theory include any text, but you should stick to alphanumeric characters. If you want to use a non-wikiname for a select, checkbox or radio field, and want to get the values from another topic, you can use [[...]] links. This notation can also be used when referencing another topic to obtain field values, but a name other than the topic name is required as the name of the field.

Leading and trailing spaces are not significant.

Field Value Notes:

The field value will be used to initialize a field when a form is created, unless specific values are given by the topic template or query parameters. The first item in the list for a select or radio type is the default item. For label, text, and textarea fields the value may also contain commas. checkbox fields cannot be initialized through the form template.

Leading and trailing spaces are not significant.

Field values can also be generated through a FormattedSearch, which must yield a suitable table as the result.

Variables in the initial values of a form definition get expanded when form values are initialized from the form definition. The escape words $quot ("), $percnt (%), $dollar ($), $n (newline), and $nop can be used to prevent expansion.

General Notes:

The topic definition is not read when a topic is viewed.

Form definition topics can be protected in the usual manner, using TWikiAccessControl, to limit who can change the form template and/or individual value lists. Note that view access is required to be able to edit topics that use the form definition, though view access to the form definition is not required to view a topic where the form has been used.

Values in Other Topics

As described above, you can also retrieve possible values for select, checkbox or radio types from other topics. For example, if you have a rows defined like this:

| *Name* | *Type* | *Size* |
| AeroplaneManufacturers | select | |

the TWiki will look for the topic AeroplaneManufacturers to get the possible values for the select.

The AeroplaneManufacturers topic must contain a table, where each row of the table describes a possible value. The table only requires one column, Name. Other columns may be present, but are ignored.

For example:

| *Name* |
| Routan |
| Focke-Wulf |
| De Havilland |

Notes:

The Values column must be empty in the referring form definition.

Extending the range of form data types

You can extend the range of data types accepted by forms by using TWikiPlugins. All such extended data types are single-valued (can only have one value) with the following exceptions:

any type name starting with checkbox

any type name with +multi anywhere in the name

Types with names like this can both take multiple values.

Hints and Tips

Build an HTML form to create new Form-based topics

New topics with a form are created by simple HTML forms asking for a topic name. For example, you can have a SubmitExpenseReport topic where you can create new expense reports, a SubmitVacationRequest topic, and so on. These can specify the required template topic with its associated form. Template topics has more.

A Form Template specifies the fields in a form. A Form Template is simply a page containing a TWiki table, where each row of the table specifies one form field.

Extending the range of form data types

Several Plugins allow you to extend the range of data types accepted by forms. For example, the TWiki:Plugins.DateFieldPlugin lets you add a 'date' type to the available data types. All data types are single-valued (can only have one value) with the following exceptions:

any type name starting with checkbox

any type name with +multi anywhere in the name

Types with names like this can both take multiple values.

Gotcha!

>>

Searching forms this way is obviously pretty inefficient, but it's easy to do. If you want better performance, take a look at some of the structured wiki extensions that support higher performance searching e.g. TWiki:Plugins.DBCachePlugin.

Gotcha!

Some browsers may strip linefeeds from text fields when a topic is saved. If you need linefeeds in a field, make sure it is a textarea.

Deleted:

<<

Importing Category Table Data

Very, very old TWiki releases used a system called the "TWikiCategoryTable". Later releases support automatic import of this data.

On upgrading from the previous TWiki, a Form Template topic has to be built for each web that used a Category Table, recreating the fields and values from the old twikicatitems.tmpl. The replacement Form Template must be set as the first item in the WebPreferences variable WEBFORMS. If missing, pages will display, but attempting to edit results in an error message.

The new Form Template system should work with old Category Table data with no special conversion. Data is assigned to Meta variables the first time an imported topic is edited and saved in the new system.

If things aren't working correctly, there may be useful entries in data/warning.txt.

TWiki Forms

Add structure to content with forms attached to twiki topics. TWiki forms (with form fields) and formatted search are the base for building database applications.

Overview

Changed:

<<

By adding form-based input to freeform content, you can structure topics with unlimited, easily searchable categories. When forms are enabled for a web and selected in a topic, a single form appears in edit mode, and the contents are rendered as a table when viewed on the display page. You can define unlimited forms per web. For each topic, you can select a template if more than one is defined, or remove forms entirely. Form input values are stored as TWikiMetaData; all data is saved.

>>

By adding form-based input to freeform content, you can structure topics with unlimited, easily searchable categories. A form is enabled for a web and can be added to a topic. The form data is shown in tabular format when the topic is viewed, and can be changed in edit mode using edit fields, radio buttons, check boxes and list boxes. Many different form types can be defined in a web, though a topic can only have only form attached to it at a time.

Changed:

<<

Form Templates replace TWikiCategoryTables from the 01-Dec-2000 version of TWiki. - see #FormsVsCategoryTables

when used in the value field of the form definition, will take the set of field values to be all topic names in the Main web which end in "Office".

Notes:

A very few field names are reserved. If you try to use one of these names, TWiki will automatically append an underscore to the name when the form is used.

The field value will be used to initialize a field when a form is created, unless specific values are given by the topic template or query parameters. The first item in the list for a select or radio type is the default item. For label, text, and textarea fields the value may also contain commas. checkbox fields cannot be initialized through the form template.

If a label field has no name (blank first column in the form definition) it will not be shown when the form is viewed, only when it is edited.

The topic definition is not read when a topic is viewed.

Added:

>>

Field names can include any text, but you should stick to alphanumeric characters. If you want to use a non-wikiname for a select, checkbox or radio field, and want to get the values from another topic, you can use [[...]] links. This notation can also be used when referencing another topic to obtain field values, but a name other than the topic name is required as the name of the field.

Field names have to be unique. If the same name is necessary (as when the field values for several fields are obtained from the same topic), an alternative name must be assigned using the [[...]] notation.

The topic defining field values can also be generated through a FormattedSearch, which must yield a suitable table as the result.

Form definition topics can be protected in the usual manner, using TWikiAccessControl, to limit who can change the form template and/or individual value lists. Note that view access is required to be able to edit topics that use the form definition, though view access to the form definition is not required to view a topic where the form has been used.

The Tooltip message column is used as a tooltip for the field name (only if field name is a WikiName) - you only see the tooltip in edit view.

The Attributes column is used to define special behavior for that form field (multiple attributes can be entered, with or without separators):

An attribute H indicates that this field should not be shown in view mode. However, the field is available for editing and storing information.

An attribute M indicates that this field is mandatory. The topic cannot be saved unless a value is provided for this field. If the field is found empty during topic save, an error is raised and the user is redirected to an oops page. Mandatory fields are indicated by an asterisks next to the field name.

Enabling Forms by Web

Changed:

<<

Forms are enabled on a per web basis. The WEBFORMS variable in WebPreferences is optional and defines a list of possible form templates. Example:

Set WEBFORMS = BugForm, FeatureForm, BookLoanForm

>>

Forms have to be enabled for each individual web. The WEBFORMS variable in WebPreferences is optional and defines a list of possible form templates.

Example:

Set WEBFORMS = BugForm, FeatureForm, Books.BookLoanForm

With WEBFORMS enabled, an extra button is added to the edit view. If the topic doesn't have a Form, an Add Form button appears at the end of the topic. If a Form is present, a Change button appears in the top row of the Form. The buttons open a screen that enables selection of a form specified in WEBFORMS, or the No form option.

Changed:

<<

Including Forms in New Topics

>>

Add a form to a topic

Changed:

<<

A default Form Template (new topics get this default form) can be provided by creating the WebTopicEditTemplate topic in a web and adding a form to it. Initial Form values can be set there.

>>

Edit a topic and follow the "Add form" button to add a Form to the topic. This is typically done to a template topic, either to the WebTopicEditTemplate topic in a web, or a new topic that serves as an application specific template topic. Initial Form values can be set there.

Changed:

<<

Additionally a new topic can be given a Form using the formtemplate parameter in the URL. Initial values can then be provided in the URLs or as form values:

>>

Additionally a new topic can be given a Form using the formtemplate parameter in the (edit or save) URL. Initial values can then be provided in the URLs or as form values:

other than checkboxes: name, ex: ?BugPriority=1

checkbox: namevalue=1, ex: ?ColorRed=1. Boxes with a tick must be specified.

Added:

>>

Example: This will add a textfield for the new topic name and a "Create"-Button to your topic. When the button is pressed, the topic editor will open with the form "MyForm" already attached to the new topic.

Note: Initial values will not be submitted to the form of a new topic if you only use the formtemplate parameter.

Changed:

<<

Setting Up Multiple Form Options

>>

Build an HTML form to create new Form-based topics

Changed:

<<

The optional WEBFORMS variable defines alternative forms that can be selected by pressing Change in edit mode.

>>

New topics with a form are created by simple HTML forms asking for a topic name. For example, you can have a SubmitExpenseReport topic where you can create new expense reports, a SubmitVacationRequest topic, and so on. These can specify the required template topic with its associated form. Template topics has more.

Changed:

<<

A topic template can use any form.

>>

Changing a form

You can change a form definition, and TWiki will try to make sure you don't lose any data from the topics that use that form.

Changed:

<<

New topics with a form are created by simple HTML forms asking for a topic name. For example, you can have a SubmitExpenseReport topic where you can create new expense reports, a SubmitVacationRequest topic, and so on. These can specify the required template topic with its associated form.

>>

If you change the form definition, the changes will not take affect in a topic that uses that form until you edit and save it.

Changed:

<<

Form Data Storage

>>

If you add a new field to the form, then it will appear next time you edit a topic that uses the form.

Changed:

<<

The form topic name, fields and values are stored as TWikiMetaData - the order of the field/value pairs is the same as in the template.

>>

If you delete a field from the form, or change a field name, then the data will not be visible when you edit the topic (the changed form definition will be used). If you save the topic, the old data will be lost (though thanks to revision control, you can always see it in older versions of the topic)

The Form Template system is a more powerful, flexible replacement for the original TWikiCategoryTable. Data from existing category tables can be imported directly.

>>

Extending the range of form data types

Several Plugins allow you to extend the range of data types accepted by forms. For example, the TWiki:Plugins.DateFieldPlugin lets you add a 'date' type to the available data types. All data types are single-valued (can only have one value) with the following exceptions:

Gotcha!

Some browsers may strip linefeeds from text fields when a topic is saved. If you need linefeeds in a field, make sure it is a textarea.

Changed:

<<

Importing Category Table Data

>>

Importing Category Table Data

Very, very old TWiki releases used a system called the "TWikiCategoryTable". Later releases support automatic import of this data.

On upgrading from the previous TWiki, a Form Template topic has to be built for each web that used a Category Table, recreating the fields and values from the old twikicatitems.tmpl. The replacement Form Template must be set as the first item in the WebPreferences variable WEBFORMS. If missing, pages will display, but attempting to edit results in an error message.

The new Form Template system should work with old Category Table data with no special conversion. Data is assigned to Meta variables the first time an imported topic is edited and saved in the new system.

Changed:

<<

NOTE: If things aren't working correctly, there may be useful entries in data/warning.txt.

Using Forms For Settings

Example process to change your WebPreferences to use forms instead of {3 spaces}* Set statements:

>>

If things aren't working correctly, there may be useful entries in data/warning.txt.

Edit WebPreferences, jump straight down to the form ignoring all the textarea stuff, and set as you like

if everything works as you like it, you can delete the Set statements (the form overrides set if they are both used).

Notes:

If it isn't working, double check that the S attribute has been specified (S for Setting).
If you change the form, the changes will not take affect until you edit and save the preferences' topics again.

A possibly unwanted side effect for using forms for the SKINS setting in their personal user topic: because the User Preferences are final you can't have different skins for different webs as the user's setting always wins. A workaround is to simply omit SKIN in the form.

Edit WebPreferences, jump straight down to the form ignoring all the textarea stuff, and set as you like

if everything works as you like it, you can delete the Set statements (the form overrides set if they are both used).

Notes:

If it isn't working, double check that the S attribute has been specified (S for Setting).
If you change the form, the changes will not take affect until you edit and save the preferences' topics again.

A possibly unwanted side effect for using forms for the SKINS setting in their personal user topic: because the User Preferences are final you can't have different skins for different webs as the user's setting always wins. A workaround is to simply omit SKIN in the form.

By adding form-based input to freeform content, you can structure topics with unlimited, easily searchable categories. When forms are enabled for a web and selected in a topic, a single form appears in edit mode, and the contents are rendered as a table when viewed on the display page. You can define unlimited forms per web. For each topic, you can select a template if more than one is defined, or remove forms entirely. Form input values are stored as TWikiMetaData; all data is saved.

Changed:

<<

Form Templates replace TWikiCategoryTables from the 01-Dec-2000 version of TWiki.

Main Changes from Category Tables

The Form Template system is a more powerful, flexible replacement for the original TWikiCategoryTable. Data from existing category tables can be imported directly.

Importing Category Table Data

On upgrading from the previous TWiki, a Form Template topic has to be built for each web that used a Category Table, recreating the fields and values from the old twikicatitems.tmpl. The replacement Form Template must be set as the first item in the WebPreferences variable WEBFORMS. If missing, pages will display, but attempting to edit results in an error message.

The new Form Template system should work with old Category Table data with no special conversion. Data is assigned to Meta variables the first time an imported topic is edited and saved in the new system.

NOTE: If things aren't working correctly, there may be useful entries in data/warning.txt.

>>

Form Templates replace TWikiCategoryTables from the 01-Dec-2000 version of TWiki. - see #FormsVsCategoryTables

Importing Category Table Data

On upgrading from the previous TWiki, a Form Template topic has to be built for each web that used a Category Table, recreating the fields and values from the old twikicatitems.tmpl. The replacement Form Template must be set as the first item in the WebPreferences variable WEBFORMS. If missing, pages will display, but attempting to edit results in an error message.

The new Form Template system should work with old Category Table data with no special conversion. Data is assigned to Meta variables the first time an imported topic is edited and saved in the new system.

NOTE: If things aren't working correctly, there may be useful entries in data/warning.txt.

With WEBFORMS enabled, an extra button is added to the edit view. If the topic doesn't have a Form, an Add Form button appears at the end of the topic. If a Form is present, a Change button appears in the top row of the Form. The buttons open a screen that enables selection of a form specified in WEBFORMS, or the No form option.

Added:

>>

Including Forms in New Topics

A default Form Template (new topics get this default form) can be provided by creating the WebTopicEditTemplate topic in a web and adding a form to it. Initial Form values can be set there.

Additionally a new topic can be given a Form using the formtemplate parameter in the URL. Initial values can then be provided in the URLs or as form values:

Line: 124 to 126

checkbox: namevalue=1, ex: ?ColourRed=1. Boxes with a tick must be specified.

Deleted:

<<

Including Forms in New Topics

When you create a new topic in a web that has the WEBFORMS Preferences variable set, an Add Form button appears at the bottom of the page. You can start all new topics with forms enabled, and pre-select a form if there's more than one available:

Overview

Changed:

<<

By adding form-based input to free-form content, you can structure topics with unlimited, easily searchable categories. When forms are enabled for a web and selected in a topic, the form appears in edit mode, and the contents are rendered as a table when viewing the actual page. When editing, can switch forms, if more than one is defined, or remove forms entirely. Form input values are stored as TWikiMetaData; all data is saved.

>>

By adding form-based input to freeform content, you can structure topics with unlimited, easily searchable categories. When forms are enabled for a web and selected in a topic, a single form appears in edit mode, and the contents are rendered as a table when viewed on the display page. You can define unlimited forms per web. For each topic, you can select a template if more than one is defined, or remove forms entirely. Form input values are stored as TWikiMetaData; all data is saved.

Form Templates replace TWikiCategory Tables from the 01-Dec-2000 version of TWiki.

Line: 29 to 29

The new Form Template system should work with old Category Table data with no special conversion. Data is assigned to Meta variables the first time an imported topic is edited and saved in the new system.

Changed:

<<

NOTE: If things aren't working correctly, there may be useful entries in data/warning.txt.

>>

NOTE: If things aren't working correctly, there may be useful entries in data/warning.txt.

Defining a Form Template

Changed:

<<

A Form Template is simply a page containing your form, defined in a table where each row is one form field.

>>

A Form Template is simply a page containing your form, defined as a table where each row is one form field.

Form Template Elements

form template - a set of fields defining a form (replaces category table definition)

Changed:

<<

A web can use one or more form templates.

form - A topic containing additional meta-data (besides the free form TEXTAREA) which categorizes the content. (replaces category table)

A topic has zero or one of the defined forms. So there are topics with a form or without.

Implementation Notes: This format allows you to define field items with or without WikiNames, depending on your needs.

Changed:

<<

The topic can be protected in the usual manner so that not everybody can change the form template - see TWikiAccessControl

[[...]] links can be used for force a link, at present [[...][...]] format is not supported.

The "Tooltip message" column is used as a tool tip for the field name (only if field name is a WikiName) - you only see the tooltip on edit.

The first item in the list is the default item. Alternative initial values can be given in a topic template such as WebTopicEditTemplate or using field=value or for checkboxes field=1.

>>

Topics can be protected in the usual manner, using TWikiAccessControl, to limit who can change the form template and/or individual value lists.

[[...]] links can be used to force a link (at present, the [[...][...]] format is not supported).

The Tooltip message column is used as a tooltip for the field name (only if field name is a WikiName) - you only see the tooltip In edit.

The first item in the list is the default item. Alternative initial values can be set in a topic template, like WebTopicEditTemplate, with field=value, or, for checkboxes, field=1.

The topic definition is not read when a topic is viewed.

Added:

>>

Enabling Forms by Web

Changed:

<<

Forms are enabled on a per web basis. The WEBFORMS variable in WebPreferences is optional and defines a list of possible Form Templates. Example:

>>

Forms are enabled on a per web basis. The WEBFORMS variable in WebPreferences is optional and defines a list of possible form templates. Example:

Set WEBFORMS = BugForm, FeatureForm, BookLoanForm

Changed:

<<

With WEBFORMS enabled, an extra button is added to the edit view. If the topic doesn't have a Form, an Add Form button appears at the end of the topic. If a Form is present, a Change button appears in the top row of the Form. The buttons open a screen that enables selection of a form specified in WEBFORMS, or the No form option.

>>

With WEBFORMS enabled, an extra button is added to the edit view. If the topic doesn't have a Form, an Add Form button appears at the end of the topic. If a Form is present, a Change button appears in the top row of the Form. The buttons open a screen that enables selection of a form specified in WEBFORMS, or the No form option.

A default Form Template (new topics get this default form) can be provided by creating the WebTopicEditTemplate topic in a web and adding a form to it. Initial Form values can be set there.

Additionally a new topic can be given a Form using the formtemplate parameter in the URL. Initial values can then be provided in the URLs or as form values:

Changed:

<<

other than checkboxes: name, ex: ?BugPriority=1

checkbox: namevalue=1, ex: ?ColourRed=1. Boxes with a tick must be specified.

>>

other than checkboxes: name, ex: ?BugPriority=1

checkbox: namevalue=1, ex: ?ColourRed=1. Boxes with a tick must be specified.

Including Forms in New Topics

Changed:

<<

When you create a new topic in a web that has the WEBFORMS Preferences variable set, an Add Form button appears at the bottom of the page. You can start all new topics with forms enabled, and pre-select a form if there's more than one available:

>>

When you create a new topic in a web that has the WEBFORMS Preferences variable set, an Add Form button appears at the bottom of the page. You can start all new topics with forms enabled, and pre-select a form if there's more than one available:

A form embedded in a topic also appears in a new topic. This is done by specifying the formtemplate parameter in the URL.

>>

A form embedded in a topic also appears in a new topic. This is done by specifying the formtemplate parameter in the URL.

Setting Up Multiple Form Options

Changed:

<<

The optional WEBFORMS variable defines alternative Form Templates that can be selected by pressing Change in edit mode.

>>

The optional WEBFORMS variable defines alternative forms that can be selected by pressing Change in edit mode.

A topic template can use any form.

Changed:

<<

A Template topic can use any Form Template.

>>

New topics with a form are created by simple HTML forms asking for a topic name. For example, you can have a SubmitExpenseReport topic where you can create new expense reports, a SubmitVacationRequest topic, and so on. These can specify the required template topic with its associated form.

Changed:

<<

New topics with a Form are created by simple HTML forms asking for a topic name. For example, you can have a SubmitExpenseReport topic where you can create new expense reports - a SubmitVacationRequest topic and so on. These can specify the required template topic with its associated Form.

>>

Form Data Storage

Changed:

<<

Form Template Data Storage

>>

The form topic name, fields and values are stored as TWikiMetaData - the order of the field/value pairs is the same as in the template.

Changed:

<<

The Form Template topic name, fields and values are stored as TWikiMetaData. The order of field/value pairs in the Meta Data is the same as in the Template.

TWiki Forms

Line: 10 to 8

Overview

Changed:

<<

By adding form-based input to free-form content, you can structure topics with unlimited, easily searchable categories. When forms are enabled for a web and selected in a topic, the form appears in edit mode, and the contents are rendered as a table when viewing the actual page. When editing, can switch forms, if more than one is defined, or remove forms entirely. Form input values are stored as TWikiMetaData; all data is saved.

>>

By adding form-based input to free-form content, you can structure topics with unlimited, easily searchable categories. When forms are enabled for a web and selected in a topic, the form appears in edit mode, and the contents are rendered as a table when viewing the actual page. When editing, can switch forms, if more than one is defined, or remove forms entirely. Form input values are stored as TWikiMetaData; all data is saved.

Form Templates replace TWikiCategory Tables from the 01-Dec-2000 version of TWiki.

Line: 27 to 25

Importing Category Table Data

Changed:

<<

On upgrading from the previous TWiki, a Form Template topic has to be built for each web that used a Category Table, recreating the fields and values from the old twikicatitems.tmpl. The replacement Form Template must be set as the first item in the WebPreferences variable =WEBFORM. If missing, pages will display, but attempting to edit results in an error message.

>>

On upgrading from the previous TWiki, a Form Template topic has to be built for each web that used a Category Table, recreating the fields and values from the old twikicatitems.tmpl. The replacement Form Template must be set as the first item in the WebPreferences variable WEBFORMS. If missing, pages will display, but attempting to edit results in an error message.

The new Form Template system should work with old Category Table data with no special conversion. Data is assigned to Meta variables the first time an imported topic is edited and saved in the new system.

Importing Existing Category Table Data

>>

Importing Category Table Data

On upgrading from the previous TWiki, a Form Template topic has to be built for each web that used a Category Table, recreating the fields and values from the old twikicatitems.tmpl. The replacement Form Template must be set as the first item in the WebPreferences variable =WEBFORM. If missing, pages will display, but attempting to edit results in an error message.

Line: 33 to 31

NOTE: If things aren't working correctly, there may be useful entries in data/warning.txt.

Changed:

<<

Form Template Elements

>>

Defining a Form Template

A Form Template is simply a page containing your form, defined in a table where each row is one form field.

Form Template Elements

form template - a set of fields defining a form (replaces category table definition)

A web can use one or more form templates.

Line: 49 to 51

textarea - a text box; size is 40x10 (columns x rows)

field value - one or more values from a fixed set (select, checkbox, radio type) or free-form (text). (replaces category item value)

Changed:

<<

Defining a Form Template

A Form Template is simply a page containing your form, defined in a table where each row is one form field.

>>

Defining a Form in One Topic

Create a new topic with your Form name: MyForm, ExpenseReport, InfoCategory, RecordReview, whatever you need.

Implementation Notes

This format allows you to define field items with / without WikiNames, depending on your needs.

>>

Implementation Notes: This format allows you to define field items with or without WikiNames, depending on your needs.

The topic can be protected in the usual manner so that not everybody can change the form template - see TWikiAccessControl

Line: 131 to 125

other than checkboxes: name, ex: ?BugPriority=1

checkbox: namevalue=1, ex: ?ColourRed=1. Boxes with a tick must be specified.

Changed:

<<

Creating New Topics with Forms

>>

Including Forms in New Topics

When you create a new topic in a web that has the WEBFORMS Preferences variable set, an Add Form button appears at the bottom of the page. You can start all new topics with forms enabled, and pre-select a form if there's more than one available:

Changed:

<<

When you create a new topic in a web that has the WEBFORMS Preferences variable set, an Add Form button appears at the bottom of the page. If the WebTopicEditTemplate topic has a form added, the form will appear with values set; press Change to remove the template or to switch to a different one.

Overview

By adding form-based input to free-form content, you can structure topics with unlimited, easily searchable categories. When forms are enabled for a web and selected in a topic, the form appears in edit mode, and the contents are rendered as a table when viewing the actual page. When editing, can switch forms, if more than one is defined, or remove forms entirely. Form input values are stored as TWikiMetaData; all data is saved.

Changed:

<<

Form Templates replace TWikiCategory Tables from the previous version of TWiki.

>>

Form Templates replace TWikiCategory Tables from the 01-Dec-2000 version of TWiki.

Changes from the Category Table System

Form Templates more powerful, flexible replacement for the original TWikiCategoryTable. Data from existing category tables can be imported directly.

Importing Existing Category Table Data

On upgrading from the previous TWiki, a Form Template topic has to be built for each web that used a Category Table, recreating the fields and values from the old twikicatitems.tmpl. The replacement Form Template must be set as the first item in the WebPreferences variable =WEBFORM. If missing, pages will display, but attempting to edit results in an error message.

The new Form Template system should work with old Category Table data with no special conversion. Data is assigned to Meta variables the first time an imported topic is edited and saved in the new system.

NOTE: If things aren't working correctly, there may be useful entries in data/warning.txt.

Form Templates

>>

Form Templates

Changed:

<<

Topics allow for flexible free format data, sometimes you want to ensure strucutre to some of the topic information, this can be done with Forms e.g. saying what type of topic it is (e.g. Bug, Feature, FAQ entry etc) and then filling in fields using dropdowns, radio buttons etc.

>>

Include form-based input in topics, with unlimited, user-selectable forms per web; values stored as Meta Data

Changed:

<<

Overview

>>

Overview

Changed:

<<

If forms are enabled for a Web and a topic has a form you will see it as a table when viewing the page. When you edit you will see the various edit controls below the normal text area. There will be a button at the top of the form marked Change which allows you to change to a different form, or remove the form. If you edit a topic without a form, there will be a button Add Form, that let's you associate a form with the topic; note that changes you have made to the topic are not lost when you select this option.

>>

By adding form-based input to free-form content, you can structure topics with unlimited, easily searchable categories. When forms are enabled for a web and selected in a topic, the form appears in edit mode, and the contents are rendered as a table when viewing the actual page. When editing, can switch forms, if more than one is defined, or remove forms entirely. Form input values are stored as TWikiMetaData; all data is saved.

Changed:

<<

You can search for topics with specific form data using the %SEARCH% variable - see TWikiVariables.

>>

Form Templates replace TWikiCategory Tables from the previous version of TWiki.

Changed:

<<

TWikiCategoryTables Are History

>>

Form Template Elements

Changed:

<<

Form Templates more powerful, flexible replacement for the original TWikiCategoryTable.

Changes from the Category Table System

Main changes from TWikiCategoryTable: The templates for category view/edit have been dropped, and the forma renders to HTML on viewing.

Migrating Existing Category Table Data

The new Form Template system should work with old Category Table data with no special conversion. Old data should be transparently upgraded to the new Meta format when a page imported from the old TWiki is edited and saved in the new system for the first time.

On upgrading, the administrator must produce a form template topic for each web that uses the old Category Tables. twikicatitems.tmpl defines the categories and is used in the conversion. The form template must be set as the first item in the WebPreferences variable =WEBFORM. If it's not present, view works, but edit results in an oops dialog result. If things aren't working correctly, there may be entries in data/warning.txt.

Form Template Elements

Form Template: A set of fields defining a form. (Class in OO speak; used to be called category table definition)

A web may contain more then zero or more form template.

Form: A topic containing additional meta-data (besides the free form TEXTAREA) which categorizes the content. (Object in OO speak; used to be called category table)

>>

form template - a set of fields defining a form (replaces category table definition)

A web can use one or more form templates.

form - A topic containing additional meta-data (besides the free form TEXTAREA) which categorizes the content. (replaces category table)

A topic has zero or one of the defined forms. So there are topics with a form or without.

Changed:

<<

Form Field: A named item in a form. (Used to be called category item name)

Field Type: The type of a field when editing a form. The type defines the HTML INPUT tag widgets when editing a topic:

select: Drop down box or selector

checkbox: One or more check boxes

checkbox+buttons: One or more check boxes, plus [Set] and [][Clear] buttons to set/clear all checkboxes

radio: One or more radio buttons

text: A one-line text field

textarea: A general text area - size is rowsxcols 40x10

Field Value: Value of a form field. Can be one or more values from a fixed set (select, checkbox, radio type) or free form (text type). (Used to be called category item value)

>>

form field - a named item in a form (replaces category item name)

field type - selects the INPUT type:

select - drop-down menu or scrollable box

checkbox - one or more checkboxes

checkbox+buttons - one or more checkboxes, plus Set and Clear buttons

radio - one or more radio buttons

text - a one-line text field

textarea - a text box; size is 40x10 (columns x rows)

field value - one or more values from a fixed set (select, checkbox, radio type) or free-form (text). (replaces category item value)

Changed:

<<

Defining a Form Template

>>

Defining a Form Template

A Form Template is simply a page containing your form, defined in a table where each row is one form field.

Defining a Form in Multiple Topics

Various Implementation Notes

Implementation Notes

This format allows you to define field items with / without WikiNames, depending on your needs.

Added:

>>

The topic can be protected in the usual manner so that not everybody can change the form template - see TWikiAccessControl

Deleted:

<<

... can be used for force a link, at present ... format is not supported

The "Tooltip message:" column is used as a tool tip for the field name (only if field name is a WikiName) - you only see the tooltip on edit

The first item in the list is the default item. Alternative initial values can be given in a topic template such as WebTopicEditTemplate or using field=value or for checkboxes field=1

The topic definition is not read when a topic is viewed

Changed:

<<

Enabling Forms by Web

>>

... can be used for force a link, at present ... format is not supported.

The "Tooltip message:" column is used as a tool tip for the field name (only if field name is a WikiName) - you only see the tooltip on edit.

The first item in the list is the default item. Alternative initial values can be given in a topic template such as WebTopicEditTemplate or using field=value or for checkboxes field=1.

The topic definition is not read when a topic is viewed.

Changed:

<<

Forms are enabled on a per web basis. The WEBFORMS variable in WebPreferences is optional and defines a list of possible form templates e.g.

>>

Enabling Forms by Web

Forms are enabled on a per web basis. The WEBFORMS variable in WebPreferences is optional and defines a list of possible Form Templates. Example:

Set WEBFORMS = BugForm, FeatureForm, BookLoanForm

Changed:

<<

With WEBFORMS enabled, an extra button is added to the edit view. If the topic doesn't have a form an [Add Form] button appears at the end of the topic. If a form is present, a [Change] button appears in the top row of the form. The buttons lead to a screen that enables no form to be selected or one of those specified by WEBFORMS.

>>

With WEBFORMS enabled, an extra button is added to the edit view. If the topic doesn't have a Form, an Add Form button appears at the end of the topic. If a Form is present, a Change button appears in the top row of the Form. The buttons open a screen that enables selection of a form specified in WEBFORMS, or the No form option.

Changed:

<<

A default form template (i.e. new topics get this default form) can be provided by creating the WebTopicEditTemplate topic in a Web and adding a form to it. Initial form values can be set here.

>>

A default Form Template (new topics get this default form) can be provided by creating the WebTopicEditTemplate topic in a web and adding a form to it. Initial Form values can be set there.

Changed:

<<

Addtionaly a new topic can be given a form using the formtemplate parameter in the URL. Initial values can then be provided in the URLs or as form values. Names being:

>>

Addtionaly a new topic can be given a form using the formtemplate parameter in the URL. Initial values can then be provided in the URLs or as form values. Names being:

Not checkboxes - name e.g. ?BugPriority=1

Checkbox - namevalue=1 e.g. ?ColourRed=1. Note that all boxes with a tick must be specified.

Changed:

<<

Creating New Topics with Forms

>>

Creating New Topics with Forms

Changed:

<<

When you create a new topic in a web that has the WEBFORMS Preferences variable set, an [Add Form] button appears at the bottom of the page. If the WebTopicEditTemplate topic has a form added, the form will appear with values set; press [Change] to remove the template or to switch to a different one.

>>

When you create a new topic in a web that has the WEBFORMS Preferences variable set, an Add Form button appears at the bottom of the page. If the WebTopicEditTemplate topic has a form added, the form will appear with values set; press Change to remove the template or to switch to a different one.

A form embedded in a topic also appears in a new topic. This is done by specifying the formtemplate parameter in the URL.

Changed:

<<

Setting Up Multiple Form Options

>>

Setting Up Multiple Form Options

The optional WEBFORMS variable defines alternative Form Templates that can be selected by pressing Change in edit mode.

A Template topic can use any Form Template.

Changed:

<<

The optional WEBFORMS variable defines alternative Form Templates that can be selected after pressing [Change] on the Edit page

A template topic can use any form template

New topics with a form get instantiated by simple HTML forms asking for a topic name. If there is a SubmitExpenseReport topic were you can create new expense reports, a SubmitVacationRequest topic and so on. These can specify the required template topic and hence form. HUH?

>>

New topics with a Form are created by simple HTML forms asking for a topic name. For example, you can have a SubmitExpenseReport topic where you can create new expense reports - a SubmitVacationRequest topic and so on. These can specify the required template topic with its associated Form.

Added:

>>

Form Template Data Storage

Changed:

<<

Form Template Data Storage

>>

The Form Template topic name, fields and values are stored as Meta Data. The order of field/value pairs in the Meta Data is the same as in the Template.

Deleted:

<<

The Form Template topic name, fields and values are stored in the topic Meta Data. The order of field/value pairs in the Meta Data is the same as in the Template. The Form name is required for [Edit] and [Save].

The topic can be protected in the usual manner so that not everybody can change the form template - see TWikiAccessControl

... can be used for force a link, at present ... format is not supported

The "Tooltip message:" column is used as a tool tip for the field name (only if field name is a WikiName) - you only see the tooltip on edit

Changed:

<<

The first item in the list is the default item. Alternative initial values can be given in a topic template such as WebTopicEditTemplate or using fieldFLD=value or for checkboxes fieldFLDcheckbox=1 in URL

>>

The first item in the list is the default item. Alternative initial values can be given in a topic template such as WebTopicEditTemplate or using field=value or for checkboxes field=1

The topic definition is not read when a topic is viewed

Enabling Forms by Web

Line: 118 to 118

A default form template (i.e. new topics get this default form) can be provided by creating the WebTopicEditTemplate topic in a Web and adding a form to it. Initial form values can be set here.

Addtionaly a new topic can be given a form using the formtemplate parameter in the URL. Initial values can then be provided in the URLs or as form values. Names being:

Changed:

<<

Not checkboxs - nameFLD e.g. ?BugPriorityFLD=1

Checkbox - nameFLDvalue=1 e.g. ?ColourFLDRed=1. Note that all boxes with a tick must be specified.

>>

Not checkboxes - name e.g. ?BugPriority=1

Checkbox - namevalue=1 e.g. ?ColourRed=1. Note that all boxes with a tick must be specified.

On upgrading, the administrator must produce a form template topic for each web that uses the old Category Tables. twikicatitems.tmpl defines the categories and is used in the conversion. The form template must be set as the first item in the WebPreferences variable =WEBFORM. If it's not present, view works, but edit results in an oops dialog result. If things aren't working correctly, there may be entries in data/warning.txt.

Deleted:

<<

Form Template Elements

Form Template: A set of fields defining a form. (Class in OO speak; used to be called category table definition)

Line: 43 to 42

Field Type: The type of a field when editing a form. The type defines the HTML INPUT tag widgets when editing a topic:

select: Drop down box or selector

checkbox: One or more check boxes

Changed:

<<

checkbox+buttons: One or more check boxes, plus set and clear buttons to set/clear all check boxes

>>

checkbox+buttons: One or more check boxes, plus [Set] and [][Clear] buttons to set/clear all checkboxes

radio: One or more radio buttons

text: A one-line text field

Changed:

<<

textarea: A general text area - size is rowsxcols e.g. 40x10

>>

textarea: A general text area - size is rowsxcols 40x10

Field Value: Value of a form field. Can be one or more values from a fixed set (select, checkbox, radio type) or free form (text type). (Used to be called category item value)

Defining a Form Template

Changed:

<<

Form templates are defined by topics, one topic per form template. A form template topic has descriptive text mixed with the form template definition in the form of a TWiki table.

>>

A Form Template is simply a page containing your form, defined in a table where each row is one form field.

Changed:

<<

Examples

>>

Create a new topic with your Form name: MyForm, ExpenseReport, InfoCategory, RecordReview, whatever you need.

Notes

Various Implementation Notes

This format allows you to define field items with / without WikiNames, depending on your needs.

The topic can be protected in the usual manner so that not everybody can change the form template - see TWikiAccessControl

Line: 94 to 108

The first item in the list is the default item. Alternative initial values can be given in a topic template such as WebTopicEditTemplate or using fieldFLD=value or for checkboxes fieldFLDcheckbox=1 in URL

The topic definition is not read when a topic is viewed

Changed:

<<

Specification

Enabling Forms for a Web

>>

Enabling Forms by Web

Changed:

<<

By default topics can be edited in free form. A form can be added to a topic to give it more structure. Forms are enabled on a per web basis.

The WEBFORMS variable in WebPreferences is optional and defines a list of possible form templates e.g.

>>

Forms are enabled on a per web basis. The WEBFORMS variable in WebPreferences is optional and defines a list of possible form templates e.g.

Set WEBFORMS = BugForm, FeatureForm, BookLoanForm

Changed:

<<

With this present an extra button is added to the edit view. If the topic doesn't have a form an Add Form button appears at the end of the topic. If a form is present a Change button appears in the top row of the form to the right of the form name. The buttons leads to a screen that enables no form to be selected of one of those specified by WEBFORMS.

>>

With WEBFORMS enabled, an extra button is added to the edit view. If the topic doesn't have a form an [Add Form] button appears at the end of the topic. If a form is present, a [Change] button appears in the top row of the form. The buttons lead to a screen that enables no form to be selected or one of those specified by WEBFORMS.

A default form template (i.e. new topics get this default form) can be provided by creating the WebTopicEditTemplate topic in a Web and adding a form to it. Initial form values can be set here.

Addtionaly a new topic can be given a form using the formtemplate parameter in the URL. Initial values can then be provided in the URLs or as form values. Names being:

Not checkboxs - nameFLD e.g. ?BugPriorityFLD=1

Checkbox - nameFLDvalue=1 e.g. ?ColourFLDRed=1. Note that all boxes with a tick must be specified.

Added:

>>

Creating New Topics with Forms

When you create a new topic in a web that has the WEBFORMS Preferences variable set, an [Add Form] button appears at the bottom of the page. If the WebTopicEditTemplate topic has a form added, the form will appear with values set; press [Change] to remove the template or to switch to a different one.

Line: 118 to 129

Setting Up Multiple Form Options

Changed:

<<

The optional WEBFORMS variable defines alternative Form Templates that can be selected after pressing [Change] button on the Edit page

>>

The optional WEBFORMS variable defines alternative Form Templates that can be selected after pressing [Change] on the Edit page

A template topic can use any form template

Deleted:

<<

Decided not to ask user to choose a template or form template when creating a topic as goes against the KISS of Wiki systems.

New topics with a form get instantiated by simple HTML forms asking for a topic name. If there is a SubmitExpenseReport topic were you can create new expense reports, a SubmitVacationRequest topic and so on. These can specify the required template topic and hence form. HUH?

Topics allow for flexible free format data, sometimes you want to ensure strucutre to some of the topic information, this can be done with Forms e.g. saying what type of topic it is (e.g. Bug, Feature, FAQ entry etc) and then filling in fields using dropdowns, radio buttons etc.

Added:

>>

Overview

If forms are enabled for a Web and a topic has a form you will see it as a table when viewing the page. When you edit you will see the various edit controls below the normal text area. There will be a button at the top of the form marked Change which allows you to change to a different form, or remove the form. If you edit a topic without a form, there will be a button Add Form, that let's you associate a form with the topic; note that changes you have made to the topic are not lost when you select this option.

Changed:

<<

You can search for topics with specific form data using the %SEARCH% variable - see TWikiVariables.

>>

You can search for topics with specific form data using the %SEARCH% variable - see TWikiVariables.

Goodby to TWikiCategoryTables

This is a more general replacement for the TWikiCategoryTable capability, in particular Forms are defined by special topics, where as categories were defineind using special templates.

Changes from the Category Table System

Main changes from TWikiCategoryTable: The templates for category view/edit have been dropped.and render to HTML on viewing

Migrating Existing Category Table Data

The new Form Template system should work with old Category Table data with no special conversion. Old data should be transparently upgraded to the new Meta format when a page imported from the old TWiki is edited and saved in the new system for the first time.

On upgrading, the administrator must produce a form template topic for each web that uses the old Category Tables. twikicatitems.tmpl defines the categories and is used in the conversion. The form template must be set as the first item in the WebPreferences variable =WEBFORM. If it's not present, view works, but edit results in an oops dialog result. If things aren't working correctly, there may be entries in data/warning.txt.

Changed:

<<

Terminology

>>

Form Template Elements

Form Template: A set of fields defining a form. (Class in OO speak; used to be called category table definition)

A web may contain more then zero or more form template.

Line: 26 to 49

textarea: A general text area - size is rowsxcols e.g. 40x10

Field Value: Value of a form field. Can be one or more values from a fixed set (select, checkbox, radio type) or free form (text type). (Used to be called category item value)

Changed:

<<

Specification

Enable forms for a web

By default topics can be edited in free form. A form can be added to a topic to give it more structure. Forms are enabled on a per web basis.

The WEBFORMS variable in WebPreferences is optional and defines a list of possible form templates e.g.

Set WEBFORMS = BugForm, FeatureForm, BookLoanForm

With this present an extra button is added to the edit view. If the topic doesn't have a form an Add Form button appears at the end of the topic. If a form is present a Change button appears in the top row of the form to the right of the form name. The buttons leads to a screen that enables no form to be selected of one of those specified by WEBFORMS.

A default form template (i.e. new topics get this default form) can be provided by creating the WebTopicEditTemplate topic in a Web and adding a form to it. Initial form values can be set here.

Addtionaly a new topic can be given a form using the formtemplate parameter in the URL. Initial values can then be provided in the URLs or as form values. Names being:

Not checkboxs - nameFLD e.g. ?BugPriorityFLD=1

Checkbox - nameFLDvalue=1 e.g. ?ColourFLDRed=1. Note that all boxes with a tick must be specified.

Defining a form template

>>

Defining a Form Template

Form templates are defined by topics, one topic per form template. A form template topic has descriptive text mixed with the form template definition in the form of a TWiki table.

Defining form in one topic

Defining a Form in One Topic

Defining a form in multiple topics

>>

Defining a Form in Multiple Topics

The form template can also be defined in an alternative way by using more then one topic:

Line: 90 to 94

The first item in the list is the default item. Alternative initial values can be given in a topic template such as WebTopicEditTemplate or using fieldFLD=value or for checkboxes fieldFLDcheckbox=1 in URL

Changes from category system

Specification

Name changed in the hope that form is more readily understandable than category

The templates for category view/edit have been dropped

Forms are defined by topics, categories were defined in a template file

A Web can have multiple forms, only one category was possible

Form data is saved in meta variables - see MetaDataDefinition, and render to HTML on viewing. Category data was stored as HTML

The UseCategory radio button has gone, the replacement being the Change form and Add Form buttons.

>>

Enabling Forms for a Web

Changed:

<<

Creating new topics with forms

>>

By default topics can be edited in free form. A form can be added to a topic to give it more structure. Forms are enabled on a per web basis.

Changed:

<<

When you create a new topic in a web that has the WEBFORMS preferences variable set you will get a Add Form button at the bottom of the page. However, if the WebTopicEditTemplate topic has had a form added this will appear with values set; Change in the form can be pressed to remove the template or switch to a different one.

>>

The WEBFORMS variable in WebPreferences is optional and defines a list of possible form templates e.g.

Set WEBFORMS = BugForm, FeatureForm, BookLoanForm

Changed:

<<

A form embedded in a topic can also cause a form to be present in a new topic, this is done by specifying the formtemplate parameter in the URL.

>>

With this present an extra button is added to the edit view. If the topic doesn't have a form an Add Form button appears at the end of the topic. If a form is present a Change button appears in the top row of the form to the right of the form name. The buttons leads to a screen that enables no form to be selected of one of those specified by WEBFORMS.

Changed:

<<

Topic meta data

>>

A default form template (i.e. new topics get this default form) can be provided by creating the WebTopicEditTemplate topic in a Web and adding a form to it. Initial form values can be set here.

Addtionaly a new topic can be given a form using the formtemplate parameter in the URL. Initial values can then be provided in the URLs or as form values. Names being:

Not checkboxs - nameFLD e.g. ?BugPriorityFLD=1

Checkbox - nameFLDvalue=1 e.g. ?ColourFLDRed=1. Note that all boxes with a tick must be specified.

Creating New Topics with Forms

Changed:

<<

The form template topic name and all form fields/values are stored in the topic meta data. The form template topic name is needed for edit and save.

>>

When you create a new topic in a web that has the WEBFORMS Preferences variable set, an [Add Form] button appears at the bottom of the page. If the WebTopicEditTemplate topic has a form added, the form will appear with values set; press [Change] to remove the template or to switch to a different one.

Changed:

<<

The order of form field/value items in the meta-data is the same as in the form template.

>>

A form embedded in a topic also appears in a new topic. This is done by specifying the formtemplate parameter in the URL.

Changed:

<<

UI for multiple form templates

>>

Setting Up Multiple Form Options

Changed:

<<

Optional WEBFORMS variable defines possible form templates that can be selected after pressing "Change" (forms) button on edit page

>>

The optional WEBFORMS variable defines alternative Form Templates that can be selected after pressing [Change] button on the Edit page

A template topic can use any form template

Decided not to ask user to choose a template or form template when creating a topic as goes against the KISS of Wiki systems.

Changed:

<<

New topics with a form get instantiated by simple HTML forms asking for a topic name, i.e. there is a SubmitExpenseReport topic were you can create new expense reports, a SubmitVacationRequest topic and so on. These can specify the required template topic and hence form.

>>

New topics with a form get instantiated by simple HTML forms asking for a topic name. If there is a SubmitExpenseReport topic were you can create new expense reports, a SubmitVacationRequest topic and so on. These can specify the required template topic and hence form. HUH?

Deleted:

<<

Migration of Category information

Changed:

<<

Principle: new system should work with old data with no special conversion.

Old data should be transparently upgraded to the new meta format when a topic is edit/previewed/saved.

On upgrading the administrator must produce a form template topic for each Web that using the old category system. twikicatitems.tmpl defines the categories and is used in the conversion. The form template must be put as first item in WebPreferences variable =WEBFORM. If it's not present view works, but edit results in an oops dialog results. If things aren't working correctly there may be entries data/warning.txt.

History

This is a more general replacement for the TWikiCategoryTable capability, in particular Forms are defined by special topics, where as categories were defineind using special templates.

>>

Form Template Data Storage

Added:

>>

The Form Template topic name, fields and values are stored in the topic Meta Data. The order of field/value pairs in the Meta Data is the same as in the Template. The Form name is required for [Edit] and [Save].

Topics allow for flexible free format data, sometimes you want to ensure strucutre to some of the topic information, this can be done with Forms e.g. saying what type of topic it is (e.g. Bug, Feature, FAQ entry etc) and then filling in fields using dropdowns, radio buttons etc.

If forms are enabled for a Web and a topic has a form you will see it as a table when viewing the page. When you edit you will see the various edit controls below the normal text area. There will be a button at the top of the form marked Change which allows you to change to a different form, or remove the form. If you edit a topic without a form, there will be a button Add Form, that let's you associate a form with the topic; note that changes you have made to the topic are not lost when you select this option.

Changed:

<<

Topics allow for flexible free format data, sometimes you want to ensure strucutre to some of the topic information, this can be done with Forms e.g. saying what type of topic it is (Bug, Feature, FAQ entry etc).

>>

You can search for topics with specific form data using the %SEARCH% variable - see TWikiVariables.

Background

This is a more general replacement for the TWikiCategoryTable capability, in particular Forms are defined by special topics, where as categories were defineind using special templates.

>>

Topics allow for flexible free format data, sometimes you want to ensure strucutre to some of the topic information, this can be done with Forms e.g. saying what type of topic it is (Bug, Feature, FAQ entry etc).

Terminology

Form Template: A set of fields defining a form. (Class in OO speak; used to be called category table definition)

Changed:

<<

A web may contain more then one form template.

>>

A web may contain more then zero or more form template.

Form: A topic containing additional meta-data (besides the free form TEXTAREA) which categorizes the content. (Object in OO speak; used to be called category table)

A topic has zero or one of the defined forms. So there are topics with a form or without.

Form Field: A named item in a form. (Used to be called category item name)

Line: 29 to 27

Enable forms for a web

Changed:

<<

By default topics can be edited in free form. A form can be added to a topic to give it more structure. Forms are enabled on a per web basis. This can be done in two ways. One is similar to that used for the older category system, with this a Web can have only one form. The other allows a Web to have any number of forms.

A default form template can be provided by creating the WebTopicEditTemplate topic in a Web and adding a form to it. Initial form values can be set here.

Enabling single default form

The DEFAULTFORM variable in WebPreferences is optional. If present it specifies the default form for all topics in the Web. Every time you edit a topic you will be presented with a form. The form must contain the special field UseForm (analogous to the UseCategory line in the old category system). The values for this must be:

First field - "Yes" (any capitalisation)

Second field - any text, but must mean no form

Enabling multiple forms

>>

By default topics can be edited in free form. A form can be added to a topic to give it more structure. Forms are enabled on a per web basis.

The WEBFORMS variable in WebPreferences is optional and defines a list of possible form templates e.g.

Set WEBFORMS = BugForm, FeatureForm, BookLoanForm

Changed:

<<

With this present an extra button is added to the edit view. If the topic doesn't have a form the button appears at the end of the page. If a form is present the button appears in the top row of the form. Pressing the button leads to a screen that enables no form to be selected of one of those specified by WEBFORMS.

>>

With this present an extra button is added to the edit view. If the topic doesn't have a form an Add Form button appears at the end of the topic. If a form is present a Change button appears in the top row of the form to the right of the form name. The buttons leads to a screen that enables no form to be selected of one of those specified by WEBFORMS.

Changed:

<<

Define a form template

>>

A default form template (i.e. new topics get this default form) can be provided by creating the WebTopicEditTemplate topic in a Web and adding a form to it. Initial form values can be set here.

Addtionaly a new topic can be given a form using the formtemplate parameter in the URL. Initial values can then be provided in the URLs or as form values. Names being:

Not checkboxs - nameFLD e.g. ?BugPriorityFLD=1

Checkbox - nameFLDvalue=1 e.g. ?ColourFLDRed=1. Note that all boxes with a tick must be specified.

Defining a form template

Form templates are defined by topics, one topic per form template. A form template topic has descriptive text mixed with the form template definition in the form of a TWiki table.

Notes

This format allows you to define field items with / without WikiNames, depending on your needs.

Changed:

<<

The topic can be protected in the usual manner so that not everybody can change the form template.

>>

The topic can be protected in the usual manner so that not everybody can change the form template - see TWikiAccessControl

... can be used for force a link, at present ... format is not supported

The "Tooltip message:" column is used as a tool tip for the field name (only if field name is a WikiName) - you only see the tooltip on edit

The first item in the list is the default item. Alternative initial values can be given in a topic template such as WebTopicEditTemplate or using fieldFLD=value or for checkboxes fieldFLDcheckbox=1 in URL

Changed:

<<

The UseForm field is special.

Will always default to second value (don't use form) when topic doesn't have a form

Is not show on preview or view

When set to no on save, form data is deleted.

It is not a good idea to use both DEFAULTFORM and WEBFORMSWebPreferences in the same Web.

Changes from category system

Name changed in the hope that form is more readily understandable than category

Deleted:

<<

UseCategory is now UseForm

The templates for category view/edit have been dropped

Forms are defined by topics, categories were defined in a template file

A Web can have multiple forms, only one category was possible

Form data is saved in meta variables - see MetaDataDefinition, and render to HTML on viewing. Category data was stored as HTML

Added:

>>

The UseCategory radio button has gone, the replacement being the Change form and Add Form buttons.

Creating new topics with forms

Changed:

<<

When you create a new topic in a web that has the WEBFORM preferences variable set you will get a topic with the default form template specified by the variable.

>>

When you create a new topic in a web that has the WEBFORMS preferences variable set you will get a Add Form button at the bottom of the page. However, if the WebTopicEditTemplate topic has had a form added this will appear with values set; Change in the form can be pressed to remove the template or switch to a different one.

Changed:

<<

For simplicity we should use the default form template when one creates a new topic by question mark link or "Go" field, i.e. better not to show a menu to select a form template.

>>

A form embedded in a topic can also cause a form to be present in a new topic, this is done by specifying the formtemplate parameter in the URL.

Topic meta data

Line: 124 to 112

UI for multiple form templates

Changed:

<<

Optional WEBFORMS variable defines possibles form templates that can be selected after pressing "Change" (forms) button on edit page

>>

Optional WEBFORMS variable defines possible form templates that can be selected after pressing "Change" (forms) button on edit page

A template topic can use any form template

Decided not to ask user to choose a template or form template when creating a topic as goes against the KISS of Wiki systems.

New topics with a form get instantiated by simple HTML forms asking for a topic name, i.e. there is a SubmitExpenseReport topic were you can create new expense reports, a SubmitVacationRequest topic and so on. These can specify the required template topic and hence form.

Line: 135 to 123

Old data should be transparently upgraded to the new meta format when a topic is edit/previewed/saved.

Changed:

<<

On upgrading the administrator must produce a form template topic for each Web that using the old category system. twikicatitems.tmpl defines the categories and is used in the conversion. The form template must be put as first item in WebPreferences variable WEBFORM or DEFAULTFORM (if/when put in). If it's not present, an oops dialog results.

>>

On upgrading the administrator must produce a form template topic for each Web that using the old category system. twikicatitems.tmpl defines the categories and is used in the conversion. The form template must be put as first item in WebPreferences variable =WEBFORM. If it's not present view works, but edit results in an oops dialog results. If things aren't working correctly there may be entries data/warning.txt.

History

This is a more general replacement for the TWikiCategoryTable capability, in particular Forms are defined by special topics, where as categories were defineind using special templates.

Background

This is a more general replacement for the TWikiCategoryTable capability, in particular Forms are defined by special topics, where as categories were defineind using special templates.

Terminology

Form Template: A set of fields defining a form. (Class in OO speak; used to be called category table definition)

A web may contain more then one form template.

Form: A topic containing additional meta-data (besides the free form TEXTAREA) which categorizes the content. (Object in OO speak; used to be called category table)

A topic has zero or one of the defined forms. So there are topics with a form or without.

Form Field: A named item in a form. (Used to be called category item name)

Field Type: The type of a field when editing a form. The type defines the HTML INPUT tag widgets when editing a topic:

select: Drop down box or selector

checkbox: One or more check boxes

checkbox+buttons: One or more check boxes, plus set and clear buttons to set/clear all check boxes

radio: One or more radio buttons

text: A one-line text field

textarea: A general text area - size is rowsxcols e.g. 40x10

Field Value: Value of a form field. Can be one or more values from a fixed set (select, checkbox, radio type) or free form (text type). (Used to be called category item value)

Specification

Enable forms for a web

By default topics can be edited in free form. A form can be added to a topic to give it more structure. Forms are enabled on a per web basis. This can be done in two ways. One is similar to that used for the older category system, with this a Web can have only one form. The other allows a Web to have any number of forms.

A default form template can be provided by creating the WebTopicEditTemplate topic in a Web and adding a form to it. Initial form values can be set here.

Enabling single default form

The DEFAULTFORM variable in WebPreferences is optional. If present it specifies the default form for all topics in the Web. Every time you edit a topic you will be presented with a form. The form must contain the special field UseForm (analogous to the UseCategory line in the old category system). The values for this must be:

First field - "Yes" (any capitalisation)

Second field - any text, but must mean no form

Enabling multiple forms

The WEBFORMS variable in WebPreferences is optional and defines a list of possible form templates e.g.

Set WEBFORMS = BugForm, FeatureForm, BookLoanForm

With this present an extra button is added to the edit view. If the topic doesn't have a form the button appears at the end of the page. If a form is present the button appears in the top row of the form. Pressing the button leads to a screen that enables no form to be selected of one of those specified by WEBFORMS.

Define a form template

Form templates are defined by topics, one topic per form template. A form template topic has descriptive text mixed with the form template definition in the form of a TWiki table.

Notes

This format allows you to define field items with / without WikiNames, depending on your needs.

The topic can be protected in the usual manner so that not everybody can change the form template.

... can be used for force a link, at present ... format is not supported

The "Tooltip message:" column is used as a tool tip for the field name (only if field name is a WikiName) - you only see the tooltip on edit

The first item in the list is the default item. Alternative initial values can be given in a topic template such as WebTopicEditTemplate or using fieldFLD=value or for checkboxes fieldFLDcheckbox=1 in URL

The UseForm field is special.

Will always default to second value (don't use form) when topic doesn't have a form

Is not show on preview or view

When set to no on save, form data is deleted.

It is not a good idea to use both DEFAULTFORM and WEBFORMSWebPreferences in the same Web.

Topic meta data

The form template topic name and all form fields/values are stored in the topic meta data. The form template topic name is needed for edit and save.

The order of form field/value items in the meta-data is the same as in the form template.

UI for multiple form templates

Optional WEBFORMS variable defines possibles form templates that can be selected after pressing "Change" (forms) button on edit page

A template topic can use any form template

Decided not to ask user to choose a template or form template when creating a topic as goes against the KISS of Wiki systems.

New topics with a form get instantiated by simple HTML forms asking for a topic name, i.e. there is a SubmitExpenseReport topic were you can create new expense reports, a SubmitVacationRequest topic and so on. These can specify the required template topic and hence form.

Migration of Category information

Principle: new system should work with old data with no special conversion.

Old data should be transparently upgraded to the new meta format when a topic is edit/previewed/saved.

On upgrading the administrator must produce a form template topic for each Web that using the old category system. twikicatitems.tmpl defines the categories and is used in the conversion. The form template must be put as first item in WebPreferences variable WEBFORM or DEFAULTFORM (if/when put in). If it's not present, an oops dialog results.