^r; or ^r(); - Make Page Printable
-Creates a link to remove the style from a page to make it printable. In addition, you can change the link text by creating a macro like this ^r("Print Me!");.
+Creates a link to alter the style from a page to make it printable.
+
-By default, when this link is clicked, the current page's style is replaced with the "Make Page Printable" style in the Style Manager. However, that can be overridden by specifying the name of another style as the second parameter, like this: ^r("Print!","WebGUI"); +The macro takes up to three arguments. The first argument allows you to replace the default internationalized link text like this ^r("Print Me!");. If this argument is the string "linkonly", then only the URL to make the page printable will be returned and nothing more. If you wish to use the internationalized label but need to use multiple arguments to change the printable style or template, then use the empty string. +
-NOTES: You can also use the special case ^r(linkonly); to return only the URL to the make printable page and nothing more. Also, the .makePrintableLink style sheet class is tied to this macro. +Normally, the default style to make the page printable is the "Make Page Printable" style. The second argument specifies that a different style than the default be used to make the page printable: ^r("Print!","WebGUI");. +
+The third argument allows a different template be used to generate the HTML code for presenting the link and text. The following variables are available in the template: + +
+printable.url+ +NOTES:The .makePrintableLink style sheet class is tied to this macro. +
+
+
^RootTitle;
Returns the title of the root of the current page. For instance, the main root in WebGUI is the "Home" page. Many advanced sites have many roots and thus need a way to display to the user which root they are in.
@@ -2003,6 +2021,14 @@ Just as the LDAP Identity Name is a label, so is the LDAP Password Name. Use thi
^a; or ^a(); - My Account Link
A link to your account information. In addition you can change the link text by creating a macro like this ^a("Account Info");. If you specify "linkonly" in the first parameter then only the URL will be returned. Also, you can specify the name of a template in the Macro/a_account namespace as the second parameter to override the default template.
+The following is a list of variables available in the template: +
+account.url
@@ -2015,6 +2041,15 @@ Displays a small text message to a user who is in admin mode. Example: ^Admi
^AdminToggle; or ^AdminToggle();
Places a link on the page which is only visible to content managers and adminstrators. 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.url+The following variables are available in the template: +
+toggle.url
+
^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.
+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: If the user is not logged in, or or already belongs to the group, or the group is not set to allow auto adds, then no link will 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.
+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:
+
NOTE: If the user is not logged in or the user does not belong to the group, or the group is not set to allow auto deletes, then no link will be displayed.
@@ -2052,51 +2113,68 @@ 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!");
-
^L; or ^L(); - Login Box
-A small login form. You can also configure this macro. You can set the width of the login box like this ^L(20);. You can also set the message displayed after the user is logged in like this ^L(20,Hi ^a(^@;);. Click %here% if you wanna log out!)
-
+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 name 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-The following are the template variables available tot he L macro.
- -user.IsVisitor - -customText - -hello.label - -logout.url - -account.display.url - -logout.label - -form.header - -username.label - -username.form - -password.label - -password.form - -form.login - -account.create.url - -account.create.label - -form.footer - -
-
^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.
+toggle.url
+The URL to login or logout.
+
^@; - Username
The username of the currently logged in user.
@@ -2449,7 +2527,7 @@ Following a guide like the above will help you get good ranking on search engine
},
'1063' => {
- message => q|These are the variables availabe in the forum notification template.
+ message => q|These are the variables available in the forum notification template.
notify.subscription.message
@@ -3459,7 +3537,26 @@ Loops come with special condition variables of their own. They are __FIRST__, __
These macros are used to create navigation on the site.
^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.
+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 avaiable for use in the template:
+ +homeLink.url^/; - System URL
The URL to the gateway script (example: /index.pl/).
^\; - Page URL
The URL to the current page (example: /index.pl/pagename).
^Navigation(crumbTrail);
A dynamically generated crumb trail to the current page.