From 55b5f0504120a333a7fc95507343f8fcd05582a5 Mon Sep 17 00:00:00 2001 From: Colin Kuskie Date: Fri, 12 Jan 2007 17:40:58 +0000 Subject: [PATCH] macro nesting docs --- docs/changelog/7.x.x.txt | 2 ++ lib/WebGUI/i18n/English/Macro_AOIHits.pm | 3 ++- lib/WebGUI/i18n/English/Macro_AOIRank.pm | 3 ++- lib/WebGUI/i18n/English/Macro_AdSpace.pm | 3 ++- lib/WebGUI/i18n/English/Macro_AdminBar.pm | 3 ++- lib/WebGUI/i18n/English/Macro_AdminText.pm | 3 ++- lib/WebGUI/i18n/English/Macro_AdminToggle.pm | 3 ++- lib/WebGUI/i18n/English/Macro_AssetProxy.pm | 3 ++- lib/WebGUI/i18n/English/Macro_At_username.pm | 3 ++- lib/WebGUI/i18n/English/Macro_CanEditText.pm | 3 ++- lib/WebGUI/i18n/English/Macro_D_date.pm | 3 ++- lib/WebGUI/i18n/English/Macro_EditableToggle.pm | 3 ++- lib/WebGUI/i18n/English/Macro_Env.pm | 3 ++- lib/WebGUI/i18n/English/Macro_Execute.pm | 3 ++- lib/WebGUI/i18n/English/Macro_FetchMimeType.pm | 3 ++- lib/WebGUI/i18n/English/Macro_FileUrl.pm | 3 ++- lib/WebGUI/i18n/English/Macro_FormParam.pm | 3 ++- lib/WebGUI/i18n/English/Macro_GroupAdd.pm | 4 +++- lib/WebGUI/i18n/English/Macro_GroupDelete.pm | 4 +++- lib/WebGUI/i18n/English/Macro_GroupText.pm | 3 ++- lib/WebGUI/i18n/English/Macro_H_homeLink.pm | 6 +++++- lib/WebGUI/i18n/English/Macro_Hash_userId.pm | 3 ++- lib/WebGUI/i18n/English/Macro_Include.pm | 3 ++- lib/WebGUI/i18n/English/Macro_International.pm | 3 ++- lib/WebGUI/i18n/English/Macro_L_loginBox.pm | 9 +++++++-- lib/WebGUI/i18n/English/Macro_LastModified.pm | 3 ++- lib/WebGUI/i18n/English/Macro_LoginToggle.pm | 5 ++++- lib/WebGUI/i18n/English/Macro_Page.pm | 3 ++- lib/WebGUI/i18n/English/Macro_PageTitle.pm | 9 ++++++--- lib/WebGUI/i18n/English/Macro_PageUrl.pm | 3 ++- lib/WebGUI/i18n/English/Macro_Quote.pm | 3 ++- lib/WebGUI/i18n/English/Macro_RandomAssetProxy.pm | 3 ++- lib/WebGUI/i18n/English/Macro_RandomThread.pm | 3 ++- lib/WebGUI/i18n/English/Macro_RootTitle.pm | 3 ++- lib/WebGUI/i18n/English/Macro_SQL.pm | 3 ++- lib/WebGUI/i18n/English/Macro_Slash_gatewayUrl.pm | 3 ++- lib/WebGUI/i18n/English/Macro_Spacer.pm | 3 ++- lib/WebGUI/i18n/English/Macro_Splat_random.pm | 3 ++- lib/WebGUI/i18n/English/Macro_SubscriptionItem.pm | 4 +++- .../i18n/English/Macro_SubscriptionItemPurchaseUrl.pm | 3 ++- lib/WebGUI/i18n/English/Macro_Thumbnail.pm | 7 ++++--- lib/WebGUI/i18n/English/Macro_URLEncode.pm | 3 ++- lib/WebGUI/i18n/English/Macro_User.pm | 3 ++- lib/WebGUI/i18n/English/Macro_a_account.pm | 7 +++++-- lib/WebGUI/i18n/English/Macro_c_companyName.pm | 3 ++- lib/WebGUI/i18n/English/Macro_e_companyEmail.pm | 3 ++- lib/WebGUI/i18n/English/Macro_r_printable.pm | 8 ++++++-- lib/WebGUI/i18n/English/Macro_u_companyUrl.pm | 3 ++- lib/WebGUI/i18n/English/Macros.pm | 10 +++++++++- 49 files changed, 131 insertions(+), 55 deletions(-) diff --git a/docs/changelog/7.x.x.txt b/docs/changelog/7.x.x.txt index c23561751..bbf4c8062 100644 --- a/docs/changelog/7.x.x.txt +++ b/docs/changelog/7.x.x.txt @@ -4,6 +4,8 @@ - fix: .wgacess (perlDreamer Consulting, LLC) - fix: Fixed a bug where date form fields would not process epoch values correctly. (Martin Kamerbeek / Oqapi) + - fix: Macro documentation now states whether or not a macro can be nested + inside other macro and if so, under what conditions. 7.3.4 - fix: SQLForm - cannot add new asset (Martin Kamerbeek / Oqapi) diff --git a/lib/WebGUI/i18n/English/Macro_AOIHits.pm b/lib/WebGUI/i18n/English/Macro_AOIHits.pm index 2fc4c21f6..096746f49 100644 --- a/lib/WebGUI/i18n/English/Macro_AOIHits.pm +++ b/lib/WebGUI/i18n/English/Macro_AOIHits.pm @@ -38,8 +38,9 @@ You visited sports stories: ^AOIHits(contentType,Business); times

You must give ^AOIRank(); two arguments, the Metadata property to use and the Metadata value whose count you want displayed to the user.

+

This Macro may be nested inside other Macros.

|, - lastUpdated => 1165363159, + lastUpdated => 1168558407, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_AOIRank.pm b/lib/WebGUI/i18n/English/Macro_AOIRank.pm index ac94d5971..455207716 100644 --- a/lib/WebGUI/i18n/English/Macro_AOIRank.pm +++ b/lib/WebGUI/i18n/English/Macro_AOIRank.pm @@ -40,8 +40,9 @@ ranked, pass the macro the rank that you want to see.

As users visit your site, each story they read will be counted up and added to the counter for the correct contentType. As you visit you separate page, you'll see the three most popular types of stories.

+

This Macro may be nested inside other Macros if the Metadata field does not contain commas or quotes.

|, - lastUpdated => 1165361640, + lastUpdated => 1168558455, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_AdSpace.pm b/lib/WebGUI/i18n/English/Macro_AdSpace.pm index 5aa04f3b6..792682b02 100644 --- a/lib/WebGUI/i18n/English/Macro_AdSpace.pm +++ b/lib/WebGUI/i18n/English/Macro_AdSpace.pm @@ -15,8 +15,9 @@ takes a single argument, which is the name of the Ad Space from the AdSpace mana from the AdSpace manager. As a convenience, the AdSpace manager will display the macro code to put into a page to display each Ad Space.

+

This Macro may not be nested inside other Macros.

|, - lastUpdated => 1165363527, + lastUpdated => 1168558375, }, 'macroName' => { diff --git a/lib/WebGUI/i18n/English/Macro_AdminBar.pm b/lib/WebGUI/i18n/English/Macro_AdminBar.pm index 9b731a7f4..8193db3ed 100644 --- a/lib/WebGUI/i18n/English/Macro_AdminBar.pm +++ b/lib/WebGUI/i18n/English/Macro_AdminBar.pm @@ -50,10 +50,11 @@ our $I18N = { ^AdminBar(custom template ID);
Places the administrative tool bar on the page. Omitting this macro will prevent you from adding content, pasting content from the clipboard, accessing the help system and other administrative functions.

+

This Macro may not be nested inside other Macros.

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:

|, - lastUpdated => 1149178399, + lastUpdated => 1168558295, }, '376' => { diff --git a/lib/WebGUI/i18n/English/Macro_AdminText.pm b/lib/WebGUI/i18n/English/Macro_AdminText.pm index 2ac7858a7..b8ac2d824 100644 --- a/lib/WebGUI/i18n/English/Macro_AdminText.pm +++ b/lib/WebGUI/i18n/English/Macro_AdminText.pm @@ -17,8 +17,9 @@ our $I18N = {

^AdminText(text message);
Displays a small text message to a user who is in admin mode. Example: ^AdminText("You are in admin mode!");

+

This Macro may be nested inside other Macros if the text does not contain commas or quotes.

|, - lastUpdated => 1146631276, + lastUpdated => 1168558334, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_AdminToggle.pm b/lib/WebGUI/i18n/English/Macro_AdminToggle.pm index 49c947f06..af6c682f3 100644 --- a/lib/WebGUI/i18n/English/Macro_AdminToggle.pm +++ b/lib/WebGUI/i18n/English/Macro_AdminToggle.pm @@ -29,12 +29,13 @@ our $I18N = { ^AdminToggle([enable admin], [disable admin], [template name]);
Places a link on the page which is only visible to content managers and administrators. The link toggles on/off admin mode. You can optionally specify other messages to display like this: ^AdminToggle("Edit On","Edit Off"); This macro optionally takes a third parameter that allows you to specify an alternate template name in the Macro/AdminToggle namespace.

+

This Macro may be nested inside other Macros if the text does not contain commas or quotes.

The following variables are available in the template:

|, - lastUpdated => 1149178461, + lastUpdated => 1168558355, }, '516' => { diff --git a/lib/WebGUI/i18n/English/Macro_AssetProxy.pm b/lib/WebGUI/i18n/English/Macro_AssetProxy.pm index c5c101bf6..950b405ed 100644 --- a/lib/WebGUI/i18n/English/Macro_AssetProxy.pm +++ b/lib/WebGUI/i18n/English/Macro_AssetProxy.pm @@ -27,9 +27,10 @@ images, links to files for downloading or for snippets.

It can also be like a Shortcut Asset, displaying content from another part of the site on this page. Unlike a Shortcut, it cannot override any part of the original Asset.

+

This Macro may not be nested inside other Macros.

|, - lastUpdated => 1146679031, + lastUpdated => 1168558479, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_At_username.pm b/lib/WebGUI/i18n/English/Macro_At_username.pm index f2da9097d..564016993 100644 --- a/lib/WebGUI/i18n/English/Macro_At_username.pm +++ b/lib/WebGUI/i18n/English/Macro_At_username.pm @@ -17,8 +17,9 @@ our $I18N = {

^@; - Username
The username of the currently logged in user.

+

This Macro may be nested inside other Macros if all usernames do not contain commas or quotes.

|, - lastUpdated => 1146679072, + lastUpdated => 1168558540, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_CanEditText.pm b/lib/WebGUI/i18n/English/Macro_CanEditText.pm index 1d185f6af..5f0a9042e 100644 --- a/lib/WebGUI/i18n/English/Macro_CanEditText.pm +++ b/lib/WebGUI/i18n/English/Macro_CanEditText.pm @@ -26,8 +26,9 @@ Display a message to a user that can edit the current Asset.

Do not use this Macro outside of an Asset as it will have unpredictable results.

+

This Macro may be nested inside other Macros if the text does not contain commas or quotes.

|, - lastUpdated => 1146679107, + lastUpdated => 1168558566, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_D_date.pm b/lib/WebGUI/i18n/English/Macro_D_date.pm index cfca3be01..2bcf7437b 100644 --- a/lib/WebGUI/i18n/English/Macro_D_date.pm +++ b/lib/WebGUI/i18n/English/Macro_D_date.pm @@ -52,9 +52,10 @@ The current date and time.

You can also pass in an epoch date into this macro as a secondary parameter. If no date is specified then today's date and time will be used.

+

This Macro may be nested inside other Macros if the formatted date does not contain commas or quotes.

|, - lastUpdated => 1146679159, + lastUpdated => 1168558613, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_EditableToggle.pm b/lib/WebGUI/i18n/English/Macro_EditableToggle.pm index c0bf60a1f..32858e691 100644 --- a/lib/WebGUI/i18n/English/Macro_EditableToggle.pm +++ b/lib/WebGUI/i18n/English/Macro_EditableToggle.pm @@ -27,12 +27,13 @@ our $I18N = {

^EditableToggle; or ^EditableToggle();
Exactly the same as AdminToggle, except that the toggle is only displayed if the user has the rights to edit the current Asset. This macro takes up to three parameters. The first is a label for "Turn Admin On", the second is a label for "Turn Admin Off", and the third is the name of a template in the Macro/EditableToggle namespace to replace the default template.

+

This Macro may not be nested inside other Macros.

The following variables are available in the template:

|, - lastUpdated => 1149218452, + lastUpdated => 1168558646, }, '516' => { diff --git a/lib/WebGUI/i18n/English/Macro_Env.pm b/lib/WebGUI/i18n/English/Macro_Env.pm index 778a84295..38a6821fa 100644 --- a/lib/WebGUI/i18n/English/Macro_Env.pm +++ b/lib/WebGUI/i18n/English/Macro_Env.pm @@ -20,9 +20,10 @@ Can be used to display a web server environment variable on a page. The environm

The macro should be specified like this ^Env("REMOTE_ADDR");

+

This Macro may be nested inside other Macros if the text returned does not contain commas or quotes.

|, - lastUpdated => 1155749273, + lastUpdated => 1168558879, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_Execute.pm b/lib/WebGUI/i18n/English/Macro_Execute.pm index 2439464a3..2cdd8aeb4 100644 --- a/lib/WebGUI/i18n/English/Macro_Execute.pm +++ b/lib/WebGUI/i18n/English/Macro_Execute.pm @@ -23,8 +23,9 @@ our $I18N = {

^Execute();
Allows a content manager or administrator to execute an external program. Takes the format of ^Execute("/this/file.sh");.

+

This Macro may be nested inside other Macros if the text it returns does not contain commas or quotes.

|, - lastUpdated => 1146679274, + lastUpdated => 1168558923, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_FetchMimeType.pm b/lib/WebGUI/i18n/English/Macro_FetchMimeType.pm index a6893865c..a4a8e1c3b 100644 --- a/lib/WebGUI/i18n/English/Macro_FetchMimeType.pm +++ b/lib/WebGUI/i18n/English/Macro_FetchMimeType.pm @@ -13,8 +13,9 @@ our $I18N = { ^FetchMimeType(file system path to file);
Returns the MIME type for a file. An absolute or relative file path to the file is required. A URL to the file will not work.

+

This Macro may be nested inside other Macros.

|, - lastUpdated => 1146679300, + lastUpdated => 1168558941, }, 'macroName' => { diff --git a/lib/WebGUI/i18n/English/Macro_FileUrl.pm b/lib/WebGUI/i18n/English/Macro_FileUrl.pm index a9b764848..fdad6174f 100644 --- a/lib/WebGUI/i18n/English/Macro_FileUrl.pm +++ b/lib/WebGUI/i18n/English/Macro_FileUrl.pm @@ -17,8 +17,9 @@ our $I18N = {

^FileUrl();
^FileUrl(Asset URL);
This macro is used to return a filesystem URL to an Asset which stores a single file (File, Image, ZipArchive, etc.) identified by its Asset URL. The Macro will not work on Assets which store multiple files, such as the Post or Article Assets.

+

This Macro may be nested inside other Macros.

|, - lastUpdated => 1165599338, + lastUpdated => 1168622358, }, 'invalid url' => { diff --git a/lib/WebGUI/i18n/English/Macro_FormParam.pm b/lib/WebGUI/i18n/English/Macro_FormParam.pm index 784a92c19..ac6de3b2d 100644 --- a/lib/WebGUI/i18n/English/Macro_FormParam.pm +++ b/lib/WebGUI/i18n/English/Macro_FormParam.pm @@ -19,8 +19,9 @@ our $I18N = { This macro is mainly used in generating dynamic queries in SQL Reports. Using this macro, you can pull the value of any form field simply by specifying the name of the form field, like this: ^FormParam("phoneNumber");

If the macro is used to pull data from a form field that returns multiple values, like a dropdown list, then only the first value will be returned.

+

This Macro may be nested inside other Macros if the text returned does not contain commas or quotes.

|, - lastUpdated => 1165517791, + lastUpdated => 1168622375, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_GroupAdd.pm b/lib/WebGUI/i18n/English/Macro_GroupAdd.pm index bab863f74..6c81771ef 100644 --- a/lib/WebGUI/i18n/English/Macro_GroupAdd.pm +++ b/lib/WebGUI/i18n/English/Macro_GroupAdd.pm @@ -40,10 +40,12 @@ Using this macro you can allow users to add themselves to a group. The first par +

This Macro may not be nested inside other Macros.

+

These variables are available in the template:

|, - lastUpdated => 1149218365, + lastUpdated => 1168622402, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_GroupDelete.pm b/lib/WebGUI/i18n/English/Macro_GroupDelete.pm index da522eda0..615a40390 100644 --- a/lib/WebGUI/i18n/English/Macro_GroupDelete.pm +++ b/lib/WebGUI/i18n/English/Macro_GroupDelete.pm @@ -38,10 +38,12 @@ Using this macro you can allow users to delete themselves from a group. The firs +

This Macro may not be nested inside other Macros.

+

>These variables are available in the template:

|, - lastUpdated => 1149217752, + lastUpdated => 1168622413, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_GroupText.pm b/lib/WebGUI/i18n/English/Macro_GroupText.pm index 29e863f3a..d6c8c3c15 100644 --- a/lib/WebGUI/i18n/English/Macro_GroupText.pm +++ b/lib/WebGUI/i18n/English/Macro_GroupText.pm @@ -25,8 +25,9 @@ Displays a small text message to the user if they belong to the specified group.

Example: ^GroupText("Visitors","You need an account to do anything cool on this site!","We value our registered users!");

+

This Macro may be nested inside other Macros if the text returned does not contain commas or quotes.

|, - lastUpdated => 1146686292, + lastUpdated => 1168622429, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_H_homeLink.pm b/lib/WebGUI/i18n/English/Macro_H_homeLink.pm index fde203941..231f63a91 100644 --- a/lib/WebGUI/i18n/English/Macro_H_homeLink.pm +++ b/lib/WebGUI/i18n/English/Macro_H_homeLink.pm @@ -25,7 +25,11 @@ our $I18N = { 'home link body' => { message => q|

^H; or ^H(); - Home Link
A link to the home page of this site. In addition you can change the link text by creating a macro like this ^H("Go Home");.

-

NOTES: You can also use the special case ^H(linkonly); to return only the URL to the home page and nothing more. Also, the .homeLink style sheet class is tied to this macro. And you can specify a second parameter that with the name of a template in the Macro/H_homeLink namespace that will override the default template. The following variables are available for use in the template:

+

NOTES: You can also use the special case ^H(linkonly); to return only the URL to the home page and nothing more. Also, the .homeLink style sheet class is tied to this macro. And you can specify a second parameter that with the name of a template in the Macro/H_homeLink namespace that will override the default template.

+ +

This Macro may only be nested inside other Macros if the "linkonly" option is used.

+ +

The following variables are available for use in the template:

|, lastUpdated => 1149217683, }, diff --git a/lib/WebGUI/i18n/English/Macro_Hash_userId.pm b/lib/WebGUI/i18n/English/Macro_Hash_userId.pm index 35f6df122..2a4153668 100644 --- a/lib/WebGUI/i18n/English/Macro_Hash_userId.pm +++ b/lib/WebGUI/i18n/English/Macro_Hash_userId.pm @@ -17,8 +17,9 @@ our $I18N = {

^#; - User ID
The user id of the currently logged in user.

+

This Macro may be nested inside other Macros.

|, - lastUpdated => 1146686310, + lastUpdated => 1168622446, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_Include.pm b/lib/WebGUI/i18n/English/Macro_Include.pm index 054e8ed91..37cbed1b3 100644 --- a/lib/WebGUI/i18n/English/Macro_Include.pm +++ b/lib/WebGUI/i18n/English/Macro_Include.pm @@ -35,8 +35,9 @@ Allows a content manager or administrator to include a file from the local files

Example: ^Include("/this/file.html");

+

This Macro may be nested inside other Macros if the included text does not contain commas or quotes.

|, - lastUpdated => 1146686398, + lastUpdated => 1168622508, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_International.pm b/lib/WebGUI/i18n/English/Macro_International.pm index 90ba00f7f..0bf7f1c63 100644 --- a/lib/WebGUI/i18n/English/Macro_International.pm +++ b/lib/WebGUI/i18n/English/Macro_International.pm @@ -20,8 +20,9 @@ Pull a translated message from the internationalization system.

Example: ^International(45,"Article");

+

This Macro may be nested inside other Macros if the message does not contain commas or quotes.

|, - lastUpdated => 1146686421, + lastUpdated => 1168622528, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_L_loginBox.pm b/lib/WebGUI/i18n/English/Macro_L_loginBox.pm index e5c386e5e..ea538c8be 100644 --- a/lib/WebGUI/i18n/English/Macro_L_loginBox.pm +++ b/lib/WebGUI/i18n/English/Macro_L_loginBox.pm @@ -88,11 +88,16 @@ our $I18N = { A small login form. This macro takes up to three parameters. The first is used to set the width of text boxes for entering the username and password: ^L(20);. This width is scaled by 2/3 if the user's browser isn't IE due to differences in the way that different browsers draw the text boxes. The second sets the message displayed after the user is logged in: ^L(20,"Hi ^a(^@;);. Click %here% if you have to scoot!");. Text between percent signs (%) is replaced by a link to the logout operation. The third parameter is the ID of a template in the Macro/L_loginBox namespace to replace the default template. The variables below are available for use in the template.

-

NOTE: The .loginBox style sheet class is tied to this macro. +

+NOTES:
+

|, - lastUpdated => 1158340077, + lastUpdated => 1168622639, }, '48' => { diff --git a/lib/WebGUI/i18n/English/Macro_LastModified.pm b/lib/WebGUI/i18n/English/Macro_LastModified.pm index bac99c7b9..49a3b674f 100644 --- a/lib/WebGUI/i18n/English/Macro_LastModified.pm +++ b/lib/WebGUI/i18n/English/Macro_LastModified.pm @@ -25,8 +25,9 @@ Displays the date that the current page was last modified based upon the wobject

Example: ^LastModified("Updated: ","%c %D, %y");

+

This Macro may be nested inside other Macros if the text it returns does not contain commas or quotes.

|, - lastUpdated => 1146686444, + lastUpdated => 1168622573, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_LoginToggle.pm b/lib/WebGUI/i18n/English/Macro_LoginToggle.pm index 5477ad5fd..26ca45521 100644 --- a/lib/WebGUI/i18n/English/Macro_LoginToggle.pm +++ b/lib/WebGUI/i18n/English/Macro_LoginToggle.pm @@ -17,6 +17,9 @@ our $I18N = {

^LoginToggle; or ^LoginToggle();
Displays a "Login" or "Logout" message depending upon whether the user is logged in or not. You can optionally specify other labels like this: ^LoginToggle("Click here to log in.","Click here to log out.");. You can also use the special case ^LoginToggle(linkonly); to return only the URL with no label.

+

This Macro may be nested inside other Macros if the text returned does not contain commas or quotes.

+ +

These variables are available in the LoginToggle template:

toggle.url
The URL to login or logout. @@ -27,7 +30,7 @@ The Internationalized label for logging in or logging out (depending on the stat

|, - lastUpdated => 1146759379, + lastUpdated => 1168622690, }, '716' => { diff --git a/lib/WebGUI/i18n/English/Macro_Page.pm b/lib/WebGUI/i18n/English/Macro_Page.pm index bd36df60d..5ebe2ad92 100644 --- a/lib/WebGUI/i18n/English/Macro_Page.pm +++ b/lib/WebGUI/i18n/English/Macro_Page.pm @@ -20,8 +20,9 @@ This can be used to retrieve information about the current asset. For instance i an asset, or if the property doesn't exist, then it returns nothing.

Properties available for retrieval depend on the type of asset that is being queried.

+

This Macro may be nested inside other Macros if the property returned does not contain commas or quotes.

|, - lastUpdated => 1153339253, + lastUpdated => 1168622743, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_PageTitle.pm b/lib/WebGUI/i18n/English/Macro_PageTitle.pm index 97476bdad..46ea0e535 100644 --- a/lib/WebGUI/i18n/English/Macro_PageTitle.pm +++ b/lib/WebGUI/i18n/English/Macro_PageTitle.pm @@ -19,11 +19,14 @@ our $I18N = { Displays the title of the current page.

-

NOTE: If you begin using admin functions or the in-depth functions of any wobject, the page title will become a link that will quickly bring you back to the page. +

NOTES:
+

- |, - lastUpdated => 1146609765, + lastUpdated => 1168622805, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_PageUrl.pm b/lib/WebGUI/i18n/English/Macro_PageUrl.pm index 7f96d56aa..e1efc782c 100644 --- a/lib/WebGUI/i18n/English/Macro_PageUrl.pm +++ b/lib/WebGUI/i18n/English/Macro_PageUrl.pm @@ -17,8 +17,9 @@ our $I18N = {

^PageUrl;
The URL to the current page (example: /index.pl/pagename).

+

This Macro may be nested inside other Macros.

|, - lastUpdated => 1146759407, + lastUpdated => 1168622829, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_Quote.pm b/lib/WebGUI/i18n/English/Macro_Quote.pm index 911340352..b3bd0180f 100644 --- a/lib/WebGUI/i18n/English/Macro_Quote.pm +++ b/lib/WebGUI/i18n/English/Macro_Quote.pm @@ -17,8 +17,9 @@ our $I18N = {

^Quote();
Use this to escape a string before using it in a database query.

+

This Macro may be nested inside other Macros if the quoted string does not contain commas or unescaped quotes.

|, - lastUpdated => 1146609178, + lastUpdated => 1168622849, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_RandomAssetProxy.pm b/lib/WebGUI/i18n/English/Macro_RandomAssetProxy.pm index 927d123ea..81061331e 100644 --- a/lib/WebGUI/i18n/English/Macro_RandomAssetProxy.pm +++ b/lib/WebGUI/i18n/English/Macro_RandomAssetProxy.pm @@ -19,8 +19,9 @@ our $I18N = { This macro works similarly to the ^AssetProxy(); macro except instead of displaying the Asset, it picks a random Asset from the descendants of the Asset whose URL is supplied as the argument.

+

This Macro may not be nested inside other Macros.

|, - lastUpdated => 1167187099, + lastUpdated => 1168622873, }, 'childless' => { diff --git a/lib/WebGUI/i18n/English/Macro_RandomThread.pm b/lib/WebGUI/i18n/English/Macro_RandomThread.pm index 90749e360..cf4c9d4b1 100644 --- a/lib/WebGUI/i18n/English/Macro_RandomThread.pm +++ b/lib/WebGUI/i18n/English/Macro_RandomThread.pm @@ -62,8 +62,9 @@ of questions), then the example above can be used to display a random question f
Gets a random post from all Collaboration Systems in root 'home' with debug output.
+

This Macro may be nested inside other Macros if the post does not contain commas or quotes.

|, - lastUpdated => 1167187168, + lastUpdated => 1168622915, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_RootTitle.pm b/lib/WebGUI/i18n/English/Macro_RootTitle.pm index 8f29ca805..199e8ceba 100644 --- a/lib/WebGUI/i18n/English/Macro_RootTitle.pm +++ b/lib/WebGUI/i18n/English/Macro_RootTitle.pm @@ -19,8 +19,9 @@ Returns the title of the root of the current page. For instance, the main root i

If the macro is called outside of an asset, or if the root can't be found, then the macro returns an empty string

+

This Macro may be nested inside other Macros if the title does not contain commas or quotes.

|, - lastUpdated => 1153849842, + lastUpdated => 1168622930, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_SQL.pm b/lib/WebGUI/i18n/English/Macro_SQL.pm index f81e6a8bb..a130f340d 100644 --- a/lib/WebGUI/i18n/English/Macro_SQL.pm +++ b/lib/WebGUI/i18n/English/Macro_SQL.pm @@ -23,8 +23,9 @@ A one line SQL report. Sometimes you just need to pull something back from the d

If there are more numeric macros than selected columns in the SQL report the extra macros will be discarded.

The rownum macro, ^rownum;, begins counting at 1.

+

This Macro may be nested inside other Macros if the text returned does not contain commas or quotes.

|, - lastUpdated => 1151986323, + lastUpdated => 1168623083, }, 'illegal query' => { diff --git a/lib/WebGUI/i18n/English/Macro_Slash_gatewayUrl.pm b/lib/WebGUI/i18n/English/Macro_Slash_gatewayUrl.pm index 41cf5f4f4..e407b591d 100644 --- a/lib/WebGUI/i18n/English/Macro_Slash_gatewayUrl.pm +++ b/lib/WebGUI/i18n/English/Macro_Slash_gatewayUrl.pm @@ -17,8 +17,9 @@ our $I18N = {

^/; - System URL
The URL to the gateway script (example: /index.pl/).

+

This Macro may be nested inside other Macros.

|, - lastUpdated => 1146760697, + lastUpdated => 1168623028, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_Spacer.pm b/lib/WebGUI/i18n/English/Macro_Spacer.pm index 67cea4a7b..219ec446b 100644 --- a/lib/WebGUI/i18n/English/Macro_Spacer.pm +++ b/lib/WebGUI/i18n/English/Macro_Spacer.pm @@ -19,8 +19,9 @@ Create a spacer in your layout. Great for creating blocks of color with divs and

Example: ^Spacer("100","50");

+

This Macro may not be nested inside other Macros.

|, - lastUpdated => 1146608671, + lastUpdated => 1168623039, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_Splat_random.pm b/lib/WebGUI/i18n/English/Macro_Splat_random.pm index d4ec83789..5321c0501 100644 --- a/lib/WebGUI/i18n/English/Macro_Splat_random.pm +++ b/lib/WebGUI/i18n/English/Macro_Splat_random.pm @@ -18,8 +18,9 @@ our $I18N = {

^*; or ^*(); - Random Number
A randomly generated, whole number between 0 and the number you send the Macro. This is often used on images (such as banner ads) that you want to ensure do not cache. You may configure this macro like this ^*(100); to create a random number between 0 and 100. If no number is sent a default of 1 billion (1,000,000,000) will be used.

+

This Macro may be nested inside other Macros.

|, - lastUpdated => 1153635269, + lastUpdated => 1168623052, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_SubscriptionItem.pm b/lib/WebGUI/i18n/English/Macro_SubscriptionItem.pm index edf7f7ddc..92eddef44 100644 --- a/lib/WebGUI/i18n/English/Macro_SubscriptionItem.pm +++ b/lib/WebGUI/i18n/English/Macro_SubscriptionItem.pm @@ -41,9 +41,11 @@ It accepts two arguments, the Id of the subscription item and an optional template to use instead of the default template, specified by a template Id from the Macro/SubscriptionItem namespace.

+

This Macro may not be nested inside other Macros.

+

These variables are available in the template:

|, - lastUpdated => 1149217429, + lastUpdated => 1168623113, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_SubscriptionItemPurchaseUrl.pm b/lib/WebGUI/i18n/English/Macro_SubscriptionItemPurchaseUrl.pm index 27ba78391..0b30f841f 100644 --- a/lib/WebGUI/i18n/English/Macro_SubscriptionItemPurchaseUrl.pm +++ b/lib/WebGUI/i18n/English/Macro_SubscriptionItemPurchaseUrl.pm @@ -18,8 +18,9 @@ our $I18N = {

^SubscriptionItemPurchaseUrl(subscriptionId);
This macro fetches the URL to purchase a subscription item identified by its subscriptionId.

+

This Macro may be nested inside other Macros.

|, - lastUpdated => 1146607246, + lastUpdated => 1168623124, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_Thumbnail.pm b/lib/WebGUI/i18n/English/Macro_Thumbnail.pm index b4ccb79f5..bac700c7b 100644 --- a/lib/WebGUI/i18n/English/Macro_Thumbnail.pm +++ b/lib/WebGUI/i18n/English/Macro_Thumbnail.pm @@ -16,12 +16,13 @@ our $I18N = { message => q|

^Thumbnail(url);
-This macro will allow you to fetch the thumbnail for any File or Image Asset by its -url. +This macro will allow you to fetch the filesystem URL for the thumbnail of any File or Image Asset by its +Asset URL.

+

This Macro may be nested inside other Macros.

|, - lastUpdated => 1146607225, + lastUpdated => 1168623188, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_URLEncode.pm b/lib/WebGUI/i18n/English/Macro_URLEncode.pm index eb00e088b..ce8fd9414 100644 --- a/lib/WebGUI/i18n/English/Macro_URLEncode.pm +++ b/lib/WebGUI/i18n/English/Macro_URLEncode.pm @@ -18,9 +18,10 @@ our $I18N = {

^URLEncode();
This macro is mainly useful in SQL reports, but it could be useful elsewhere as well. It takes the input of a string and URL Encodes it so that the string can be passed through a URL. It's syntax looks like this: ^URLEncode("Is this my string?");

+

This Macro may be nested inside other Macros if the encoded text does not contain commas or quotes.

|, - lastUpdated => 1146607207, + lastUpdated => 1168623216, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_User.pm b/lib/WebGUI/i18n/English/Macro_User.pm index bd76b06f2..176a885d9 100644 --- a/lib/WebGUI/i18n/English/Macro_User.pm +++ b/lib/WebGUI/i18n/English/Macro_User.pm @@ -18,9 +18,10 @@ our $I18N = {

^User();
This macro will allow you to display any information from the current user's account or profile. For instance, if you wanted to display a user's email address you'd create this macro: ^User("email");

+

This Macro may be nested inside other Macros if the information returned does not contain commas or quotes.

|, - lastUpdated => 1153172116, + lastUpdated => 1168623231, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_a_account.pm b/lib/WebGUI/i18n/English/Macro_a_account.pm index aacbabc20..f525b4181 100644 --- a/lib/WebGUI/i18n/English/Macro_a_account.pm +++ b/lib/WebGUI/i18n/English/Macro_a_account.pm @@ -28,13 +28,16 @@ link and a template from the Macro/a_account namespace to be used to display the link and text. If the link text is set to the word "linkonly" then only the URL will be returned.

-

NOTES: The .myAccountLink style sheet class is tied to this macro. +

NOTES:
+