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. | ||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | Form Templates replace TWikiCategory Tables from the 01-Dec-2000 version of TWiki. | ||||||||||||||||||||
> > | Form Templates replace TWikiCategoryTables from the 01-Dec-2000 version of TWiki. | ||||||||||||||||||||
Main Changes from Category TablesForm Templates 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. | |||||||||||||||||||||
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: | |||||||||||||||||||||
< < |
| ||||||||||||||||||||
> > |
| ||||||||||||||||||||
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, 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... |
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: | |||||||||||||||||||||
< < |
| ||||||||||||||||||||
> > |
| ||||||||||||||||||||
Added: | |||||||||||||||||||||
> > | Leave the Values field blank. | ||||||||||||||||||||
| |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | | ||||||||||||||||||||
> > | | ||||||||||||||||||||
| |||||||||||||||||||||
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: | |||||||||||||||||||||
< < |
| ||||||||||||||||||||
> > |
| ||||||||||||||||||||
Added: | |||||||||||||||||||||
> > | Boxes with a tick must be specified. | ||||||||||||||||||||
Including Forms in New Topics | |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | When you create a new topic in a web that has the WEBFORMS Preferences variable set, an Add Form button appears at the bottom of the page. You can start all new topics with forms enabled, and pre-select a form if there's more than one available: | ||||||||||||||||||||
> > | When you create a new topic in a web that has the WEBFORMS Preferences variable set, an Add Form button appears at the bottom of the page. You can start all new topics with forms enabled, and pre-select a form if there's more than one available: | ||||||||||||||||||||
| |||||||||||||||||||||
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: | |||||||||||||||||||||
< < |
| ||||||||||||||||||||
> > |
| ||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | Form Template Data Storage | ||||||||||||||||||||
> > | Form Data Storage | ||||||||||||||||||||
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. | ||||||||||||||||||||
> > | 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. | ||||||||||||||||||||
Added: | |||||||||||||||||||||
> > |
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 | ||||||||||||||||||||
Added: | |||||||||||||||||||||
> > | |||||||||||||||||||||
|