diff options
Diffstat (limited to 'TWiki')
| -rw-r--r-- | TWiki/TWikiForms.mdwn | 135 |
1 files changed, 53 insertions, 82 deletions
diff --git a/TWiki/TWikiForms.mdwn b/TWiki/TWikiForms.mdwn index e040a748..b8eb69a1 100644 --- a/TWiki/TWikiForms.mdwn +++ b/TWiki/TWikiForms.mdwn @@ -1,69 +1,32 @@ %TOC% %STARTINCLUDE% -## <a name="Form_Templates"> Form Templates </a> +# <a name="Form_Templates"> Form Templates </a> -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 -### <a name="Overview"> Overview </a> +## <a name="Overview"> Overview </a> -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 [[TWikiDocumentation]]; all data is saved. -You can search for topics with specific form data using the %SEARCH% variable - see [[TWikiDocumentation]]. +Form Templates replace TWikiCategory Tables from the previous version of TWiki. -### <a name="TWikiCategoryTables_Are_History"> TWikiCategoryTables Are History </a> +## <a name="Form_Template_Elements"> Form Template Elements </a> -Form Templates more powerful, flexible replacement for the original TWikiCategoryTable. - -#### <a name="Changes_from_the_Category_Table_"> Changes from the Category Table System </a> - -Main changes from TWikiCategoryTable: The templates for category view/edit have been dropped, and the forma renders to HTML on viewing. - -<table border="1" cellpadding="1" cellspacing="0"> - <tr> - <th bgcolor="#99CCCC"><strong>Form Templates</strong></th> - <th bgcolor="#99CCCC"><strong>Category Tables</strong></th> - </tr> - <tr> - <td> defined by topics </td> - <td> defined in a template file </td> - </tr> - <tr> - <td> multiple forms per web </td> - <td> one category per web </td> - </tr> - <tr> - <td> data saved in Meta variables </td> - <td> data saved as HTML </td> - </tr> - <tr> - <td> [Change] form and [Add Form] contol buttons </td> - <td><nop>UseCategory radio button </nop></td> - </tr> -</table> - -#### <a name="Migrating_Existing_Category_Tabl"> Migrating Existing Category Table Data </a> - -The 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`. - -### <a name="Form_Template_Elements"> Form Template Elements </a> - -* **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_) +* **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 free form TEXTAREA) which categorizes the content. (replaces _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 checkboxes - * **radio:** One or more radio buttons - * **text:** A one-line text field - * **textarea:** A general text area - size is _rows_x_cols_ 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="Defining_a_Form_Template"> Defining a Form Template </a> +* **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_Template"> Defining a Form Template </a> A Form Template is simply a page containing your form, defined in a table where each row is one form field. @@ -79,7 +42,7 @@ A Form Template is simply a page containing your form, defined in a table where > | Target | checkbox+buttons | 3 | 1, No.2, No.3 | Select OS | > | Version | text | 16 | | OS version | -#### <a name="Defining_a_Form_in_One_Topic"> Defining a Form in One Topic </a> +### <a name="Defining_a_Form_in_One_Topic"> Defining a Form in One Topic </a> Example: WebFormTemplate of the TWiki.Know web: @@ -114,7 +77,7 @@ Example: WebFormTemplate of the TWiki.Know web: </tr> </table> -#### <a name="Defining_a_Form_in_Multiple_Topi"> Defining a Form in Multiple Topics </a> +### <a name="Defining_a_Form_in_Multiple_Topi"> Defining a Form in Multiple Topics </a> The form template can also be defined in an alternative way by using more then one topic: @@ -177,42 +140,50 @@ The form template can also be defined in an alternative way by using more then o > </tr> > </table> -#### <a name="Various_Implementation_Notes"> Various Implementation Notes </a> +#### <a name="Implementation_Notes"> Implementation Notes </a> -* 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 <code>**WebTopicEditTemplate**</code> or using field=value or for checkboxes field=1 -* The topic definition is not read when a topic is viewed +* * This format allows you to define field items with / without [[TWiki/WikiNames]], depending on your needs. -### <a name="Enabling_Forms_by_Web"> Enabling Forms by Web </a> +* * The topic can be protected in the usual manner so that not everybody can change the form template - see [[TWikiAccessControl]] -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. +* * `...` can be used for force a link, at present `...` format is not supported. -* Set WEBFORMS = BugForm, FeatureForm, BookLoanForm +* * 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 field=value or for checkboxes field=1. -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 lead to a screen that enables _no form_ to be selected or one of those specified by `WEBFORMS`. +* * The topic definition is not read when a topic is viewed. -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. +## <a name="Enabling_Forms_by_Web"> Enabling Forms by Web </a> -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: +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: -* Not checkboxes - name e.g. ?BugPriority=1 -* Checkbox - namevalue=1 e.g. ?ColourRed=1. Note that all boxes with a tick must be specified. +* Set WEBFORMS = BugForm, FeatureForm, BookLoanForm + +* 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 open a screen that enables selection of a form specified in `WEBFORMS`, or the **No form** option. + +* 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. + +* 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 checkboxes - name e.g. ?BugPriority=1 + * Checkbox - namevalue=1 e.g. ?ColourRed=1. Note that all boxes with a tick must be specified. -### <a name="Creating_New_Topics_with_Forms"> Creating New Topics with Forms </a> +## <a name="Creating_New_Topics_with_Forms"> Creating New Topics with Forms </a> -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. -### <a name="Setting_Up_Multiple_Form_Options"> Setting Up Multiple Form Options </a> +## <a name="Setting_Up_Multiple_Form_Options"> Setting Up Multiple Form Options </a> + +* The optional <code>**WEBFORMS**</code> variable defines alternative Form Templates that can be selected by pressing **Change** in edit mode. + +* A Template topic can use any Form Template. + +* New topics with a Form are created by simple HTML forms asking for a topic name. For example, you can have a <code>SubmitExpenseReport</code> topic where you can create new expense reports - a <code>SubmitVacationRequest</code> topic and so on. These can specify the required template topic with its associated Form. -* The optional <code>**WEBFORMS**</code> variable defines alternative Form Templates that can be selected after pressing [Change] on the Edit page -* A template topic can use any form template -* New topics with a form get instantiated by simple HTML forms asking for a topic name. If 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. **_HUH?_** +## <a name="Form_Template_Data_Storage"> Form Template Data Storage </a> -### <a name="Form_Template_Data_Storage"> Form Template Data Storage </a> +The Form Template topic name, fields and values are stored as [[TWikiDocumentation]]. 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 in the topic [[TWikiDocumentation]]. 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 <br /> +-- [[JohnTalintyre]] - 16 Aug 2001 <br /> |