macro nesting docs

This commit is contained in:
Colin Kuskie 2007-01-12 17:40:58 +00:00
parent 72e6a896f9
commit 55b5f05041
49 changed files with 131 additions and 55 deletions

View file

@ -38,8 +38,9 @@ You visited sports stories: &#94;AOIHits(contentType,Business); times</p>
<p>You must give &#94;AOIRank(); two arguments, the Metadata property to use and the
Metadata value whose count you want displayed to the user.</p>
<p>This Macro may be nested inside other Macros.</p>
|,
lastUpdated => 1165363159,
lastUpdated => 1168558407,
},
};

View file

@ -40,8 +40,9 @@ ranked, pass the macro the rank that you want to see.</p>
<p>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.</p>
<p>This Macro may be nested inside other Macros if the Metadata field does not contain commas or quotes.</p>
|,
lastUpdated => 1165361640,
lastUpdated => 1168558455,
},
};

View file

@ -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.</p>
<p>This Macro may not be nested inside other Macros.</p>
|,
lastUpdated => 1165363527,
lastUpdated => 1168558375,
},
'macroName' => {

View file

@ -50,10 +50,11 @@ our $I18N = {
<b>&#94;AdminBar(<i>custom template ID</i>);</b><br />
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.</p>
<p>This Macro may not be nested inside other Macros.</p>
<p>
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:</p>
|,
lastUpdated => 1149178399,
lastUpdated => 1168558295,
},
'376' => {

View file

@ -17,8 +17,9 @@ our $I18N = {
<p><b>&#94;AdminText(<i>text message</i>);</b><br />
Displays a small text message to a user who is in admin mode. Example: &#94;AdminText("You are in admin mode!");
</p>
<p>This Macro may be nested inside other Macros if the text does not contain commas or quotes.</p>
|,
lastUpdated => 1146631276,
lastUpdated => 1168558334,
},
};

View file

@ -29,12 +29,13 @@ our $I18N = {
<b>&#94;AdminToggle([<i>enable admin</i>], [<i>disable admin</i>], [<i>template name</i>]);</b><br />
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: &#94;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.
</p>
<p>This Macro may be nested inside other Macros if the text does not contain commas or quotes.</p>
<p>
The following variables are available in the template:
</p>
|,
lastUpdated => 1149178461,
lastUpdated => 1168558355,
},
'516' => {

View file

@ -27,9 +27,10 @@ images, links to files for downloading or for snippets.</p>
<p>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.</p>
<p>This Macro may not be nested inside other Macros.</p>
|,
lastUpdated => 1146679031,
lastUpdated => 1168558479,
},
};

View file

@ -17,8 +17,9 @@ our $I18N = {
<p><b>&#94;@; - Username</b><br />
The username of the currently logged in user.
</p>
<p>This Macro may be nested inside other Macros if all usernames do not contain commas or quotes.</p>
|,
lastUpdated => 1146679072,
lastUpdated => 1168558540,
},
};

View file

@ -26,8 +26,9 @@ Display a message to a user that can edit the current Asset.
<p>Do not use this Macro outside of an Asset as it will have unpredictable
results.
</p>
<p>This Macro may be nested inside other Macros if the text does not contain commas or quotes.</p>
|,
lastUpdated => 1146679107,
lastUpdated => 1168558566,
},
};

View file

@ -52,9 +52,10 @@ The current date and time.
</p>
<p>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.</p>
<p>This Macro may be nested inside other Macros if the formatted date does not contain commas or quotes.</p>
|,
lastUpdated => 1146679159,
lastUpdated => 1168558613,
},
};

View file

@ -27,12 +27,13 @@ our $I18N = {
<p><b>&#94;EditableToggle; or &#94;EditableToggle();</b><br />
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.
</p>
<p>This Macro may not be nested inside other Macros.</p>
<p>The following variables are available in the template:
</p>
|,
lastUpdated => 1149218452,
lastUpdated => 1168558646,
},
'516' => {

View file

@ -20,9 +20,10 @@ Can be used to display a web server environment variable on a page. The environm
<p>The macro should be specified like this &#94;Env("REMOTE_ADDR");
</p>
<p>This Macro may be nested inside other Macros if the text returned does not contain commas or quotes.</p>
|,
lastUpdated => 1155749273,
lastUpdated => 1168558879,
},
};

View file

@ -23,8 +23,9 @@ our $I18N = {
<p><b>&#94;Execute();</b><br />
Allows a content manager or administrator to execute an external program. Takes the format of <b>&#94;Execute("/this/file.sh");</b>.
</p>
<p>This Macro may be nested inside other Macros if the text it returns does not contain commas or quotes.</p>
|,
lastUpdated => 1146679274,
lastUpdated => 1168558923,
},
};

View file

@ -13,8 +13,9 @@ our $I18N = {
<b>&#94;FetchMimeType(<i>file system path to file</i>);</b><br />
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.</p>
<p>This Macro may be nested inside other Macros.</p>
|,
lastUpdated => 1146679300,
lastUpdated => 1168558941,
},
'macroName' => {

View file

@ -17,8 +17,9 @@ our $I18N = {
<p><b>&#94;FileUrl</b>();<br />
<b>&#94;FileUrl</b>(<i>Asset URL</i>);<br />
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 <i>not</i> work on Assets which store multiple files, such as the Post or Article Assets.</p>
<p>This Macro may be nested inside other Macros.</p>
|,
lastUpdated => 1165599338,
lastUpdated => 1168622358,
},
'invalid url' => {

View file

@ -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: &#94;FormParam("phoneNumber");
</p>
<p>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.</p>
<p>This Macro may be nested inside other Macros if the text returned does not contain commas or quotes.</p>
|,
lastUpdated => 1165517791,
lastUpdated => 1168622375,
},
};

View file

@ -40,10 +40,12 @@ Using this macro you can allow users to add themselves to a group. The first par
</ul>
</div>
<p>This Macro may not be nested inside other Macros.</p>
<p>These variables are available in the template:</p>
|,
lastUpdated => 1149218365,
lastUpdated => 1168622402,
},
};

View file

@ -38,10 +38,12 @@ Using this macro you can allow users to delete themselves from a group. The firs
</ul>
</div>
<p>This Macro may not be nested inside other Macros.</p>
<p>>These variables are available in the template:</p>
|,
lastUpdated => 1149217752,
lastUpdated => 1168622413,
},
};

View file

@ -25,8 +25,9 @@ Displays a small text message to the user if they belong to the specified group.
</p>
<p><i>Example:</i> &#94;GroupText("Visitors","You need an account to do anything cool on this site!","We value our registered users!");
</p>
<p>This Macro may be nested inside other Macros if the text returned does not contain commas or quotes.</p>
|,
lastUpdated => 1146686292,
lastUpdated => 1168622429,
},
};

View file

@ -25,7 +25,11 @@ our $I18N = {
'home link body' => {
message => q|
<p><b>&#94;H; or &#94;H(); - Home Link</b><br />A link to the home page of this site. In addition you can change the link text by creating a macro like this <b>&#94;H("Go Home");</b>.</p>
<p><b>NOTES:</b> You can also use the special case &#94;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:</p>
<p><b>NOTES:</b> You can also use the special case &#94;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.</p>
<p>This Macro may only be nested inside other Macros if the "linkonly" option is used.</p>
<p>The following variables are available for use in the template:</p>
|,
lastUpdated => 1149217683,
},

View file

@ -17,8 +17,9 @@ our $I18N = {
<p><b>&#94;#; - User ID</b><br />
The user id of the currently logged in user.
</p>
<p>This Macro may be nested inside other Macros.</p>
|,
lastUpdated => 1146686310,
lastUpdated => 1168622446,
},
};

View file

@ -35,8 +35,9 @@ Allows a content manager or administrator to include a file from the local files
<p><i>Example:</i> &#94;Include("/this/file.html");
</p>
<p>This Macro may be nested inside other Macros if the included text does not contain commas or quotes.</p>
|,
lastUpdated => 1146686398,
lastUpdated => 1168622508,
},
};

View file

@ -20,8 +20,9 @@ Pull a translated message from the internationalization system.
<p><i>Example:</i> &#94;International(45,"Article");
</p>
<p>This Macro may be nested inside other Macros if the message does not contain commas or quotes.</p>
|,
lastUpdated => 1146686421,
lastUpdated => 1168622528,
},
};

View file

@ -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: &#94;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: &#94;L(20,"Hi &#94;a(&#94;@;);. 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.</p>
<p><b>NOTE:</b> The .loginBox style sheet class is tied to this macro.
<p>
<b>NOTES:</b><br />
<ul>
<li>The .loginBox style sheet class is tied to this macro.</li>
<li>This Macro may not be nested inside other Macros.</li>
</ul>
</p>
|,
lastUpdated => 1158340077,
lastUpdated => 1168622639,
},
'48' => {

View file

@ -25,8 +25,9 @@ Displays the date that the current page was last modified based upon the wobject
</p>
<p><i>Example:</i> &#94;LastModified("Updated: ","%c %D, %y");
</p>
<p>This Macro may be nested inside other Macros if the text it returns does not contain commas or quotes.</p>
|,
lastUpdated => 1146686444,
lastUpdated => 1168622573,
},
};

View file

@ -17,6 +17,9 @@ our $I18N = {
<p><b>&#94;LoginToggle; or &#94;LoginToggle();</b><br />
Displays a "Login" or "Logout" message depending upon whether the user is logged in or not. You can optionally specify other labels like this: &#94;LoginToggle("Click here to log in.","Click here to log out.");. You can also use the special case &#94;LoginToggle(linkonly); to return only the URL with no label.
</p>
<p>This Macro may be nested inside other Macros if the text returned does not contain commas or quotes.</p>
<p>These variables are available in the LoginToggle template:</p>
<p><b>toggle.url</b><br />
The URL to login or logout.
@ -27,7 +30,7 @@ The Internationalized label for logging in or logging out (depending on the stat
</p>
|,
lastUpdated => 1146759379,
lastUpdated => 1168622690,
},
'716' => {

View file

@ -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.
</p>
<p>Properties available for retrieval depend on the type of asset that is being queried.</p>
<p>This Macro may be nested inside other Macros if the property returned does not contain commas or quotes.</p>
|,
lastUpdated => 1153339253,
lastUpdated => 1168622743,
},
};

View file

@ -19,11 +19,14 @@ our $I18N = {
Displays the title of the current page.
</p>
<p><b>NOTE:</b> 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.
<p><b>NOTES:</b><br />
<ul>
<li>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.</li>
<li>This Macro may be nested inside other Macros if the title does not contain commas or quotes</li>
</ul>
</p>
|,
lastUpdated => 1146609765,
lastUpdated => 1168622805,
},
};

View file

@ -17,8 +17,9 @@ our $I18N = {
<p><b>&#94;PageUrl;</b><br />
The URL to the current page (example: <i>/index.pl/pagename</i>).
</p>
<p>This Macro may be nested inside other Macros.</p>
|,
lastUpdated => 1146759407,
lastUpdated => 1168622829,
},
};

View file

@ -17,8 +17,9 @@ our $I18N = {
<p><b>&#94;Quote();</b><br />
Use this to escape a string before using it in a database query.
</p>
<p>This Macro may be nested inside other Macros if the quoted string does not contain commas or unescaped quotes.</p>
|,
lastUpdated => 1146609178,
lastUpdated => 1168622849,
},
};

View file

@ -19,8 +19,9 @@ our $I18N = {
This macro works similarly to the &#94;<b>AssetProxy</b>(); 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.</p>
<p>This Macro may not be nested inside other Macros.</p>
|,
lastUpdated => 1167187099,
lastUpdated => 1168622873,
},
'childless' => {

View file

@ -62,8 +62,9 @@ of questions), then the example above can be used to display a random question f
<dd>Gets a random post from all Collaboration Systems in root 'home' with debug output.</dd>
</dl>
</div>
<p>This Macro may be nested inside other Macros if the post does not contain commas or quotes.</p>
|,
lastUpdated => 1167187168,
lastUpdated => 1168622915,
},
};

View file

@ -19,8 +19,9 @@ Returns the title of the root of the current page. For instance, the main root i
</p>
<p>If the macro is called outside of an asset, or if the root can't be found, then
the macro returns an empty string</p>
<p>This Macro may be nested inside other Macros if the title does not contain commas or quotes.</p>
|,
lastUpdated => 1153849842,
lastUpdated => 1168622930,
},
};

View file

@ -23,8 +23,9 @@ A one line SQL report. Sometimes you just need to pull something back from the d
</p>
<p>If there are more numeric macros than selected columns in the SQL report the extra macros will be discarded.</p>
<p>The rownum macro, &#94;rownum;, begins counting at 1.</p>
<p>This Macro may be nested inside other Macros if the text returned does not contain commas or quotes.</p>
|,
lastUpdated => 1151986323,
lastUpdated => 1168623083,
},
'illegal query' => {

View file

@ -17,8 +17,9 @@ our $I18N = {
<p><b>&#94;/; - System URL</b><br />
The URL to the gateway script (example: <i>/index.pl/</i>).
</p>
<p>This Macro may be nested inside other Macros.</p>
|,
lastUpdated => 1146760697,
lastUpdated => 1168623028,
},
};

View file

@ -19,8 +19,9 @@ Create a spacer in your layout. Great for creating blocks of color with divs and
</p>
<p><i>Example:</i> &#94;Spacer("100","50");
</p>
<p>This Macro may not be nested inside other Macros.</p>
|,
lastUpdated => 1146608671,
lastUpdated => 1168623039,
},
};

View file

@ -18,8 +18,9 @@ our $I18N = {
<p><b>&#94;*; or &#94;*(); - Random Number</b><br />
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 <b>&#94;*(100);</b> 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.
</p>
<p>This Macro may be nested inside other Macros.</p>
|,
lastUpdated => 1153635269,
lastUpdated => 1168623052,
},
};

View file

@ -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.</p>
<p>This Macro may not be nested inside other Macros.</p>
<p>These variables are available in the template:</p>
|,
lastUpdated => 1149217429,
lastUpdated => 1168623113,
},
};

View file

@ -18,8 +18,9 @@ our $I18N = {
<p><b>&#94;SubscriptionItemPurchaseUrl(<i>subscriptionId</i>);</b><br />
This macro fetches the URL to purchase a subscription item identified
by its subscriptionId.</p>
<p>This Macro may be nested inside other Macros.</p>
|,
lastUpdated => 1146607246,
lastUpdated => 1168623124,
},
};

View file

@ -16,12 +16,13 @@ our $I18N = {
message => q|
<p><b>&#94;Thumbnail(<i>url</i>);</b><br />
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.
</p>
<p>This Macro may be nested inside other Macros.</p>
|,
lastUpdated => 1146607225,
lastUpdated => 1168623188,
},
};

View file

@ -18,9 +18,10 @@ our $I18N = {
<p><b>&#94;URLEncode();</b><br />
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: &#94;URLEncode("Is this my string?");
</p>
<p>This Macro may be nested inside other Macros if the encoded text does not contain commas or quotes.</p>
|,
lastUpdated => 1146607207,
lastUpdated => 1168623216,
},
};

View file

@ -18,9 +18,10 @@ our $I18N = {
<p><b>&#94;User();</b><br />
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: &#94;User("email");
</p>
<p>This Macro may be nested inside other Macros if the information returned does not contain commas or quotes.</p>
|,
lastUpdated => 1153172116,
lastUpdated => 1168623231,
},
};

View file

@ -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 <i>link text</i> is set to the word
"linkonly" then only the URL will be returned.</p>
<p><b>NOTES:</b> The .myAccountLink style sheet class is tied to this macro.
<p><b>NOTES:</b><br />
<ul>
<li>The .myAccountLink style sheet class is tied to this macro.</li>
<li>This Macro may only be nested inside other Macros if the "linkonly" option is used.</li>
</p>
<p>The following is a list of variables available in the template:</p>
|,
lastUpdated => 1149177708,
lastUpdated => 1168558260,
},
'46' => {

View file

@ -17,8 +17,9 @@ our $I18N = {
<p><b>&#94;c;</b><br />
The name of your company specified in the settings by your Administrator.
</p>
<p>This Macro may be nested inside other Macros if the text does not contain commas or quotes.</p>
|,
lastUpdated => 1146679121,
lastUpdated => 1168558579,
},
};

View file

@ -17,8 +17,9 @@ our $I18N = {
<p><b>&#94;e;</b><br />
The email address for your company specified in the settings by your Administrator.
</p>
<p>This Macro may be nested inside other Macros if the email address does not contain commas or quotes.</p>
|,
lastUpdated => 1146679191,
lastUpdated => 1168558595,
},
};

View file

@ -38,11 +38,15 @@ Creates a link to alter the style from a page to make it printable.
<p>The third argument allows a different template be used to generate the HTML code for presenting the link and text, by specifying the URL of the template. The following variables are available in the template:</p>
<p><b>NOTES:</b>The <i>.makePrintableLink</i> style sheet class is tied to the default template for this macro.
<p><b>NOTES:</b><br />
<ul>
<li>The <i>.makePrintableLink</i> style sheet class is tied to the default template for this macro.</li>
<li>This Macro may only be nested inside other Macros if the "linkonly" option is used.</li>
</ul>
</p>
|,
lastUpdated => 1155309743,
lastUpdated => 1168623000,
},
'53' => {

View file

@ -18,9 +18,10 @@ our $I18N = {
<p><b>&#94;u; - Company URL</b><br />
The URL for your company specified in the settings by your Administrator.
</p>
<p>This Macro may be nested inside other Macros.</p>
|,
lastUpdated => 1146607213,
lastUpdated => 1168623198,
},
};

View file

@ -61,8 +61,16 @@ our $I18N = {
<b>&#94;x</b>(<i>"First argument",2</i>);
</p>
<p>You may nest Macros, but only if they do not contains commas or quotes. You should follow the following guidelines:
<ul>
<li>Macros which contain HTML or javascript cannot be nested.</li>
<li>Macros which return user input that may contain quotes or commas may be nested, but it's dangerous.</li>
<li>If your user input must contain quotes and/or commas, it is recommended that the HTML encodings for comma and quote be used.</li>
</ul>
</p>
|,
lastUpdated => 1165518386,
lastUpdated => 1168556567,
},
'topicName' => {