|
META TOPICPARENT |
name="WebHome" |
|
|
You can search for topics with specific form data using the %SEARCH% variable - see TWikiVariables. |
|
< < | 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. |
|
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 |
> > | Main changes from TWikiCategoryTable: The templates for category view/edit have been dropped, and the forma renders to HTML on viewing. |
|
|
|
- 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
|
> > |
-
- 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 e.g. 40x10
|
> > |
-
- 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)
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 Form Template is simply a page containing your form, defined in a table where each row is one form field. |
| |
|
< < | Examples |
> > |
- Create a new topic with your Form name: MyForm, ExpenseReport, InfoCategory, RecordReview, whatever you need.
- Create a TWiki table, with each column representing one element of an entry field: Name, Type, Size, Values, and Tooltip msessage (see sample below).
- For each field, fill in a new line; for the type of field, select from the list.
- 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 |
|
|
Defining a Form in 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: |
> > |
Code from: |
|
- WebFormTemplate of the TWiki.Know web:
|
|
|
|
> > | |
| |
|
< < | Notes |
> > | Various Implementation 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
|
|
- The first item in the list is the default item. Alternative initial values can be given in a topic template such as
WebTopicEditTemplate or using fieldFLD=value or for checkboxes fieldFLDcheckbox=1 in URL
- The topic definition is not read when a topic is viewed
|
|
< < | 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. |
|
- 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 . |
> > | 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 . |
|
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. |
|
Setting Up Multiple Form Options |
|
< < |
- 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
|
|
- 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. 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?
|