From a71d841746cfe12832f1c7dd785d17881fda38ed Mon Sep 17 00:00:00 2001 From: Colin Kuskie Date: Fri, 9 Jun 2006 03:43:40 +0000 Subject: [PATCH] template variable breakout, T-4 Assets to go --- lib/WebGUI/Help/Asset_SQLForm.pm | 225 +++++++ lib/WebGUI/i18n/English/Asset_SQLForm.pm | 747 +++++++++++++---------- 2 files changed, 638 insertions(+), 334 deletions(-) diff --git a/lib/WebGUI/Help/Asset_SQLForm.pm b/lib/WebGUI/Help/Asset_SQLForm.pm index f96fd11e6..9e23c19ca 100644 --- a/lib/WebGUI/Help/Asset_SQLForm.pm +++ b/lib/WebGUI/Help/Asset_SQLForm.pm @@ -340,6 +340,171 @@ our $HELP = { 'edit record template' => { title => 'edit template help title', body => 'edit template help', + variables => [ + { + 'name' => 'showFieldsDefined' + }, + { + 'name' => 'searchForm' + }, + { + 'name' => 'searchFormHeader' + }, + { + 'name' => 'searchFormTrash.label' + }, + { + 'name' => 'searchFormMode.label' + }, + { + 'name' => 'searchFormMode.form' + }, + { + 'name' => 'searchFormQuery.label' + }, + { + 'name' => 'searchFormSearchIn.label' + }, + { + 'name' => 'searchFormSearchIn.form' + }, + { + 'name' => 'searchFormType.label' + }, + { + 'name' => 'searchFormType.form' + }, + { + 'name' => 'searchFormFooter' + }, + { + 'name' => 'searchFormSubmit' + }, + { + 'name' => 'searchFormJavascript' + }, + { + 'name' => 'searchForm.field_loop', + 'variables' => [ + { + 'name' => 'field.label', + }, + { + 'name' => 'field.conditionalForm' + }, + { + 'name' => 'field.conditional' + }, + { + 'name' => 'field.searchForm1' + }, + { + 'name' => 'field.searchForm2' + }, + { + 'name' => 'field.formValue1' + }, + { + 'name' => 'field.formValue2' + }, + { + 'name' => 'field.__FIELDNAME__.id' + } + ] + }, + { + 'name' => 'headerLoop', + 'variables' => [ + { + 'name' => 'header.title' + }, + { + 'name' => 'header.sort.url' + }, + { + 'name' => 'header.sort.onThis' + }, + { + 'name' => 'header.sort.ascending' + } + ] + }, + { + 'name' => 'searchResults.header' + }, + { + 'name' => 'searchResults.footer' + }, + { + 'name' => 'searchResults.actionButtons' + }, + { + 'name' => 'searchResults.recordLoop', + 'variables' => [ + { + 'name' => 'record.controls', + }, + { + 'name' => 'record.deletionDate' + }, + { + 'name' => 'record.deletedBy' + }, + { + 'name' => 'record.updateDate' + }, + { + 'name' => 'record.updatedBy' + }, + { + 'name' => 'record.valueLoop', + 'variables' => [ + { + 'name' => 'record.value' + }, + { + 'name' => 'record.value.isFile' + }, + { + 'name' => 'record.value.isImage' + }, + { + 'name' => 'record.value.downloadUrl' + } + ] + } + ] + }, + { + 'name' => 'superSearch.url' + }, + { + 'name' => 'superSearch.label' + }, + { + 'name' => 'normalSearch.url' + }, + { + 'name' => 'normalSearch.label' + }, + { + 'name' => 'showMetaData' + }, + { + 'name' => 'managementLinks', + }, + { + 'name' => 'errorOccurred', + }, + { + 'name' => 'errorLoop', + 'variables' => [ + { + 'name' => 'error.message', + } + ], + } + ], related => [ { tag => 'sql form add/edit', @@ -355,6 +520,66 @@ our $HELP = { 'search record template' => { title => 'search template help title', body => 'search template help', + variables => [ + { + 'name' => 'completeForm' + }, + { + 'name' => 'formLoop', + 'variables' => [ + { + 'name' => 'field.label' + }, + { + 'name' => 'field.formElement' + }, + { + 'name' => 'field.value' + } + ] + }, + { + 'name' => 'field.__FIELDNAME__.formElement' + }, + { + 'name' => 'field.__FIELDNAME__.label' + }, + { + 'name' => 'field.__FIELDNAME__.value' + }, + { + 'name' => 'formHeader' + }, + { + 'name' => 'formFooter' + }, + { + 'name' => 'errorOccurred' + }, + { + 'name' => 'errorLoop', + 'variables' => [ + { + 'name' => 'error.message' + } + ] + }, + { + 'name' => 'isNew' + }, + { + 'name' => 'viewHistory.url' + }, + { + 'name' => 'viewHistory.label' + }, + { + 'name' => 'managementLinks' + }, + { + 'name' => 'record.controls' + } + ], related => [ { tag => 'sql form add/edit', diff --git a/lib/WebGUI/i18n/English/Asset_SQLForm.pm b/lib/WebGUI/i18n/English/Asset_SQLForm.pm index 43a69a12e..61c73a4f0 100644 --- a/lib/WebGUI/i18n/English/Asset_SQLForm.pm +++ b/lib/WebGUI/i18n/English/Asset_SQLForm.pm @@ -50,12 +50,12 @@ type of no importance. The database field type is very important, though, and should chosen with proper care.

|, lastUpdated => 0, }, - + 'ef signed' => { message => q|Sign|, lastUpdated => 0, }, - + 'ef signed description' => { message => q|

This property determines wheter this field interprets number as signed or unsigned. The difference lies in the boundaries @@ -64,17 +64,17 @@ of allowed values.

This property is available only for numeric fieldtypes like int.

|, lastUpdated => 0, }, - + 'ef signed label' => { message => q|Signed|, lastUpdated => 0, }, - + 'ef unsigned label' => { message => q|Unsigned|, lastUpdated => 0, }, - + 'ef autoincrement' => { message => q|Autoincrement|, lastUpdated => 0, @@ -96,7 +96,7 @@ form field type is irrelevant if autoincrement is enabled.

|, message => q|Height of form element|, lastUpdated => 0, }, - + 'ef form height description' => { message => q|

This property sets the height of the form element, if applicable for the chosen form field type. Not all form elements @@ -108,7 +108,7 @@ have a settable height.

|, message => q|Width of form element|, lastUpdated => 0, }, - + 'ef form width description' => { message => q|

This property sets the width of the form element, if applicable for the chosen form field type. Not all form elements @@ -511,12 +511,12 @@ of form and db types do not make much sense.

|, message => q|Keep|, lastUpdated => 0, }, - + 'overwrite' => { message => q|Overwrite|, lastUpdated => 0, }, - + 'delete' => { message => q|Delete|, lastUpdated => 0, @@ -912,12 +912,12 @@ search results.

|, message => q|Default view|, lastUpdated => 0, }, - + 'gef default view description' => { message => q|

This property switches the default view between normal and advanced search.

|, lastUpdated => 0, }, - + 'gef submit group' => { message => q|Group to submit records|, lastUpdated => 0, @@ -1009,7 +1009,7 @@ have been purged yet.

|, message => q|Manage fields|, lastUpdated => 0, }, - + 'manage fields title' => { message => q|SQLForm, Manage Fields|, lastUpdated => 0, @@ -1024,7 +1024,7 @@ have been purged yet.

|, message => q|Manage field types|, lastUpdated => 0, }, - + 'manage regexes title' => { message => q|SQLForm, Manage Regexes|, lastUpdated => 0, @@ -1040,45 +1040,128 @@ have been purged yet.

|, lastUpdated => 0, }, + 'completeForm' => { + message => q|This contains the entire form, complete +and layed out in a WebGUI-style table. You don't need to add a +seperate form header, footer or anything else.|, + lastUpdated => 1149822620, + }, + + 'formLoop' => { + message => q|A loop containing each field. Using +this loop will allow you to use a different layout than that of +completeForm. The formLoop loop provides the following +variables:|, + lastUpdated => 1149822620, + }, + + 'field.label' => { + message => q|The display name of the field.|, + lastUpdated => 1149822620, + }, + + 'field.formElement' => { + message => q|The form Element for the field
+In view mode this is the same as field.value.|, + lastUpdated => 1149822620, + }, + + 'field.value' => { + message => q|The value of the field|, + lastUpdated => 1149822620, + }, + + 'field.__FIELDNAME__.formElement' => { + message => q|Contains the form element of the field +__FIELDNAME__. You must substitute __FIELDNAME__ with the +name of the field you intend to place.
+In view mode this is the same as __FIELDNAME__.value.|, + lastUpdated => 1149822620, + }, + + 'field.__FIELDNAME__.label' => { + message => q|Contains the display name of the field +__FIELDNAME__. You must substitute __FIELDNAME__ with the +field name of the field you intend to place.|, + lastUpdated => 1149822620, + }, + + 'field.__FIELDNAME__.value' => { + message => q|Contains the value of the field +__FIELDNAME__. You must substitute __FIELDNAME__ with the +name of the field you intend to place.|, + lastUpdated => 1149822620, + }, + + 'formHeader' => { + message => q|The header of the form. If you are +not using the completeForm you must include this variable +before any other form variable. If you do use the completeForm +variable, however, you must not use the formHeader +variable.|, + lastUpdated => 1149822620, + }, + + 'formFooter' => { + message => q|The footer of the form. If you are +not using the completeForm you must include this variable +after all form variables. If you do use the completeForm +variable, however, you must not use the formFooter variable.|, + lastUpdated => 1149822620, + }, + + 'errorOccurred' => { + message => q|Conditional indicating whether an error +occurred in the submitted data.|, + lastUpdated => 1149822620, + }, + + 'errorLoop' => { + message => q|Loop containing any errors that occurred while processing data submitted in the form.|, + lastUpdated => 1149822620, + }, + + 'error.message' => { + message => q|The actual error message.|, + lastUpdated => 1149822620, + }, + + 'isNew' => { + message => q|Conditional indicating whether the user +is adding a new record or editing an existing one. It will be true if the record +is new.|, + lastUpdated => 1149822620, + }, + + 'viewHistory.url' => { + message => q|The url to the history of this record.|, + lastUpdated => 1149822620, + }, + + 'viewHistory.label' => { + message => q|The label of the link to the history of this record.|, + lastUpdated => 1149822620, + }, + + 'record.controls' => { + message => q|Delete, edit and copy buttons for theis record. Only available if the user is +allowed to edit the record.|, + lastUpdated => 1149822620, + }, + 'edit template help' => { message => q|

The SQLForm provides you with three methods to construct record input and edit forms, offering three levels of flexibility. Please note that more flexibilty has the downside of increased complexity.

-

The three methods you can use are: completeForm, formloop or manual placement of form -elements using field.<fieldname>.formElement and -field.<fieldname>.label

- - -

completeForm
-This contains the entire form, complete -and layouted in a WebGUI style table. You don't need to add a -seperate form header, footer or anything else.

- -

formLoop
-A loop containing each field. Using -this loop will allow you to use a different layout than that of -completeForm. The formLoop loop provides the following -variables:

- -
-

field.label
-The display name of the field.

- - -

field.formElement
-The form Element for the field
-In view mode this is the same as field.value. -

- -

field.value
-The value of the field

- - -
- +elements using field.__FIELDNAME__.formElement and +field.__FIELDNAME__.label

+

completeForm handles placing everything that you need in a table, +automatically, using a default layout.

+

formloop handles placing everything that you need in a table, +automatically. This allows you some flexibility in your form layout.

Finally there is the option of placing each seperate field by hand. This allows you to define the order and place of each form element. Please note, however, that using this @@ -1087,81 +1170,8 @@ If you add, delete or rename a field you must update the template by hand. Using this method also implies the use of formHeader and formFooter. You should use the following two template variables:

- - -

field.<fieldname>.formElement
-Contains the form element of the field -<fieldname>. You must substitute <fieldname> with the -field name of the field you intend to place.
-In view mode this is the same as field<fieldname>.value. -

- - -

field.<fieldname>.label
-Contains the display name of the field -<fieldname>. You must substitute <fieldname> with the -field name of the field you intend to place.

- -

field.<fieldname>.value
-Contains the value of the field -<fieldname>. You must substitute <fieldname> with the -field name of the field you intend to place.

- - -

formHeader
-The header of the form. If you are -not using the completeForm You must include this variable -before any other form variable. If you do use the completeForm -variable, however, you must not use the formHeader -variable.

- - -

formFooter
-The footer of the form. If you are -not using the completeForm You must include this variable -after every other form variable. If you do use the completeForm -variable, however, you must not use the formFooter variable.

- -

This template also provides some other -variables:

- - -

errorOccurred
-Conditional indicating whether an error -occurred in the submitted data.

- - -

errorLoop
-Loop containing the errors.

- -
-

error.message
-The actual error message.

-
- -

isNew
-Conditional idicating whether the user -is adding a new record or editing an existing one. True is the record -is new.

- - -

viewHistory.url
-The url to the history of this record.

- - -

viewHistory.label
-The label of the link to the history of -this record.

- - -

managementLinks
-A string of links to all of the -management functions.

- -

record.controls
-Delete, edit and copy buttons for theis record. Only available if the user is -allowed to edit the record.

|, - lastUpdated => 0, +|, + lastUpdated => 1149822668, }, 'search template help title' => { @@ -1169,6 +1179,285 @@ allowed to edit the record.

|, lastUpdated => 0, }, + 'showFieldsDefined' => { + message => q|Conditional which returns true if there are field that are defined to be shown. +In other words, this is false if every field is configured not to be displayed +in the search results.|, + lastUpdated => 1149822982, + }, + + 'searchForm' => { + message => q|Contains the complete form which allows users to search.|, + lastUpdated => 1149822982, + }, + + 'searchFormHeader' => { + message => q|The header of the form, available in normal and advanced search. If you are +not using the complete searchForm You must include this variable +before any other form variable. If you do use the complete searchForm + variable, however, you must not use the searchFormHeader +variable.|, + lastUpdated => 1149822982, + }, + + 'searchFormTrash.label' => { + message => q|The label for the search in trash option. Available in normal and advanced search. Only use this if you are +not using the complete searchForm.

+

searchFormTrash.form
+The form Element for the search in trash option. Available in normal and advanced search. Only use this if you are +not using the complete searchForm.|, + lastUpdated => 1149822982, + }, + + 'searchFormMode.label' => { + message => q|The label for the search mode option (with regex or not). Available in normal search. Only use this if you are +not using the complete searchForm.|, + lastUpdated => 1149822982, + }, + + 'searchFormMode.form' => { + message => q|The form Element for the search mode option (with regex or not). Available in normal search. Only use this if you are +not using the complete searchForm.|, + lastUpdated => 1149822982, + }, + + 'searchFormQuery.label' => { + message => q|The label for the search query. Available in normal search. Only use this if you are +not using the complete searchForm.

+

searchFormQuery.form
+The form Element for the search query. Available in normal search. Only use this if you are +not using the complete searchForm.|, + lastUpdated => 1149822982, + }, + + 'searchFormSearchIn.label' => { + message => q|The label for the search in fields select list. Available in normal search. Only use this if you are +not using the complete searchForm.|, + lastUpdated => 1149822982, + }, + + 'searchFormSearchIn.form' => { + message => q|The form Element for the search in fields select list. Available in normal search. Only use this if you are +not using the complete searchForm.|, + lastUpdated => 1149822982, + }, + + 'searchFormType.label' => { + message => q|The label for the search type option (or/and). Available in advanced search. Only use this if you are|, + lastUpdated => 1149822982, + }, + + 'searchFormType.form' => { + message => q|The form Element for the search type option (or/and). Available in advanced search. Only use this if you are +not using the complete searchForm.|, + lastUpdated => 1149822982, + }, + + 'searchFormFooter' => { + message => q|The footer of the form, available in normal and advanced search. If you are +not using the complete searchForm You must use this variable +after every other searchForm variable. If you do use the complete searchForm +variable, however, you must not use the searchFormFooter variable.|, + lastUpdated => 1149822982, + }, + + 'searchFormSubmit' => { + message => q|The submit button of the form, available in normal and advanced search. Only use this if you are +not using the complete searchForm.|, + lastUpdated => 1149822982, + }, + + 'searchFormJavascript' => { + message => q|Only used for advanced search. This links the SQLFormSearch.js file and contains some inline javascript that is used by advanced search. If you are +not using the complete searchForm you must include this variable +for adUse of uninitialized value in exists at varify.pl line 62, <> chunk 26. +Use of uninitialized value in printf at varify.pl line 63, <> chunk 26. +vanced search. If you do use the complete searchForm +variable, however, you must not use the searchFormJavascript variable.|, + lastUpdated => 1149822982, + }, + + 'searchForm.field_loop' => { + message => q|A loop containing each field, only available in advanced search. +The field_loop provides the following +variables:|, + lastUpdated => 1149822982, + }, + + 'field.conditionalForm' => { + message => q|The form Element for the conditional for this field|, + lastUpdated => 1149822982, + }, + + 'field.conditional' => { + message => q|The value of the conditional form Element for this field|, + lastUpdated => 1149822982, + }, + + 'field.searchForm1' => { + message => q|The first search form Element for this field|, + lastUpdated => 1149822982, + }, + + 'field.searchForm2' => { + message => q|The second search form Element for this field|, + lastUpdated => 1149822982, + }, + + 'field.formValue1' => { + message => q|The value of first search form Element for this field|, + lastUpdated => 1149822982, + }, + + 'field.formValue2' => { + message => q|The value of second search form Element for this field|, + lastUpdated => 1149822982, + }, + + 'field.__FIELDNAME__.id' => { + message => q|Contains the id of the field +__FIELDNAME__. You must substitute __FIELDNAME__ with the +field name of the field.
+You can use this if you want to create a custom Advanced search form that completely overrides the default search form.|, + lastUpdated => 1149822982, + }, + + '' => { + message => q||, + lastUpdated => 1149822982, + }, + + 'headerLoop' => { + message => q|A loop containing the display names of each field, inclding sort controls. The +following variables are provided within this loop:|, + lastUpdated => 1149822982, + }, + + 'header.title' => { + message => q|The display name of the current field.|, + lastUpdated => 1149822982, + }, + + 'header.sort.url' => { + message => q|The url that allows you to sort on this field.|, + lastUpdated => 1149822982, + }, + + 'header.sort.onThis' => { + message => q|Conditional indicating whether the search results are sorted on this +field.|, + lastUpdated => 1149822982, + }, + + 'header.sort.ascending' => { + message => q|Conditional indicating whether the search results are sorted ascending +or descending.|, + lastUpdated => 1149822982, + }, + + 'searchResults.header' => { + message => q|Contains the form header for the batch restore and purge functions in the search +results. You should put this somewhere before the searchResults loop.|, + lastUpdated => 1149822982, + }, + + 'searchResults.footer' => { + message => q|Contains the form footer for the search results batch functions. Put this +template variable somewhere after the searchResults loop.|, + lastUpdated => 1149822982, + }, + + 'searchResults.actionButtons' => { + message => q|Contains the restore and purge buttons for the batch operations. Put this +variable between searchResults.header and searchResults.footer.|, + lastUpdated => 1149822982, + }, + + 'searchResults.recordLoop' => { + message => q|The loop containg the results of the search query. This should be between +searchResults.header and searchResults.footer. Within this loop the following +variables are available for use:|, + lastUpdated => 1149822982, + }, + + 'record.deletionDate' => { + message => q|Contains the date this record was deleted. Only available for records|, + lastUpdated => 1149822982, + }, + + 'record.deletedBy' => { + message => q|Contains the username of the person that deleted this record. Only|, + lastUpdated => 1149822982, + }, + + 'record.updateDate' => { + message => q|The date of the last time this record has been updated.|, + lastUpdated => 1149822982, + }, + + 'record.updatedBy' => { + message => q|The username of the person that made the most recent update to this|, + lastUpdated => 1149822982, + }, + + 'record.valueLoop' => { + message => q|A loop containing the values for each field of this record. This loop|, + lastUpdated => 1149822982, + }, + + 'record.value' => { + message => q|The value the record has for this field.|, + lastUpdated => 1149822982, + }, + + 'record.value.isFile' => { + message => q|Conditional being true if this field contains an uploaded file. +Also returns true if the file is an image.|, + lastUpdated => 1149822982, + }, + + 'record.value.isImage' => { + message => q|Conditional indicating if the uploaded file is an image.|, + lastUpdated => 1149822982, + }, + + 'record.value.downloadUrl' => { + message => q|The url to download the uploaded file in this field. Only +available for files and images.|, + lastUpdated => 1149822982, + }, + + 'superSearch.url' => { + message => q|The url to the advanced search mode.|, + lastUpdated => 1149822982, + }, + + 'superSearch.label' => { + message => q|The internationalized name of the advanced search.|, + lastUpdated => 1149822982, + }, + + 'normalSearch.url' => { + message => q|The url to the normal search mode.|, + lastUpdated => 1149822982, + }, + + 'normalSearch.label' => { + message => q|The internationalized name of the normal search.|, + lastUpdated => 1149822982, + }, + + 'showMetaData' => { + message => q|A conditional indictating whether the show meta data flag is turned on.|, + lastUpdated => 1149822982, + }, + + 'managementLinks' => { + message => q|A collection of links to the admin functions of the SQLForm like manage fields, +as well as links to add record and search record.|, + lastUpdated => 1149822982, + }, + 'search template help' => { message => q|

The search template of the SQLForm asset provides you with a way to customize the looks of the search @@ -1176,222 +1465,12 @@ functionality that the SQLForm offers.

There are two separate search methods, being normal and advanced search, but both use the same template. In both cases a complete searchForm is available. -The individual form Elements are also available, but note that different form Elements are used for normal and advanced search.

- -

The following template variable are available to you:

- -

showFieldsDefined
-Conditional which returns true if there are field that are defined to be shown. -In other words, this is false if every field is configured not to be displayed -in the search results.

- -

searchForm
-Contains the complete form which allows users to search.

- -

searchFormHeader
-The header of the form, available in normal and advanced search. If you are -not using the complete searchForm You must include this variable -before any other form variable. If you do use the complete searchForm - variable, however, you must not use the searchFormHeader -variable.

- -

searchFormTrash.label
-The label for the search in trash option. Available in normal and advanced search. Only use this if you are -not using the complete searchForm.

-

searchFormTrash.form
-The form Element for the search in trash option. Available in normal and advanced search. Only use this if you are -not using the complete searchForm.

- -

searchFormMode.label
-The label for the search mode option (with regex or not). Available in normal search. Only use this if you are -not using the complete searchForm.

-

searchFormMode.form
-The form Element for the search mode option (with regex or not). Available in normal search. Only use this if you are -not using the complete searchForm.

- -

searchFormQuery.label
-The label for the search query. Available in normal search. Only use this if you are -not using the complete searchForm.

-

searchFormQuery.form
-The form Element for the search query. Available in normal search. Only use this if you are -not using the complete searchForm.

- -

searchFormSearchIn.label
-The label for the search in fields select list. Available in normal search. Only use this if you are -not using the complete searchForm.

-

searchFormSearchIn.form
-The form Element for the search in fields select list. Available in normal search. Only use this if you are -not using the complete searchForm.

- -

searchFormType.label
-The label for the search type option (or/and). Available in advanced search. Only use this if you are -not using the complete searchForm.

-

searchFormType.form
-The form Element for the search type option (or/and). Available in advanced search. Only use this if you are -not using the complete searchForm.

- -

searchFormFooter
-The footer of the form, available in normal and advanced search. If you are -not using the complete searchForm You must use this variable -after every other searchForm variable. If you do use the complete searchForm -variable, however, you must not use the searchFormFooter variable.

- -

searchFormSubmit
-The submit button of the form, available in normal and advanced search. Only use this if you are -not using the complete searchForm.

- -

searchFormJavascript
-Only used for advanced search. This links the SQLFormSearch.js file and contains some inline javascript that is used by advanced search. If you are -not using the complete searchForm you must include this variable -for advanced search. If you do use the complete searchForm -variable, however, you must not use the searchFormJavascript variable.

- -

searchForm.field_loop
-A loop containing each field, only available in advanced search. -The field_loop provides the following -variables:

- -
-

field.label
-The display name of the field.

- -

field.conditionalForm
-The form Element for the conditional for this field

- -

field.conditional
-The value of the conditional form Element for this field

- -

field.searchForm1
-The first search form Element for this field

- -

field.searchForm1
-The second search form Element for this field

-

field.formValue1
-The value of first search form Element for this field

- -

field.formValue2
-The value of second search form Element for this field

- -

field.<fieldname>.id
-Contains the id of the field -<fieldname>. You must substitute <fieldname> with the -field name of the field.
-You can use this if you want to create a custom Advanced search form that completely overrides the default search form. +The individual form Elements are also available, but note that different form Elements are used for normal and advanced search.

-
- -

The template provides variables for the search results that are the same for normal and advanced search.

- -

headerLoop
-A loop containing the display names of each field, inclding sort controls. The -following variables are provided within this loop:

- -
-

header.title
- The display name of the current field.

- -

header.sort.url
- The url that allows you to sort on this field.

- -

header.sort.onThis
- Conditional indicating whether the search results are sorted on this - field.

- -

header.sort.ascending
- Conditional indicating whether the search results are sorted ascending - or descending.

-
- -

searchResults.header
-Contains the form header for the batch restore and purge functions in the search -results. You should put this somewhere before the searchResults loop.

- -

searchResults.footer
-Contains the form footer for the search results batch functions. Put this -template variable somewhere after the searchResults loop.

- -

searchResults.actionButtons
-Contains the restore and purge buttons for the batch operations. Put this -variable between searchResults.header and searchResults.footer.

- -

searchResults.recordLoop
-The loop containg the results of the search query. This should be between -searchResults.header and searchResults.footer. Within this loop the following -variables are available for use:

- -
-

record.controls
- Contains the edit/view, delete and purge restore controls for this - record.

- -

record.deletionDate
- Contains the date this record was deleted. Only available for records - that are deleted.

- -

record.deletedBy
- Contains the username of the person that deleted this record. Only - available for records that are deleted.

- -

record.updateDate
- The date of the last time this record has been updated.

- -

record.updatedBy
- The username of the person that made the most recent update to this - record.

- -

record.valueLoop
- A loop containing the values for each field of this record. This loop - provides the following variables:

- -
-

record.value
- The value the record has for this field.

- -

record.value.isFile
- Conditional being true if this field contains an uploaded file. - Also returns true if the file is an image.

- -

record.value.isImage
- Conditional indicating if the uploaded file is an image.

- -

record.value.downloadUrl
- The url to download the uploaded file in this field. Only - available for files and images.

-
-
- -

superSearch.url
-The url to the advanced search mode.

- -

superSearch.label
-The internationalized name of the advanced search.

- -

normalSearch.url
-The url to the normal search mode.

- -

normalSearch.label
-The internationalized name of the normal search.

- -

showMetaData
-A conditional indictating whether the show meta data flag is turned on.

- -

managementLinks
-A collection of links to the admin functions of the SQLForm like manage fields, -as well as links to add record and search record.

- -

errorOccurred
-Conditional which is true if some error happened while processing the search query.

- -

errorLoop
-A loop containing the errors that have occurred while processing the search -query. The following variable is available in this loop:

- -
-

error.message
- Contains the actual error message.

-
|, - lastUpdated => 0, +

The template provides variables for the search results that are the same for normal and advanced search:

+|, + lastUpdated => 1149823247, }, 'dft cannot delete' => {