Line: 1 to 1 | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
TWiki Forms - Foundation of TWiki Applications | |||||||||||||
Line: 143 to 143 | |||||||||||||
| |||||||||||||
Changed: | |||||||||||||
< < |
| ||||||||||||
> > |
| ||||||||||||
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: | |||||||||||||
< < |
| ||||||||||||
> > |
| ||||||||||||
For example, a simple form just supporting entry of a name and a date would look as follows: | |||||||||||||
Line: 187 to 188 | |||||||||||||
| |||||||||||||
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: | ||||||||||||
| |||||||||||||
Line: 203 to 204 | |||||||||||||
| |||||||||||||
Added: | |||||||||||||
> > | Note on Attributes:
| ||||||||||||
Values in Other TopicsAs 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: |
Line: 1 to 1 | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
TWiki Forms - Foundation of TWiki Applications | |||||||||||||
Line: 199 to 199 | |||||||||||||
| |||||||||||||
Changed: | |||||||||||||
< < |
| ||||||||||||
> > |
| ||||||||||||
|
Line: 1 to 1 | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
TWiki Forms - Foundation of TWiki Applications | |||||||||||||
Line: 25 to 25 | |||||||||||||
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: | |||||||||||||
> > | The name of a Form Template topic must end in Form. | ||||||||||||
| |||||||||||||
Changed: | |||||||||||||
< < |
| ||||||||||||
> > |
| ||||||||||||
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:
Adding a form to a topic
| ||||||||||||
> > |
| ||||||||||||
| |||||||||||||
Line: 105 to 100 | |||||||||||||
Changed: | |||||||||||||
< < |
| ||||||||||||
> > |
| ||||||||||||
<form name="newtopic" action="%SCRIPTURLPATH{"save"}%/%WEB%/" method="post"> ..... </form> | |||||||||||||
Changed: | |||||||||||||
< < |
| ||||||||||||
> > |
| ||||||||||||
Changed: | |||||||||||||
< < |
| ||||||||||||
> > |
| ||||||||||||
Changed: | |||||||||||||
< < |
| ||||||||||||
> > |
| ||||||||||||
Changed: | |||||||||||||
< < | Changing a form | ||||||||||||
> > |
Changing a Form | ||||||||||||
Changed: | |||||||||||||
< < |
| ||||||||||||
> > |
| ||||||||||||
Changed: | |||||||||||||
< < |
| ||||||||||||
> > |
| ||||||||||||
| |||||||||||||
Line: 200 to 196 | |||||||||||||
| |||||||||||||
Added: | |||||||||||||
> > |
| ||||||||||||
| |||||||||||||
Line: 228 to 225 | |||||||||||||
Notes:
| |||||||||||||
Added: | |||||||||||||
> > | Using a form template on a different webYou 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 theTWIKIFORMPATH 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 typesYou 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 | |||||||||||||
| |||||||||||||
Added: | |||||||||||||
> > | |||||||||||||
Build an HTML Form to Create New Form-based TopicsNew topics with a form are created by simple HTML forms asking for a topic name. For example, you can have aSubmitExpenseReport 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 FieldsAll 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:%EDITFORMFIELD{ "form" type="start" action="save" topic="%BASETOPIC%" }% | Priority: | %EDITFORMFIELD{ "Priority" topic="%BASETOPIC%" }% | | Status: | %EDITFORMFIELD{ "Status" topic="%BASETOPIC%" }% | | | %EDITFORMFIELD{ "form" type="submit" value="Update" }% | %EDITFORMFIELD{ "LastUpdate" type="hidden" value="%SERVERTIME{$year-$mo-$day}%" }% %EDITFORMFIELD{ "form" type="end" }%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. | ||||||||||||
Searching for Form Data | |||||||||||||
Changed: | |||||||||||||
< < | TWiki Forms accept user-input data, stored as TWikiMetaData. Meta data also contains program-generated info about changes, attachments, etc. To find, format and display form and other meta data, see TWikiMetaData, FORMFIELD , SEARCH and METASEARCH variables in TWikiVariables, and TWiki Formatted Search. | ||||||||||||
> > | TWiki Forms accept user-input data, stored as TWikiMetaData. Meta data also contains program-generated info about changes, attachments, etc. To find, format and display form and other meta data, see TWikiMetaData, EDITFORMFIELD, FORMFIELD, SEARCH and METASEARCH variables in TWikiVariables, and TWiki Formatted Search. | ||||||||||||
Example | |||||||||||||
Changed: | |||||||||||||
< < | %SEARCH{"Main.UserName" scope="text" nosearch="on" nototal="on" order="modified" reverse="on" | ||||||||||||
> > | %SEARCH{"Main.UserName" scope="text" nosearch="on" nototal="on" sort="modified" reverse="on" | ||||||||||||
format="|$topic |$formfield(TopicClassification) |" web="Sandbox"}% | |||||||||||||
Line: 274 to 303 | |||||||||||||
Related Topics: TWikiTemplates, TWikiScripts, VarSEARCH, FormattedSearch, UserDocumentationCategory | |||||||||||||
Added: | |||||||||||||
> > |
|
Line: 1 to 1 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
TWiki Forms - Foundation of TWiki Applications | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Line: 134 to 134 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
< < | Each column of the table is one element of an entry field: Name , Type , Size , Values , Tooltip message , and Attributes . | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
> > | Each row of the table defines one element of an input field: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
< < | 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 column: Name is the name of the form field.
Type, Size, Value columns: Type , Size and Value describe the type, size and initial value for this field: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
> > | 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
< < | Attributes column: Attributes specifies special attributes for the field. Multiple attributes can be entered, separated by spaces. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
For example, a simple form just supporting entry of a name and a date would look as follows: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Line: 194 to 183 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Added: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
> > |
Form Field TypesEach table row of a form template defines one element of an input field:
Size and Value depend on the Type used. Form field types:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Values in Other TopicsAs 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: |
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
Changed: | ||||||||
< < | TWiki Forms | |||||||
> > | TWiki Forms - Foundation of TWiki Applications | |||||||
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. | ||||||||
Line: 18 to 18 | ||||||||
| ||||||||
Added: | ||||||||
> > | Tip: The blog How to Create a TWiki Application on TWiki.org is a good tutorial to get started with TWiki forms based applications. | |||||||
Defining a FormA 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: | ||||||||
< < |
| |||||||
> > |
| |||||||
|
Line: 1 to 1 | |||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
TWiki Forms | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Line: 132 to 136 | |||||||||||||||||||||||||||||||||||||||||||||||||||||
The Name , Type and Size columns are required. Other columns are optional. The form must have a header row (e.g. | *Name* | *Type* | *Size* | ). | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||||||||||||||||||||||||
< < | Name is the name of the form field. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
> > | Name column: Name is the name of the form field.
Type, Size, Value columns: Type , Size and Value describe the type, size and initial value for this field:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||||||||||||||||||||||||
< < | The Type , Size and Value fields describe the legal values for this field, and how to display them.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
> > | 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||
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
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
> > |
Editing Just Form Data, Without Topic TextIn some cases you want to change only the form data. You have the option of hiding the topic text with two methods:
Build an HTML Form to Create New Form-based TopicsNew topics with a form are created by simple HTML forms asking for a topic name. For example, you can have aSubmitExpenseReport 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: | |||||||||||||||||||||||||||||||||||||||||||||||||||||
> > | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Searching for Form Data | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Added: | |||||||||||||||||||||||||||||||||||||||||||||||||||||
> > | |||||||||||||||||||||||||||||||||||||||||||||||||||||
TWiki Forms accept user-input data, stored as TWikiMetaData. Meta data also contains program-generated info about changes, attachments, etc. To find, format and display form and other meta data, see TWikiMetaData, FORMFIELD , SEARCH and METASEARCH variables in TWikiVariables, and TWiki Formatted Search.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||
Line: 231 to 258 | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||||||||||||||||||||||||
< < | Related Topics: TWikiTemplates, TWikiScripts, UserDocumentationCategory | ||||||||||||||||||||||||||||||||||||||||||||||||||||
> > | Related Topics: TWikiTemplates, TWikiScripts, VarSEARCH, FormattedSearch, UserDocumentationCategory |
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
TWiki Forms | ||||||||
Line: 100 to 100 | ||||||||
Added: | ||||||||
> > |
| |||||||
| ||||||||
Line: 223 to 231 | ||||||||
Changed: | ||||||||
< < | Related Topics: UserDocumentationCategory, TWikiTemplates | |||||||
> > | Related Topics: TWikiTemplates, TWikiScripts, UserDocumentationCategory |
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
Deleted: | ||||||||
< < | ||||||||
Changed: | ||||||||
< < | TWiki Forms | |||||||
> > | 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. | ||||||||
Added: | ||||||||
> > | ||||||||
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:
| ||||||||
Line: 64 to 65 | ||||||||
| ||||||||
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, | |||||||
Changed: | ||||||||
< < | %SEARCH{"Office$" scope="topic" web="%MAINWEB%" nonoise="on" type="regex" format="$web.$topic" separator=", " }% | |||||||
> > | %SEARCH{"Office$" scope="topic" web="%USERSWEB%" nonoise="on" type="regex" format="$web.$topic" separator=", " }% | |||||||
Changed: | ||||||||
< < | 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. | |||||||
> > | 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 | ||||||||
Line: 101 to 102 | ||||||||
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
Changing a form
| ||||||||
Line: 129 to 130 | ||||||||
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
| ||||||||
Line: 162 to 163 | ||||||||
Field Value Notes:
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
General Notes:
| ||||||||
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:
| *Topic* | *Classification* | | ||||||||
Changed: | ||||||||
< < | %SEARCH{"Main.UserName" scope="text" nosearch="on" nototal="on" order="modified" reverse="on" | |||||||
> > | %SEARCH{"Main.UserName" scope="text" nosearch="on" nototal="on" order="modified" reverse="on" | |||||||
format="|$topic |$formfield(TopicClassification) |" web="Sandbox"}% |
Line: 1 to 1 | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
On this page:
TWiki Forms | |||||||||||||||||||||||||||||||||
Line: 16 to 16 | |||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||||
< < | Defining a Form TemplateA 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 is one form field.Form Template Elements
Defining a Form | ||||||||||||||||||||||||||||||||
> > | Defining a FormA 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. | ||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||||
< < | Example: WebForm | ||||||||||||||||||||||||||||||||
> > | Example: | ||||||||||||||||||||||||||||||||
| *Name* | *Type* | *Size* | *Values* | *Tooltip message* | *Attributes* | | TopicClassification | select | 1 | NoDisclosure, PublicSupported, PublicFAQ | blah blah... | | | OperatingSystem | checkbox | 3 | OsHPUX, OsLinux, OsSolaris, OsWin | blah blah... | | | |||||||||||||||||||||||||||||||||
Line: 58 to 36 | |||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||||
< < | You can also retrieve possible values for select, checkbox or radio types from other topics: | ||||||||||||||||||||||||||||||||
> > | See structure of a form for full details of what types are available and what all the columns mean.
You can also retrieve possible values for select , checkbox or radio types from other topics: | ||||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||||
< < | Example: WebForm | ||||||||||||||||||||||||||||||||
> > | Example: | ||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||
Line: 74 to 54 | |||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||||||||||
> > | | *Name* | | NoDisclosure | | Public Supported | | Public FAQ |
| ||||||||||||||||||||||||||||||||
Field values can also be obtained as the result of a FormattedSearch. For example, | |||||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||||
< < | 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:
| ||||||||||||||||||||||||||||||||
> > | 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 WebForms have to be enabled for each individual web. TheWEBFORMS variable in WebPreferences is optional and defines a list of possible form templates. | |||||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||||
< < | |||||||||||||||||||||||||||||||||
> > | |||||||||||||||||||||||||||||||||
Example:
| |||||||||||||||||||||||||||||||||
Added: | |||||||||||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||||
< < | Add a form to a topic | ||||||||||||||||||||||||||||||||
> > | Adding a form to a topic | ||||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||
Line: 127 to 96 | |||||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||||
< < | |||||||||||||||||||||||||||||||||
> > | |||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||
Deleted: | |||||||||||||||||||||||||||||||||
< < | Build an HTML form to create new Form-based topics
| ||||||||||||||||||||||||||||||||
Changing a form
| |||||||||||||||||||||||||||||||||
Line: 147 to 112 | |||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||
Added: | |||||||||||||||||||||||||||||||||
> > |
Structure of a Form TemplateA 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.
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.
| *Name* | *Type* | *Size* | | Name | text | 80 | | Date | date | 30 |Field Name Notes:
Values in Other TopicsAs 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:
Extending the range of form data typesYou 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:
Hints and TipsBuild an HTML form to create new Form-based topics
| ||||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||||
< < | Searching for Form Data | ||||||||||||||||||||||||||||||||
> > | Searching for Form Data | ||||||||||||||||||||||||||||||||
TWiki Forms accept user-input data, stored as TWikiMetaData. Meta data also contains program-generated info about changes, attachments, etc. To find, format and display form and other meta data, see TWikiMetaData, FORMFIELD , SEARCH and METASEARCH variables in TWikiVariables, and TWiki Formatted Search.
| |||||||||||||||||||||||||||||||||
Line: 156 to 208 | |||||||||||||||||||||||||||||||||
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:
| *Topic* | *Classification* | | |||||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||||
< < | %SEARCH{"Main.UserName" scope="text" regex="off" nosearch="on" nototal="on" order="modified" reverse="on" | ||||||||||||||||||||||||||||||||
> > | %SEARCH{"Main.UserName" scope="text" nosearch="on" nototal="on" order="modified" reverse="on" | ||||||||||||||||||||||||||||||||
format="|$topic |$formfield(TopicClassification) |" web="Sandbox"}% | |||||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||||
< < | Extending the range of form data typesSeveral 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! | ||||||||||||||||||||||||||||||||
> > | 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! | ||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||
Deleted: | |||||||||||||||||||||||||||||||||
< < |
Importing Category Table DataVery, 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 oldtwikicatitems.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 . | ||||||||||||||||||||||||||||||||
Related Topics: UserDocumentationCategory, TWikiTemplates |
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
On this page:
TWiki Forms |
Line: 1 to 1 | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Deleted: | |||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||
On this page:
TWiki Forms | |||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||
< < | Form-based input in topics, with name/value pairs stored as Meta Data variables; choose one of multiple forms per web & topic | ||||||||||||||||||||||||
> > | 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 | ||||||||||||||||||||||||
> > | Typical steps to build an application based on TWiki forms:
| ||||||||||||||||||||||||
Defining a Form Template | |||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||
< < | A Form Template is simply a page containing your form, defined as a table where each row is one form field. | ||||||||||||||||||||||||
> > | 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 is one form field. | ||||||||||||||||||||||||
Form Template Elements | |||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||
| |||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||
| |||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||
| |||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||
| |||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||
< < | Defining a Form in One Topic | ||||||||||||||||||||||||
> > | Defining a Form | ||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||
| |||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||
< < | Example: WebForm | *Name* | *Type* | *Size* | *Values* | *Tooltip message* | | TopicClassification | select | 1 | NoDisclosure, PublicSupported, PublicFAQ | blah blah... | | OperatingSystem | checkbox | 3 | OsHPUX, OsLinux, OsSolaris, OsWin | blah blah... | | OsVersion | text | 16 | | blah blah... |
| ||||||||||||||||||||||||
> > | Example: WebForm | *Name* | *Type* | *Size* | *Values* | *Tooltip message* | *Attributes* | | TopicClassification | select | 1 | NoDisclosure, PublicSupported, PublicFAQ | blah blah... | | | OperatingSystem | checkbox | 3 | OsHPUX, OsLinux, OsSolaris, OsWin | blah blah... | | | OsVersion | text | 16 | | blah blah... | |
| ||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||
< < | Defining a Form with Multiple TopicsForms can also be defined by using form templates that retrieve field values from one or more separate topics:
| ||||||||||||||||||||||||
> > | You can also retrieve possible values for select, checkbox or radio types from other topics: | ||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||
< < | Example: WebFormTemplate | ||||||||||||||||||||||||
> > | Example: WebForm | ||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||
Leave the Values field blank. | |||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||
| |||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||
> > | Field values can also be obtained as the result of a FormattedSearch. For example,
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:
| ||||||||||||||||||||||||
| |||||||||||||||||||||||||
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 have to be enabled for each individual web. The WEBFORMS variable in WebPreferences is optional and defines a list of possible form templates.
Example: | ||||||||||||||||||||||||
| |||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||
< < | Including Forms in New Topics | ||||||||||||||||||||||||
> > | Add a form to a topic | ||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||
| |||||||||||||||||||||||||
Added: | |||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||
< < | Setting Up Multiple Form Options | ||||||||||||||||||||||||
> > | Build an HTML form to create new Form-based topics | ||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||
> > | Changing a form
| ||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||
< < | Form Data Storage | ||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||
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. | ||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||
< < | Using Form DataTWikiForms accept user-input data, stored as TWikiMetaData. Meta data also contains program-generated info about changes, attachments, etc. To find, format and display form and other meta data, see TWikiMetaData,SEARCH and METASEARCH variables in TWikiVariables, and TWiki Formatted Search for various options. | ||||||||||||||||||||||||
> > | Searching for Form DataTWiki Forms accept user-input data, stored as TWikiMetaData. Meta data also contains program-generated info about changes, attachments, etc. To find, format and display form and other meta data, see TWikiMetaData,FORMFIELD , SEARCH and METASEARCH variables in TWikiVariables, and TWiki Formatted Search. | ||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||
< < |
Main Changes from Category Tables | ||||||||||||||||||||||||
> > | Example | ||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||
< < | 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 typesSeveral 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:
| ||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||
> > | Gotcha!
| ||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||
< < | Importing Category Table Data | ||||||||||||||||||||||||
> > |
Importing Category Table DataVery, 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 SettingsExample 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 . | ||||||||||||||||||||||||
Deleted: | |||||||||||||||||||||||||
< < |
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.
Using the TWiki:Plugins.EditTablePlugin on WebPreferencesForm makes adding new prefedrences a breeze.
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.
Another example, this one using EditTablePlugin, source:
%EDITTABLE{ header="|*Name*|*Type*|*Size*|*Values*|*Tooltip message*|*Attributes*|" format="|text,20|text,20|text,20|text,20|text,20|text,1|" }%
Result (after some editing):
<-- /editTable -->-- TWiki:Main.JohnTalintyre - 16 Aug 2001 -- TWiki:Main.MikeMannix - 05 Jan 2002 -- TWiki:Main.PeterThoeny - 25 Apr 2004 -- TWiki:Main.MattWilkie - 27 Jul 2004 | ||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||
> > | Related Topics: UserDocumentationCategory, TWikiTemplates |
Line: 1 to 1 | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||
Line: 29 to 29 | |||||||||||||
| |||||||||||||
Changed: | |||||||||||||
< < |
| ||||||||||||
> > |
| ||||||||||||
|
Line: 1 to 1 | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
Line: 42 to 42 | ||||||||||||||||
| ||||||||||||||||
Changed: | ||||||||||||||||
< < | Example: WebForm
| *Name* | *Type* | *Size* | *Values* | *Tooltip message* | | Know.TopicClassification | select | 1 | Know.NoDisclosure, Know.PublicSupported, Know.PublicFAQ | blah blah... | | Know.OperatingSystem | checkbox | 3 | Know.OsHPUX, Know.OsLinux, Know.OsSolaris, Know.OsWin | blah blah... | | Know.OsVersion | text | 16 | | blah blah... | | |||||||||||||||
> > | Example: WebForm | *Name* | *Type* | *Size* | *Values* | *Tooltip message* | | TopicClassification | select | 1 | NoDisclosure, PublicSupported, PublicFAQ | blah blah... | | OperatingSystem | checkbox | 3 | OsHPUX, OsLinux, OsSolaris, OsWin | blah blah... | | OsVersion | text | 16 | | blah blah... | | |||||||||||||||
| ||||||||||||||||
Changed: | ||||||||||||||||
< < |
| |||||||||||||||
> > |
| |||||||||||||||
Defining a Form with Multiple Topics | ||||||||||||||||
Line: 68 to 64 | ||||||||||||||||
Example: WebFormTemplate | ||||||||||||||||
Changed: | ||||||||||||||||
< < |
| |||||||||||||||
> > |
| |||||||||||||||
| ||||||||||||||||
Changed: | ||||||||||||||||
< < |
| |||||||||||||||
> > |
| |||||||||||||||
Leave the Values field blank. | ||||||||||||||||
Changed: | ||||||||||||||||
< < |
| |||||||||||||||
> > |
| |||||||||||||||
| ||||||||||||||||
Changed: | ||||||||||||||||
< < |
| |||||||||||||||
> > |
| |||||||||||||||
| ||||||||||||||||
Line: 106 to 102 | ||||||||||||||||
| ||||||||||||||||
Changed: | ||||||||||||||||
< < |
| |||||||||||||||
> > |
| |||||||||||||||
Boxes with a tick must be specified.
Setting Up Multiple Form Options | ||||||||||||||||
Line: 144 to 140 | ||||||||||||||||
NOTE: If things aren't working correctly, there may be useful entries in data/warning.txt . | ||||||||||||||||
Added: | ||||||||||||||||
> > | Using Forms For SettingsExample process to change your WebPreferences to use forms instead of{3 spaces}* Set statements:
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.
Using the TWiki:Plugins.EditTablePlugin on WebPreferencesForm makes adding new prefedrences a breeze.
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.
Another example, this one using EditTablePlugin, source:
%EDITTABLE{ header="|*Name*|*Type*|*Size*|*Values*|*Tooltip message*|*Attributes*|" format="|text,20|text,20|text,20|text,20|text,20|text,1|" }%
Result (after some editing):
<-- /editTable --> | |||||||||||||||
-- TWiki:Main.JohnTalintyre - 16 Aug 2001 -- TWiki:Main.MikeMannix - 05 Jan 2002 | ||||||||||||||||
Changed: | ||||||||||||||||
< < | -- TWiki:Main.PeterThoeny - 25 Apr 2004 | |||||||||||||||
> > | -- TWiki:Main.PeterThoeny - 25 Apr 2004 -- TWiki:Main.MattWilkie - 27 Jul 2004 | |||||||||||||||
|
Line: 1 to 1 | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||
Line: 24 to 24 | |||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||||||||||
Defining a Form in One Topic | |||||||||||||||||||||||||||||||||
Line: 142 to 144 | |||||||||||||||||||||||||||||||||
NOTE: If things aren't working correctly, there may be useful entries in data/warning.txt . | |||||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||||
< < | -- JohnTalintyre - 16 Aug 2001 -- MikeMannix - 05 Jan 2002 | ||||||||||||||||||||||||||||||||
> > | -- TWiki:Main.JohnTalintyre - 16 Aug 2001 -- TWiki:Main.MikeMannix - 05 Jan 2002 -- TWiki:Main.PeterThoeny - 25 Apr 2004 | ||||||||||||||||||||||||||||||||
Added: | |||||||||||||||||||||||||||||||||
> > | |||||||||||||||||||||||||||||||||
|
Line: 1 to 1 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
Line: 10 to 10 | |||||||||||
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 TablesThe 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 DataOn 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 oldtwikicatitems.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 | ||||||||||
Defining a Form Template | |||||||||||
Line: 142 to 123 | |||||||||||
Using Form DataTWikiForms accept user-input data, stored as TWikiMetaData. Meta data also contains program-generated info about changes, attachments, etc. To find, format and display form and other meta data, see TWikiMetaData,SEARCH and METASEARCH variables in TWikiVariables, and TWiki Formatted Search for various options. | |||||||||||
Added: | |||||||||||
> > |
Main Changes from Category TablesThe 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 DataOn 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 oldtwikicatitems.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 . | ||||||||||
-- JohnTalintyre - 16 Aug 2001 -- MikeMannix - 05 Jan 2002 |
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Line: 117 to 117 | ||||||||
| ||||||||
Added: | ||||||||
> > | Including Forms in New Topics | |||||||
| ||||||||
Line: 124 to 126 | ||||||||
| ||||||||
Deleted: | ||||||||
< < | Including Forms in New TopicsWhen you create a new topic in a web that has theWEBFORMS 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:
formtemplate parameter in the URL. | |||||||
Setting Up Multiple Form Options
|
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Line: 15 to 15 | ||||||||
Main Changes from Category Tables | ||||||||
Changed: | ||||||||
< < | Form Templates more powerful, flexible replacement for the original TWikiCategoryTable. Data from existing category tables can be imported directly. | |||||||
> > | The Form Template system is a more powerful, flexible replacement for the original TWikiCategoryTable. Data from existing category tables can be imported directly. | |||||||
| ||||||||
Line: 54 to 54 | ||||||||
Defining a Form in One Topic
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
|
Line: 1 to 1 | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
On this page:
TWiki Forms | ||||||||||||||||
Changed: | ||||||||||||||||
< < | Form-based input in topics, with name/value pairs stored as Meta Data variables; multiple forms per web & topic | |||||||||||||||
> > | Form-based input in topics, with name/value pairs stored as Meta Data variables; choose one of multiple forms per web & topic | |||||||||||||||
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
| ||||||||||||||||
Changed: | ||||||||||||||||
< < |
| |||||||||||||||
> > |
| |||||||||||||||
| ||||||||||||||||
Line: 53 to 53 | ||||||||||||||||
Defining a Form in One Topic | ||||||||||||||||
Changed: | ||||||||||||||||
< < |
| |||||||||||||||
> > |
| |||||||||||||||
| ||||||||||||||||
Changed: | ||||||||||||||||
< < |
| |||||||||||||||
> > |
| |||||||||||||||
Changed: | ||||||||||||||||
< < | Example: WebForm from the TWiki.Know web | |||||||||||||||
> > | Example: WebForm | |||||||||||||||
| *Name* | *Type* | *Size* | *Values* | *Tooltip message* | | Know.TopicClassification | select | 1 | Know.NoDisclosure, | ||||||||||||||||
Line: 77 to 77 | ||||||||||||||||
Defining a Form with Multiple Topics | ||||||||||||||||
Changed: | ||||||||||||||||
< < | The Form Template can also be defined in an alternative way by using more then one topic: | |||||||||||||||
> > | Forms can also be defined by using form templates that retrieve field values from one or more separate topics: | |||||||||||||||
Changed: | ||||||||||||||||
< < |
| |||||||||||||||
> > |
| |||||||||||||||
Example: WebFormTemplate | ||||||||||||||||
Changed: | ||||||||||||||||
< < |
| |||||||||||||||
> > |
| |||||||||||||||
| ||||||||||||||||
Changed: | ||||||||||||||||
< < |
| |||||||||||||||
> > |
Leave the Values field blank. | |||||||||||||||
| ||||||||||||||||
Changed: | ||||||||||||||||
< < | | |||||||||||||||
> > | | |||||||||||||||
| ||||||||||||||||
Line: 101 to 103 | ||||||||||||||||
| ||||||||||||||||
Changed: | ||||||||||||||||
< < |
| |||||||||||||||
> > |
| |||||||||||||||
| ||||||||||||||||
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: | |||||||||||||||
| ||||||||||||||||
Changed: | ||||||||||||||||
< < |
| |||||||||||||||
> > |
| |||||||||||||||
| ||||||||||||||||
Changed: | ||||||||||||||||
< < |
| |||||||||||||||
> > |
| |||||||||||||||
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: | |||||||||||||||
| ||||||||||||||||
Changed: | ||||||||||||||||
< < | 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: | ||||||||||||||||
< < |
| |||||||||||||||
> > |
| |||||||||||||||
Changed: | ||||||||||||||||
< < |
| |||||||||||||||
> > |
| |||||||||||||||
Changed: | ||||||||||||||||
< < |
| |||||||||||||||
> > | 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. | |||||||||||||||
> > |
Using Form DataTWikiForms accept user-input data, stored as TWikiMetaData. Meta data also contains program-generated info about changes, attachments, etc. To find, format and display form and other meta data, see TWikiMetaData,SEARCH and METASEARCH variables in TWikiVariables, and TWiki Formatted Search for various options. | |||||||||||||||
-- JohnTalintyre - 16 Aug 2001 | ||||||||||||||||
Changed: | ||||||||||||||||
< < | -- MikeMannix - 03 Dec 2001 | |||||||||||||||
> > | -- MikeMannix - 05 Jan 2002 | |||||||||||||||
|
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Line: 148 to 143 | ||||||||
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.
-- JohnTalintyre - 16 Aug 2001 | ||||||||
Changed: | ||||||||
< < | -- MikeMannix - 15 Sep 2001 | |||||||
> > | -- MikeMannix - 03 Dec 2001 | |||||||
|
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Line: 147 to 147 | ||||||||
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. | ||||||||
Changed: | ||||||||
< < | -- JohnTalintyre - 16 Aug 2001 | |||||||
> > | -- JohnTalintyre - 16 Aug 2001 -- MikeMannix - 15 Sep 2001 | |||||||
|
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Deleted: | ||||||||
< < | Warning: Can't find topic TWiki.UtilTempDocNote | |||||||
On this page:
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. | ||||||||
Line: 61 to 59 | ||||||||
| ||||||||
Changed: | ||||||||
< < | Example: WebFormTemplate from the TWiki.Know web | |||||||
> > | Example: WebForm from the TWiki.Know web | |||||||
| *Name* | *Type* | *Size* | *Values* | *Tooltip message* | | Know.TopicClassification | select | 1 | Know.NoDisclosure, | ||||||||
Line: 106 to 104 | ||||||||
| ||||||||
Changed: | ||||||||
< < | ||||||||
> > |
| |||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
| ||||||||
Line: 147 to 145 | ||||||||
Form Template Data Storage | ||||||||
Changed: | ||||||||
< < | 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. | |||||||
> > | 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. | |||||||
-- JohnTalintyre - 16 Aug 2001
|
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Added: | ||||||||
> > | Warning: Can't find topic TWiki.UtilTempDocNote | |||||||
Changed: | ||||||||
< < | TWiki Form Templates | |||||||
> > | TWiki Forms | |||||||
Form-based input in topics, with name/value pairs stored as Meta Data variables; multiple forms per web & topic | ||||||||
Line: 148 to 150 | ||||||||
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.
-- JohnTalintyre - 16 Aug 2001 | ||||||||
Added: | ||||||||
> > |
|
Line: 1 to 1 | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
Line: 13 to 13 | ||||||||||||||||
Form Templates replace TWikiCategory Tables from the 01-Dec-2000 version of TWiki. | ||||||||||||||||
Changed: | ||||||||||||||||
< < | Changes from the Category Table System | |||||||||||||||
> > | Main Changes from Category Tables | |||||||||||||||
Form Templates more powerful, flexible replacement for the original TWikiCategoryTable. Data from existing category tables can be imported directly. | ||||||||||||||||
Deleted: | ||||||||||||||||
< < | Main changes from TWikiCategoryTable: | |||||||||||||||
| ||||||||||||||||
Changed: | ||||||||||||||||
< < | 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 TemplateA Form Template is simply a page containing your form, defined in a table where each row is one form field.Form Template Elements | |||||||||||||||
| ||||||||||||||||
Line: 49 to 51 | ||||||||||||||||
| ||||||||||||||||
Changed: | ||||||||||||||||
< < | Defining a Form TemplateA 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 | |||||||||||||||
| ||||||||||||||||
Line: 68 to 68 | ||||||||||||||||
OsSolaris, OsWin | blah blah... |
| ||||||||||||||||
Deleted: | ||||||||||||||||
< < |
Defining a Form in One TopicExample: WebFormTemplate from the TWiki.Know web | |||||||||||||||
| ||||||||||||||||
Line: 81 to 75 | ||||||||||||||||
| ||||||||||||||||
Changed: | ||||||||||||||||
< < | Defining a Form in Multiple Topics | |||||||||||||||
> > | Defining a Form with Multiple Topics | |||||||||||||||
The Form Template can also be defined in an alternative way by using more then one topic: | ||||||||||||||||
Changed: | ||||||||||||||||
< < |
| |||||||||||||||
> > |
| |||||||||||||||
Changed: | ||||||||||||||||
< < | Code from: | |||||||||||||||
> > | Example: WebFormTemplate | |||||||||||||||
Changed: | ||||||||||||||||
< < |
| |||||||||||||||
> > |
| |||||||||||||||
| ||||||||||||||||
Changed: | ||||||||||||||||
< < |
| |||||||||||||||
> > |
| |||||||||||||||
Changed: | ||||||||||||||||
< < |
| |||||||||||||||
> > |
| |||||||||||||||
| ||||||||||||||||
Changed: | ||||||||||||||||
< < | Implementation Notes
| |||||||||||||||
> > |
| |||||||||||||||
| ||||||||||||||||
Line: 131 to 125 | ||||||||||||||||
| ||||||||||||||||
Changed: | ||||||||||||||||
< < | Creating New Topics with Forms | |||||||||||||||
> > | Including Forms in New TopicsWhen 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. | |||||||||||||||
> > |
| |||||||||||||||
A form embedded in a topic also appears in a new topic. This is done by specifying the formtemplate parameter in the URL. |
Line: 1 to 1 | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | Form Templates | ||||||||||||||||||||
> > | TWiki Form Templates | ||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | Include form-based input in topics, with unlimited, user-selectable forms per web; values stored as Meta Data | ||||||||||||||||||||
> > | Form-based input in topics, with name/value pairs stored as Meta Data variables; multiple forms per web & topic | ||||||||||||||||||||
OverviewBy 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 SystemForm Templates more powerful, flexible replacement for the original TWikiCategoryTable. Data from existing category tables can be imported directly. Main changes from TWikiCategoryTable:
Importing Existing Category Table DataOn 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 oldtwikicatitems.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 Template Elements | |||||||||||||||||||||
Line: 38 to 59 | |||||||||||||||||||||
| |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | Example: Form Template | ||||||||||||||||||||
> > | Example: WebFormTemplate from the TWiki.Know web | ||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < |
| ||||||||||||||||||||
> > |
| ||||||||||||||||||||
Defining a Form in One Topic | |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | Example: WebFormTemplate of the TWiki.Know web: | ||||||||||||||||||||
> > | Example: WebFormTemplate from the TWiki.Know web | ||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < |
| ||||||||||||||||||||
> > |
| ||||||||||||||||||||
| |||||||||||||||||||||
Added: | |||||||||||||||||||||
> > | |||||||||||||||||||||
Defining a Form in Multiple Topics | |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | The form template can also be defined in an alternative way by using more then one topic: | ||||||||||||||||||||
> > | The Form Template can also be defined in an alternative way by using more then one topic: | ||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < |
| ||||||||||||||||||||
> > |
| ||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | Code from: | ||||||||||||||||||||
> > | Code from: | ||||||||||||||||||||
| |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < |
| ||||||||||||||||||||
> > |
| ||||||||||||||||||||
| |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < |
| ||||||||||||||||||||
> > |
| ||||||||||||||||||||
| |||||||||||||||||||||
Line: 102 to 127 | |||||||||||||||||||||
| |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < |
| ||||||||||||||||||||
> > |
| ||||||||||||||||||||
Creating New Topics with Forms |
Line: 1 to 1 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
Changed: | |||||||||||
< < | 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 SystemMain changes from TWikiCategoryTable: The templates for category view/edit have been dropped, and the forma renders to HTML on viewing.
Migrating Existing Category Table DataThe 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
| ||||||||||
> > |
| ||||||||||
| |||||||||||
Changed: | |||||||||||
< < |
| ||||||||||
> > |
| ||||||||||
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. | |||||||||||
Line: 67 to 47 | |||||||||||
Changed: | |||||||||||
< < | Defining a Form in One Topic | ||||||||||
> > | Defining a Form in One Topic | ||||||||||
Example: WebFormTemplate of the TWiki.Know web: | |||||||||||
Line: 76 to 56 | |||||||||||
| |||||||||||
Changed: | |||||||||||
< < | 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: 99 to 79 | |||||||||||
| |||||||||||
Changed: | |||||||||||
< < | Various Implementation Notes | ||||||||||
> > | Implementation Notes | ||||||||||
| |||||||||||
Added: | |||||||||||
> > | |||||||||||
| |||||||||||
Deleted: | |||||||||||
< < |
| ||||||||||
Changed: | |||||||||||
< < | 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 e.g. | ||||||||||
> > | Enabling Forms by WebForms are enabled on a per web basis. TheWEBFORMS variable in WebPreferences is optional and defines a list of possible Form Templates. Example: | ||||||||||
| |||||||||||
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 . | ||||||||||
> > |
| ||||||||||
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. | ||||||||||
> > |
| ||||||||||
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: | ||||||||||
> > |
| ||||||||||
| |||||||||||
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
| ||||||||||
Changed: | |||||||||||
< < |
| ||||||||||
> > |
| ||||||||||
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]. | ||||||||||
-- JohnTalintyre - 16 Aug 2001 |
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Line: 105 to 105 | ||||||||
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
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: | ||||||||
< < |
| |||||||
> > |
| |||||||
Creating New Topics with Forms |
Line: 1 to 1 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Line: 12 to 12 | ||||||||||
You can search for topics with specific form data using the %SEARCH% variable - see TWikiVariables. | ||||||||||
Changed: | ||||||||||
< < | Goodby to TWikiCategoryTables | |||||||||
> > | TWikiCategoryTables Are History | |||||||||
Changed: | ||||||||||
< < | 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 Templates more powerful, flexible replacement for the original TWikiCategoryTable. | |||||||||
Changes from the Category Table System | ||||||||||
Changed: | ||||||||||
< < | Main changes from TWikiCategoryTable: The templates for category view/edit have been dropped.and render to HTML on viewing | |||||||||
> > | Main changes from TWikiCategoryTable: The templates for category view/edit have been dropped, and the forma renders to HTML on viewing. | |||||||||
| ||||||||||
Line: 43 to 42 | ||||||||||
| ||||||||||
Changed: | ||||||||||
< < |
| |||||||||
> > |
| |||||||||
| ||||||||||
Changed: | ||||||||||
< < |
| |||||||||
> > |
| |||||||||
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 | |||||||||
> > |
Example: Form Template| *Name:* | *Type:* | *Size:* | *Values:* | *Tooltip message:* | | TopClass | select | 1 | Select one..., Private, Public | must fill | | Target | checkbox+buttons | 3 | 1, No.2, No.3 | Select OS | | Version | text | 16 | | OS version | | |||||||||
Defining a Form in One Topic | ||||||||||
Line: 71 to 83 | ||||||||||
| ||||||||||
Changed: | ||||||||||
< < | Above Example: | |||||||||
> > | Code from: | |||||||||
| ||||||||||
Line: 84 to 97 | ||||||||||
| ||||||||||
Added: | ||||||||||
> > | ||||||||||
Changed: | ||||||||||
< < | Notes | |||||||||
> > | Various Implementation Notes | |||||||||
| ||||||||||
Line: 94 to 108 | ||||||||||
| ||||||||||
Changed: | ||||||||||
< < | SpecificationEnabling 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. | |||||||||
| ||||||||||
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. | ||||||||||
Line: 118 to 129 | ||||||||||
Setting Up Multiple Form Options | ||||||||||
Changed: | ||||||||||
< < |
| |||||||||
> > |
| |||||||||
| ||||||||||
Deleted: | ||||||||||
< < |
| |||||||||
|
Line: 1 to 1 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
Line: 6 to 6 | |||||||||||
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 TWikiCategoryTablesThis 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 SystemMain changes from TWikiCategoryTable: The templates for category view/edit have been dropped.and render to HTML on viewing
Migrating Existing Category Table DataThe 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 | ||||||||||
| |||||||||||
Line: 26 to 49 | |||||||||||
| |||||||||||
Changed: | |||||||||||
< < |
SpecificationEnable forms for a webBy 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. TheWEBFORMS variable in WebPreferences is optional and defines a list of possible form templates e.g.
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:
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. | |||||||||||
Changed: | |||||||||||
< < | Examples | ||||||||||
> > | Examples | ||||||||||
Changed: | |||||||||||
< < | Defining form in one topic | ||||||||||
> > | Defining a Form in One Topic | ||||||||||
Example: WebFormTemplate of the TWiki.Know web: | |||||||||||
Line: 59 to 64 | |||||||||||
| |||||||||||
Changed: | |||||||||||
< < |
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 | |||||||||||
| |||||||||||
Changed: | |||||||||||
< < | Changes from category system | ||||||||||
> > | Specification | ||||||||||
Changed: | |||||||||||
< < | Main changes from TWikiCategoryTable:
| ||||||||||
> > | 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.
| ||||||||||
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. | ||||||||||
Changed: | |||||||||||
< < | See MetaDataDefinition. | ||||||||||
> > | 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:
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: | |||||||||||
< < |
| ||||||||||
> > |
| ||||||||||
| |||||||||||
Changed: | |||||||||||
< < |
| ||||||||||
> > |
| ||||||||||
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 .
HistoryThis 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]. | ||||||||||
-- JohnTalintyre - 16 Aug 2001 |
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Added: | ||||||||
> > | ||||||||
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. 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. | |||||||
Terminology | ||||||||
Line: 56 to 60 | ||||||||
| ||||||||
Changed: | ||||||||
< < | Defining 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: 104 to 108 | ||||||||
Topic meta data | ||||||||
Changed: | ||||||||
< < | See TWikiMetaDataDefinition. | |||||||
> > | See MetaDataDefinition. | |||||||
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. | ||||||||
Line: 129 to 133 | ||||||||
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. | ||||||||
Changed: | ||||||||
< < | -- JohnTalintyre - 16 Aug 2001 | |||||||
> > | -- JohnTalintyre - 16 Aug 2001 |
Line: 1 to 1 | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Form Templates | ||||||||||||||||
Changed: | ||||||||||||||||
< < | BackgroundThis 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
| ||||||||||||||||
Changed: | ||||||||||||||||
< < |
| |||||||||||||||
> > |
| |||||||||||||||
| ||||||||||||||||
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 formTheDEFAULTFORM 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:
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.
| ||||||||||||||||
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:
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. | ||||||||||||||||
Line: 57 to 51 | ||||||||||||||||
Example: WebFormTemplate of the TWiki.Know web:
| ||||||||||||||||
Deleted: | ||||||||||||||||
< < |
| |||||||||||||||
| ||||||||||||||||
Line: 74 to 67 | ||||||||||||||||
| ||||||||||||||||
Deleted: | ||||||||||||||||
< < |
| |||||||||||||||
| ||||||||||||||||
Line: 88 to 80 | ||||||||||||||||
Notes
| ||||||||||||||||
Changed: | ||||||||||||||||
< < |
| |||||||||||||||
> > |
| |||||||||||||||
| ||||||||||||||||
Changed: | ||||||||||||||||
< < |
| |||||||||||||||
> > |
| |||||||||||||||
Changes from category systemMain changes from TWikiCategoryTable:
| ||||||||||||||||
Deleted: | ||||||||||||||||
< < |
| |||||||||||||||
| ||||||||||||||||
Added: | ||||||||||||||||
> > |
| |||||||||||||||
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: | ||||||||||||||||
< < |
| |||||||||||||||
> > |
| |||||||||||||||
| ||||||||||||||||
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 .
HistoryThis 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. | |||||||||||||||
Changed: | ||||||||||||||||
< < | -- JohnTalintyre - 07 Aug 2001 | |||||||||||||||
> > | -- JohnTalintyre - 16 Aug 2001 |
Line: 1 to 1 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Added: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
> > |
Form TemplatesOn this page:
BackgroundThis 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
SpecificationEnable forms for a webBy 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 theWebTopicEditTemplate topic in a Web and adding a form to it. Initial form values can be set here.
Enabling single default formTheDEFAULTFORM 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:
Enabling multiple formsTheWEBFORMS variable in WebPreferences is optional and defines a list of possible form templates e.g.
WEBFORMS .
Define a form templateForm 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.ExamplesDefining form in one topicExample: WebFormTemplate of the TWiki.Know web:
Defining form in multiple topicsThe form template can also be defined in an alternative way by using more then one topic:
Notes
Changes from category systemMain changes from TWikiCategoryTable:
Creating new topics with formsWhen 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. 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.Topic meta dataSee TWikiMetaDataDefinition. 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
Migration of Category informationPrinciple: 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.
-- JohnTalintyre - 07 Aug 2001 |