update the DataForm template docs
This commit is contained in:
Colin Kuskie
parent
e7dd6b6bfc
commit
708e591211
1 changed files with 163 additions and 61 deletions
|
|
@ -227,16 +227,15 @@ Enter the default value (if any) for the field. For Yes/No fields, enter "yes"
|
|||
'83' => {
|
||||
message => q|The following template variables are available for Data Form templates.
|
||||
<p/>
|
||||
* : Only available if the user has already submitted the form.<p/>
|
||||
! : This variable is required for the Data Form to function correctly.<p/>
|
||||
|
||||
<b>acknowledgment</b><br>
|
||||
The acknowledgment specified in the wobject's properties. This message should be displayed after a user submits data.
|
||||
<p>
|
||||
<b>export.tab.url</b><br>
|
||||
Following this URL will export the data stored to this data form as a tab delimited file.
|
||||
<b>canEdit</b>
|
||||
A conditional indicating whether the current user has the privileges to edit this Data Form.
|
||||
<p>
|
||||
|
||||
<b>export.tab.label</b><br>
|
||||
The default label for the export.tab.url variable.
|
||||
<b>form.start</b> !<br>
|
||||
The beginning of the form.
|
||||
<p>
|
||||
|
||||
<b>entryList.url</b><br>
|
||||
|
|
@ -247,8 +246,12 @@ Following this URL will display a list of all the record entries in this data fo
|
|||
The default label for the entryList.url variable.
|
||||
<p>
|
||||
|
||||
<b>canEdit</b>
|
||||
A conditional indicating whether the current user has the privileges to edit an existing entry or export the form's data.
|
||||
<b>export.tab.url</b><br>
|
||||
Following this URL will export the data stored to this data form as a tab delimited file.
|
||||
<p>
|
||||
|
||||
<b>export.tab.label</b><br>
|
||||
The default label for the export.tab.url variable.
|
||||
<p>
|
||||
|
||||
<b>back.url</b><br>
|
||||
|
|
@ -259,42 +262,6 @@ A url that will take you back to the default page in the form.
|
|||
The default label for the back.url variable.
|
||||
<p>
|
||||
|
||||
<b>username</b>*<br>
|
||||
The username of the user that submitted the data.
|
||||
<p>
|
||||
|
||||
<b>userId</b>*<br>
|
||||
The user id of the user that submitted the data.
|
||||
<p>
|
||||
|
||||
<b>date</b>*<br>
|
||||
The date that this data was submitted or last updated formatted as the user's preferred date/time format.
|
||||
<p>
|
||||
|
||||
|
||||
<b>epoch</b>*<br>
|
||||
The date that this data was submitted or last updated formatted as an epoch date.
|
||||
<p>
|
||||
|
||||
<b>ipAddress</b>*<br>
|
||||
The IP address of the user that submitted the data.
|
||||
<p>
|
||||
|
||||
<b>edit.url</b>*<br>
|
||||
The URL to the page to edit this entry.
|
||||
<p>
|
||||
|
||||
<b>error_loop</b>*<br>
|
||||
A loop containing error information, for instance if someone doesn't fill out a required field.
|
||||
<p>
|
||||
|
||||
<blockquote>
|
||||
|
||||
<b>error.message</b>*<br>
|
||||
An error message indicating what the user might have done wrong.
|
||||
|
||||
</blockquote>
|
||||
|
||||
<b>addField.url</b><br>
|
||||
The URL that content managers will visit to add a new field to the form.
|
||||
<p>
|
||||
|
|
@ -303,17 +270,149 @@ The URL that content managers will visit to add a new field to the form.
|
|||
The default label for the addField.url variable.
|
||||
<p>
|
||||
|
||||
<b>form.start</b><br>
|
||||
The beginning of the form.
|
||||
<b>addTab.url</b><br>
|
||||
The URL that content managers will visit to add a new tab to the form.
|
||||
<p>
|
||||
|
||||
<b>addTab.label</b><br>
|
||||
The default label for the addTab.url variable.
|
||||
<p>
|
||||
|
||||
<b>tab.init</b>!<br>
|
||||
Code to enable tabs to work correctly.
|
||||
<p>
|
||||
|
||||
<b>username</b> *<br>
|
||||
The username of the user that submitted the data.
|
||||
<p>
|
||||
|
||||
<b>userId</b> *<br>
|
||||
The user id of the user that submitted the data.
|
||||
<p>
|
||||
|
||||
<b>date</b> *<br>
|
||||
The date that this data was submitted or last updated formatted as the user's preferred date/time format.
|
||||
<p>
|
||||
|
||||
<b>epoch</b> *<br>
|
||||
The date that this data was submitted or last updated formatted as an epoch date.
|
||||
<p>
|
||||
|
||||
<b>ipAddress</b> *<br>
|
||||
The IP address of the user that submitted the data.
|
||||
<p>
|
||||
|
||||
<b>edit.url</b> *<br>
|
||||
The URL to the page to edit this entry.
|
||||
<p>
|
||||
|
||||
<b>error_loop</b> *<br>
|
||||
A loop containing error information, for instance if someone doesn't fill out a required field.
|
||||
<p>
|
||||
|
||||
<blockquote>
|
||||
|
||||
<b>error.message</b> *<br>
|
||||
An error message indicating what the user might have done wrong.
|
||||
|
||||
</blockquote>
|
||||
|
||||
<b>tab_loop</b><br>
|
||||
A loop containing information about tabs that may have been defined for this Data Form.
|
||||
<p>
|
||||
|
||||
<blockquote>
|
||||
|
||||
<b>tab.start</b> !<br>
|
||||
Code to start the tab.
|
||||
<p>
|
||||
|
||||
<b>tab.sequence</b><br>
|
||||
A number indicating which tab this is (first, second, etc.).
|
||||
<p>
|
||||
|
||||
<b>tab.label</b><br>
|
||||
The label for this tab.
|
||||
<p>
|
||||
|
||||
<b>tab.tid</b><br>
|
||||
This tab's ID.
|
||||
<p>
|
||||
|
||||
<b>tab.subtext</b><br>
|
||||
A description of this tab that can explain more the tab contents than the label.
|
||||
<p>
|
||||
|
||||
<b>tab.controls</b> !<br>
|
||||
Editing icons for this tab.
|
||||
<p>
|
||||
|
||||
<b>tab.field_loop</b> !<br>
|
||||
A loop containing all the fields for this tab. See the <b>field_loop</b> description
|
||||
below to see which template variables may be used inside this loop.
|
||||
<p>
|
||||
|
||||
<blockquote>
|
||||
|
||||
<b>tab.field.form</b> !<br>
|
||||
The form element for this field.
|
||||
<p>
|
||||
|
||||
<b>tab.field.name</b><br>
|
||||
The name of this field.
|
||||
<p>
|
||||
|
||||
<b>tab.field.tid</b><br>
|
||||
The ID of the Tab that this field is in.
|
||||
<p>
|
||||
|
||||
<b>tab.field.value</b><br>
|
||||
The value of this field. If this is new data, then the default value will be used.
|
||||
<p>
|
||||
|
||||
<b>tab.field.label</b><br>
|
||||
The text label for this field.
|
||||
<p>
|
||||
|
||||
<b>tab.field.isHidden</b><br>
|
||||
A conditional indicating whether this field is supposed to be hidden.
|
||||
<p>
|
||||
|
||||
<b>tab.field.isDisplayed</b><br>
|
||||
A conditional indicating whether this field is supposed to be displayed.
|
||||
<p>
|
||||
|
||||
<b>tab.field.isRequired</b><br>
|
||||
A conditional indicating whether this field is required.
|
||||
<p>
|
||||
|
||||
<b>tab.field.isMailField</b><br>
|
||||
A conditional indicating whether this field is present only to facilitate sending an email.
|
||||
<p>
|
||||
|
||||
<b>tab.field.subtext</b><br>
|
||||
A description of the field so that users know what to put in the field.
|
||||
<p>
|
||||
|
||||
<b>tab.field.controls</b><br>
|
||||
WebGUI's administrative controls for editing this field.
|
||||
<p>
|
||||
|
||||
</blockquote>
|
||||
|
||||
<b>tab.end</b> !<br>
|
||||
Code to end the tab.
|
||||
<p>
|
||||
|
||||
</blockquote>
|
||||
|
||||
<b>field_loop</b><br>
|
||||
A loop containing all of the field information.
|
||||
<p>
|
||||
|
||||
<blockquote>
|
||||
|
||||
<b>field.form</b><br>
|
||||
<b>field.form</b> !<br>
|
||||
The form element for this field.
|
||||
<p>
|
||||
|
||||
|
|
@ -321,6 +420,14 @@ The form element for this field.
|
|||
The name of this field.
|
||||
<p>
|
||||
|
||||
<b>field.tid</b><br>
|
||||
The ID of the Tab that this field is in.
|
||||
<p>
|
||||
|
||||
<b>field.inTab</b><br>
|
||||
A conditional indicating if the field is inside of a tab.
|
||||
<p>
|
||||
|
||||
<b>field.value</b><br>
|
||||
The value of this field. If this is new data, then the default value will be used.
|
||||
<p>
|
||||
|
|
@ -337,10 +444,6 @@ A conditional indicating whether this field is supposed to be hidden.
|
|||
A conditional indicating whether this field is supposed to be displayed.
|
||||
<p>
|
||||
|
||||
<b>field.isEditable</b><br>
|
||||
A conditional indicating whether this field is editable.
|
||||
<p>
|
||||
|
||||
<b>field.isRequired</b><br>
|
||||
A conditional indicating whether this field is required.
|
||||
<p>
|
||||
|
|
@ -349,13 +452,12 @@ A conditional indicating whether this field is required.
|
|||
A conditional indicating whether this field is present only to facilitate sending an email.
|
||||
<p>
|
||||
|
||||
|
||||
<b>field.subtext</b><br>
|
||||
A description of the field so that users know what to put in the field.
|
||||
<p>
|
||||
|
||||
<b>field.controls</b><br>
|
||||
WebGUI's administrative controls for this field.
|
||||
WebGUI's administrative controls for editing this field.
|
||||
<p>
|
||||
|
||||
</blockquote>
|
||||
|
|
@ -364,20 +466,20 @@ WebGUI's administrative controls for this field.
|
|||
From outside the <b>field_loop</b> it's also possible to access all form fields directly. To accomplish this you should use these variables. Call them with <b>field.noloop.<i>fieldName</i>.<i>property</i></b>, where fieldName is the name of the field (not the label) and property is anyone of the properties supplied by the <b>field_loop</b>. If you want the form tag of field 'name' you should use <b>field.noloop.name.form</b> anywhere in your template. If you want to know if the field is required use <b>field.noloop.name.isRequired</b>.
|
||||
<p>
|
||||
|
||||
<b>form.send</b><br>
|
||||
A form button with the word "send" printed on it.
|
||||
<b>form.send</b> !<br>
|
||||
A form button with the internationalized word "send" printed on it.
|
||||
<p>
|
||||
|
||||
<b>form.save</b><br>
|
||||
A form button with the word "save" printed on it.
|
||||
<b>form.save</b> !<br>
|
||||
A form button to submit the form data.
|
||||
<p>
|
||||
|
||||
<b>form.end</b><br>
|
||||
<b>form.end</b> !<br>
|
||||
The end of the form.
|
||||
<p>
|
||||
|
||||
*Only available if the user has already submitted the form.|,
|
||||
lastUpdated => 1101772868
|
||||
|,
|
||||
lastUpdated => 1110613373,
|
||||
},
|
||||
|
||||
'61' => {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue