From d94ca3347400a1d83e77ea5347b8434ba87f00cb Mon Sep 17 00:00:00 2001
From: Colin Kuskie <colink@perldreamer.com>
Date: Fri, 2 Mar 2007 06:26:57 +0000
Subject: [PATCH] beginning to document the super search template

---
 lib/WebGUI/Help/Asset_SQLForm.pm         | 206 +++++++++++++++++++++++
 lib/WebGUI/i18n/English/Asset_SQLForm.pm |  18 +-
 2 files changed, 220 insertions(+), 4 deletions(-)

diff --git a/lib/WebGUI/Help/Asset_SQLForm.pm b/lib/WebGUI/Help/Asset_SQLForm.pm
index 91c46523c..981e33617 100644
--- a/lib/WebGUI/Help/Asset_SQLForm.pm
+++ b/lib/WebGUI/Help/Asset_SQLForm.pm
@@ -540,6 +540,212 @@ our $HELP = {
 		],
 	},
 
+	'advanced search record template' => {
+		title => 'advanced search template help title',
+		body => 'advanced search template help body',
+		isa => [
+			{
+				namespace => "Asset_SQLForm",
+				tag => "sql form asset template variables"
+			},
+			{
+				namespace => "Asset_Template",
+				tag => "template variables"
+			},
+			{
+				namespace => "Asset",
+				tag => "asset template"
+			},
+		],
+		variables => [
+		          {
+		            'name' => 'headerLoop',
+		            'variables' => [
+		                             {
+		                               'name' => 'header.title'
+		                             },
+		                             {
+		                               'name' => 'header.sort.url'
+		                             },
+		                             {
+		                               'name' => 'header.sort.onThis'
+		                             },
+		                             {
+		                               'name' => 'header.sort.ascending'
+		                             }
+		                           ]
+		          },
+		          {
+		            'name' => 'superSearch.url'
+		          },
+		          {
+		            'name' => 'superSearch.label'
+		          },
+		          {
+		            'name' => 'normalSearch.url'
+		          },
+		          {
+		            'name' => 'normalSearch.label'
+		          },
+		          {
+		            'name' => 'showFieldsDefined'
+		          },
+		          {
+		            'name' => 'searchResults.header'
+		          },
+		          {
+		            'name' => 'searchResults.footer'
+		          },
+		          {
+		            'name' => 'searchResults.actionButtons'
+		          },
+		          {
+		            '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' => 'searchResults.header'
+		          },
+		          {
+		            'name' => 'searchResults.footer'
+		          },
+		          {
+		            'name' => 'searchResults.actionButtons'
+		          },
+		          {
+		            'name' => 'searchResults.recordLoop',
+		            'variables' => [
+		                             {
+		                               'name' => 'record.id',
+		                             },
+		                             {
+		                               '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' => 'showMetaData'
+		          },
+		          {
+		            'name' => 'managementLinks',
+		          },
+		          {
+		            'name' => 'errorOccurred',
+		          },
+		          {
+		            'name' => 'errorLoop',
+		            'variables' => [
+		                             {
+		                               'name' => 'error.message',
+		                             }
+		                           ],
+		          }
+		],
+		related => [
+			{
+				tag => 'sql form add/edit',
+				namespace => 'Asset_SQLForm',
+			},
+			{
+				tag => 'template language',
+				namespace => 'Asset_Template',
+			},
+		],
+	},
+
 	'edit record template' => {
 		title => 'edit template help title',
 		body => 'edit template help',
diff --git a/lib/WebGUI/i18n/English/Asset_SQLForm.pm b/lib/WebGUI/i18n/English/Asset_SQLForm.pm
index 25e3c7092..2a20d1f37 100644
--- a/lib/WebGUI/i18n/English/Asset_SQLForm.pm
+++ b/lib/WebGUI/i18n/English/Asset_SQLForm.pm
@@ -914,7 +914,7 @@ search results.</p>|,
 	},
 
 	'gef default view description' => {
-		message => q|<p>This property switches the default view between normal and advanced search.</p>|,
+		message => q|<p>This property switches the default view between normal and advanced search.  The two views have different templates.</p>|,
 		lastUpdated => 0,
 	},
 
@@ -930,12 +930,12 @@ delete and restore but not purge records.</p>|,
 	},
 
 	'assetName' => {
-		message => q|SQL Form|,
+		message => q|SQLForm|,
 		lastUpdated => 0,
 	},
 
 	'edit sqlform' => {
-		message => q|SQL Form, Add/Edit|,
+		message => q|SQLForm, Add/Edit|,
 		lastUpdated => 0,
 	},
 
@@ -1180,7 +1180,7 @@ variables:</p>
 	},
 
 	'search template help title' => {
-		message => q|SQLForm, Search Record Template|,
+		message => q|SQLForm, Normal Search Record Template|,
 		lastUpdated => 0,
 	},
 
@@ -1600,6 +1600,16 @@ be useful, others may not.|,
 	},
 
 
+	'advanced search template help title' => {
+		message => q|SQLForm, Advanced Search Record Template|,
+		lastUpdated => 0,
+	},
+
+	'advanced search template help body' => {
+		message => q|These template variables are available in the Advanced Search Record Template.|,
+		lastUpdated => 1172816905,
+	},
+
 };
 
 1;