Macro help pruning, up through but NOT including RootTitle
This commit is contained in:
Colin Kuskie
parent
3fa2a81d98
commit
1d9a95cce2
30 changed files with 24 additions and 590 deletions
|
|
@ -4,7 +4,7 @@ our $HELP = {
|
|||
|
||||
'home link' => {
|
||||
title => 'home link title',
|
||||
body => 'home link body',
|
||||
body => '',
|
||||
variables => [
|
||||
{
|
||||
'name' => 'homeLink.url'
|
||||
|
|
|
|||
|
|
@ -1,16 +0,0 @@
|
|||
package WebGUI::Help::Macro_Hash_userId;
|
||||
|
||||
our $HELP = {
|
||||
|
||||
'user id' => {
|
||||
title => 'user id title',
|
||||
body => 'user id body',
|
||||
fields => [
|
||||
],
|
||||
related => [
|
||||
]
|
||||
},
|
||||
|
||||
};
|
||||
|
||||
1;
|
||||
|
|
@ -1,16 +0,0 @@
|
|||
package WebGUI::Help::Macro_Include;
|
||||
|
||||
our $HELP = {
|
||||
|
||||
'include' => {
|
||||
title => 'include title',
|
||||
body => 'include body',
|
||||
fields => [
|
||||
],
|
||||
related => [
|
||||
]
|
||||
},
|
||||
|
||||
};
|
||||
|
||||
1;
|
||||
|
|
@ -1,16 +0,0 @@
|
|||
package WebGUI::Help::Macro_International;
|
||||
|
||||
our $HELP = {
|
||||
|
||||
'international' => {
|
||||
title => 'international title',
|
||||
body => 'international body',
|
||||
fields => [
|
||||
],
|
||||
related => [
|
||||
]
|
||||
},
|
||||
|
||||
};
|
||||
|
||||
1;
|
||||
|
|
@ -4,7 +4,7 @@ our $HELP = {
|
|||
|
||||
'login box' => {
|
||||
title => 'login box title',
|
||||
body => 'login box body',
|
||||
body => '',
|
||||
isa => [
|
||||
{
|
||||
namespace => "Asset_Template",
|
||||
|
|
|
|||
|
|
@ -1,16 +0,0 @@
|
|||
package WebGUI::Help::Macro_LastModified;
|
||||
|
||||
our $HELP = {
|
||||
|
||||
'last modified' => {
|
||||
title => 'last modified title',
|
||||
body => 'last modified body',
|
||||
fields => [
|
||||
],
|
||||
related => [
|
||||
]
|
||||
},
|
||||
|
||||
};
|
||||
|
||||
1;
|
||||
|
|
@ -2,9 +2,23 @@ package WebGUI::Help::Macro_LoginToggle;
|
|||
|
||||
our $HELP = {
|
||||
|
||||
'login toggle' => {
|
||||
'login toggle' => {
|
||||
isa => [
|
||||
{
|
||||
namespace => "Asset_Template",
|
||||
tag => "template variables"
|
||||
},
|
||||
],
|
||||
title => 'login toggle title',
|
||||
body => 'login toggle body',
|
||||
variables => [
|
||||
{
|
||||
'name' => 'toggle.url'
|
||||
},
|
||||
{
|
||||
'name' => 'toggle.text'
|
||||
},
|
||||
],
|
||||
fields => [
|
||||
],
|
||||
related => [
|
||||
|
|
|
|||
|
|
@ -1,16 +0,0 @@
|
|||
package WebGUI::Help::Macro_NewMail;
|
||||
|
||||
our $HELP = {
|
||||
|
||||
'new mail' => {
|
||||
title => 'new mail title',
|
||||
body => 'new mail body',
|
||||
fields => [
|
||||
],
|
||||
related => [
|
||||
]
|
||||
},
|
||||
|
||||
};
|
||||
|
||||
1;
|
||||
|
|
@ -1,16 +0,0 @@
|
|||
package WebGUI::Help::Macro_Page;
|
||||
|
||||
our $HELP = {
|
||||
|
||||
'page' => {
|
||||
title => 'page title',
|
||||
body => 'page body',
|
||||
fields => [
|
||||
],
|
||||
related => [
|
||||
]
|
||||
},
|
||||
|
||||
};
|
||||
|
||||
1;
|
||||
|
|
@ -1,16 +0,0 @@
|
|||
package WebGUI::Help::Macro_PageTitle;
|
||||
|
||||
our $HELP = {
|
||||
|
||||
'page title' => {
|
||||
title => 'page title title',
|
||||
body => 'page title body',
|
||||
fields => [
|
||||
],
|
||||
related => [
|
||||
]
|
||||
},
|
||||
|
||||
};
|
||||
|
||||
1;
|
||||
|
|
@ -1,16 +0,0 @@
|
|||
package WebGUI::Help::Macro_PageUrl;
|
||||
|
||||
our $HELP = {
|
||||
|
||||
'page url' => {
|
||||
title => 'page url title',
|
||||
body => 'page url body',
|
||||
fields => [
|
||||
],
|
||||
related => [
|
||||
]
|
||||
},
|
||||
|
||||
};
|
||||
|
||||
1;
|
||||
|
|
@ -4,7 +4,7 @@ our $HELP = {
|
|||
|
||||
'product' => {
|
||||
title => 'product title',
|
||||
body => 'product body',
|
||||
body => '',
|
||||
variables => [
|
||||
{
|
||||
'name' => 'variants.message'
|
||||
|
|
|
|||
|
|
@ -1,16 +0,0 @@
|
|||
package WebGUI::Help::Macro_Quote;
|
||||
|
||||
our $HELP = {
|
||||
|
||||
'quote' => {
|
||||
title => 'quote title',
|
||||
body => 'quote body',
|
||||
fields => [
|
||||
],
|
||||
related => [
|
||||
]
|
||||
},
|
||||
|
||||
};
|
||||
|
||||
1;
|
||||
|
|
@ -1,16 +0,0 @@
|
|||
package WebGUI::Help::Macro_RandomAssetProxy;
|
||||
|
||||
our $HELP = {
|
||||
|
||||
'random asset proxy' => {
|
||||
title => 'random asset proxy title',
|
||||
body => 'random asset proxy body',
|
||||
fields => [
|
||||
],
|
||||
related => [
|
||||
]
|
||||
},
|
||||
|
||||
};
|
||||
|
||||
1;
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
package WebGUI::Help::Macro_RandomThread;
|
||||
|
||||
our $HELP = {
|
||||
'random thread' => {
|
||||
title => 'random thread title',
|
||||
body => 'random thread body',
|
||||
fields => [
|
||||
],
|
||||
related => [
|
||||
{
|
||||
tag => 'random asset proxy',
|
||||
namespace => 'Macro_RandomAssetProxy'
|
||||
},
|
||||
{
|
||||
tag => 'collaboration post list template variables',
|
||||
namespace => 'Asset_Collaboration'
|
||||
}
|
||||
]
|
||||
},
|
||||
|
||||
};
|
||||
|
||||
1;
|
||||
|
|
@ -8,8 +8,8 @@ our $I18N = {
|
|||
},
|
||||
|
||||
'home link title' => {
|
||||
message => q|Home Link Macro|,
|
||||
lastUpdated => 1112466408,
|
||||
message => q|Home Link Macro Template Variables|,
|
||||
lastUpdated => 1184709588,
|
||||
},
|
||||
|
||||
'homeLink.url' => {
|
||||
|
|
@ -22,18 +22,6 @@ our $I18N = {
|
|||
lastUpdated => 1149217666,
|
||||
},
|
||||
|
||||
'home link body' => {
|
||||
message => q|
|
||||
<p><b>^H; or ^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>^H("Go Home");</b>.</p>
|
||||
<p><b>NOTES:</b> 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.</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,
|
||||
},
|
||||
|
||||
'47' => {
|
||||
message => q|Home|,
|
||||
lastUpdated => 1031514049
|
||||
|
|
|
|||
|
|
@ -1,26 +0,0 @@
|
|||
package WebGUI::i18n::English::Macro_Hash_userId;
|
||||
|
||||
our $I18N = {
|
||||
|
||||
'macroName' => {
|
||||
message => q|User Id|,
|
||||
lastUpdated => 1128838613,
|
||||
},
|
||||
|
||||
'user id title' => {
|
||||
message => q|User Id Macro|,
|
||||
lastUpdated => 1112466408,
|
||||
},
|
||||
|
||||
'user id body' => {
|
||||
message => q|
|
||||
<p><b>^#; - 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 => 1168622446,
|
||||
},
|
||||
};
|
||||
|
||||
1;
|
||||
|
|
@ -22,23 +22,6 @@ our $I18N = {
|
|||
lastUpdated => 1112466408,
|
||||
},
|
||||
|
||||
'include title' => {
|
||||
message => q|Include Macro|,
|
||||
lastUpdated => 1112466408,
|
||||
},
|
||||
|
||||
'include body' => {
|
||||
message => q|
|
||||
<p><b>^Include();</b><br />
|
||||
Allows a content manager or administrator to include a file from the local filesystem.
|
||||
</p>
|
||||
|
||||
<p><i>Example:</i> ^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 => 1168622508,
|
||||
},
|
||||
};
|
||||
|
||||
1;
|
||||
|
|
|
|||
|
|
@ -1,29 +0,0 @@
|
|||
package WebGUI::i18n::English::Macro_International;
|
||||
|
||||
our $I18N = {
|
||||
|
||||
'macroName' => {
|
||||
message => q|International|,
|
||||
lastUpdated => 1128838702,
|
||||
},
|
||||
|
||||
'international title' => {
|
||||
message => q|International Macro|,
|
||||
lastUpdated => 1112466408,
|
||||
},
|
||||
|
||||
'international body' => {
|
||||
message => q|
|
||||
<p><b>^International();</b><br />
|
||||
Pull a translated message from the internationalization system.
|
||||
</p>
|
||||
|
||||
<p><i>Example:</i> ^International(45,"Article");
|
||||
</p>
|
||||
<p>This Macro may be nested inside other Macros if the message does not contain commas or quotes.</p>
|
||||
|,
|
||||
lastUpdated => 1168622528,
|
||||
},
|
||||
};
|
||||
|
||||
1;
|
||||
|
|
@ -8,8 +8,8 @@ our $I18N = {
|
|||
},
|
||||
|
||||
'login box title' => {
|
||||
message => q|Login Box Macro|,
|
||||
lastUpdated => 1112466408,
|
||||
message => q|Login Box Macro Template Variables|,
|
||||
lastUpdated => 1184709750,
|
||||
},
|
||||
|
||||
'user.isVisitor' => {
|
||||
|
|
@ -82,24 +82,6 @@ our $I18N = {
|
|||
lastUpdated => 1148963673,
|
||||
},
|
||||
|
||||
'login box body' => {
|
||||
message => q|
|
||||
<p><b>^L; or ^L(); - Login Box</b><br />
|
||||
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.</p>
|
||||
|
||||
<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 => 1168622639,
|
||||
},
|
||||
|
||||
'48' => {
|
||||
message => q|Hello|,
|
||||
lastUpdated => 1031514049,
|
||||
|
|
|
|||
|
|
@ -7,30 +7,6 @@ our $I18N = {
|
|||
lastUpdated => 1134969093
|
||||
},
|
||||
|
||||
'macroName' => {
|
||||
message => q|LastModified|,
|
||||
lastUpdated => 1128839043,
|
||||
},
|
||||
|
||||
'last modified title' => {
|
||||
message => q|LastModified Macro|,
|
||||
lastUpdated => 1112466408,
|
||||
},
|
||||
|
||||
'last modified body' => {
|
||||
message => q|
|
||||
<p><b>^LastModified;</b><br />
|
||||
<b>^LastModified(<i>"text"</i>,<i>"date format"</i>);</b><br />
|
||||
Displays the date that the current page was last edited. 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.
|
||||
</p>
|
||||
<p><i>Example:</i> ^LastModified("Updated: ","%c %D, %y");
|
||||
</p>
|
||||
<p>If you would like to get the last modified time of Assets on a page, see the Date macro for an example.
|
||||
</p>
|
||||
<p>This Macro may be nested inside other Macros if the text it returns does not contain commas or quotes.</p>
|
||||
|,
|
||||
lastUpdated => 1170179085,
|
||||
},
|
||||
};
|
||||
|
||||
1;
|
||||
|
|
|
|||
|
|
@ -8,29 +8,8 @@ our $I18N = {
|
|||
},
|
||||
|
||||
'login toggle title' => {
|
||||
message => q|Login Toggle Macro|,
|
||||
lastUpdated => 1112466408,
|
||||
},
|
||||
|
||||
'login toggle body' => {
|
||||
message => q|
|
||||
<p><b>^LoginToggle; or ^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: ^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.
|
||||
</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.
|
||||
</p>
|
||||
|
||||
<p><b>toggle.text</b><br />
|
||||
The Internationalized label for logging in or logging out (depending on the state of the macro), or the text that you supply to the macro.
|
||||
</p>
|
||||
|
||||
|,
|
||||
lastUpdated => 1168622690,
|
||||
message => q|Login Toggle Macro Template Variables|,
|
||||
lastUpdated => 1184710063,
|
||||
},
|
||||
|
||||
'716' => {
|
||||
|
|
|
|||
|
|
@ -1,29 +0,0 @@
|
|||
package WebGUI::i18n::English::Macro_NewMail;
|
||||
|
||||
our $I18N = {
|
||||
|
||||
'macroName' => {
|
||||
message => q|New Mail|,
|
||||
lastUpdated => 1181942771,
|
||||
},
|
||||
|
||||
'new mail title' => {
|
||||
message => q|New Mail Macro|,
|
||||
lastUpdated => 1181942777,
|
||||
},
|
||||
|
||||
'new mail body' => {
|
||||
message => q|
|
||||
<p><b>^NewMail</b>();<br />
|
||||
<b>^NewMail</b>(<i>CSS Class</i>);<br />
|
||||
This macro will display whether the current user has unread messages in their Inbox. If there
|
||||
are no unread messages, it will return nothing.
|
||||
</p>
|
||||
<p>This Macro may be nested inside other Macros.</p>
|
||||
|,
|
||||
lastUpdated => 1181942878,
|
||||
},
|
||||
|
||||
};
|
||||
|
||||
1;
|
||||
|
|
@ -1,29 +0,0 @@
|
|||
package WebGUI::i18n::English::Macro_Page;
|
||||
|
||||
our $I18N = {
|
||||
|
||||
'macroName' => {
|
||||
message => q|Page|,
|
||||
lastUpdated => 1128839316,
|
||||
},
|
||||
|
||||
'page title' => {
|
||||
message => q|Page Macro|,
|
||||
lastUpdated => 1112466408,
|
||||
},
|
||||
|
||||
'page body' => {
|
||||
message => q|
|
||||
|
||||
<p><b>^Page();</b><br />
|
||||
This can be used to retrieve information about the current asset. For instance it could be used to get the page URL like this ^Page("urlizedTitle"); or to get the menu title like this ^Page("menuTitle");. If the macro is called outside the context of
|
||||
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 => 1168622743,
|
||||
},
|
||||
};
|
||||
|
||||
1;
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
package WebGUI::i18n::English::Macro_PageTitle;
|
||||
|
||||
our $I18N = {
|
||||
|
||||
'macroName' => {
|
||||
message => q|Page Title|,
|
||||
lastUpdated => 1128839334,
|
||||
},
|
||||
|
||||
'page title title' => {
|
||||
message => q|Page Title Macro|,
|
||||
lastUpdated => 1128839384,
|
||||
},
|
||||
|
||||
'page title body' => {
|
||||
message => q|
|
||||
|
||||
<p><b>^PageTitle;</b><br />
|
||||
Displays the title of the current page.
|
||||
</p>
|
||||
|
||||
<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 => 1168622805,
|
||||
},
|
||||
};
|
||||
|
||||
1;
|
||||
|
|
@ -1,32 +0,0 @@
|
|||
package WebGUI::i18n::English::Macro_PageUrl;
|
||||
|
||||
our $I18N = {
|
||||
|
||||
'macroName' => {
|
||||
message => q|Page URL|,
|
||||
lastUpdated => 1128839374,
|
||||
},
|
||||
|
||||
'page url title' => {
|
||||
message => q|Page URL Macro|,
|
||||
lastUpdated => 1112466408,
|
||||
},
|
||||
|
||||
'page url body' => {
|
||||
message => q|
|
||||
<p><b>^PageUrl;</b><br />
|
||||
<b>^PageUrl(/sub/page);</b><br />
|
||||
The URL to the current page (example: <i>/index.pl/pagename</i>).
|
||||
</p>
|
||||
|
||||
<p>The macro takes a single, optional argument; a URL. The URL will be appended to
|
||||
the end of the page's URL. This is mainly useful when you enable Prevent Proxy Caching
|
||||
in the WebGUI settings.</p>
|
||||
|
||||
<p>This Macro may be nested inside other Macros.</p>
|
||||
|,
|
||||
lastUpdated => 1169588703,
|
||||
},
|
||||
};
|
||||
|
||||
1;
|
||||
|
|
@ -119,19 +119,6 @@ of the Product to their shopping cart.|,
|
|||
},
|
||||
|
||||
|
||||
'product body' => {
|
||||
message => q|
|
||||
|
||||
<p><b>^Product(<i>SKU or productId</i>, [<i>templateId</i>]);</b><br />
|
||||
This macro looks up a Product in the Product Manager by SKU or productId and
|
||||
allows information about it to be displayed. If the SKU or productId cannot
|
||||
be found, the message ^International("cannot find product","Macro_Product"); will
|
||||
be displayed.</p>
|
||||
<p>The macro takes one optional argument, an alternate template in the Macro/Product namespace for formatting information about the Product. The following variables are available in the template:</p>
|
||||
|,
|
||||
lastUpdated => 1149217613,
|
||||
},
|
||||
|
||||
};
|
||||
|
||||
1;
|
||||
|
|
|
|||
|
|
@ -1,26 +0,0 @@
|
|||
package WebGUI::i18n::English::Macro_Quote;
|
||||
|
||||
our $I18N = {
|
||||
|
||||
'macroName' => {
|
||||
message => q|Quote|,
|
||||
lastUpdated => 1128918940,
|
||||
},
|
||||
|
||||
'quote title' => {
|
||||
message => q|Quote Macro|,
|
||||
lastUpdated => 1112466408,
|
||||
},
|
||||
|
||||
'quote body' => {
|
||||
message => q|
|
||||
<p><b>^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 => 1168622849,
|
||||
},
|
||||
};
|
||||
|
||||
1;
|
||||
|
|
@ -7,23 +7,6 @@ our $I18N = {
|
|||
lastUpdated => 1128918962,
|
||||
},
|
||||
|
||||
'random asset proxy title' => {
|
||||
message => q|Random Asset Proxy Macro|,
|
||||
lastUpdated => 1112315917,
|
||||
},
|
||||
|
||||
'random asset proxy body' => {
|
||||
message => q|
|
||||
<p><b>^RandomAssetProxy</b>();<br />
|
||||
<b>^RandomAssetProxy</b>(<i>Asset URL</i>);<br />
|
||||
This macro works similarly to the ^<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 => 1168622873,
|
||||
},
|
||||
|
||||
'childless' => {
|
||||
message => q|Asset has no children.|,
|
||||
lastUpdated => 1135101140,
|
||||
|
|
|
|||
|
|
@ -1,71 +0,0 @@
|
|||
package WebGUI::i18n::English::Macro_RandomThread;
|
||||
|
||||
our $I18N = {
|
||||
|
||||
'macroName' => {
|
||||
message => q|Random Thread|,
|
||||
lastUpdated => 1132970060,
|
||||
},
|
||||
|
||||
'random thread title' => {
|
||||
message => q|Random Thread Macro|,
|
||||
lastUpdated => 1132970060,
|
||||
},
|
||||
|
||||
'random thread body' => {
|
||||
message => q|<p><b>^RandomThread( [ startURL, relatives, templateURL ] );</b><br />
|
||||
The Collaboration System can be used for much more than just a forum. A few examples of its
|
||||
possible usages are an FAQ, photo gallery, job listings, quotes database or weblog. For these
|
||||
applications (and others that you might think of) it can be nice to display a random entry
|
||||
from such a CS somewhere on your site. That is exactly the functionality that this macro provides.</p>
|
||||
|
||||
<p>It displays the start post of a thread that is randomly selected from a (possibly random) CS,
|
||||
depending on the parameters. The way the selected post is displayed is controlled by a template. All
|
||||
the template variables that are normally available in a CS Post template are available in this macro as well.</p>
|
||||
|
||||
<p><b>Parameters</b></p>
|
||||
<p>Although all the parameters can be omitted, it usually makes sense to specify them all. If you
|
||||
want to display a random thread from a single CS, we suggest you use the URL of the CS as the <i>startURL</i>
|
||||
and "self" as <i>relatives</i>.</p>
|
||||
<div>
|
||||
<dl>
|
||||
<dt><i>startURL</i></dt>
|
||||
<dd>URL of the asset you want to use as the starting point for finding a random CS. If omitted
|
||||
it defaults to 'home' (i.e. the root page of most websites). Must be a valid URL within WebGUI.</dd>
|
||||
|
||||
<dt><i>relatives</i></dt>
|
||||
<dd>Only posts from Collaboration Systems that are relatives of the start-asset in this way
|
||||
are used. Allowed values for this parameter are 'siblings', 'children', 'ancestors', 'self',
|
||||
'descendants' and 'pedigree'. Default value is descendants.</dd>
|
||||
|
||||
<dt><i>templateURL</i></dt>
|
||||
<dd>URL of the template to use to display the random thread. Must be a valid URL within WebGUI.
|
||||
<br /><br />IMPORTANT NOTE: if omitted, a default debug template is used that outputs a list of all the
|
||||
available template variables. Since you almost certainly will not want this output in a
|
||||
production-environment, it makes sense to not omit this parameter.</dd>
|
||||
</dl>
|
||||
</div>
|
||||
|
||||
<p><b>Examples:</b></p>
|
||||
<div>
|
||||
<dl>
|
||||
<dt><tt>^RandomThread(home/photo_album, descendants, templates/randomPhoto);</tt></dt>
|
||||
<dd>If you have a page with many subpages with photo galleries, you can use the parameters above
|
||||
to easily retrieve a random thumbnail from all your photo albums.</dd>
|
||||
<dt><tt>^RandomThread(home/quotes/quotes-db, self, templates/randomQuote);</tt></dt>
|
||||
<dd>If you have one CS that you use to keep a database of interesting quotes, you could use
|
||||
the above example to display a random quote on your website.</dd>
|
||||
<dt><tt>^RandomThread(home/faq, children, templates/faq);</tt></dt>
|
||||
<dd>Suppose you have one page with a couple of Collaboration Systems (for different categories
|
||||
of questions), then the example above can be used to display a random question from any category.</dd>
|
||||
<dt><tt>^RandomThread;</tt></dt>
|
||||
<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 => 1168622915,
|
||||
},
|
||||
};
|
||||
|
||||
1;
|
||||
Loading…
Add table
Add a link
Reference in a new issue