TWikiForms < TWiki/

%TOC%
%STARTINCLUDE%
---## Form 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 (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.

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

---+++ Terminology

   * *Form Template:* A set of fields defining a form. (_Class_ in OO speak; used to be called _category table definition_)
      * A web may contain more then zero or more form template.
   * *Form:* A topic containing additional meta-data (besides the free form TEXTAREA) which categorizes the content. (_Object_ in OO speak; used to be called _category table_)
      * A topic has zero or one of the defined forms. So there are topics with a form or without.
   * *Form Field:* A named item in a form. (Used to be called _category item name_)
   * *Field Type:* The type of a field when editing a form. The type defines the HTML INPUT tag widgets when editing a topic:
      * *select:* Drop down box or selector
      * *checkbox:* One or more check boxes
      * *checkbox+buttons:* One or more check boxes, plus _set_ and _clear_ buttons to set/clear all check boxes
      * *radio:* One or more radio buttons
      * *text:* A one-line text field
      * *textarea:* A general text area - size is <i>rows</i>x<i>cols</i> e.g. 40x10
   * *Field Value:* Value of a form field. Can be one or more values from a fixed set (select, checkbox, radio type) or free form (text type). (Used to be called _category item value_)


---+++ Specification

---++++ Enable forms for a web

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

The ==WEBFORMS== variable in WebPreferences is optional and defines a list of possible form templates e.g.
   * <nop>Set WEBFORMS = <nop>BugForm, <nop>FeatureForm, <nop>BookLoanForm

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

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

Addtionaly a new topic can be given a form using the =formtemplate= parameter in the URL.  Initial values can then be provided in the URLs or as form values.  Names being:
   * Not checkboxs - nameFLD e.g. ?BugPriorityFLD=1
   * Checkbox - nameFLDvalue=1 e.g. ?ColourFLDRed=1.  Note that all boxes with a tick must be specified.

---++++ Defining a form template

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.

---+++ Examples

---++++ Defining form in one topic

Example: <nop>WebFormTemplate of the TWiki.Know web:

| *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 in multiple topics

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

   * A *form template topic* defines the form
   * Values of fields that have more then one value, e.g. of type radio, select and checkbox can be defined by *field value template topics*

Above Example:

   * <nop>WebFormTemplate of the TWiki.Know web:
     | *Name:* | *Type:* | *Size:* | *Values:*  | *Tooltip message:* |
     | Know.TopicClassification | select | 1 | | blah blah... |
     | Know.OperatingSystem | checkbox | 3 | | blah blah... |
     | Know.OsVersion | text | 16 | | blah blah... |

   * <nop>TopicClassification topic:
     | *Name:* | *Type:* | *Tooltip message:* |
     | Know.NoDisclosure | option | blah blah... |
     | Know.PublicSupported | option | blah blah... |
     | Know.PublicFAQ | option | blah blah... |

---++++ Notes

   * This format allows you to define field items with / without TWiki.WikiNames, depending on your needs.
   * The topic can be protected in the usual manner so that not everybody can change the form template - see TWikiAccessControl
   * =[[...]]= can be used for force a link, at present =[[...][...]]= format is not supported
   * The "Tooltip message:" column is used as a tool tip for the field name (only if field name is a TWiki.WikiName) - you only see the tooltip on edit
   * The first item in the list is the default item.  Alternative initial values can be given in a topic template such as ==WebTopicEditTemplate== or using fieldFLD=value or for checkboxes fieldFLDcheckbox=1 in URL
   * The topic definition is not read when a topic is viewed

---+++ Changes from category system

Main changes from TWikiCategoryTable:
   * Name changed in the hope that form is more readily understandable than category
   * The templates for category view/edit have been dropped
   * Forms are defined by topics, categories were defined in a template file
   * A Web can have multiple forms, only one category was possible
   * Form data is saved in meta variables - see MetaDataDefinition, and render to HTML on viewing.  Category data was stored as HTML
   * The <nop>UseCategory radio button has gone, the replacement being the _Change_ form and _Add Form_ buttons.

---+++ Creating new topics with forms

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.

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

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.

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

---+++ UI for multiple form templates

   * Optional ==WEBFORMS== variable defines possible form templates that can be selected after pressing "Change" (forms) button on edit page
   * A template topic can use any form template 
   * Decided not to ask user to choose a template or form template when creating a topic as goes against the KISS of Wiki systems.
   * New topics with a form get instantiated by simple HTML forms asking for a topic name, i.e. there is a <nop>SubmitExpenseReport topic were you can create new expense reports, a <nop>SubmitVacationRequest topic and so on. These can specify the required template topic and hence form.

---+++ Migration of Category information

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

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

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

---+++ History

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

-- JohnTalintyre - 16 Aug 2001 <br>
This topic: TWiki/ > TWiki > TWikiForms
Topic revision: r3 - 29 Aug 2001 - 13:30:22 - JohnTalintyre?
Copyright � by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback