From 1a3f8caac505782225c56305917fd5ab07aa2081 Mon Sep 17 00:00:00 2001 From: Colin Kuskie Date: Tue, 6 Jun 2006 22:35:26 +0000 Subject: [PATCH] template variable breakout --- lib/WebGUI/Help/Asset_MessageBoard.pm | 109 ++++++ lib/WebGUI/Help/Asset_SQLReport.pm | 98 ++++++ lib/WebGUI/i18n/English/Asset_MessageBoard.pm | 327 ++++++++++-------- lib/WebGUI/i18n/English/Asset_SQLReport.pm | 286 +++++++-------- 4 files changed, 528 insertions(+), 292 deletions(-) diff --git a/lib/WebGUI/Help/Asset_MessageBoard.pm b/lib/WebGUI/Help/Asset_MessageBoard.pm index 4b664c74d..4ec042c7b 100644 --- a/lib/WebGUI/Help/Asset_MessageBoard.pm +++ b/lib/WebGUI/Help/Asset_MessageBoard.pm @@ -31,6 +31,115 @@ our $HELP = { 'message board template' => { title => '73', body => '74', + variables => [ + { + 'name' => 'forum.add.url' + }, + { + 'name' => 'forum.add.label' + }, + { + 'name' => 'title.label' + }, + { + 'name' => 'views.label' + }, + { + 'name' => 'rating.label' + }, + { + 'name' => 'threads.label' + }, + { + 'name' => 'replies.label' + }, + { + 'name' => 'lastpost.label' + }, + { + 'name' => 'forum_loop', + 'variables' => [ + { + 'name' => 'forum.controls' + }, + { + 'name' => 'forum.count' + }, + { + 'name' => 'forum.title' + }, + { + 'name' => 'forum.description' + }, + { + 'name' => 'forum.replies' + }, + { + 'name' => 'forum.rating' + }, + { + 'name' => 'forum.views' + }, + { + 'name' => 'forum.threads' + }, + { + 'name' => 'forum.url' + }, + { + 'name' => 'forum.lastpost.url' + }, + { + 'name' => 'forum.lastpost.date' + }, + { + 'name' => 'forum.lastpost.time' + }, + { + 'name' => 'forum.lastpost.epoch' + }, + { + 'name' => 'forum.lastpost.subject' + }, + { + 'name' => 'forum.lastpost.user.id' + }, + { + 'name' => 'forum.lastpost.user.name' + }, + { + 'name' => 'forum.lastpost.user.alias' + }, + { + 'name' => 'forum.lastpost.user.profile' + }, + { + 'name' => 'forum.lastpost.user.isVisitor' + }, + { + 'name' => 'forum.user.canView' + }, + { + 'name' => 'forum.user.canPost' + } + ] + }, + { + 'name' => 'default.listing' + }, + { + 'name' => 'default.description' + }, + { + 'name' => 'default.title' + }, + { + 'name' => 'default.controls' + }, + { + 'name' => 'areMultipleForums' + } + ], fields => [ ], related => [ diff --git a/lib/WebGUI/Help/Asset_SQLReport.pm b/lib/WebGUI/Help/Asset_SQLReport.pm index a61e09db2..d66b767c1 100644 --- a/lib/WebGUI/Help/Asset_SQLReport.pm +++ b/lib/WebGUI/Help/Asset_SQLReport.pm @@ -66,6 +66,104 @@ our $HELP = { body => '73', fields => [ ], + variables => [ + { + 'name' => 'columns_loop', + 'variables' => [ + { + 'name' => 'column.number' + }, + { + 'name' => 'column.name' + } + ] + }, + { + 'name' => 'rows.count' + }, + { + 'name' => 'rows.count.isZero' + }, + { + 'name' => 'rows.count.isZero.label' + }, + { + 'name' => 'rows_loop', + 'variables' => [ + { + 'name' => 'row.number' + }, + { + 'name' => 'row.field.__NAME__.value' + }, + { + 'name' => 'row.field_loop', + 'variables' => [ + { + 'name' => 'field.number' + }, + { + 'name' => 'field.name' + }, + { + 'name' => 'field.value' + } + ] + } + ] + }, + { + 'name' => 'hasNest' + }, + { + 'name' => 'queryN.columns_loop', + 'variables' => [ + { + 'name' => 'column.number' + }, + { + 'name' => 'column.name' + } + ] + }, + { + 'name' => 'queryN.rows.count' + }, + { + 'name' => 'queryN.count.isZero' + }, + { + 'name' => 'queryN.rows.count.isZero.label' + }, + { + 'name' => 'queryN.rows_loop', + 'variables' => [ + { + 'name' => 'queryN.row.number' + }, + { + 'name' => 'queryN.row.field.__NAME__.value' + }, + { + 'name' => 'queryN.row.field_loop', + 'variables' => [ + { + 'name' => 'field.number' + }, + { + 'name' => 'field.name' + }, + { + 'name' => 'field.value' + } + ] + } + ] + }, + { + 'name' => 'queryN.hasNest' + } + ], related => [ { tag => 'pagination template variables', diff --git a/lib/WebGUI/i18n/English/Asset_MessageBoard.pm b/lib/WebGUI/i18n/English/Asset_MessageBoard.pm index b72b28768..c770de517 100644 --- a/lib/WebGUI/i18n/English/Asset_MessageBoard.pm +++ b/lib/WebGUI/i18n/English/Asset_MessageBoard.pm @@ -11,158 +11,185 @@ our $I18N = { lastUpdated => 1146454744 }, + 'forum.add.url' => { + message => q|A url that will add a forum to this message board.|, + lastUpdated => 1149632734, + }, + + 'forum.add.label' => { + message => q|The default label for forum.add.url.|, + lastUpdated => 1149632734, + }, + + 'title.label' => { + message => q|The default label for the title column.|, + lastUpdated => 1149632734, + }, + + 'views.label' => { + message => q|The default label for the views column.|, + lastUpdated => 1149632734, + }, + + 'rating.label' => { + message => q|The default label for the ratings column.|, + lastUpdated => 1149632734, + }, + + 'threads.label' => { + message => q|The default label for the threads column.|, + lastUpdated => 1149632734, + }, + + 'replies.label' => { + message => q|The default label for the replies column.|, + lastUpdated => 1149632734, + }, + + 'lastpost.label' => { + message => q|The default label for the last post column.|, + lastUpdated => 1149632734, + }, + + 'forum_loop' => { + message => q|A loop containing the data for each of the forums contained in this message board.|, + lastUpdated => 1149632734, + }, + + 'forum.controls' => { + message => q|The editing controls for this forum.|, + lastUpdated => 1149632734, + }, + + 'forum.count' => { + message => q|An integer displaying the forum count as it goes through the loop.|, + lastUpdated => 1149632734, + }, + + 'forum.title' => { + message => q|The title of this forum.|, + lastUpdated => 1149632734, + }, + + 'forum.description' => { + message => q|The description of this forum.|, + lastUpdated => 1149632734, + }, + + 'forum.replies' => { + message => q|The number of replies all the threads in this forum have received.|, + lastUpdated => 1149632734, + }, + + 'forum.rating' => { + message => q|The average rating of all the posts in the forum.|, + lastUpdated => 1149632734, + }, + + 'forum.views' => { + message => q|The total number of views of all the posts in the forum.|, + lastUpdated => 1149632734, + }, + + 'forum.threads' => { + message => q|The total number of threads in this forum.|, + lastUpdated => 1149632734, + }, + + 'forum.url' => { + message => q|The url to view this forum.|, + lastUpdated => 1149632734, + }, + + 'forum.lastpost.url' => { + message => q|The url to view the last post in this forum.|, + lastUpdated => 1149632734, + }, + + 'forum.lastpost.date' => { + message => q|The human readable date of the last post in this forum.|, + lastUpdated => 1149632734, + }, + + 'forum.lastpost.time' => { + message => q|The human readable time of the last post in this forum.|, + lastUpdated => 1149632734, + }, + + 'forum.lastpost.epoch' => { + message => q|The epoch date of the last post in this forum.|, + lastUpdated => 1149632734, + }, + + 'forum.lastpost.subject' => { + message => q|The subject of the last post in this forum.|, + lastUpdated => 1149632734, + }, + + 'forum.lastpost.user.id' => { + message => q|The userid of the last poster.|, + lastUpdated => 1149632734, + }, + + 'forum.lastpost.user.name' => { + message => q|The username of the last poster.|, + lastUpdated => 1149632734, + }, + + 'forum.lastpost.user.alias' => { + message => q|The current alias of the last poster.|, + lastUpdated => 1149632734, + }, + + 'forum.lastpost.user.profile' => { + message => q|The url to the last poster's profile.|, + lastUpdated => 1149632734, + }, + + 'forum.lastpost.user.isVisitor' => { + message => q|A conditional indicating whether the last poster was a visitor.|, + lastUpdated => 1149632734, + }, + + 'forum.user.canView' => { + message => q|A conditional indicating whether the user can view this forum.|, + lastUpdated => 1149632734, + }, + + 'forum.user.canPost' => { + message => q|A conditional indicating whether the user can post to this forum.|, + lastUpdated => 1149632734, + }, + + 'default.listing' => { + message => q|A full forum rendered using the forum template.|, + lastUpdated => 1149632734, + }, + + 'default.description' => { + message => q|The description of the default forum.|, + lastUpdated => 1149632734, + }, + + 'default.title' => { + message => q|The title of the default forum.|, + lastUpdated => 1149632734, + }, + + 'default.controls' => { + message => q|The editing controls for the default forum.|, + lastUpdated => 1149632734, + }, + + 'areMultipleForums' => { + message => q|A conditional indicating whether there is more than one forum.|, + lastUpdated => 1149632734, + }, + '74' => { - message => q|The following is the list of template variables available in message board templates. -

- -

forum.add.url
-A url that will add a forum to this message board. -

- -

forum.add.label
-The default label for forum.add.url. -

- -

title.label
-The default label for the title column. -

- -

views.label
-The default label for the views column. -

- -

rating.label
-The default label for the ratings column. -

- -

threads.label
-The default label for the threads column. -

- -

replies.label
-The default label for the replies column. -

- -

lastpost.label
-The default label for the last post column. -

- - -

forum_loop
-A loop containing the data for each of the forums contained in this message board. -

- -
- -

forum.controls
-The editing controls for this forum. -

- -

forum.count
-An integer displaying the forum count as it goes through the loop. -

- -

forum.title
-The title of this forum. -

- -

forum.description
-The description of this forum. -

- -

forum.replies
-The number of replies all the threads in this forum have received. -

- -

forum.rating
-The average rating of all the posts in the forum. -

- -

forum.views
-The total number of views of all the posts in the forum. -

- -

forum.threads
-The total number of threads in this forum. -

- -

forum.url
-The url to view this forum. -

- -

forum.lastpost.url
-The url to view the last post in this forum. -

- -

forum.lastpost.date
-The human readable date of the last post in this forum. -

- -

forum.lastpost.time
-The human readable time of the last post in this forum. -

- -

forum.lastpost.epoch
-The epoch date of the last post in this forum. -

- -

forum.lastpost.subject
-The subject of the last post in this forum. -

- -

forum.lastpost.user.id
-The userid of the last poster. -

- -

forum.lastpost.user.name
-The username of the last poster. -

- -

forum.lastpost.user.alias
-The current alias of the last poster. -

- -

forum.lastpost.user.profile
-The url to the last poster's profile. -

- -

forum.lastpost.user.isVisitor
-A conditional indicating whether the last poster was a visitor. -

- -

forum.user.canView
-A conditional indicating whether the user can view this forum. -

- -

forum.user.canPost
-A conditional indicating whether the user can post to this forum. -

- - -
- -

default.listing
-A full forum rendered using the forum template. -

- -

default.description
-The description of the default forum. -

- -

default.title
-The title of the default forum. -

- -

default.controls
-The editing controls for the default forum. -

- -

areMultipleForums
-A conditional indicating whether there is more than one forum. -

- + message => q|

The following is the list of template variables available in message board templates:

|, - lastUpdated => 1146776084 + lastUpdated => 1149632767 }, '6' => { diff --git a/lib/WebGUI/i18n/English/Asset_SQLReport.pm b/lib/WebGUI/i18n/English/Asset_SQLReport.pm index 0eaac464b..8b54f583e 100644 --- a/lib/WebGUI/i18n/English/Asset_SQLReport.pm +++ b/lib/WebGUI/i18n/English/Asset_SQLReport.pm @@ -133,153 +133,155 @@ while the second question mark will contain the form variable "field1".

lastUpdated => 1082371148 }, + 'columns_loop' => { + message => q|A loop containing information about each column.|, + lastUpdated => 1149633030, + }, + + 'column.number' => { + message => q|An integer starting with 1 and counting through the number of columns.|, + lastUpdated => 1149633030, + }, + + 'column.name' => { + message => q|The name of this column as returned by the query.|, + lastUpdated => 1149633030, + }, + + 'rows.count' => { + message => q|The total number of rows returned by the query.|, + lastUpdated => 1149633030, + }, + + 'rows.count.isZero' => { + message => q|A boolean indicating that the query returned zero rows.|, + lastUpdated => 1149633030, + }, + + 'rows.count.isZero.label' => { + message => q|The default label for rows.count.isZero.|, + lastUpdated => 1149633030, + }, + + 'rows_loop' => { + message => q|A loop containing the data returned from the query.|, + lastUpdated => 1149633030, + }, + + 'row.number' => { + message => q|An integer starting with 1 and counting through the total list of rows.|, + lastUpdated => 1149633030, + }, + + 'row.field.__NAME__.value' => { + message => q|The data for a given field in this row where __NAME__ is the name of the field as it is returned by the query.|, + lastUpdated => 1149633030, + }, + + 'row.field_loop' => { + message => q|A loop containing all of the fields for this row.|, + lastUpdated => 1149633030, + }, + + 'field.number' => { + message => q|An integer starting with 1 and counting through the number of fields in this row. This is the same as column.number in the column_loop.|, + lastUpdated => 1149633030, + }, + + 'field.name' => { + message => q|The name of the field as it is returned by the query.|, + lastUpdated => 1149633030, + }, + + 'field.value' => { + message => q|The data in this field.|, + lastUpdated => 1149633030, + }, + + 'hasNest' => { + message => q|A boolean indicating whether query2 has returned any results.|, + lastUpdated => 1149633030, + }, + + 'queryN.columns_loop' => { + message => q|A loop containing information about each column for queryN.|, + lastUpdated => 1149633030, + }, + + 'column.number' => { + message => q|An integer starting with 1 and counting through the number of columns.|, + lastUpdated => 1149633030, + }, + + 'column.name' => { + message => q|The name of this column as returned by the query.|, + lastUpdated => 1149633030, + }, + + 'queryN.rows.count' => { + message => q|The total number of rows returned by queryN.|, + lastUpdated => 1149633030, + }, + + 'queryN.count.isZero' => { + message => q|A boolean indicating that queryN returned zero rows.|, + lastUpdated => 1149633030, + }, + + 'queryN.rows.count.isZero.label' => { + message => q|The default label for rows.count.isZero.|, + lastUpdated => 1149633030, + }, + + 'queryN.rows_loop' => { + message => q|A loop containing the data returned from queryN.|, + lastUpdated => 1149633030, + }, + + 'queryN.row.number' => { + message => q|An integer starting with 1 and counting through the total list of rows.|, + lastUpdated => 1149633030, + }, + + 'queryN.row.field.__NAME__.value' => { + message => q|The data for a given field in this row where __NAME__ is the name of the field as it is returned by the query.|, + lastUpdated => 1149633030, + }, + + 'queryN.row.field_loop' => { + message => q|A loop containing all of the fields for this row.|, + lastUpdated => 1149633030, + }, + + 'field.number' => { + message => q|An integer starting with 1 and counting through the number of fields in this row. This is the same as column.number in the column_loop.|, + lastUpdated => 1149633030, + }, + + 'field.name' => { + message => q|The name of the field as it is returned by the query.|, + lastUpdated => 1149633030, + }, + + 'field.value' => { + message => q|The data in this field.|, + lastUpdated => 1149633030, + }, + + 'queryN.hasNest' => { + message => q|A boolean indicating whether the queryN+1 has returned any results. This variable +will always be false for query5.|, + lastUpdated => 1149633030, + }, + '73' => { message => q|

The following variables are made available in SQL Reports:

-

columns_loop
-A loop containing information about each column. -

- -
- -

column.number
-An integer starting with 1 and counting through the number of columns. -

- -

column.name
-The name of this column as returned by the query. -

- -
- -

rows.count
-The total number of rows returned by the query. -

- -

rows.count.isZero
-A boolean indicating that the query returned zero rows. -

- -

rows.count.isZero.label
-The default label for rows.count.isZero. -

- -

rows_loop
-A loop containing the data returned from the query. -

- -
- -

row.number
-An integer starting with 1 and counting through the total list of rows. -

- -

row.field.NAME.value
-The data for a given field in this row where NAME is the name of the field as it is returned by the query. -

- -

row.field_loop
-A loop containing all of the fields for this row. -

- -
- -

field.number
-An integer starting with 1 and counting through the number of fields in this row. This is the same as column.number in the column_loop. -

- -

field.name
-The name of the field as it is returned by the query. -

- -

field.value
-The data in this field. -

- -
- -
- -

hasNest
-A boolean indicating whether query2 has returned any results. -

- -

Any subqueries will have exactly the same format as the loops -and variables above, but will be prefixed with queryN where N -goes from 2 to 5.

- -

queryN.columns_loop
-A loop containing information about each column for queryN. -

- -
- -

column.number
-An integer starting with 1 and counting through the number of columns. -

- -

column.name
-The name of this column as returned by the query. -

- -
- -

queryN.rows.count
-The total number of rows returned by queryN. -

- -

queryN.count.isZero
-A boolean indicating that queryN returned zero rows. -

- -

queryN.rows.count.isZero.label
-The default label for rows.count.isZero. -

- -

queryN.rows_loop
-A loop containing the data returned from queryN. -

- -
- -

queryN.row.number
-An integer starting with 1 and counting through the total list of rows. -

- -

queryN.row.field.NAME.value
-The data for a given field in this row where NAME is the name of the field as it is returned by the query. -

- -

queryN.row.field_loop
-A loop containing all of the fields for this row. -

- -
- -

field.number
-An integer starting with 1 and counting through the number of fields in this row. This is the same as column.number in the column_loop. -

- -

field.name
-The name of the field as it is returned by the query. -

- -

field.value
-The data in this field. -

- -
- -
- -

queryN.hasNest
-A boolean indicating whether the queryN+1 has returned any results. This variable -will always be false for query5. -

- +

Variables for any subqueries will have exactly the same format as the first +query, but will be prefixed with queryN where N goes from 2 to 5.

|, - lastUpdated => 1146785660, + lastUpdated => 1149633053, }, '16' => {