buildrelease

[openafs-wiki.git] / TWiki / TWikiForms.mdwn

<div>
  <ul>
    <li><a href="#TWiki Forms"> TWiki Forms</a><ul>
        <li><a href="#Overview"> Overview</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"> Defining a Form</a></li>
          </ul>
        </li>
        <li><a href="#Enabling Forms by Web"> Enabling Forms by Web</a></li>
        <li><a href="#Add a form to a topic"> Add a form to a topic</a></li>
        <li><a href="#Build an HTML form to create new"> Build an HTML form to create new Form-based topics</a></li>
        <li><a href="#Changing a form"> Changing a form</a></li>
        <li><a href="#Searching for Form Data"> Searching for Form Data</a></li>
        <li><a href="#Extending the range of form data"> Extending the range of form data types</a></li>
        <li><a href="#Gotcha!"> Gotcha!</a></li>
        <li><a href="#Importing Category Table Data"> Importing Category Table Data</a></li>
      </ul>
    </li>
  </ul>
</div>

# <a name="TWiki Forms"></a> 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._

## <a name="Overview"></a> Overview

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.

Typical steps to build an application based on TWiki forms:

1. Define a form template
2. Enable the form for a web
3. Add the form to a [[template topic|Main/TWikiTemplates#Template_Topics]]
4. Build an HTML form to create new topics based on that template topic
5. Build a [[FormattedSearch]] to list topics that share the same form

## <a name="Defining a Form Template"></a> Defining a Form Template

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

### <a name="Form Template Elements"></a> Form Template Elements

- **form template** - a set of fields defining a form
  - A web can use one or more form templates
- **form** - additional meta data (besides the freeform TEXTAREA) attached to a topic
  - Within a form-enabled web, individual topics can have a form or no form
- **form field** - a named item in a form (also known as a _key_)
- **field type** - selects the field type: <table border="1" cellpadding="0" cellspacing="0">
  <tr>
    <th bgcolor="#99CCCC"><strong> Input type </strong></th>
    <th bgcolor="#99CCCC"><strong> Type field </strong></th>
    <th bgcolor="#99CCCC"><strong> Size field </strong></th>
    <th bgcolor="#99CCCC"><strong> Value field </strong></th>
  </tr>
  <tr>
    <td> One or more checkboxes </td>
    <td><code>checkbox</code></td>
    <td> number of items per line </td>
    <td> comma list of item labels </td>
  </tr>
  <tr>
    <td> One or more checkboxes, plus <strong>Set</strong> and <strong>Clear</strong> buttons </td>
    <td><code>checkbox+buttons</code></td>
    <td> (same) </td>
    <td> (same) </td>
  </tr>
  <tr>
    <td> One or more radio buttons (radio buttons are mutually exclusive; only one can be selected) </td>
    <td><code>radio</code></td>
    <td> (same) </td>
    <td> (same) </td>
  </tr>
  <tr>
    <td> Read-only label text </td>
    <td><code>label</code></td>
    <td><em>ignored</em></td>
    <td> text </td>
  </tr>
  <tr>
    <td> Drop-down menu or scrollable box </td>
    <td><code>select</code></td>
    <td><code>1</code> for drop down, <code>2</code> and up for scrollable box </td>
    <td> comma-separated list of options </td>
  </tr>
  <tr>
    <td> A one-line text field </td>
    <td><code>text</code></td>
    <td> text box width in number of characters </td>
    <td> initial text, if a new topic is created with a form template </td>
  </tr>
  <tr>
    <td> A text box </td>
    <td><code>textarea</code></td>
    <td> columns x rows, e.g. <code>80x6</code>; default size is 40x5 </td>
    <td> initial text, if a new topic is created with a form template </td>
  </tr>
</table>
- **field value** - one or more values from a fixed set (select, checkbox, radio type) or free-form (label, text, text area).

### <a name="Defining a Form"></a> Defining a Form

1. Create a new topic with your form name: <code>**YourForm**</code>, <code>**ExpenseReportForm**</code>, <code>**InfoCategoryForm**</code>, <code>**RecordReviewForm**</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>, <code>**Tooltip message**</code>, and <code>**Attributes**</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: WebForm**
>
> %BR%
>
> `| *Name* | *Type* | *Size* | *Values* | *Tooltip message* | *Attributes* |`
>
> %BR%
>
> `| TopicClassification | select | 1 | NoDisclosure, PublicSupported, PublicFAQ | blah blah... |   |`
>
> %BR%
>
> `| OperatingSystem | checkbox | 3 | OsHPUX, OsLinux, OsSolaris, OsWin | blah blah... |   |`
>
> %BR%
>
> `| 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>
>     <th bgcolor="#99CCCC"><strong> Attributes </strong></th>
>   </tr>
>   <tr>
>     <td>[[Sandbox/TopicClassification]]</td>
>     <td> select </td>
>     <td align="center"> 1 </td>
>     <td>[[Sandbox/NoDisclosure]], [[Sandbox/PublicSupported]], [[Sandbox/PublicFAQ]]</td>
>     <td> blah blah... </td>
>     <td>   </td>
>   </tr>
>   <tr>
>     <td>[[Sandbox/OperatingSystem]]</td>
>     <td> checkbox </td>
>     <td align="center"> 3 </td>
>     <td>[[Sandbox/OsHPUX]], [[Sandbox/OsLinux]], [[Sandbox/OsSolaris]], [[Sandbox/OsWin]]</td>
>     <td> blah blah... </td>
>     <td>   </td>
>   </tr>
>   <tr>
>     <td>[[Sandbox/OsVersion]]</td>
>     <td> text </td>
>     <td align="center"> 16 </td>
>     <td>   </td>
>     <td> blah blah... </td>
>     <td>   </td>
>   </tr>
> </table>

You can also retrieve possible values for select, checkbox or radio types from other topics:

> **Example: WebForm**
>
> - In the WebForm topic, define the form: <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>
>     <th bgcolor="#99CCCC"><strong> Attributes </strong></th>
>   </tr>
>   <tr>
>     <td> TopicClassification </td>
>     <td> select </td>
>     <td> 1 </td>
>     <td>   </td>
>     <td> blah blah... </td>
>     <td>   </td>
>   </tr>
>   <tr>
>     <td> OperatingSystem </td>
>     <td> checkbox </td>
>     <td> 3 </td>
>     <td>   </td>
>     <td> blah blah... </td>
>     <td>   </td>
>   </tr>
>   <tr>
>     <td> OsVersion </td>
>     <td> text </td>
>     <td> 16 </td>
>     <td>   </td>
>     <td> blah blah... </td>
>     <td>   </td>
>   </tr>
> </table>
> <br /> %X% Leave the <code>**Values**</code> field **blank**.
>
> - Then in the TopicClassification topic, define the possible values: <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> NoDisclosure </td>
>     <td> option </td>
>     <td> blah blah... </td>
>   </tr>
>   <tr>
>     <td> Public Supported </td>
>     <td> option </td>
>     <td> blah blah... </td>
>   </tr>
>   <tr>
>     <td> Public FAQ </td>
>     <td> option </td>
>     <td> blah blah... </td>
>   </tr>
> </table>

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

> `%SEARCH{"Office$" scope="topic" web="%MAINWEB%" nototal="on" nosummary="on" nosearch="on" regex="on" format="$web.$topic" separator=", " }%`

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

**Notes:**

- A very few field names are reserved. If you try to use one of these names, TWiki will automatically append an underscore to the name when the form is used.
- The field value will be used to initialize a field when a form is created, unless specific values are given by the topic template or query parameters. The first item in the list for a select or radio type is the default item. For `label`, `text`, and `textarea` fields the value may also contain commas. `checkbox` fields cannot be initialized through the form template.
- If a `label` field has no name (blank first column in the form definition) it will **not** be shown when the form is **viewed**, only when it is **edited**.
- The topic definition is not read when a topic is viewed.
- Field names can include any text, but you should stick to alphanumeric characters. If you want to use a non-wikiname for a `select`, `checkbox` or `radio` field, and want to get the values from another topic, you can use <code>**\[[...]]**</code> links. This notation can also be used when referencing another topic to obtain field values, but a name other than the topic name is required as the name of the field.
- Field names have to be unique. If the same name is necessary (as when the field values for several fields are obtained from the same topic), an alternative name must be assigned using the <code>**\[[...]]**</code> notation.
- The topic defining field values can also be generated through a [[FormattedSearch]], which must yield a suitable table as the result.
- Form definition topics can be protected in the usual manner, using [[TWikiAccessControl]], to limit who can change the form template and/or individual value lists. Note that view access is required to be able to edit topics that use the form definition, though view access to the form definition is _not_ required to view a topic where the form has been used.
- The <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 view.
- The <code>**Attributes**</code> column is used to define special behavior for that form field (multiple attributes can be entered, with or without separators):
  - An attribute `H` indicates that this field should not be shown in view mode. However, the field is available for editing and storing information.
  - An attribute `M` indicates that this field is mandatory. The topic cannot be saved unless a value is provided for this field. If the field is found empty during topic save, an error is raised and the user is redirected to an `oops` page. Mandatory fields are indicated by an asterisks next to the field name.

<a name="EnablingForms"></a>

## <a name="Enabling Forms by Web"></a> Enabling Forms by Web

Forms have to be enabled for each individual web. The <code>**WEBFORMS**</code> variable in [[WebPreferences]] is optional and defines a list of possible form templates.

> **Example:**
>
> - Set WEBFORMS = BugForm, FeatureForm, Books.BookLoanForm

- 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="Add a form to a topic"></a> Add a form to a topic

- Edit a topic and follow the "Add form" button to add a Form to the topic. This is typically done to a [[template topic|Main/TWikiTemplates#TemplateTopic]], either to the `WebTopicEditTemplate` topic in a web, or a new topic that serves as an application specific template topic. Initial Form values can be set there.

- Additionally a new topic can be given a Form using the `formtemplate` parameter in the (edit or save) URL. Initial values can then be provided in the URLs or as form values:
  - other than checkboxes: <code>**name**</code>, ex: <code>**?BugPriority=1**</code>
  - checkbox: <code>**namevalue=1**</code>, ex: <code>**?ColorRed=1**</code>. <br /> Boxes with a tick must be specified.
  - Example: This will add a textfield for the new topic name and a "Create"-Button to your topic. When the button is pressed, the topic editor will open with the form "MyForm" already attached to the new topic.
        <form name="newtopic" action="%SCRIPTURLPATH{"edit"}%/%WEB%/">
           <input type="hidden" name="formtemplate" value="MyForm" />
           New topic name <input type="text" name="topic" size="40" />
           <input type="submit" value="Create" />
        </form>
- **_%T% Tip:_** For TWiki applications you can [[automatically generate unique topicnames|Main/TWikiTemplates#AutomaticallyGeneratedTopicname]].

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

## <a name="Build an HTML form to create new"></a> Build an HTML form to create new Form-based topics

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

## <a name="Changing a form"></a> Changing a form

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

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

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

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

<a name="UsingFormData"></a>

## <a name="Searching for Form Data"></a> 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]], <code>**FORMFIELD**</code>, <code>**SEARCH**</code> and <code>**METASEARCH**</code> variables in [[TWikiVariables]], and [[TWiki Formatted Search|Main/FormattedSearch]].

> **Example**
>
> %BR% TWiki users often want to have an overview of topics they contributed to. With the
>
> <code>**$formfield**</code>
>
> parameter it is easy to display the value of a classification field next to the topic link:
>
>     | *Topic* | *Classification* |
>     %SEARCH{"%MAINWEB%.UserName" scope="text" regex="off" nosearch="on" nototal="on" order="modified" reverse="on"
>     format="|<b>[[$web.$topic][$topic]]</b> |<nop>$formfield(TopicClassification) |" web="Sandbox"}%

## <a name="Extending the range of form data"></a> Extending the range of form data types

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

- any type name starting with `checkbox`
- any type name with `+multi` anywhere in the name

Types with names like this can both take multiple values.

## <a name="Gotcha!"></a> Gotcha!

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

<a name="FormsVsCategoryTables"></a>

## <a name="Importing Category Table Data"></a> Importing Category Table Data

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

On upgrading from the previous TWiki, a Form Template topic has to be built for each web that used a Category Table, recreating the fields and values from the old <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% If things aren't working correctly, there may be useful entries in `data/warning.txt`.

**_Related Topics:_** [[UserDocumentationCategory]], [[TWikiTemplates]]