Changes between Version 2 and Version 3 of TracFormsPlugin/Docs


Ignore:
Timestamp:
Jun 17, 2008 2:31:51 AM (6 years ago)
Author:
rharkins
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracFormsPlugin/Docs

    v2 v3  
    33TODO: Pontificate on the merits of forms in wikis... 
    44 
    5 == TracForm Configuration == 
     5=== TracForm Configuration === 
    66 
    7 == TracForm Environment == 
     7In the header section of the form, several commands can be used to control the rendering and configuration of the form in the form of "#!command [arg...]" lines before the first non-comment line: 
     8 
     9|| '''Command''' || '''Version''' || '''Arguments''' || '''Meaning''' || 
     10|| '''page''' || 0.1+ || page-context || Sets the page portion of the context used to store the form.  This defaults to the page the user is currently on. || 
     11|| '''subcontext''' || 0.1+ || subcontext || Sets a subcontext within the page.  For example, a SVN checklist could have a "#!subcontext SVN" to differentiate it from other forms on the page. || 
     12|| '''default''' || 0.1+ || operation || Specifies the default operation in [tf:args] blocks.  Defaults to "checkbox" || 
     13|| '''track_fields''' || 0.1+ || [yes|no] || If no argument given or yes, keep track of field changes in this form.  Defaults to false (no field changes tracked).  This affects [tf.who] and [tf.when] || 
     14|| '''submit_label''' || 0.1+ || label || Set the label to use for the submit button at the end of the form.  The default is "Submit Form" || 
     15 
     16=== TracForm Environment === 
    817 
    918Using the #!setenv command above, you can retrieve previously defined elements with %NAME% (case insensitive).  Other environment variables are also defined by the system: 
    1019 
    1120|| '''Variable''' || '''Version''' || '''Meaning''' || 
    12 || %USER% || 0.1+ || The currently active user || 
    13 || %NOW% || 0.1+ || The current date and time || 
     21|| '''%USER%''' || 0.1+ || The currently active user || 
     22|| '''%NOW%''' || 0.1+ || The current date and time || 
    1423 
    15 == TracForm Operations == 
     24=== TracForm Operations === 
    1625 
    1726Within the TracForm, you can use the following commands with [tf.OP:arg...] blocks: 
    1827 
    1928|| '''Operation''' || '''Version''' || '''Argument(s)''' || '''Meaning''' || 
    20 || tf.checkbox || 0.1+ || name [value] || Put an HTML checkbox here.  Use value only if specified (on is default). || 
    21 || tf.radio || 0.1+ || name value || Put an HTML checkbox here.  Use the name and value pair together. || 
    22 || tf.input || 0.1+ || name default || Put an HTML form input field here. || 
    23 || tf.who || 0.1+ || name || Show which user most recently affected the specified field.  This requires track_fields to be set in the commands section. || 
    24 || tf.when || 0.1+ || name [strftime format string] || Show when the most change was made on the specified field.  This requires track_fields to be set in the commands section. || 
    25 || tf.form_updater || 0.1+ || || Show the most recent updater of the form itself. || 
    26 || tf.form_updated_on || 0.1+ || [strftime format string] || Show when the form was most recently updated. || 
     29|| '''tf.checkbox''' || 0.1+ || name [value] || Put an HTML checkbox here.  Use value only if specified (on is default). || 
     30|| '''tf.radio''' || 0.1+ || name value || Put an HTML checkbox here.  Use the name and value pair together. || 
     31|| '''tf.input''' || 0.1+ || name default || Put an HTML form input field here. || 
     32|| '''tf.who''' || 0.1+ || name || Show which user most recently affected the specified field.  This requires track_fields to be set in the commands section. || 
     33|| '''tf.when''' || 0.1+ || name [strftime format string] || Show when the most change was made on the specified field.  This requires track_fields to be set in the commands section. || 
     34|| '''tf.form_updater''' || 0.1+ || || Show the most recent updater of the form itself. || 
     35|| '''tf.form_updated_on''' || 0.1+ || [strftime format string] || Show when the form was most recently updated. ||