Including Forms in New Topics

Including Forms in New Topics

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:

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.

A form embedded in a topic also appears in a new topic. This is done by specifying the formtemplate parameter in the URL.

Form Templates more powerful, flexible replacement for the original TWikiCategoryTable. Data from existing category tables can be imported directly.

The Form Template system is a more powerful, flexible replacement for the original TWikiCategoryTable. Data from existing category tables can be imported directly.

1. Create a TWiki table, with each column head representing one element of an entry field: Name, Type, Size, Values, and Tooltip msessage (see sample below).

1. Create a TWiki table, with each column head representing one element of an entry field: Name, Type, Size, Values, and Tooltip message (see sample below).

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

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.

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.

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.

• • 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.

• • 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

1. Create a new topic with your Form name: MyForm, ExpenseReport, InfoCategory, RecordReview, whatever you need.
2. Create a TWiki table, with each column representing one element of an entry field: Name, Type, Size, Values, and Tooltip msessage (see sample below).

1. Create a new topic with your form name: YourForm, ExpenseReport, InfoCategory, RecordReview, whatever you need.
2. Create a TWiki table, with each column head representing one element of an entry field: Name, Type, Size, Values, and Tooltip msessage (see sample below).

1. Save the topic.

1. Save the topic (you can later choose to enable/disable individual forms).

Example: WebForm from the TWiki.Know web

Example: WebForm

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:

• A Form Template topic defines the Form.
• Fields that have more then one value - radio, select, checkbox - can be defined in individual field value topics.

• A FormTemplate topic defines the Form, ex: YourFormTemplate.
• For each field that has a value list - select, radio, checkbox - can use separate topic to define the available values.

• Know.WebFormTemplate Form main definition:
   

• Know.WebFormTemplate main definition:
   

• • The topic can be protected in the usual manner so that not everybody can change the form template - see TWikiAccessControl
  • [[...]] links 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 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.

• • Topics can be protected in the usual manner, using TWikiAccessControl, to limit who can change the form template and/or individual value lists.
  • [[...]] links can be used to force a link (at present, the [[...][...]] format is not supported).
  • The Tooltip message 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 WebTopicEditTemplate, with field=value, or, for checkboxes, field=1.

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:

• 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.

• 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.

• • other than checkboxes: name, ex: ?BugPriority=1
  • checkbox: namevalue=1, ex: ?ColourRed=1.
    Boxes with a tick must be specified.

• • other than checkboxes: name, ex: ?BugPriority=1
  • checkbox: namevalue=1, ex: ?ColourRed=1.
    Boxes with a tick must be specified.

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:

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.

• The optional WEBFORMS variable defines alternative Form Templates that can be selected by pressing Change in edit mode.

• The optional WEBFORMS variable defines alternative forms that can be selected by pressing Change in edit mode.

• A topic template can use any form.

• 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 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.

• 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.

Form Data Storage

Form Template Data Storage

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.

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.

Using Form Data

-- MikeMannix - 03 Dec 2001

-- MikeMannix - 05 Jan 2002

-- MikeMannix - 15 Sep 2001

-- MikeMannix - 03 Dec 2001

-- JohnTalintyre - 16 Aug 2001

-- JohnTalintyre - 16 Aug 2001
-- MikeMannix - 15 Sep 2001

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 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.

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 twikicatitems.tmpl. The replacement Form Template must be set as the first item in the WebPreferences variable =WEBFORM. If missing, pages will display, but attempting to edit results in an error message.

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 twikicatitems.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.

Example: WebFormTemplate from the TWiki.Know web

Example: WebForm from the TWiki.Know web

• • ... can be used for force a link, at present ... format is not supported.

• • [[...]] links 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 WikiName) - you only see the tooltip on edit.

• • 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 Form Template topic name, fields and values are stored as Meta Data. 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 as TWikiMetaData. The order of field/value pairs in the Meta Data is the same as in the Template.

TWiki Form Templates

TWiki Forms

%META:TOPICMOVED{by="MikeMannix" date="1000277489" from="TWiki.TWikiFormTemplate" to="TWiki.TWikiForms"}%

Changes from the Category Table System

Main Changes from Category Tables

Main changes from TWikiCategoryTable:

Importing Existing Category Table Data

Importing Category Table Data

Form Template Elements

Defining a Form Template

A Form Template is simply a page containing your form, defined in a table where each row is one form field.

Form Template Elements

Defining a Form Template

A Form Template is simply a page containing your form, defined in a table where each row is one form field.

Defining a Form in One Topic

Defining a Form in One Topic

Example: WebFormTemplate from the TWiki.Know web

Defining a Form in Multiple Topics

Defining a Form with Multiple Topics

• A Form Template topic defines the form.
• Values of fields that have more then one value - radio, select, checkbox - can be defined by field value Template topics.

• A Form Template topic defines the Form.
• Fields that have more then one value - radio, select, checkbox - can be defined in individual field value topics.

Code from:

Example: WebFormTemplate

• WebFormTemplate of the TWiki.Know web:

• Know.WebFormTemplate Form main definition:
   

• TopicClassification topic:

• Know.TopicClassification field value definition:
   

Implementation Notes

• • This format allows you to define field items with / without WikiNames, depending on your needs.

• Implementation Notes: This format allows you to define field items with or without WikiNames, depending on your needs.

Creating New Topics with Forms

Including Forms in New Topics

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. 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.

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.

Form Templates

TWiki Form Templates

Include form-based input in topics, with unlimited, user-selectable forms per web; values stored as Meta Data

Form-based input in topics, with name/value pairs stored as Meta Data variables; multiple forms per web & topic

Form Templates replace TWikiCategory Tables from the previous version of TWiki.

Form Templates replace TWikiCategory Tables from the 01-Dec-2000 version of TWiki.

Changes from the Category Table System

Form Templates more powerful, flexible replacement for the original TWikiCategoryTable. Data from existing category tables can be imported directly.

Main changes from TWikiCategoryTable:

Importing Existing 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 twikicatitems.tmpl. The replacement Form Template must be set as the first item in the WebPreferences variable =WEBFORM. 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.

NOTE: If things aren't working correctly, there may be useful entries in data/warning.txt.

Example: Form Template

Example: WebFormTemplate from the TWiki.Know web

Example: WebFormTemplate of the TWiki.Know web:

Example: WebFormTemplate from the TWiki.Know web

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

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

• A Form Template topic defines the form.
• Values of fields that have more then one value - radio, select, checkbox - can be defined by field value Template topics.

Code from:

Code from:

• 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.

• 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: name, ex: ?BugPriority=1
  • checkbox: namevalue=1, ex: ?ColourRed=1.
    Boxes with a tick must be specified.

Form Templates

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.

Include form-based input in topics, with unlimited, user-selectable forms per web; values stored as Meta Data

Overview

Overview

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 TWikiMetaData; all data is saved.

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

Form Templates replace TWikiCategory Tables from the previous version of TWiki.

TWikiCategoryTables Are History

Form Template Elements

Form Templates more powerful, flexible replacement for the original TWikiCategoryTable.

Changes from the Category Table System

Main changes from TWikiCategoryTable: The templates for category view/edit have been dropped, and the forma renders to HTML on viewing.

Migrating Existing Category Table Data

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.

Form Template Elements

• 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)

• 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 rowsxcols 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)

• 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)

Defining a Form Template

Defining a Form Template

Defining a Form in One Topic

Defining a Form in One Topic

Defining a Form in Multiple Topics

Defining a Form in Multiple Topics

Various Implementation Notes

Implementation Notes

• ... 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 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
• The topic definition is not read when a topic is viewed

Enabling Forms by Web

• • ... 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 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.

• • The topic definition is not read when a topic is viewed.

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.

Enabling Forms by Web

Forms are enabled on a per web basis. The WEBFORMS variable in WebPreferences is optional and defines a list of possible Form Templates. Example:

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 lead to a screen that enables no form to be selected or one of those specified by WEBFORMS.

• 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 (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.

• 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:

• 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:

Creating New Topics with Forms

Creating New Topics with Forms

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.

Setting Up Multiple Form Options

Setting Up Multiple Form Options

• The optional WEBFORMS variable defines alternative Form Templates that can be selected by pressing Change in edit mode.

• A Template topic can use any Form Template.

• The optional WEBFORMS 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?

• 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.

Form Template Data Storage

Form Template Data Storage

The Form Template topic name, fields and values are stored as Meta Data. 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 Meta Data. 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].

• 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 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

• Not checkboxs - nameFLD e.g. ?BugPriorityFLD=1
• Checkbox - nameFLDvalue=1 e.g. ?ColourFLDRed=1. Note that all boxes with a tick must be specified.

• Not checkboxes - name e.g. ?BugPriority=1
• Checkbox - namevalue=1 e.g. ?ColourRed=1. Note that all boxes with a tick must be specified.

Goodby to TWikiCategoryTables

TWikiCategoryTables Are 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.

Form Templates more powerful, flexible replacement for the original TWikiCategoryTable.

Main changes from TWikiCategoryTable: The templates for category view/edit have been dropped.and render to HTML on viewing

Main changes from TWikiCategoryTable: The templates for category view/edit have been dropped, and the forma renders to HTML on viewing.

• • checkbox+buttons: One or more check boxes, plus set and clear buttons to set/clear all check boxes

• • checkbox+buttons: One or more check boxes, plus [Set] and [][Clear] buttons to set/clear all checkboxes

• • textarea: A general text area - size is rowsxcols e.g. 40x10

• • textarea: A general text area - size is rowsxcols 40x10

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 Form Template is simply a page containing your form, defined in a table where each row is one form field.

Examples

1. Create a new topic with your Form name: MyForm, ExpenseReport, InfoCategory, RecordReview, whatever you need.
2. Create a TWiki table, with each column representing one element of an entry field: Name, Type, Size, Values, and Tooltip msessage (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.

Example: Form Template

| *Name:* | *Type:* | *Size:* | *Values:* | *Tooltip message:* |
| TopClass | select | 1 | Select one..., Private, Public | must fill |
| Target   | checkbox+buttons | 3 | 1, No.2, No.3 | Select OS |
| Version | text | 16 | | OS version |

Above Example:

Code from:

Notes

Various Implementation Notes

Specification

Enabling Forms for a Web

Enabling Forms by 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.

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.

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.

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 lead to a screen that enables no form to be selected or one of those specified by WEBFORMS.

• The optional WEBFORMS variable defines alternative Form Templates that can be selected after pressing [Change] button on the Edit page

• The optional WEBFORMS variable defines alternative Form Templates that can be selected after pressing [Change] on the Edit page

• Decided not to ask user to choose a template or form template when creating a topic as goes against the KISS of Wiki systems.

Overview

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

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

Goodby to TWikiCategoryTables

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.

Changes from the Category Table System

Main changes from TWikiCategoryTable: The templates for category view/edit have been dropped.and render to HTML on viewing

Migrating Existing Category Table Data

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.

Terminology

Form Template Elements

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.

• 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 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

Defining a Form Template

Examples

Examples

Defining form in one topic

Defining a Form in One Topic

Defining a form in multiple topics

Defining a Form in Multiple Topics

Changes from category system

Specification

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 UseCategory radio button has gone, the replacement being the Change form and Add Form buttons.

Enabling Forms for a Web

Creating new topics with forms

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.

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.

The WEBFORMS variable in WebPreferences is optional and defines a list of possible form templates e.g.

• Set WEBFORMS = BugForm, FeatureForm, BookLoanForm

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.

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.

Topic meta data

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.

See MetaDataDefinition.

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.

Creating New Topics with 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.

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.

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

A form embedded in a topic also appears in a new topic. This is done by specifying the formtemplate parameter in the URL.

UI for multiple form templates

Setting Up Multiple Form Options

• Optional WEBFORMS variable defines possible form templates that can be selected after pressing "Change" (forms) button on edit page

• The optional WEBFORMS variable defines alternative Form Templates that can be selected after pressing [Change] button on the Edit page

• 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.

• 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?

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.

Form Template Data Storage

The Form Template topic name, fields and values are stored in the topic Meta Data. 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].

TOC: No TOC in "TWiki.TWikiForms"

TOC: No TOC in "TWiki.TWikiForms"

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.

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 (Bug, Feature, FAQ entry etc).

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

Defining form in multiple topics

Defining a form in multiple topics

See TWikiMetaDataDefinition?.

See MetaDataDefinition.

-- JohnTalintyre - 16 Aug 2001

-- JohnTalintyre - 16 Aug 2001

Background

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.

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 (Bug, Feature, FAQ entry etc).

• • A web may contain more then one form template.

• • A web may contain more then zero or more form template.

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. This can be done in two ways. One is similar to that used for the older category system, with this a Web can have only one form. The other allows a Web to have any number of forms.

A default form template can be provided by creating the WebTopicEditTemplate topic in a Web and adding a form to it. Initial form values can be set here.

Enabling single default form

The DEFAULTFORM variable in WebPreferences is optional. If present it specifies the default form for all topics in the Web. Every time you edit a topic you will be presented with a form. The form must contain the special field UseForm (analogous to the UseCategory line in the old category system). The values for this must be:

• First field - "Yes" (any capitalisation)
• Second field - any text, but must mean no form

Enabling multiple forms

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.

With this present an extra button is added to the edit view. If the topic doesn't have a form the button appears at the end of the page. If a form is present the button appears in the top row of the form. Pressing the button leads to a screen that enables no form to be selected of one of those specified by WEBFORMS.

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.

Define a form template

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

• The topic can be protected in the usual manner so that not everybody can change the form template.

• The topic can be protected in the usual manner so that not everybody can change the form template - see TWikiAccessControl

• The UseForm field is special.
  • Will always default to second value (don't use form) when topic doesn't have a form
  • Is not show on preview or view
  • When set to no on save, form data is deleted.
• It is not a good idea to use both DEFAULTFORM and WEBFORMS WebPreferences in the same Web.

• The topic definition is not read when a topic is viewed

• UseCategory is now UseForm

• The UseCategory radio button has gone, the replacement being the Change form and Add Form buttons.

When you create a new topic in a web that has the WEBFORM preferences variable set you will get a topic with the default form template specified by the variable.

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.

For simplicity we should use the default form template when one creates a new topic by question mark link or "Go" field, i.e. better not to show a menu to select a form template.

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.

• Optional WEBFORMS variable defines possibles form templates that can be selected after pressing "Change" (forms) button on edit page

• Optional WEBFORMS variable defines possible form templates that can be selected after pressing "Change" (forms) button on edit page

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 or DEFAULTFORM (if/when put in). If it's not present, an oops dialog results.

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 - 07 Aug 2001

-- JohnTalintyre - 16 Aug 2001

%META:TOPICINFO{author="JohnTalintyre" date="997201374" format="1.0beta2" version="1.1"}% %META:TOPICPARENT{name="WebHome"}%

Form Templates

• Form Templates
  • Background
  • Terminology
  • Specification
    • Enable forms for a web
    • Enabling single default form
    • Enabling multiple forms
    • Define a form template
  • Examples
    • Defining form in one topic
    • Defining form in multiple topics
    • Notes
  • Changes from category system
  • Creating new topics with forms
  • Topic meta data
  • UI for multiple form templates
  • Migration of Category information

Background

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.

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 one 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 rowsxcols 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. This can be done in two ways. One is similar to that used for the older category system, with this a Web can have only one form. The other allows a Web to have any number of forms.

A default form template can be provided by creating the WebTopicEditTemplate topic in a Web and adding a form to it. Initial form values can be set here.

Enabling single default form

The DEFAULTFORM variable in WebPreferences is optional. If present it specifies the default form for all topics in the Web. Every time you edit a topic you will be presented with a form. The form must contain the special field UseForm (analogous to the UseCategory line in the old category system). The values for this must be:

• First field - "Yes" (any capitalisation)
• Second field - any text, but must mean no form

Enabling multiple forms

The WEBFORMS 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 the button appears at the end of the page. If a form is present the button appears in the top row of the form. Pressing the button leads to a screen that enables no form to be selected of one of those specified by WEBFORMS.

Define 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: WebFormTemplate of the TWiki.Know web:

Defining 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:

  Name:	Type:	Size:	Values:	Tooltip message:
  UseForm?	radio	0	Yes, No	blah blah...
  TopicClassification	select	1		blah blah...
  OperatingSystem	checkbox	3		blah blah...
  OsVersion	text	16		blah blah...

• TopicClassification topic:

  Name:	Type:	Tooltip message:
  NoDisclosure	option	blah blah...
  PublicSupported	option	blah blah...
  PublicFAQ	option	blah blah...

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.
• ... 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 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 UseForm field is special.
  • Will always default to second value (don't use form) when topic doesn't have a form
  • Is not show on preview or view
  • When set to no on save, form data is deleted.
• It is not a good idea to use both DEFAULTFORM and WEBFORMS WebPreferences in the same Web.

Changes from category system

Main changes from TWikiCategoryTable:

• Name changed in the hope that form is more readily understandable than category
• UseCategory is now UseForm
• 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

Creating new topics with forms

When you create a new topic in a web that has the WEBFORM preferences variable set you will get a topic with the default form template specified by the variable.

For simplicity we should use the default form template when one creates a new topic by question mark link or "Go" field, i.e. better not to show a menu to select a form template.

Topic meta data

See TWikiMetaDataDefinition?.

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 possibles 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.

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 or DEFAULTFORM (if/when put in). If it's not present, an oops dialog results.

-- JohnTalintyre - 07 Aug 2001