Wiki Tutorial

Form Definition for a Wiki Application

View raw Wiki code for this page


  • Each row in the table below defines a field in the resulting Wiki form.
    • These fields must also match any HTML data entry or search forms.

  • Be sure to use a unique and unambiguous name for each field.
    • Avoid using field names that collide with those in another form!
    • A naming convention with a common prefix is recommended.

  • Use WikiWord format for each field Name. You may "space out" the name.

  • You may use an Editable table to create the form definition.

  • Do not press "return" in any textarea fields when adding data to this table. All fields should contain one unbroken line of text.

  • Note that menu items (for type select) can be stored on another page (where the page name must match the field name).

Columns in the Table
  • Name
    • required
    • Use WikiWord format
  • Type
    • required
    • one of: text, textarea, checkbox, radio, label, select, date
  • Size
    • required
    • For text fields, the size is the width in characters (e.g. 40)
    • For a text area, the size is columns x rows (e.g. 40x5)
    • If type is select, radio, or checkbox, the "size" defines how much to show,
      e.g. how many menu items are visible at once or how many checkboxes in a row
  • Values
    • depends on type
    • If type is select, radio, or checkbox, the "values" should be a list of choices
      • these values may be defined in a page of their own, named by the field name.
      • If you want a menu to be empty initially, begin the list with a comma
    • For other types, ignore the "values" field
  • Tooltip Message
    • optional
    • This should be a short descriptive phrase
  • Attributes
    • optional
    • An attribute H indicates that this field should not be shown in view mode.
    • An attribute M indicates that this field is mandatory.

See DataForms and WikiTutApp for additional documentation.



The Form Definition

Name: Type: Size: Values: Tooltip message: Attributes
Tut Project Name
text
60
 
Name of this Project
 
Tut Project Page Link
text
60
 
Link to Project Development page
 
Tut Launch Date
date
10
 
Launch Date (planned)
 
select
1
 
Top level of organization
 
select
1
 
Select the project size
 
select
1
 
Select the level of involvement
 
select
1
 
Primary country where operation is handled
 
Tut Exec Summary
text
60
 
Brief description (100 chars)
 
Tut Page Comments
textarea
80x6
 
Any additional comments
 
select
1
 
Project Classification
 
Tut Project Status
select
1
%Red%, %Yellow%, %Green%
Project Status
 

Important:

  • If you add a field (row) to this table, be sure to update any related forms (e.g. Search and Initialization pages) as well.

  • If you change the Name on any row below, all data values for that field will be lost for any existing pages using this form!

Be sure to add this form to the WEBFORMS setting on the WebPreferences page!
   * Set WEBFORMS = ..., WikiTutAppE1Form

After you've done that, this form will be available behind the "Add Form" button on the Edit page for any topic in this Web.

See also:

Topic revision: r2 - 25 Feb 2013, RichMorin
This site is powered by Foswiki Copyright © by the contributing authors. All material on this wiki is the property of the contributing authors.
Foswiki version v2.1.6, Release Foswiki-2.1.6, Plugin API version 2.4
Ideas, requests, problems regarding CFCL Wiki? Send us email