^AdminToggle();
^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.
+
The following variables are available in the template: -
-toggle.urltoggle.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.
-
^AssetProxy(Asset URL);
+
^AssetProxy(Asset URL);
This macro is used to render an Asset and display it inline according
to its template. Any Asset can be displayed, including Navigations,
-images, links to files for downloading or for snippets.
+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. +any part of the original Asset.
|, - lastUpdated => 1112583827, + lastUpdated => 1146679031, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_At_username.pm b/lib/WebGUI/i18n/English/Macro_At_username.pm index 33f6a54f8..f2da9097d 100644 --- a/lib/WebGUI/i18n/English/Macro_At_username.pm +++ b/lib/WebGUI/i18n/English/Macro_At_username.pm @@ -14,13 +14,11 @@ our $I18N = { 'username body' => { message => q| - -^@; - Username^@; - Username
The username of the currently logged in user.
-
- +
|, - lastUpdated => 1112466919, + lastUpdated => 1146679072, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_CanEditText.pm b/lib/WebGUI/i18n/English/Macro_CanEditText.pm index d55d6d2b9..1d185f6af 100644 --- a/lib/WebGUI/i18n/English/Macro_CanEditText.pm +++ b/lib/WebGUI/i18n/English/Macro_CanEditText.pm @@ -14,18 +14,20 @@ our $I18N = { 'can edit text body' => { message => q| - -^CanEditText(text message);^CanEditText(text message);
Display a message to a user that can edit the current Asset.
-
-Example:
+
Example:
^CanEditText("You may edit this Asset");
^CanEditText(^AdminToggle;);
-
-Do not use this Macro outside of an Asset as it will have unpredictable +
+ +Do not use this Macro outside of an Asset as it will have unpredictable results. +
|, - lastUpdated => 1134773763, + lastUpdated => 1146679107, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_D_date.pm b/lib/WebGUI/i18n/English/Macro_D_date.pm index 7abd36e4e..cfca3be01 100644 --- a/lib/WebGUI/i18n/English/Macro_D_date.pm +++ b/lib/WebGUI/i18n/English/Macro_D_date.pm @@ -14,14 +14,13 @@ our $I18N = { 'date body' => { message => q| - -^D();^D();
^D([date formatting code],[epoch date]);
The current date and time.
-
+
-You can configure the date by using date formatting symbols. For instance, if you created a macro like this ^D("%c %D, %y"); it would output September 26, 2001. The following are the available date formatting symbols: -+
You can configure the date by using date formatting symbols. For instance, if you created a macro like this ^D("%c %D, %y"); it would output September 26, 2001. The following are the available date formatting symbols: +
| %% | A literal percent sign '%' |
| %z | The current user's date format preference, (default: '%H:%n %p'). |
| %Z | The current user's time format preference, (default: '%M/%D/%y') |
-The default format code is %z %Z. -
-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. + +
The default format code is %z %Z. +
+ +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.
|, - lastUpdated => 1112466919, + lastUpdated => 1146679159, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_EditableToggle.pm b/lib/WebGUI/i18n/English/Macro_EditableToggle.pm index 42926878e..14ef491ed 100644 --- a/lib/WebGUI/i18n/English/Macro_EditableToggle.pm +++ b/lib/WebGUI/i18n/English/Macro_EditableToggle.pm @@ -14,21 +14,22 @@ our $I18N = { 'editable toggle body' => { message => q| - -^EditableToggle; or ^EditableToggle();^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.
-
-The following variables are available in the template: -
-toggle.urlThe following variables are available in the template: +
+ +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.
+
^Env()
Can be used to display a web server environment variable on a page. The environment variables available on each server are different, but you can find out which ones your web server has by going to: http://www.yourwebguisite.com/env.pl
-
+
-The macro should be specified like this ^Env("REMOTE_ADDR"); -+
The macro should be specified like this ^Env("REMOTE_ADDR"); +
|, - lastUpdated => 1112466919, + lastUpdated => 1146679257, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_Execute.pm b/lib/WebGUI/i18n/English/Macro_Execute.pm index a5b39bf04..2439464a3 100644 --- a/lib/WebGUI/i18n/English/Macro_Execute.pm +++ b/lib/WebGUI/i18n/English/Macro_Execute.pm @@ -20,11 +20,11 @@ our $I18N = { 'execute body' => { message => q| -^Execute();^Execute();
Allows a content manager or administrator to execute an external program. Takes the format of ^Execute("/this/file.sh");.
-
+
|, - lastUpdated => 1112466919, + lastUpdated => 1146679274, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_Extras.pm b/lib/WebGUI/i18n/English/Macro_Extras.pm index 976c2c91f..773e0c31b 100644 --- a/lib/WebGUI/i18n/English/Macro_Extras.pm +++ b/lib/WebGUI/i18n/English/Macro_Extras.pm @@ -15,11 +15,11 @@ our $I18N = { 'extras body' => { message => q| -^Extras; or ^Extras(path/to/something/in/extras/folder);^Extras; or ^Extras(path/to/something/in/extras/folder);
Returns the path to the WebGUI "extras" folder, which contains things like WebGUI icons.
-
+
|, - lastUpdated => 1146245155, + lastUpdated => 1146679288, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_FetchMimeType.pm b/lib/WebGUI/i18n/English/Macro_FetchMimeType.pm index bccd3c08e..a6893865c 100644 --- a/lib/WebGUI/i18n/English/Macro_FetchMimeType.pm +++ b/lib/WebGUI/i18n/English/Macro_FetchMimeType.pm @@ -9,13 +9,12 @@ our $I18N = { 'fetch mime type body' => { message => q| - -^FetchMimeType;^FetchMimeType;
^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.
+to the file is required. A URL to the file will not work.
^FileUrl();
+
^FileUrl();
^FileUrl(Asset URL);
-This macro is used to return a filesystem URL to an File, Image or Snippet Asset identified by its Asset URL.
+This macro is used to return a filesystem URL to an File, Image or Snippet Asset identified by its Asset URL.
^FormParam();
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");
-
- +
|, - lastUpdated => 1112466919, + lastUpdated => 1146679330, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_GroupAdd.pm b/lib/WebGUI/i18n/English/Macro_GroupAdd.pm index 5d071c2ac..0c887d7f0 100644 --- a/lib/WebGUI/i18n/English/Macro_GroupAdd.pm +++ b/lib/WebGUI/i18n/English/Macro_GroupAdd.pm @@ -15,27 +15,30 @@ our $I18N = { 'group add body' => { message => q| -^GroupAdd();^GroupAdd();
+Using this macro you can allow users to add themselves to a group. The first parameter is the name of the group this user should be added to. The second parameter is a text string for the user to click on to add themselves to this group. The third parameter allows you to specify the name of a template in the Macro/GroupAdd namespace to replace the default template. These variables are available in the template:
-NOTE: All these conditions must be met for the link to be displayed: +
group.url
+The URL with the action to add the user to the group.
+
group.text
+The supplied text string for the user to click on.
+
NOTE: All these conditions must be met for the link to be displayed: +
+ +- +
^GroupDelete();
+Using this macro you can allow users to delete themselves from a group. The first parameter is the name of the group this user should be deleted from. The second parameter is a text string for the user to click on to delete themselves from this group. The third parameter allows you to specify the name of a template in the Macro/GroupDelete namespace to replace the default template. These variables are available in the template:
group.url
The URL with the action to add the user to the group.
-
-NOTE: All these conditions must be met for the link to be displayed: +
group.text
+The supplied text string for the user to click on.
+
NOTE: All these conditions must be met for the link to be displayed:
+ +^GroupText();
Displays a small text message to the user if they belong to the specified group. And you can specify an alternate message to those who are not in the group.
-
-Example: ^GroupText("Visitors","You need an account to do anything cool on this site!","We value our registered users!"); -
- +
+Example: ^GroupText("Visitors","You need an account to do anything cool on this site!","We value our registered users!"); +
|, - lastUpdated => 1112466919, + lastUpdated => 1146686292, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_H_homeLink.pm b/lib/WebGUI/i18n/English/Macro_H_homeLink.pm index 73f6ff53a..aed321110 100644 --- a/lib/WebGUI/i18n/English/Macro_H_homeLink.pm +++ b/lib/WebGUI/i18n/English/Macro_H_homeLink.pm @@ -14,18 +14,19 @@ 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:
- -homeLink.url^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:
+ +homeLink.url
The URL to the home page.
-
homeLink.text
The translated label for the link to the home page or the text that you supply to the macro.
-
^#; - User ID
The user id of the currently logged in user.
-
- +
|, - lastUpdated => 1112466919, + lastUpdated => 1146686310, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_Include.pm b/lib/WebGUI/i18n/English/Macro_Include.pm index 312939423..054e8ed91 100644 --- a/lib/WebGUI/i18n/English/Macro_Include.pm +++ b/lib/WebGUI/i18n/English/Macro_Include.pm @@ -29,15 +29,14 @@ our $I18N = { 'include body' => { message => q| - -^Include();^Include();
Allows a content manager or administrator to include a file from the local filesystem.
-
+
+Example: ^Include("/this/file.html"); +
|, - lastUpdated => 1112466919, + lastUpdated => 1146686398, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_International.pm b/lib/WebGUI/i18n/English/Macro_International.pm index 4ca4f851b..90ba00f7f 100644 --- a/lib/WebGUI/i18n/English/Macro_International.pm +++ b/lib/WebGUI/i18n/English/Macro_International.pm @@ -14,15 +14,14 @@ our $I18N = { 'international body' => { message => q| - -^International();^International();
Pull a translated message from the internationalization system.
-
Example: ^International(45,"Article"); +
|, - lastUpdated => 1112466919, + lastUpdated => 1146686421, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_L_loginBox.pm b/lib/WebGUI/i18n/English/Macro_L_loginBox.pm index 37c792cf6..b47ce176c 100644 --- a/lib/WebGUI/i18n/English/Macro_L_loginBox.pm +++ b/lib/WebGUI/i18n/English/Macro_L_loginBox.pm @@ -14,62 +14,75 @@ our $I18N = { 'login box body' => { message => q| - -^L; or ^L(); - Login Box^L; or ^L(); - Login Box
A small login form. This macro takes up to three parameters. The first is used to set the width of the login box: ^L(20);. The second sets the message displayed after the user is logged in: ^L(20,"Hi ^a(^@;);. Click %here% if you wanna log out!");. 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 in the template. Not all of them are required, but variables that will cause the macro to output code that doesn't function properly (like not actually log someone in) are marked with an asterisk '*'
-
+
user.isVisitor
+True if the user is a visitor.
+
customText
+The user defined text to display if the user is logged in.
+
hello.label
+Internationalized welcome message.
+
customText
+The text supplied to the macro to display if the user is logged in.
+
account.display.url
+URL to display the account.
+
logout.label
+Internationalized logout message.
+
* form.header
+Form header.
+
username.label
+Internationalized label for "username".
+
* username.form
+Form element for the username.
+
password.label
+Internationalized label for "password".
+
* password.form
+Form element for the password.
+
* form.login
+Action to perform when logging in.
+
account.create.url
+URL to create an account.
+
account.create.label
+Internationalized label for "create an account"
+
* form.footer
+Form footer.
+
NOTE: The .loginBox style sheet class is tied to this macro. +
|, - lastUpdated => 1112466919, + lastUpdated => 1146686545, }, '48' => { diff --git a/lib/WebGUI/i18n/English/Macro_LastModified.pm b/lib/WebGUI/i18n/English/Macro_LastModified.pm index 8ba93a6e6..bac99c7b9 100644 --- a/lib/WebGUI/i18n/English/Macro_LastModified.pm +++ b/lib/WebGUI/i18n/English/Macro_LastModified.pm @@ -19,16 +19,14 @@ our $I18N = { 'last modified body' => { message => q| - -^LastModified;^LastModified;
^LastModified("text","date format");
Displays the date that the current page was last modified based upon the wobjects on the page. By default, the date is displayed based upon the user's date preferences. Optionally, it can take two parameters. The first is text to display before the date. The second is a date format string (see the date macro, ^D;, for details.
-
-Example: ^LastModified("Updated: ","%c %D, %y"); -
- +
+Example: ^LastModified("Updated: ","%c %D, %y"); +
|, - lastUpdated => 1112466919, + lastUpdated => 1146686444, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_c_companyName.pm b/lib/WebGUI/i18n/English/Macro_c_companyName.pm index 1d9fbce5e..2fc5429d4 100644 --- a/lib/WebGUI/i18n/English/Macro_c_companyName.pm +++ b/lib/WebGUI/i18n/English/Macro_c_companyName.pm @@ -14,13 +14,11 @@ our $I18N = { 'company name body' => { message => q| -^c;^c;
The name of your company specified in the settings by your Administrator.
-
- - +
|, - lastUpdated => 1112374920, + lastUpdated => 1146679121, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_e_companyEmail.pm b/lib/WebGUI/i18n/English/Macro_e_companyEmail.pm index 450f3ad3b..a1f7faf91 100644 --- a/lib/WebGUI/i18n/English/Macro_e_companyEmail.pm +++ b/lib/WebGUI/i18n/English/Macro_e_companyEmail.pm @@ -14,11 +14,11 @@ our $I18N = { 'company email body' => { message => q| -^e;^e;
The email address for your company specified in the settings by your Administrator.
-
+
|, - lastUpdated => 1112466411, + lastUpdated => 1146679191, }, };