diff --git a/lib/WebGUI/Help/Macro_AdminBar.pm b/lib/WebGUI/Help/Macro_AdminBar.pm index 602fdddcd..25636cc6b 100644 --- a/lib/WebGUI/Help/Macro_AdminBar.pm +++ b/lib/WebGUI/Help/Macro_AdminBar.pm @@ -7,6 +7,33 @@ our $HELP = { body => 'admin bar body', fields => [ ], + variables => [ + { + 'name' => 'adminbar_loop', + 'variables' => [ + { + 'name' => 'label' + }, + { + 'name' => 'name' + }, + { + 'name' => 'items', + 'variables' => [ + { + 'name' => 'title' + }, + { + 'name' => 'url' + }, + { + 'name' => 'icon' + } + ] + } + ] + } + ], related => [ { tag => 'macros using', diff --git a/lib/WebGUI/Help/Macro_AdminToggle.pm b/lib/WebGUI/Help/Macro_AdminToggle.pm index e53d301f6..1d3975639 100644 --- a/lib/WebGUI/Help/Macro_AdminToggle.pm +++ b/lib/WebGUI/Help/Macro_AdminToggle.pm @@ -5,6 +5,14 @@ our $HELP = { 'admin toggle' => { title => 'admin toggle title', body => 'admin toggle body', + variables => [ + { + 'name' => 'toggle.url' + }, + { + 'name' => 'toggle.text' + } + ], fields => [ ], related => [ diff --git a/lib/WebGUI/Help/Macro_a_account.pm b/lib/WebGUI/Help/Macro_a_account.pm index 1481fb172..c9f7fc65b 100644 --- a/lib/WebGUI/Help/Macro_a_account.pm +++ b/lib/WebGUI/Help/Macro_a_account.pm @@ -7,6 +7,14 @@ our $HELP = { body => 'account body', fields => [ ], + variables => [ + { + 'name' => 'account.url' + }, + { + 'name' => 'account.text' + } + ], related => [ { tag => 'macros using', diff --git a/lib/WebGUI/Help/WebGUI.pm b/lib/WebGUI/Help/WebGUI.pm index 9f9e38b67..3e9403435 100644 --- a/lib/WebGUI/Help/WebGUI.pm +++ b/lib/WebGUI/Help/WebGUI.pm @@ -38,6 +38,14 @@ our $HELP = { 'style template' => { title => '1073', body => '1074', + variables => [ + { + 'name' => 'body.content' + }, + { + 'name' => 'head.tags' + } + ], fields => [ ], related => [ @@ -685,7 +693,102 @@ our $HELP = { 'pagination template variables' => { title => '1085', body => '1086', - fields => [ + variables => [ + { + 'name' => 'pagination.firstPage' + }, + { + 'name' => 'pagination.firstPageUrl' + }, + { + 'name' => 'pagination.firstPageText' + }, + { + 'name' => 'pagination.isFirstPage' + }, + { + 'name' => 'pagination.lastPage' + }, + { + 'name' => 'pagination.lastPageUrl' + }, + { + 'name' => 'pagination.lastPageText' + }, + { + 'name' => 'pagination.isLastPage' + }, + { + 'name' => 'pagination.nextPage' + }, + { + 'name' => 'pagination.nextPageUrl' + }, + { + 'name' => 'pagination.nextPageText' + }, + { + 'name' => 'pagination.previousPage' + }, + { + 'name' => 'pagination.previousPageUrl' + }, + { + 'name' => 'pagination.previousPageText' + }, + { + 'name' => 'pagination.pageNumber' + }, + { + 'name' => 'pagination.pageCount' + }, + { + 'name' => 'pagination.pageCount.isMultiple' + }, + { + 'name' => 'pagination.pageList', + 'variables' => [ + { + 'name' => 'pagination.pageLoop' + }, + { + 'name' => 'pagination.url' + }, + { + 'name' => 'pagination.text' + } + ] + }, + { + 'name' => 'pagination.pageList.upTo20' + }, + { + 'name' => 'pagination.pageLoop.upTo20', + 'variables' => [ + { + 'name' => 'pagination.url' + }, + { + 'name' => 'pagination.text' + } + ] + }, + { + 'name' => 'pagination.pageList.upTo10' + }, + { + 'name' => 'pagination.pageLoop.upTo10', + 'variables' => [ + { + 'name' => 'pagination.url' + }, + { + 'name' => 'pagination.text' + } + ] + } + ], + fields => [ ], related => [ { diff --git a/lib/WebGUI/i18n/English/Macro_AdminBar.pm b/lib/WebGUI/i18n/English/Macro_AdminBar.pm index ac1d8f0c6..9b731a7f4 100644 --- a/lib/WebGUI/i18n/English/Macro_AdminBar.pm +++ b/lib/WebGUI/i18n/English/Macro_AdminBar.pm @@ -2,10 +2,46 @@ package WebGUI::i18n::English::Macro_AdminBar; our $I18N = { - 'admin bar title' => { - message => q|Admin Bar Macro|, - lastUpdated => 1112374923, - }, + 'admin bar title' => { + message => q|Admin Bar Macro|, + lastUpdated => 1112374923, + }, + + 'adminbar_loop' => { + message => q|A loop containing the various lists of data to display.|, + lastUpdated => 1149178356, + }, + + 'label' => { + message => q|A heading label for this category.|, + lastUpdated => 1149178356, + }, + + 'name' => { + message => q|A javascript friendly name for this category.|, + lastUpdated => 1149178356, + }, + + 'items' => { + message => q|A loop containing the list if items in this category.|, + lastUpdated => 1149178356, + }, + + 'title' => { + message => q|The displayable link title for this item.|, + lastUpdated => 1149178356, + }, + + 'url' => { + message => q|The link URL for this item.|, + lastUpdated => 1149178356, + }, + + 'icon' => { + message => q|The URL of an icon to associate with this item.|, + lastUpdated => 1149178356, + }, + 'admin bar body' => { message => q| @@ -16,46 +52,8 @@ Places the administrative tool bar on the page. Omitting this macro will prevent content from the clipboard, accessing the help system and other administrative functions.
The macro may take one optional argument, an alternate template in the Macro/AdminBar namespace for generating the AdminBar. The following variables are available in the template:
- -
-adminbar_loop
-A loop containing the various lists of data to display.
-
-label
-A heading label for this category.
-
-name
-A javascript friendly name for this category.
-
items
-A loop containing the list if items in this category.
-
title
-The displayable link title for this item.
-
url
-The link URL for this item.
-
icon
-The URL of an icon to associate with this item.
-
toggle.url
-The URL to activate or deactivate Admin mode.
-
toggle.text
-The Internationalized label for turning on or off Admin (depending on the state of the macro), or the text that you supply to the macro.
-
The following is a list of variables available in the template:
- -account.url
-The URL to the account page.
-
account.text
-The translated label for the account link, or the text that you supply to the macro.
-
NOTES: The .myAccountLink style sheet class is tied to this macro.
+The following is a list of variables available in the template:
+ |, - lastUpdated => 1146627819, + lastUpdated => 1149177708, }, '46' => { diff --git a/lib/WebGUI/i18n/English/WebGUI.pm b/lib/WebGUI/i18n/English/WebGUI.pm index ef9d4a13d..9e97a2779 100644 --- a/lib/WebGUI/i18n/English/WebGUI.pm +++ b/lib/WebGUI/i18n/English/WebGUI.pm @@ -881,29 +881,28 @@ to add or remove users from their groups. lastUpdated => 1031514049 }, + 'body.content' => { + message => q|The the content on the current page.|, + lastUpdated => 1149182155, + }, + + 'head.tags' => { + message => q|Tags that WebGUI automatically generates for you so that caching works the way it should, search engines can find you better, and other useful automated functionality. This should go in the <head> </head> section of your style. + +We suggest using something like this in the <title> </title> portion of your style: +
+<tmpl_var session.page.title> - <tmpl_var session.setting.companyName> +
+That particular example will help you get good ranking on search engines.|, + lastUpdated => 1149182155, + }, + '1074' => { message => q|
Style templates are a special kind of template in WebGUI. They allow you to keep your content separated from the look and feel of your site. The following are the template variables available in style templates:
-body.content
-The the content on the current page.
-
head.tags
-Tags that WebGUI automatically generates for you so that caching works the way it should, search engines can find you better, and other useful automated functionality. This should go in the <head> </head> section of your style.
-
We suggest using something like this in the <title> </title> portion of your style: -
- -<tmpl_var session.page.title> - <tmpl_var session.setting.companyName> -
- -That particular example will help you get good ranking on search engines. -
- |, - lastUpdated => 1102702313, + lastUpdated => 1149182205, }, '860' => { @@ -2211,141 +2210,156 @@ div.tabs { lastUpdated => 1031514049 }, + 'pagination.firstPage' => { + message => q|A link to the first page in the paginator.|, + lastUpdated => 1149182026, + }, + + 'pagination.firstPageUrl' => { + message => q|The url component of pagination.firstPage broken out.|, + lastUpdated => 1149182026, + }, + + 'pagination.firstPageText' => { + message => q|The text component of pagination.firstPage broken out.|, + lastUpdated => 1149182026, + }, + + 'pagination.isFirstPage' => { + message => q|A boolean indicating whether the current page is the first page.|, + lastUpdated => 1149182026, + }, + + 'pagination.lastPage' => { + message => q|A link to the last page in the paginator.|, + lastUpdated => 1149182026, + }, + + 'pagination.lastPageUrl' => { + message => q|The url component of pagination.lastPage broken out.|, + lastUpdated => 1149182026, + }, + + 'pagination.lastPageText' => { + message => q|The text component of pagination.lastPage broken out.|, + lastUpdated => 1149182026, + }, + + 'pagination.isLastPage' => { + message => q|A boolean indicating whether the current page is the last page.|, + lastUpdated => 1149182026, + }, + + 'pagination.nextPage' => { + message => q|A link to the next page in the paginator relative to the current page.|, + lastUpdated => 1149182026, + }, + + 'pagination.nextPageUrl' => { + message => q|The url component of pagination.nextPage broken out.|, + lastUpdated => 1149182026, + }, + + 'pagination.nextPageText' => { + message => q|The text component of pagination.nextPage broken out.|, + lastUpdated => 1149182026, + }, + + 'pagination.previousPage' => { + message => q|A link to the previous page in the paginator relative to the current page.|, + lastUpdated => 1149182026, + }, + + 'pagination.previousPageUrl' => { + message => q|The url component of pagination.previousPage broken out.|, + lastUpdated => 1149182026, + }, + + 'pagination.previousPageText' => { + message => q|The text component of pagination.previousPage broken out.|, + lastUpdated => 1149182026, + }, + + 'pagination.pageNumber' => { + message => q|The current page number.|, + lastUpdated => 1149182026, + }, + + 'pagination.pageCount' => { + message => q|The total number of pages.|, + lastUpdated => 1149182026, + }, + + 'pagination.pageCount.isMultiple' => { + message => q|A boolean indicating whether there is more than one page.|, + lastUpdated => 1149182026, + }, + + 'pagination.pageList' => { + message => q|A list of links to every page in the paginator.|, + lastUpdated => 1149182026, + }, + + 'pagination.pageLoop' => { + message => q|Same as pagination.pageList except broken into individual elements.|, + lastUpdated => 1149182026, + }, + + 'pagination.url' => { + message => q|The URL of page X, where X is the number in the loop we're at.|, + lastUpdated => 1149182026, + }, + + 'pagination.text' => { + message => q|The number of page X, where X is the number in the loop we're at.|, + lastUpdated => 1149182026, + }, + + 'pagination.pageList.upTo20' => { + message => q|A list of links to the 20 nearest in the paginator relative to the current page. So if you're on page 60, you'll see links for 50-70.|, + lastUpdated => 1149182026, + }, + + 'pagination.pageLoop.upTo20' => { + message => q|Same as pagination.pageList.upTo20 except broken into individual elements.|, + lastUpdated => 1149182026, + }, + + 'pagination.url' => { + message => q|The URL of page X, where X is the number in the loop we're at.|, + lastUpdated => 1149182026, + }, + + 'pagination.text' => { + message => q|The number of page X, where X is the number in the loop we're at.|, + lastUpdated => 1149182026, + }, + + 'pagination.pageList.upTo10' => { + message => q|A list of links to the 10 nearest in the paginator relative to the current page. So if you're on page 20, you'll see links for 15-25.|, + lastUpdated => 1149182026, + }, + + 'pagination.pageLoop.upTo10' => { + message => q|Same as pagination.pageList.upTo10 except broken into individual elements.|, + lastUpdated => 1149182026, + }, + + 'pagination.url' => { + message => q|The URL of page X, where X is the number in the loop we're at.|, + lastUpdated => 1149182026, + }, + + 'pagination.text' => { + message => q|The number of page X, where X is the number in the loop we're at.|, + lastUpdated => 1149182026, + }, + + '1086' => { message => q|Many wobjects have pagination features. Though some wobjects define their own pagination variables, most use a common set of pagination variables:
- -pagination.firstPage
-A link to the first page in the paginator.
-
pagination.firstPageUrl
-The url component of pagination.firstPage broken out.
-
pagination.firstPageText
-The text component of pagination.firstPage broken out.
-
pagination.isFirstPage
-A boolean indicating whether the current page is the first page.
-
pagination.lastPage
-A link to the last page in the paginator.
-
pagination.lastPageUrl
-The url component of pagination.lastPage broken out.
-
pagination.lastPageText
-The text component of pagination.lastPage broken out.
-
pagination.isLastPage
-A boolean indicating whether the current page is the last page.
-
pagination.nextPage
-A link to the next page in the paginator relative to the current page.
-
pagination.nextPageUrl
-The url component of pagination.nextPage broken out.
-
pagination.nextPageText
-The text component of pagination.nextPage broken out.
-
pagination.previousPage
-A link to the previous page in the paginator relative to the current page.
-
pagination.previousPageUrl
-The url component of pagination.previousPage broken out.
-
pagination.previousPageText
-The text component of pagination.previousPage broken out.
-
pagination.pageNumber
-The current page number.
-
pagination.pageCount
-The total number of pages.
-
pagination.pageCount.isMultiple
-A boolean indicating whether there is more than one page.
-
pagination.pageList
-A list of links to every page in the paginator.
-
pagination.pageLoop
-Same as pagination.pageList except broken into individual elements.
-
pagination.url
-The URL of page X, where X is the number in the loop we're at.
-
pagination.text
-The number of page X, where X is the number in the loop we're at.
-
pagination.pageList.upTo20
-A list of links to the 20 nearest in the paginator relative to the current page. So if you're on page 60, you'll see links for 50-70.
-
pagination.pageLoop.upTo20
-Same as pagination.pageList.upTo20 except broken into individual elements.
-
pagination.url
-The URL of page X, where X is the number in the loop we're at.
-
pagination.text
-The number of page X, where X is the number in the loop we're at.
-
pagination.pageList.upTo10
-A list of links to the 10 nearest in the paginator relative to the current page. So if you're on page 20, you'll see links for 15-25.
-
pagination.pageLoop.upTo10
-Same as pagination.pageList.upTo10 except broken into individual elements.
-
pagination.url
-The URL of page X, where X is the number in the loop we're at.
-
pagination.text
-The number of page X, where X is the number in the loop we're at.
-