Input type | Type field | Size field | Value field |
---|---|---|---|
A one-line text field | text | text box width in number of characters | (unused) |
A text box; size is 40x10 (columns x rows) | textarea | columns x rows, e.g. 40x6 | (unused) |
Drop-down menu or scrollable box | label | 1 for drop down, 2 and up for scrollable box | comma list of options |
One or more checkboxes | checkbox | number of checkboxes per line | comma list of checkbox labels |
One or more checkboxes, plus Set and Clear buttons | checkbox+buttons | (same) | (same) |
One or more radio buttons | radio | number of radio buttons per line | comma list of checkbox labels |
Read-only label text | label | 1 | (unused) |
YourForm
, ExpenseReport
, InfoCategory
, RecordReview
, whatever you need.
Name
, Type
, Size
, Values
, and Tooltip message
(see sample below).
Example:WebForm
| *Name* | *Type* | *Size* | *Values* | *Tooltip message* |
| TopicClassification | select | 1 | NoDisclosure, PublicSupported, PublicFAQ | blah blah... |
| OperatingSystem | checkbox | 3 | OsHPUX, OsLinux, OsSolaris, OsWin | blah blah... |
| OsVersion | text | 16 | | blah blah... |
Name Type Size Values Tooltip message TopicClassification select 1 NoDisclosure, PublicSupported, PublicFAQ blah blah... OperatingSystem checkbox 3 OsHPUX, OsLinux, OsSolaris, OsWin blah blah... OsVersion text 16 blah blah...
FormTemplate
topic defines the Form, ex: YourFormTemplate
.
Example: WebFormTemplate
- WebFormTemplate main definition:
Name Type Size Values Tooltip message TopicClassification select 1 blah blah... OperatingSystem checkbox 3 blah blah... OsVersion text 16 blah blah...
Leave theValues
field blank.
- TopicClassification field value definition:
Name Type Tooltip message NoDisclosure option blah blah... PublicSupported option blah blah... PublicFAQ option blah blah...
[[...]]
links can be used to force a link (at present, the [[...][...]]
format is not supported).
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.
WebTopicEditTemplate
, with field=value
, or, for checkboxes, field=1
.
WEBFORMS
variable in WebPreferences is optional and defines a list of possible form templates. Example:
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.
WebTopicEditTemplate
topic in a web and adding a form to it. Initial Form values can be set there.
formtemplate
parameter in the URL. Initial values can then be provided in the URLs or as form values:
name
, ex: ?BugPriority=1
namevalue=1
, ex: ?ColorRed=1
. WEBFORMS
variable defines alternative forms that can be selected by pressing Change in edit mode.
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.
SEARCH
and METASEARCH
variables in TWikiVariables, and TWiki Formatted Search for various options.
Form Templates | Category Tables |
---|---|
defined in topics | defined in templates |
many forms per web | one table per web |
saved as Meta Data | saved as HTML |
Change & Add Form buttons | UseCategory radio button |
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.
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
.
{3 spaces}* Set
statements:
| *Name*|*Type*|*Size*|*Value*|*Tooltip message*|*Attributes*|
| WEBTOPICLIST |textarea| | | List of topics of the %WEB% web |S|
| SITEMAPLIST |select |3| on, | list this web in the Site Map |S|
| SITEMAPWHAT |textarea| | | short web summary |S|
| WEBBGCOLOR |text |8| | Web specific background color |S|
Set WEBFORMS
line
textarea
stuff, and set as you like
S
attribute has been specified (S for Setting).
If you change the form, the changes will not take affect until you edit and save the preferences' topics again.
Using the TWiki:Plugins.EditTablePlugin on WebPreferencesForm makes adding new prefedrences a breeze.
A possibly unwanted side effect for using forms for the SKINS setting in their personal user topic: because the User Preferences are final you can't have different skins for different webs as the user's setting always wins. A workaround is to simply omit SKIN in the form.
Another example, this one using EditTablePlugin, source:
%EDITTABLE{ header="|*Name*|*Type*|*Size*|*Values*|*Tooltip message*|*Attributes*|" format="|text,20|text,20|text,20|text,20|text,20|text,1|" }%
Result (after some editing):
-- TWiki:Main.JohnTalintyre - 16 Aug 2001