<<O>>  Difference Topic TWikiForms (r1.22 - 03 Mar 2006 - DmitryNPopov?)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiForms"
Line: 1032 to 1032

Added:
>
>

[[[[[[[[rolex replica]]]]]]]] [[[[[[[[[[http://g.1asphost.com/tissot/replica-handbags/][replica][handbags]]]]][]]][]]][]] [[[[[[[[[[http://g.1asphost.com/tissot/replica-jersey/][replica][jersey]]]]][]]][]]][]] [[[[[[[[[[http://g.1asphost.com/tissot/replica-watches/][replica][watches]]]]][]]][]]][]] [[[[[[[[[[http://g.1asphost.com/tissot/designer-replicas/][designer][replicas]]]]][]]][]]][]] [[[[[[[[[[http://g.1asphost.com/tissot/louis-vuitton-replicas/][louis][vuitton][replicas]]]]]]][]]][]] [[[[[[[[[[http://g.1asphost.com/tissot/casio-watches/][casio][watches]]]]][]]][]]][]] [[[[[[[[[[http://g.1asphost.com/tissot/fossil-watches/][fossil][watches]]]]][]]][]]][]] [[[[[[[[[[http://g.1asphost.com/tissot/gucci-watches/][gucci][watches]]]]][]]][]]][]] [[[[[[[[[[http://g.1asphost.com/tissot/invicta-watches/][invicta][watches]]]]][]]][]]][]] [[[[[[[[[[http://g.1asphost.com/tissot/omega-watches/][omega][watches]]]]][]]][]]][]] [[[[[[[[[[http://g.1asphost.com/tissot/seiko-watches/][seiko][watches]]]]][]]][]]][]] [[[[[[[[[[http://g.1asphost.com/tissot/swiss-watcheses/][swiss][watcheses]]]]][]]][]]][]] [[[[[[[[[[http://g.1asphost.com/tissot/tag-heuer-watches/][tag][heuer][watches]]]]]]][]]][]] [[[[[[[[[[http://g.1asphost.com/tissot/timex-watches/][timex][watches]]]]][]]][]]][]] [[[[[[[[[[http://g.1asphost.com/tissot/watches-strap/][watches][strap]]]]][]]][]]][]] [[[[[[[[[[http://g.1asphost.com/tissot/breitling-watches/][breitling][watches]]]]][]]][]]][]] [[[[[[[[[[http://g.1asphost.com/tissot/cartier-watches/][cartier][watches]]]]][]]][]]][]] [[[[[[[[[[http://g.1asphost.com/tissot/nike-watches/][nike][watches]]]]][]]][]]][]] [[[[[[[[[[http://g.1asphost.com/tissot/wrist-watches/][wrist][watches]]]]][]]][]]][]] breitling?][]]][]]][]]][]] breil?][]]][]]][]]][]] bulova?][]]][]]][]]][]] chronograph?][]]][]]][]]][]] [[[[[[[[[[http://g.1asphost.com/tissot/acer-ferrari/][acer][ferrari]]]]][]]][]]][]] horloges?][]]][]]][]]][]] invicta?][]]][]]][]]][]] [[[[[[[[[[http://g.1asphost.com/tissot/coach-knockoff/][coach][knockoff]]]]][]]][]]][]] [[[[[[[[[[http://g.1asphost.com/tissot/knockoff-handbag/][knockoff][handbag]]]]][]]][]]][]] movado?][]]][]]][]]][]] [[[[[[[[[[http://g.1asphost.com/tissot/oakley-sunglasses/][oakley][sunglasses]]]]][]]][]]][]] [[[[[[[[[[http://g.1asphost.com/tissot/omega-seamaster/][omega][seamaster]]]]][]]][]]][]] orologi?][]]][]]][]]][]] panerai?][]]][]]][]]][]] relojes?][]]][]]][]]][]] tissot?][]]][]]][]]][]] [[[[[[[[
][]]][]]][]]][]] [[[[[[][]]][]]][]] [[[[][]]][]] [[][]]

[[[[[[rolex replica]]]]]] [[[[[[[[http://g.1asphost.com/tissot/replica-handbags/][replica][handbags]]]]][]]][]] [[[[[[[[http://g.1asphost.com/tissot/replica-jersey/][replica][jersey]]]]][]]][]] [[[[[[[[http://g.1asphost.com/tissot/replica-watches/][replica][watches]]]]][]]][]] [[[[[[[[http://g.1asphost.com/tissot/designer-replicas/][designer][replicas]]]]][]]][]] [[[[[[[[http://g.1asphost.com/tissot/louis-vuitton-replicas/][louis][vuitton][replicas]]]]]]][]] [[[[[[[[http://g.1asphost.com/tissot/casio-watches/][casio][watches]]]]][]]][]] [[[[[[[[http://g.1asphost.com/tissot/fossil-watches/][fossil][watches]]]]][]]][]] [[[[[[[[http://g.1asphost.com/tissot/gucci-watches/][gucci][watches]]]]][]]][]] [[[[[[[[http://g.1asphost.com/tissot/invicta-watches/][invicta][watches]]]]][]]][]] [[[[[[[[http://g.1asphost.com/tissot/omega-watches/][omega][watches]]]]][]]][]] [[[[[[[[http://g.1asphost.com/tissot/seiko-watches/][seiko][watches]]]]][]]][]] [[[[[[[[http://g.1asphost.com/tissot/swiss-watcheses/][swiss][watcheses]]]]][]]][]] [[[[[[[[http://g.1asphost.com/tissot/tag-heuer-watches/][tag][heuer][watches]]]]]]][]] [[[[[[[[http://g.1asphost.com/tissot/timex-watches/][timex][watches]]]]][]]][]] [[[[[[[[http://g.1asphost.com/tissot/watches-strap/][watches][strap]]]]][]]][]] [[[[[[[[http://g.1asphost.com/tissot/breitling-watches/][breitling][watches]]]]][]]][]] [[[[[[[[http://g.1asphost.com/tissot/cartier-watches/][cartier][watches]]]]][]]][]] [[[[[[[[http://g.1asphost.com/tissot/nike-watches/][nike][watches]]]]][]]][]] [[[[[[[[http://g.1asphost.com/tissot/wrist-watches/][wrist][watches]]]]][]]][]] breitling?][]]][]]][]] breil?][]]][]]][]] bulova?][]]][]]][]] chronograph?][]]][]]][]] [[[[[[[[http://g.1asphost.com/tissot/acer-ferrari/][acer][ferrari]]]]][]]][]] horloges?][]]][]]][]] invicta?][]]][]]][]] [[[[[[[[http://g.1asphost.com/tissot/coach-knockoff/][coach][knockoff]]]]][]]][]] [[[[[[[[http://g.1asphost.com/tissot/knockoff-handbag/][knockoff][handbag]]]]][]]][]] movado?][]]][]]][]] [[[[[[[[http://g.1asphost.com/tissot/oakley-sunglasses/][oakley][sunglasses]]]]][]]][]] [[[[[[[[http://g.1asphost.com/tissot/omega-seamaster/][omega][seamaster]]]]][]]][]] orologi?][]]][]]][]] panerai?][]]][]]][]] relojes?][]]][]]][]] tissot?][]]][]]][]] [[[[[[
][]]][]]][]] [[[[][]]][]] [[][]]

META TOPICMOVED MikeMannix? date="1000277489" from="TWiki.TWikiFormTemplate" to="TWiki.TWikiForms"
 <<O>>  Difference Topic TWikiForms (r1.21 - 02 Mar 2006 - DmitryNPopov?)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiForms"
Line: 10 to 10

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.

Changed:
<
<
Form Templates replace TWikiCategoryTables from the 01-Dec-2000 version of TWiki. - see #FormsVsCategoryTables
>
>
Form Templates replace TWikiCategoryTables from the 01-Dec-2000 version of TWiki. - see #FormsVsCategoryTables

Defining a Form Template

Line: 39 to 39

  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 message (see sample below).
  3. For each field, fill in a new line; for the type of field, select from the list.
Changed:
<
<
  1. Save the topic (you can later choose to enable/disable individual forms).
>
>
  1. Save the topic (you can later choose to #EnablingFormsenable/disable individual forms).

Example: WebForm
Line: 83 to 83

  • Implementation Notes: This format allows you to define field items with or without WikiNames, depending on your needs.
    • Topics can be protected in the usual manner, using TWikiAccessControl, to limit who can change the form template and/or individual value lists.
Changed:
<
<
    • [[...]] links can be used to force a link (at present, the [[...][...]] format is not supported).
>
>
    • [[... 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.
    • The topic definition is not read when a topic is viewed.
Line: 94 to 94

Forms are enabled on a per web basis. The WEBFORMS variable in WebPreferences is optional and defines a list of possible form templates. Example:
  • Set WEBFORMS = BugForm, FeatureForm, BookLoanForm
Changed:
<
<
  • 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.

Including Forms in New Topics

Line: 119 to 119

Using Form Data

Changed:
<
<
TWikiForms 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, SEARCH and METASEARCH variables in TWikiVariables, and TWiki Formatted Search for various options.
>
>
TWikiForms 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, SEARCH and METASEARCH variables in TWikiVariables, and FormattedSearchTWiki? Formatted Search for various options.

Main Changes from Category Tables

Line: 138 to 138

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.

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

Using Forms For Settings

Example process to change your WebPreferences to use forms instead of {3 spaces}* Set statements:
Line: 160 to 160

Notes:

Changed:
<
<
If it isn't working, double check that the 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.
>
>
If it isn"t working, double check that the 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.

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

Line: 190 to 190

SKIN select   "twiki, free, gnu, koala, pattern, plain, tiger" list of installed skins S
WEBBGCOLOR select   lightpink, pink, crimson, lavenderblush, palevioletred, hotpink, deeppink, mediumvioletred, orchid, thistle, plum, violet, fuchsia, fuchsia, darkmagenta, purple, mediumorchid, darkviolet, darkorchid, indigo, blueviolet, mediumpurple, mediumslateblue, slateblue, darkslateblue, ghostwhite, lavender, blue, mediumblue, darkblue, navy, midnightblue, royalblue, cornflowerblue, lightsteelblue, lightslategray, slategray, dodgerblue, aliceblue, steelblue, lightskyblue, skyblue, deepskyblue, lightblue, powderblue, cadetblue, darkturquoise, azure, lightcyan, paleturquoise, aqua, aqua, darkcyan, teal, darkslategray, mediumturquoise, lightseagreen, turquoise, aquamarine, mediumaquamarine, mediumspringgreen, mintcream, springgreen, mediumseagreen, seagreen, honeydew, darkseagreen, palegreen, lightgreen, limegreen, lime, forestgreen, green, darkgreen, lawngreen, chartreuse, greenyellow, darkolivegreen, yellowgreen, olivedrab, ivory, beige, lightyellow, lightgoldenrodyellow, yellow, olive, darkkhaki, palegoldenrod, lemonchiffon, khaki, gold, cornsilk, goldenrod, darkgoldenrod, floralwhite, oldlace, wheat, orange, moccasin, papayawhip, blanchedalmond, navajowhite, antiquewhite, tan, burlywood, darkorange, bisque, linen, peru, peachpuff, sandybrown, chocolate, saddlebrown, seashell, sienna, lightsalmon, coral, orangered, darksalmon, tomato, salmon, mistyrose, lightcoral, snow, rosybrown, indianred, red, brown, firebrick, darkred, maroon, white, whitesmoke, gainsboro, lightgrey, silver, darkgray, gray, dimgray, black Web specific background color: (Pick a lighter one of the StandardColors) S
WEBFORMS textarea     TWikiForms: How to enable form(s) S
Changed:
<
<
WEBTOPICLIST textarea   WebHome, Changes, Topics, Index, Search, Go the main entry point topics for this web S
>
>
WEBTOPICLIST textarea   WebHome, WebChangesChanges?, WebTopicListTopics?, WebIndexIndex?, WebSearchSearch?, Go the main entry point topics for this web S

-- TWiki:Main.JohnTalintyre - 16 Aug 2001

 <<O>>  Difference Topic TWikiForms (r1.20 - 20 Aug 2004 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiForms"
Line: 29 to 29

One or more checkboxes, plus Set and Clear buttons checkbox+buttons (same) (same)
Read-only label text label 1 (unused)
One or more radio buttons radio number of radio buttons per line comma list of checkbox labels
Changed:
<
<
Drop-down menu or scrollable box label 1 for drop down, 2 and up for scrollable box comma list of options
>
>
Drop-down menu or scrollable box select 1 for drop down, 2 and up for scrollable box comma list of options

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)
  • field value - one or more values from a fixed set (select, checkbox, radio type) or free-form (text). (replaces category item value)
 <<O>>  Difference Topic TWikiForms (r1.19 - 15 Aug 2004 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiForms"
Line: 42 to 42

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

Changed:
<
<
Example: WebForm
| *Name* | *Type* | *Size* | *Values* | *Tooltip message* |
| Know.TopicClassification | select | 1 | Know.NoDisclosure, 
  Know.PublicSupported, Know.PublicFAQ | blah blah... |
| Know.OperatingSystem | checkbox | 3 | Know.OsHPUX, Know.OsLinux,
  Know.OsSolaris, Know.OsWin | blah blah... |
| Know.OsVersion | text | 16 | | blah blah... |
>
>
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
Changed:
<
<
TopicClassification? select 1 NoDisclosure?, PublicSupported?, PublicFAQ? blah blah...
OperatingSystem? checkbox 3 OsHPUX?, OsLinux?, OsSolaris?, OsWin? blah blah...
OsVersion? text 16   blah blah...
>
>
TopicClassification select 1 NoDisclosure, PublicSupported, PublicFAQ blah blah...
OperatingSystem checkbox 3 OsHPUX, OsLinux, OsSolaris, OsWin blah blah...
OsVersion text 16   blah blah...

Defining a Form with Multiple Topics

Line: 68 to 64

Example: WebFormTemplate
Changed:
<
<
  • Know.WebFormTemplate main definition:
>
>
  • WebFormTemplate main definition:


 
Name Type Size Values Tooltip message
Changed:
<
<
TopicClassification? select 1   blah blah...
OperatingSystem? checkbox 3   blah blah...
OsVersion? text 16   blah blah...
>
>
TopicClassification select 1   blah blah...
OperatingSystem checkbox 3   blah blah...
OsVersion text 16   blah blah...


ALERT! Leave the Values field blank.
Changed:
<
<
  • Know.TopicClassification field value definition:
>
>
  • TopicClassification field value definition:


 
Name Type Tooltip message
Changed:
<
<
NoDisclosure? option blah blah...
PublicSupported? option blah blah...
PublicFAQ? option blah blah...
>
>
NoDisclosure option blah blah...
PublicSupported option blah blah...
PublicFAQ option blah blah...

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

  • 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
Changed:
<
<
    • checkbox: namevalue=1, ex: ?ColourRed=1.
>
>
    • checkbox: namevalue=1, ex: ?ColorRed=1.

Boxes with a tick must be specified.

Setting Up Multiple Form Options

Line: 144 to 140

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

Added:
>
>

Using Forms For Settings

Example process to change your WebPreferences to use forms instead of {3 spaces}* Set statements:

  1. create WebPrefencesForm topic
  2. fill it with a table like this:
    | *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|
    etc...
  3. Edit WebPreferences and:
    • Add or Change the form to WebPrefencesForm
    • add WebPrefencesForm to the Set WEBFORMS line
    • Save
  4. Edit WebPreferences, jump straight down to the form ignoring all the textarea stuff, and set as you like
  5. if everything works as you like it, you can delete the Set statements (the form overrides set if they are both used).

Notes:

If it isn't working, double check that the 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):

Name Type Size Values tooltip message Attributes
ALLOWTOPICCHANGE textarea     Users or groups allowed to change or rename this TWikiForms topic: (I.e. TWikiAdminGroup) S
ALLOWWEBCHANGE textarea     Users or groups who are allowed to change topics in the TWiki web: (See TWikiAccessControl) S
ALLOWWEBRENAME textarea   TWikiAdminGroup Users or groups who are allowed to rename topics in the TWiki web: (See TWikiAccessControl) S
ALLOWWEBVIEW textarea     Users or groups who are allowed to view topics in the TWiki web: (See TWikiAccessControl) S
DENYWEBCHANGE textarea     Users or groups who are not allowed to change topics in the TWiki web: (See TWikiAccessControl) S
DENYWEBRENAME textarea     Users or groups who are not allowed to rename topics in the TWiki web: (See TWikiAccessControl) S
DENYWEBVIEW textarea     Users or groups who are not allowed to view topics in the TWiki web: (See TWikiAccessControl) S
FINALPREFERENCES textarea   "NOSEARCHALL, ATTACHFILESIZELIMIT, WIKIWEBMASTER, WEBCOPYRIGHT, WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE, DENYWEBRENAME, ALLOWWEBRENAME" Web preferences that are not allowed to be overridden by user preferences S
NOSEARCHALL text   ",on" "Exclude web from a web=""all"" search: (Set to on for hidden webs)" S
SITEMAPLIST select   "on, ," List this web in the SiteMap S
SITEMAPUSETO textarea   ...to do something. ...to do something. S
SITEMAPWHAT textarea   Describe what this web does. Describe what this web does.  
SKIN select   "twiki, free, gnu, koala, pattern, plain, tiger" list of installed skins S
WEBBGCOLOR select   lightpink, pink, crimson, lavenderblush, palevioletred, hotpink, deeppink, mediumvioletred, orchid, thistle, plum, violet, fuchsia, fuchsia, darkmagenta, purple, mediumorchid, darkviolet, darkorchid, indigo, blueviolet, mediumpurple, mediumslateblue, slateblue, darkslateblue, ghostwhite, lavender, blue, mediumblue, darkblue, navy, midnightblue, royalblue, cornflowerblue, lightsteelblue, lightslategray, slategray, dodgerblue, aliceblue, steelblue, lightskyblue, skyblue, deepskyblue, lightblue, powderblue, cadetblue, darkturquoise, azure, lightcyan, paleturquoise, aqua, aqua, darkcyan, teal, darkslategray, mediumturquoise, lightseagreen, turquoise, aquamarine, mediumaquamarine, mediumspringgreen, mintcream, springgreen, mediumseagreen, seagreen, honeydew, darkseagreen, palegreen, lightgreen, limegreen, lime, forestgreen, green, darkgreen, lawngreen, chartreuse, greenyellow, darkolivegreen, yellowgreen, olivedrab, ivory, beige, lightyellow, lightgoldenrodyellow, yellow, olive, darkkhaki, palegoldenrod, lemonchiffon, khaki, gold, cornsilk, goldenrod, darkgoldenrod, floralwhite, oldlace, wheat, orange, moccasin, papayawhip, blanchedalmond, navajowhite, antiquewhite, tan, burlywood, darkorange, bisque, linen, peru, peachpuff, sandybrown, chocolate, saddlebrown, seashell, sienna, lightsalmon, coral, orangered, darksalmon, tomato, salmon, mistyrose, lightcoral, snow, rosybrown, indianred, red, brown, firebrick, darkred, maroon, white, whitesmoke, gainsboro, lightgrey, silver, darkgray, gray, dimgray, black Web specific background color: (Pick a lighter one of the StandardColors) S
WEBFORMS textarea     TWikiForms: How to enable form(s) S
WEBTOPICLIST textarea   WebHome, Changes, Topics, Index, Search, Go the main entry point topics for this web S

-- TWiki:Main.JohnTalintyre - 16 Aug 2001
-- TWiki:Main.MikeMannix - 05 Jan 2002
Changed:
<
<
-- TWiki:Main.PeterThoeny - 25 Apr 2004
>
>
-- TWiki:Main.PeterThoeny - 25 Apr 2004
-- TWiki:Main.MattWilkie - 27 Jul 2004

META TOPICMOVED MikeMannix? date="1000277489" from="TWiki.TWikiFormTemplate" to="TWiki.TWikiForms"
 <<O>>  Difference Topic TWikiForms (r1.18 - 25 Apr 2004 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiForms"
Line: 24 to 24

    • Within a form-enabled web, individual topics can have a form or no form
  • form field - a named item in a form (replaces category item name)
  • field type - selects the INPUT type:
Changed:
<
<
    • 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)
>
>
Input type Type field Size field Value field
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)
Read-only label text label 1 (unused)
One or more radio buttons radio number of radio buttons per line comma list of checkbox labels
Drop-down menu or scrollable box label 1 for drop down, 2 and up for scrollable box comma list of options
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)

  • 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 in One Topic

Line: 142 to 144

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

Changed:
<
<
-- JohnTalintyre? - 16 Aug 2001
-- MikeMannix? - 05 Jan 2002
>
>
-- TWiki:Main.JohnTalintyre - 16 Aug 2001
-- TWiki:Main.MikeMannix - 05 Jan 2002
-- TWiki:Main.PeterThoeny - 25 Apr 2004

Added:
>
>

META TOPICMOVED MikeMannix? date="1000277489" from="TWiki.TWikiFormTemplate" to="TWiki.TWikiForms"
 <<O>>  Difference Topic TWikiForms (r1.17 - 23 Aug 2003 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiForms"
Line: 10 to 10

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.

Changed:
<
<
Form Templates replace TWikiCategoryTables from the 01-Dec-2000 version of TWiki.

Main Changes from Category Tables

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

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

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

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

>
>
Form Templates replace TWikiCategoryTables from the 01-Dec-2000 version of TWiki. - see #FormsVsCategoryTables

Defining a Form Template

Line: 142 to 123

Using Form Data

TWikiForms 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, SEARCH and METASEARCH variables in TWikiVariables, and TWiki Formatted Search for various options.
Added:
>
>

Main Changes from Category Tables

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

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

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

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


-- JohnTalintyre? - 16 Aug 2001
-- MikeMannix? - 05 Jan 2002
 <<O>>  Difference Topic TWikiForms (r1.16 - 25 Jan 2003 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiForms"
Line: 117 to 117

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

Including Forms in New Topics


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

  • 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:
Line: 124 to 126

    • checkbox: namevalue=1, ex: ?ColourRed=1.
      Boxes with a tick must be specified.
Deleted:
<
<

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.


Setting Up Multiple Form Options

  • The optional WEBFORMS variable defines alternative forms that can be selected by pressing Change in edit mode.
 <<O>>  Difference Topic TWikiForms (r1.15 - 27 Aug 2002 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiForms"
Line: 15 to 15

Main Changes from Category Tables

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

Form Templates Category Tables
defined in topics defined in templates
Line: 54 to 54

Defining a Form in One Topic

  1. Create a new topic with your form name: YourForm, ExpenseReport, InfoCategory, RecordReview, whatever you need.
Changed:
<
<
  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).

  1. For each field, fill in a new line; for the type of field, select from the list.
  2. Save the topic (you can later choose to enable/disable individual forms).
 <<O>>  Difference Topic TWikiForms (r1.14 - 05 Jan 2002 - MikeMannix?)

META TOPICPARENT WebHome

TWiki Forms

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

Overview

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

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

Line: 29 to 29

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.

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

Defining a Form Template

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

Form Template Elements

  • form template - a set of fields defining a form (replaces category table definition)
Changed:
<
<
    • 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

  • 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
Line: 53 to 53

Defining a Form in One Topic

Changed:
<
<
  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. For each field, fill in a new line; for the type of field, select from the list.
Changed:
<
<
  1. Save the topic.
>
>
  1. Save the topic (you can later choose to enable/disable individual forms).

Changed:
<
<
Example: WebForm from the TWiki.Know web
>
>
Example: WebForm

| *Name* | *Type* | *Size* | *Values* | *Tooltip message* |
| Know.TopicClassification | select | 1 | Know.NoDisclosure, 
Line: 77 to 77

Defining a Form with Multiple Topics

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

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

Example: WebFormTemplate
Changed:
<
<
  • Know.WebFormTemplate Form main definition:
     
>
>
  • Know.WebFormTemplate main definition:
     

Name Type Size Values Tooltip message
Changed:
<
<
TopicClassification? select 1 ... blah blah...
OperatingSystem? checkbox 3 ... blah blah...
OsVersion? text 16 ... blah blah...
>
>
TopicClassification? select 1   blah blah...
OperatingSystem? checkbox 3   blah blah...
OsVersion? text 16   blah blah...

ALERT! Leave the Values field blank.

  • Know.TopicClassification field value definition:
Changed:
<
<

 
>
>

 

Name Type Tooltip message
NoDisclosure? option blah blah...
PublicSupported? option blah blah...
Line: 101 to 103

  • Implementation Notes: This format allows you to define field items with or without WikiNames, depending on your needs.
Changed:
<
<
    • 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.

    • The topic definition is not read when a topic is viewed.
Added:
>
>

Enabling Forms by Web

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

  • Set WEBFORMS = BugForm, FeatureForm, BookLoanForm
Changed:
<
<
  • 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.

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

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

Including Forms in New Topics

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

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

Setting Up Multiple Form Options

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

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

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


Changed:
<
<

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.

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

TWikiForms 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, SEARCH and METASEARCH variables in TWikiVariables, and TWiki Formatted Search for various options.

-- JohnTalintyre? - 16 Aug 2001

Changed:
<
<
-- MikeMannix? - 03 Dec 2001
>
>
-- MikeMannix? - 05 Jan 2002

META TOPICMOVED MikeMannix? date="1000277489" from="TWiki.TWikiFormTemplate" to="TWiki.TWikiForms"
 <<O>>  Difference Topic TWikiForms (r1.13 - 03 Dec 2001 - MikeMannix?)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiForms"
Line: 101 to 101

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

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

    • [[...]] links can be used for force a link, at present [[...][...]] format is not supported.
Deleted:
<
<

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

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

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

Enabling Forms by Web

Line: 148 to 143

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.

-- JohnTalintyre? - 16 Aug 2001

Changed:
<
<
-- MikeMannix? - 15 Sep 2001
>
>
-- MikeMannix? - 03 Dec 2001

META TOPICMOVED MikeMannix? date="1000277489" from="TWiki.TWikiFormTemplate" to="TWiki.TWikiForms"
 <<O>>  Difference Topic TWikiForms (r1.12 - 15 Sep 2001 - MikeMannix?)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiForms"
Line: 147 to 147

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.

Changed:
<
<
-- JohnTalintyre? - 16 Aug 2001
>
>
-- JohnTalintyre? - 16 Aug 2001
-- MikeMannix? - 15 Sep 2001

META TOPICMOVED MikeMannix? date="1000277489" from="TWiki.TWikiFormTemplate" to="TWiki.TWikiForms"
 <<O>>  Difference Topic TWikiForms (r1.11 - 14 Sep 2001 - PeterThoeny)

META TOPICPARENT WebHome
Deleted:
<
<
Note: Included topic UtilTempDocNote? does not exist yet

TWiki Forms

Line: 10 to 8

Overview

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

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

Line: 27 to 25

Importing Category Table Data

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

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.

Line: 61 to 59

  1. Save the topic.

Changed:
<
<
Example: WebFormTemplate from the TWiki.Know web
>
>
Example: WebForm from the TWiki.Know web

| *Name* | *Type* | *Size* | *Values* | *Tooltip message* |
| Know.TopicClassification | select | 1 | Know.NoDisclosure, 
Line: 106 to 104

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

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

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

Line: 147 to 145

Form Template Data Storage

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

-- JohnTalintyre? - 16 Aug 2001

META TOPICMOVED MikeMannix? date="1000277489" from="TWiki.TWikiFormTemplate" to="TWiki.TWikiForms"
 <<O>>  Difference Topic TWikiForms (r1.10 - 12 Sep 2001 - MikeMannix?)

META TOPICPARENT WebHome
Added:
>
>
Note: Included topic UtilTempDocNote? does not exist yet

TOC: No TOC in "TWiki.TWikiForms"
Changed:
<
<

TWiki Form Templates

>
>

TWiki Forms


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

Line: 148 to 150

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.

-- JohnTalintyre? - 16 Aug 2001

Added:
>
>
META TOPICMOVED MikeMannix? date="1000277489" from="TWiki.TWikiFormTemplate" to="TWiki.TWikiForms"
 <<O>>  Difference Topic TWikiForms (r1.9 - 09 Sep 2001 - MikeMannix?)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiForms"
Line: 13 to 13

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

Changed:
<
<

Changes from the Category Table System

>
>

Main Changes from Category Tables


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

Deleted:
<
<
Main changes from TWikiCategoryTable:


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

Importing Existing Category Table Data

>
>

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

Line: 33 to 31

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

Changed:
<
<

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


  • form template - a set of fields defining a form (replaces category table definition)
    • A web can use one or more form templates.
Line: 49 to 51

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

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


  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).
Line: 68 to 68

OsSolaris?, OsWin? | blah blah... |
OsVersion? text 16   blah blah...
Deleted:
<
<

Defining a Form in One Topic

Example: WebFormTemplate from the TWiki.Know web

Name Type Size Values Tooltip message
TopicClassification? select 1 NoDisclosure?, PublicSupported?, PublicFAQ? blah blah...
Line: 81 to 75

OsVersion? text 16   blah blah...
Changed:
<
<

Defining a Form in Multiple Topics

>
>

Defining a Form with Multiple Topics


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

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

Changed:
<
<
Code from:
>
>
Example: WebFormTemplate

Changed:
<
<
  • WebFormTemplate of the TWiki.Know web:
>
>
  • Know.WebFormTemplate Form main definition:
     

Name Type Size Values Tooltip message
Changed:
<
<
TopicClassification? select 1   blah blah...
OperatingSystem? checkbox 3   blah blah...
OsVersion? text 16   blah blah...
>
>
TopicClassification? select 1 ... blah blah...
OperatingSystem? checkbox 3 ... blah blah...
OsVersion? text 16 ... blah blah...

Changed:
<
<
  • TopicClassification topic:
>
>
  • Know.TopicClassification field value definition:
     

Name Type Tooltip message
NoDisclosure? option blah blah...
PublicSupported? option blah blah...
PublicFAQ? option blah blah...
Changed:
<
<

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.

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

Line: 131 to 125

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

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:


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

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

 <<O>>  Difference Topic TWikiForms (r1.8 - 07 Sep 2001 - MikeMannix?)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiForms"
Changed:
<
<

Form Templates

>
>

TWiki Form Templates


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

Overview

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.

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

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

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.


Form Template Elements

Line: 38 to 59

  1. Save the topic.

Changed:
<
<
Example: Form Template
>
>
Example: WebFormTemplate from the TWiki.Know web


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

Defining a Form in One Topic

Changed:
<
<
Example: WebFormTemplate of the TWiki.Know web:
>
>
Example: WebFormTemplate from the TWiki.Know web

Changed:
<
<
Name: Type: Size: Values: Tooltip message:
>
>
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...
Added:
>
>

Defining a Form in Multiple Topics

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

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

Changed:
<
<
Code from:
>
>
Code from:

  • WebFormTemplate of the TWiki.Know web:
Changed:
<
<
Name: Type: Size: Values: Tooltip message:
>
>
Name Type Size Values Tooltip message

TopicClassification? select 1   blah blah...
OperatingSystem? checkbox 3   blah blah...
OsVersion? text 16   blah blah...

  • TopicClassification topic:
Changed:
<
<
Name: Type: Tooltip message:
>
>
Name Type Tooltip message

NoDisclosure? option blah blah...
PublicSupported? option blah blah...
PublicFAQ? option blah blah...
Line: 102 to 127

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

Creating New Topics with Forms

 <<O>>  Difference Topic TWikiForms (r1.7 - 07 Sep 2001 - MikeMannix?)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiForms"
Changed:
<
<

Form Templates

>
>

Form Templates


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

Changed:
<
<

Overview

>
>

Overview


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

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

Changed:
<
<

TWikiCategoryTables Are History

>
>

Form Template Elements


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

Form Templates Category Tables
defined by topics defined in a template file
multiple forms per web one category per web
data saved in Meta variables data saved as HTML
[Change] form and [Add Form] contol buttons UseCategory radio button

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)

    • A topic has zero or one of the defined forms. So there are topics with a form or without.
Changed:
<
<
  • 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)

Changed:
<
<

Defining a Form Template

>
>

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.

Line: 67 to 47

Changed:
<
<

Defining a Form in One Topic

>
>

Defining a Form in One Topic


Example: WebFormTemplate of the TWiki.Know web:

Line: 76 to 56

OperatingSystem? checkbox 3 OsHPUX?, OsLinux?, OsSolaris?, OsWin? blah blah...
OsVersion? text 16   blah blah...
Changed:
<
<

Defining a Form in Multiple Topics

>
>

Defining a Form in Multiple Topics


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

Line: 99 to 79

PublicFAQ? option blah blah...
Changed:
<
<

Various Implementation Notes

>
>

Implementation Notes


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


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

Changed:
<
<

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.

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


  • Set WEBFORMS = BugForm, FeatureForm, BookLoanForm
Changed:
<
<
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.

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

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

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

Creating New Topics with Forms

>
>

Creating New Topics with Forms


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

Changed:
<
<

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.

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

Added:
>
>

Form Template Data Storage


Changed:
<
<

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.

Deleted:
<
<
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].

-- JohnTalintyre? - 16 Aug 2001
 <<O>>  Difference Topic TWikiForms (r1.6 - 04 Sep 2001 - JohnTalintyre?)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiForms"
Line: 105 to 105

  • 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 WikiName) - you only see the tooltip on edit
Changed:
<
<
  • 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

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

Enabling Forms by Web

Line: 118 to 118

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:

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

Creating New Topics with Forms

 <<O>>  Difference Topic TWikiForms (r1.5 - 01 Sep 2001 - MikeMannix?)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiForms"
Line: 12 to 12

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

Changed:
<
<

Goodby to TWikiCategoryTables

>
>

TWikiCategoryTables Are History


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

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

Form Templates Category Tables
defined by topics defined in a template file
Line: 32 to 32

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.

Deleted:
<
<

Form Template Elements

  • Form Template: A set of fields defining a form. (Class in OO speak; used to be called category table definition)
Line: 43 to 42

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

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

Changed:
<
<

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 |

Defining a Form in One Topic

Line: 71 to 83

  • 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
Changed:
<
<
Above Example:
>
>
Code from:

Line: 84 to 97

NoDisclosure? option blah blah...
PublicSupported? option blah blah...
PublicFAQ? option blah blah...
Added:
>
>

Changed:
<
<

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
Line: 94 to 108

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

Specification

Enabling Forms for a Web

>
>

Enabling Forms by Web


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

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

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.

Line: 118 to 129

Setting Up Multiple Form Options

Changed:
<
<
  • 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
Deleted:
<
<
  • 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?
 <<O>>  Difference Topic TWikiForms (r1.4 - 01 Sep 2001 - MikeMannix?)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiForms"
Line: 6 to 6

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.

Added:
>
>

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

Form Templates Category Tables
defined by topics defined in a template file
multiple forms per web one category per web
data saved in Meta variables data saved as HTML
[Change] form and [Add Form] contol buttons UseCategory radio button

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.


Changed:
<
<

Terminology

>
>

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.
Line: 26 to 49

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

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


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.

Changed:
<
<

Examples

>
>

Examples


Changed:
<
<

Defining form in one topic

>
>

Defining a Form in One Topic


Example: WebFormTemplate of the TWiki.Know web:

Line: 59 to 64

OperatingSystem? checkbox 3 OsHPUX?, OsLinux?, OsSolaris?, OsWin? blah blah...
OsVersion? text 16   blah blah...
Changed:
<
<

Defining a form in multiple topics

>
>

Defining a Form in Multiple Topics


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

Line: 90 to 94

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

Changes from category system

>
>

Specification


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


Changed:
<
<

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.

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

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

Changed:
<
<

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.

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


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

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

Changed:
<
<

UI for multiple form templates

>
>

Setting Up Multiple Form Options


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

  • 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.
Changed:
<
<
  • 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?

Deleted:
<
<

Migration of Category information


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


Added:
>
>
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].

-- JohnTalintyre? - 16 Aug 2001
 <<O>>  Difference Topic TWikiForms (r1.3 - 29 Aug 2001 - JohnTalintyre?)

META TOPICPARENT WebHome
Added:
>
>
TOC: No TOC in "TWiki.TWikiForms"

Form Templates

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


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

Terminology

Line: 56 to 60

OsVersion? text 16   blah blah...
Changed:
<
<

Defining form in multiple topics

>
>

Defining a form in multiple topics


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

Line: 104 to 108

Topic meta data

Changed:
<
<
See TWikiMetaDataDefinition?.
>
>
See MetaDataDefinition.

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.

Line: 129 to 133

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.

Changed:
<
<
-- JohnTalintyre? - 16 Aug 2001
>
>
-- JohnTalintyre? - 16 Aug 2001
 <<O>>  Difference Topic TWikiForms (r1.2 - 16 Aug 2001 - JohnTalintyre?)

META TOPICPARENT WebHome

Form Templates

Changed:
<
<

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

Terminology

  • Form Template: A set of fields defining a form. (Class in OO speak; used to be called category table definition)
Changed:
<
<
    • A web may contain more then one form template.
>
>
    • 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)
    • 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)
Line: 29 to 27

Enable forms for a web

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

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

  • Set WEBFORMS = BugForm, FeatureForm, BookLoanForm
Changed:
<
<
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.

Changed:
<
<

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


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.

Line: 57 to 51

Example: WebFormTemplate of the TWiki.Know web:

Name: Type: Size: Values: Tooltip message:
Deleted:
<
<
UseForm? radio 0 Yes, No Select 'No' to remove the form

TopicClassification? select 1 NoDisclosure?, PublicSupported?, PublicFAQ? blah blah...
OperatingSystem? checkbox 3 OsHPUX?, OsLinux?, OsSolaris?, OsWin? blah blah...
OsVersion? text 16   blah blah...
Line: 74 to 67

Deleted:
<
<
UseForm? radio 0 Yes, No blah blah...

TopicClassification? select 1   blah blah...
OperatingSystem? checkbox 3   blah blah...
OsVersion? text 16   blah blah...
Line: 88 to 80

Notes

  • This format allows you to define field items with / without WikiNames, depending on your needs.
Changed:
<
<
  • 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

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

Changes from category system

Main changes from TWikiCategoryTable:

  • Name changed in the hope that form is more readily understandable than category
Deleted:
<
<
  • 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
Added:
>
>
  • The UseCategory radio button has gone, the replacement being the Change form and Add Form buttons.

Creating new topics with forms

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

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

Topic meta data

Line: 124 to 112

UI for multiple form templates

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

  • 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.
Line: 135 to 123

Old data should be transparently upgraded to the new meta format when a topic is edit/previewed/saved.

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


Changed:
<
<
-- JohnTalintyre? - 07 Aug 2001
>
>
-- JohnTalintyre? - 16 Aug 2001
 <<O>>  Difference Topic TWikiForms (r1.1 - 07 Aug 2001 - JohnTalintyre?)
Line: 1 to 1
Added:
>
>
META TOPICPARENT WebHome

Form Templates

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:

Name: Type: Size: Values: Tooltip message:
UseForm? radio 0 Yes, No Select 'No' to remove the form
TopicClassification? select 1 NoDisclosure?, PublicSupported?, PublicFAQ? blah blah...
OperatingSystem? checkbox 3 OsHPUX?, OsLinux?, OsSolaris?, OsWin? blah blah...
OsVersion? text 16   blah blah...

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

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

Revision r1.1 - 07 Aug 2001 - 16:22 - JohnTalintyre?
Revision r1.22 - 03 Mar 2006 - 09:13 - DmitryNPopov?