Wiki Tutorial

Generic Document Form: Form Definition for a Wiki Application

Hints and Tips

Each row below defines a field in the resulting form. These fields must also match any data entry forms.

You can query pages (search) by these fields as well. If you want to query something in the search, it MUST be represented below.

Hints
  • Do not press "return" in any textarea fields when adding data to this table. All fields should contain one unbroken line of text.
  • Ignore the apparent "broken Wiki links" in the Name column. This is OK

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 "values" should be a comma-separated list of choices
      • If you want a menu to be empty initially, begin the list with a comma
  • 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.
    • 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.

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

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

Note that menu items (for type select) can be stored on another page. (the field names double as page names).

Important:
  • If you add a row (field) to this table, be sure to update your 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!



The Form Definition

Name: Type: Size: Values: Tooltip message: Attributes
Document Name
text
60
 
Name of this Document
 
Document Author
text
60
 
Author of this Document
 
Document Pub Date
date
12
 
Publication Date (planned)
 
select
1
 
Choose category
 
select
1
 
Choose type
 
Document Summary
text
60
 
Brief description (100 chars)
 
Document Keywords
textarea
80x6
 
Optional. Freeform field. Enter keywords that might make searching easier
 
Document Status
select
1
Draft, Published, Revising, In Review, Needs Review, Archived
Document Status
 

Related Topics: WikiTutApp, %IF{"$'FORMFIELD{TutProjectName}'", then="%FORMFIELD{"TutProjectName"}%", else="%TOPIC%"}%, WebPreferences, TWikiForms


-- VickiBrown - 23 Jul 2008

WikiTutDocForm edit

Document Name
Document Author
Document Pub Date
DocumentCategory
DocumentType
Document Summary
Document Keywords
Document Status Draft
Topic revision: r2 - 30 Nov 2014, VickiBrown
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