<div>
<ul>
- <li><a href="#Form Templates"> Form Templates</a><ul>
- <li><a href="#Terminology"> Terminology</a></li>
- <li><a href="#Specification"> Specification</a><ul>
- <li><a href="#Enable forms for a web"> Enable forms for a web</a></li>
- <li><a href="#Defining a form template"> Defining a form template</a></li>
+ <li><a href="#TWiki Forms"> TWiki Forms</a><ul>
+ <li><a href="#Overview"> Overview</a></li>
+ <li><a href="#Main Changes from Category Table"> Main Changes from Category Tables</a><ul>
+ <li><a href="#Importing Category Table Data"> Importing Category Table Data</a></li>
</ul>
</li>
- <li><a href="#Examples"> Examples</a><ul>
- <li><a href="#Defining form in one topic"> Defining form in one topic</a></li>
- <li><a href="#Defining a form in multiple topi"> Defining a form in multiple topics</a></li>
- <li><a href="#Notes"> Notes</a></li>
+ <li><a href="#Defining a Form Template"> Defining a Form Template</a><ul>
+ <li><a href="#Form Template Elements"> Form Template Elements</a></li>
+ <li><a href="#Defining a Form in One Topic"> Defining a Form in One Topic</a></li>
+ <li><a href="#Defining a Form with Multiple To"> Defining a Form with Multiple Topics</a></li>
</ul>
</li>
- <li><a href="#Changes from category system"> Changes from category system</a></li>
- <li><a href="#Creating new topics with forms"> Creating new topics with forms</a></li>
- <li><a href="#Topic meta data"> Topic meta data</a></li>
- <li><a href="#UI for multiple form templates"> UI for multiple form templates</a></li>
- <li><a href="#Migration of Category informatio"> Migration of Category information</a></li>
- <li><a href="#History"> History</a></li>
+ <li><a href="#Enabling Forms by Web"> Enabling Forms by Web</a></li>
+ <li><a href="#Including Forms in New Topics"> Including Forms in New Topics</a></li>
+ <li><a href="#Setting Up Multiple Form Options"> Setting Up Multiple Form Options</a></li>
+ <li><a href="#Form Data Storage"> Form Data Storage</a></li>
+ <li><a href="#Using Form Data"> Using Form Data</a></li>
</ul>
</li>
</ul>
</div>
-## <a name="Form Templates"></a> Form Templates
+# <a name="TWiki Forms"></a> TWiki Forms
-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.
+_Form-based input in topics, with name/value pairs stored as Meta Data variables; choose one of multiple forms per web & topic_
-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.
+## <a name="Overview"></a> Overview
-You can search for topics with specific form data using the %SEARCH% variable - see [[TWikiVariables]].
+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.
-### <a name="Terminology"></a> Terminology
+Form Templates replace TWikiCategoryTables from the 01-Dec-2000 version of TWiki.
-- **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 _rows_x_cols_ 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_)
+<a name="FormsVsCategoryTables"></a>
-### <a name="Specification"></a> Specification
+## <a name="Main Changes from Category Table"></a> Main Changes from Category Tables
-#### <a name="Enable forms for a web"></a> 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 <code>**WEBFORMS**</code> variable in [[WebPreferences]] is optional and defines a list of possible form templates e.g.
-
-- Set WEBFORMS = BugForm, FeatureForm, BookLoanForm
-
-With this present an extra button is added to the edit view. If the topic doesn't have a form an _Add Form_ button appears at the end of the topic. If a form is present a _Change_ button appears in the top row of the form to the right of the form name. The buttons leads to a screen that enables _no form_ to be selected of one of those specified by `WEBFORMS`.
-
-A default form template (i.e. new topics get this default form) can be provided by creating the <code>**WebTopicEditTemplate**</code> 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.
-
-#### <a name="Defining a form template"></a> 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.
-
-### <a name="Examples"></a> Examples
-
-#### <a name="Defining form in one topic"></a> Defining form in one topic
-
-Example: WebFormTemplate of the TWiki.Know web:
+The Form Template system is a more powerful, flexible replacement for the original TWikiCategoryTable. Data from existing category tables can be imported directly.
<table border="1" cellpadding="0" cellspacing="0">
<tr>
- <th bgcolor="#99CCCC"><strong> Name: </strong></th>
- <th bgcolor="#99CCCC"><strong> Type: </strong></th>
- <th bgcolor="#99CCCC"><strong> Size: </strong></th>
- <th bgcolor="#99CCCC"><strong> Values: </strong></th>
- <th bgcolor="#99CCCC"><strong> Tooltip message: </strong></th>
- </tr>
- <tr>
- <td>[[Know/TopicClassification]]</td>
- <td> select </td>
- <td> 1 </td>
- <td>[[Know/NoDisclosure]], [[Know/PublicSupported]], [[Know/PublicFAQ]]</td>
- <td> blah blah... </td>
- </tr>
- <tr>
- <td>[[Know/OperatingSystem]]</td>
- <td> checkbox </td>
- <td> 3 </td>
- <td>[[Know/OsHPUX]], [[Know/OsLinux]], [[Know/OsSolaris]], [[Know/OsWin]]</td>
- <td> blah blah... </td>
- </tr>
- <tr>
- <td>[[Know/OsVersion]]</td>
- <td> text </td>
- <td> 16 </td>
- <td> </td>
- <td> blah blah... </td>
+ <th align="center" bgcolor="#99CCCC"><strong> Form Templates </strong></th>
+ <th align="center" bgcolor="#99CCCC"><strong> Category Tables </strong></th>
</tr>
-</table>
-
-#### <a name="Defining a form in multiple topi"></a> 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:
-
-- WebFormTemplate of the TWiki.Know web: <table border="1" cellpadding="0" cellspacing="0">
<tr>
- <th bgcolor="#99CCCC"><strong> Name: </strong></th>
- <th bgcolor="#99CCCC"><strong> Type: </strong></th>
- <th bgcolor="#99CCCC"><strong> Size: </strong></th>
- <th bgcolor="#99CCCC"><strong> Values: </strong></th>
- <th bgcolor="#99CCCC"><strong> Tooltip message: </strong></th>
+ <td align="center"> defined in topics </td>
+ <td align="center"> defined in templates </td>
</tr>
<tr>
- <td>[[Know/TopicClassification]]</td>
- <td> select </td>
- <td> 1 </td>
- <td> </td>
- <td> blah blah... </td>
+ <td align="center"> many forms per web </td>
+ <td align="center"> one table per web </td>
</tr>
<tr>
- <td>[[Know/OperatingSystem]]</td>
- <td> checkbox </td>
- <td> 3 </td>
- <td> </td>
- <td> blah blah... </td>
+ <td align="center"> saved as Meta Data </td>
+ <td align="center"> saved as HTML </td>
</tr>
<tr>
- <td>[[Know/OsVersion]]</td>
- <td> text </td>
- <td> 16 </td>
- <td> </td>
- <td> blah blah... </td>
+ <td align="center"><strong>Change</strong> & <strong>Add Form</strong> buttons </td>
+ <td align="center"><strong>UseCategory</strong> radio button </td>
</tr>
</table>
-- TopicClassification topic: <table border="1" cellpadding="0" cellspacing="0">
- <tr>
- <th bgcolor="#99CCCC"><strong> Name: </strong></th>
- <th bgcolor="#99CCCC"><strong> Type: </strong></th>
- <th bgcolor="#99CCCC"><strong> Tooltip message: </strong></th>
- </tr>
- <tr>
- <td>[[Know/NoDisclosure]]</td>
- <td> option </td>
- <td> blah blah... </td>
- </tr>
- <tr>
- <td>[[Know/PublicSupported]]</td>
- <td> option </td>
- <td> blah blah... </td>
- </tr>
- <tr>
- <td>[[Know/PublicFAQ]]</td>
- <td> option </td>
- <td> blah blah... </td>
- </tr>
-</table>
+### <a name="Importing Category Table Data"></a> 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 <code>**twikicatitems.tmpl**</code>. 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.
+
+%T% **NOTE:** If things aren't working correctly, there may be useful entries in `data/warning.txt`.
+
+## <a name="Defining a Form Template"></a> Defining a Form Template
+
+A Form Template is simply a page containing your form, defined as a table where each row is one form field.
+
+### <a name="Form Template Elements"></a> Form Template Elements
+
+- **form template** - a set of fields defining a form (replaces _category table definition_)
+ - A web can use one or more form templates
+- **form** - a topic containing additional meta data (besides the freeform TEXTAREA) that categorizes the content (replaces _category table_)
+ - Within a form-enabled web, individual topics can have a form or no form
+- **form field** - a named item in a form (replaces _category item name_)
+- **field type** - selects the INPUT type:
+ - **select** - drop-down menu or scrollable box
+ - **checkbox** - one or more checkboxes
+ - **checkbox+buttons** - one or more checkboxes, plus **Set** and **Clear** buttons
+ - **radio** - one or more radio buttons
+ - **text** - a one-line text field
+ - **textarea** - a text box; size is 40x10 (columns x rows)
+- **field value** - one or more values from a fixed set (select, checkbox, radio type) or free-form (text). (replaces _category item value_)
+
+### <a name="Defining a Form in One Topic"></a> Defining a Form in One Topic
+
+1. Create a new topic with your form name: <code>**YourForm**</code>, <code>**ExpenseReport**</code>, <code>**InfoCategory**</code>, <code>**RecordReview**</code>, whatever you need.
+2. Create a TWiki table, with each column head representing one element of an entry field: <code>**Name**</code>, <code>**Type**</code>, <code>**Size**</code>, <code>**Values**</code>, and <code>**Tooltip message**</code> _(see sample below)_.
+3. For each field, fill in a new line; for the type of field, select from the list.
+4. Save the topic _(you can later choose to [[enable/disable|Main/WebHome#EnablingForms]] individual forms)_.
+
+> **Example:**
+>
+> <code>**WebForm**</code>
+>
+> | *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... |
+>
+> <table border="1" cellpadding="0" cellspacing="0">
+> <tr>
+> <th bgcolor="#99CCCC"><strong> Name </strong></th>
+> <th bgcolor="#99CCCC"><strong> Type </strong></th>
+> <th bgcolor="#99CCCC"><strong> Size </strong></th>
+> <th bgcolor="#99CCCC"><strong> Values </strong></th>
+> <th bgcolor="#99CCCC"><strong> Tooltip message </strong></th>
+> </tr>
+> <tr>
+> <td>[[Know/TopicClassification]]</td>
+> <td> select </td>
+> <td align="center"> 1 </td>
+> <td>[[Know/NoDisclosure]], [[Know/PublicSupported]], [[Know/PublicFAQ]]</td>
+> <td> blah blah... </td>
+> </tr>
+> <tr>
+> <td>[[Know/OperatingSystem]]</td>
+> <td> checkbox </td>
+> <td align="center"> 3 </td>
+> <td>[[Know/OsHPUX]], [[Know/OsLinux]], [[Know/OsSolaris]], [[Know/OsWin]]</td>
+> <td> blah blah... </td>
+> </tr>
+> <tr>
+> <td>[[Know/OsVersion]]</td>
+> <td> text </td>
+> <td align="center"> 16 </td>
+> <td> </td>
+> <td> blah blah... </td>
+> </tr>
+> </table>
+
+### <a name="Defining a Form with Multiple To"></a> Defining a Form with Multiple Topics
+
+Forms can also be defined by using form templates that retrieve field values from one or more separate topics:
+
+- A <code>**FormTemplate**</code> topic defines the Form, ex: <code>**YourFormTemplate**</code>.
+- For each field that has a value list - select, radio, checkbox - can use separate topic to define the available values.
+
+> **Example: WebFormTemplate**
+>
+> - Know.WebFormTemplate main definition: <br /> <table border="1" cellpadding="0" cellspacing="0">
+> <tr>
+> <th bgcolor="#99CCCC"><strong> Name </strong></th>
+> <th bgcolor="#99CCCC"><strong> Type </strong></th>
+> <th bgcolor="#99CCCC"><strong> Size </strong></th>
+> <th bgcolor="#99CCCC"><strong> Values </strong></th>
+> <th bgcolor="#99CCCC"><strong> Tooltip message </strong></th>
+> </tr>
+> <tr>
+> <td>[[Know/TopicClassification]]</td>
+> <td> select </td>
+> <td> 1 </td>
+> <td> </td>
+> <td> blah blah... </td>
+> </tr>
+> <tr>
+> <td>[[Know/OperatingSystem]]</td>
+> <td> checkbox </td>
+> <td> 3 </td>
+> <td> </td>
+> <td> blah blah... </td>
+> </tr>
+> <tr>
+> <td>[[Know/OsVersion]]</td>
+> <td> text </td>
+> <td> 16 </td>
+> <td> </td>
+> <td> blah blah... </td>
+> </tr>
+> </table>
+> <br /> %X% Leave the <code>**Values**</code> field **blank**.
+>
+> - Know.TopicClassification field value definition: <br /> <table border="1" cellpadding="0" cellspacing="0">
+> <tr>
+> <th bgcolor="#99CCCC"><strong> Name </strong></th>
+> <th bgcolor="#99CCCC"><strong> Type </strong></th>
+> <th bgcolor="#99CCCC"><strong> Tooltip message </strong></th>
+> </tr>
+> <tr>
+> <td>[[Know/NoDisclosure]]</td>
+> <td> option </td>
+> <td> blah blah... </td>
+> </tr>
+> <tr>
+> <td>[[Know/PublicSupported]]</td>
+> <td> option </td>
+> <td> blah blah... </td>
+> </tr>
+> <tr>
+> <td>[[Know/PublicFAQ]]</td>
+> <td> option </td>
+> <td> blah blah... </td>
+> </tr>
+> </table>
+
+- **Implementation Notes:** This format allows you to define field items with or without [[WikiNames]], depending on your needs.
+ - Topics can be protected in the usual manner, using [[TWikiAccessControl]], to limit who can change the form template and/or individual value lists.
+ - <code>**\[[...]]**</code> links can be used to force a link (at present, the <code>**\[[...]\[...]]**</code> format is not supported).
+ - The <code>**Tooltip message**</code> column is used as a tooltip for the field name (only if field name is a [[WikiName]]) - you only see the tooltip In edit.
+ - The first item in the list is the default item. Alternative initial values can be set in a topic template, like <code>**WebTopicEditTemplate**</code>, with <code>**field=value**</code>, or, for checkboxes, <code>**field=1**</code>.
+ - The topic definition is not read when a topic is viewed.
+
+<a name="EnablingForms"></a>
+
+## <a name="Enabling Forms by Web"></a> Enabling Forms by Web
+
+Forms are enabled on a per web basis. The <code>**WEBFORMS**</code> variable in [[WebPreferences]] is optional and defines a list of possible form templates. Example:
-#### <a name="Notes"></a> Notes
-
-- This format allows you to define field items with / without [[WikiNames]], depending on your needs.
-- The topic can be protected in the usual manner so that not everybody can change the form template - see [[TWikiAccessControl]]
-- <code>[[...|/WebHome]]</code> can be used for force a link, at present <code>[[...|/WebHome]]</code> format is not supported
-- The "Tooltip message:" column is used as a tool tip for the field name (only if field name is a [[WikiName]]) - you only see the tooltip on edit
-- The first item in the list is the default item. Alternative initial values can be given in a topic template such as <code>**WebTopicEditTemplate**</code> or using fieldFLD=value or for checkboxes fieldFLDcheckbox=1 in URL
-- The topic definition is not read when a topic is viewed
-
-### <a name="Changes from category system"></a> Changes from category system
-
-Main changes from [[TWikiCategoryTable]]:
+- Set WEBFORMS = BugForm, FeatureForm, BookLoanForm
-- Name changed in the hope that form is more readily understandable than category
-- The templates for category view/edit have been dropped
-- Forms are defined by topics, categories were defined in a template file
-- A Web can have multiple forms, only one category was possible
-- Form data is saved in meta variables - see [[MetaDataDefinition]], and render to HTML on viewing. Category data was stored as HTML
-- The UseCategory radio button has gone, the replacement being the _Change_ form and _Add Form_ buttons.
+- With <code>**WEBFORMS**</code> enabled, an extra button is added to the edit view. If the topic doesn't have a Form, an **Add Form** button appears at the end of the topic. If a Form is present, a **Change** button appears in the top row of the Form. The buttons open a screen that enables selection of a form specified in `WEBFORMS`, or the **No form** option.
-### <a name="Creating new topics with forms"></a> Creating new topics with forms
+- A default Form Template (new topics get this default form) can be provided by creating the `WebTopicEditTemplate` topic in a web and adding a form to it. Initial Form values can be set there.
-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.
+- Additionally a new topic can be given a Form using the `formtemplate` parameter in the URL. Initial values can then be provided in the URLs or as form values:
+ - other than checkboxes: <code>**name**</code>, ex: <code>**?BugPriority=1**</code>
+ - checkbox: <code>**namevalue=1**</code>, ex: <code>**?ColourRed=1**</code>. <br /> Boxes with a tick must be specified.
-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.
+## <a name="Including Forms in New Topics"></a> Including Forms in New Topics
-### <a name="Topic meta data"></a> Topic meta data
+When you create a new topic in a web that has the <code>**WEBFORMS**</code> 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:
-See [[MetaDataDefinition]].
+1. **Edit** the [[WebTopicEditTemplate]] topic, adding the name of an available Form.
+2. **Create** a new topic to check - the Form should appear with values set.
+ - Click **Change** to switch or remove Forms.
-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.
+A form embedded in a topic also appears in a new topic. This is done by specifying the <code>**formtemplate**</code> parameter in the URL.
-The order of form field/value items in the meta-data is the same as in the form template.
+## <a name="Setting Up Multiple Form Options"></a> Setting Up Multiple Form Options
-### <a name="UI for multiple form templates"></a> UI for multiple form templates
+- The optional <code>**WEBFORMS**</code> variable defines alternative forms that can be selected by pressing **Change** in edit mode.
-- Optional <code>**WEBFORMS**</code> variable defines possible form templates that can be selected after pressing "Change" (forms) button on edit page
-- A template topic can use any form template
-- Decided not to ask user to choose a template or form template when creating a topic as goes against the KISS of Wiki systems.
-- New topics with a form get instantiated by simple HTML forms asking for a topic name, i.e. there is a SubmitExpenseReport topic were you can create new expense reports, a SubmitVacationRequest topic and so on. These can specify the required template topic and hence form.
+- A topic template can use any form.
-### <a name="Migration of Category informatio"></a> Migration of Category information
+- New topics with a form are created by simple HTML forms asking for a topic name. For example, you can have a `SubmitExpenseReport` topic where you can create new expense reports, a `SubmitVacationRequest` topic, and so on. These can specify the required template topic with its associated form.
-Principle: new system should work with old data with no special conversion.
+## <a name="Form Data Storage"></a> Form Data Storage
-Old data should be transparently upgraded to the new meta format when a topic is edit/previewed/saved.
+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.
-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`.
+<a name="UsingFormData"></a>
-### <a name="History"></a> History
+## <a name="Using Form Data"></a> Using Form Data
-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.
+[[TWikiForms]] 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]], <code>**SEARCH**</code> and <code>**METASEARCH**</code> variables in [[TWikiVariables]], and [[TWiki Formatted Search|Main/FormattedSearch]] for various options.
--- [[JohnTalintyre]] - 16 Aug 2001 <br />
+-- [[JohnTalintyre]] - 16 Aug 2001 <br /> -- [[MikeMannix]] - 05 Jan 2002
git://git.openafs.org / openafs-wiki.git / blobdiff