all macro template docs broken into variable entries
This commit is contained in:
Colin Kuskie
parent
e19ab5f67a
commit
c0dd288dfc
14 changed files with 283 additions and 143 deletions
|
|
@ -5,6 +5,14 @@ our $HELP = {
|
|||
'editable toggle' => {
|
||||
title => 'editable toggle title',
|
||||
body => 'editable toggle body',
|
||||
variables => [
|
||||
{
|
||||
'name' => 'toggle.url'
|
||||
},
|
||||
{
|
||||
'name' => 'toggle.text'
|
||||
}
|
||||
],
|
||||
fields => [
|
||||
],
|
||||
related => [
|
||||
|
|
|
|||
|
|
@ -5,6 +5,14 @@ our $HELP = {
|
|||
'group add' => {
|
||||
title => 'group add title',
|
||||
body => 'group add body',
|
||||
variables => [
|
||||
{
|
||||
'name' => 'group.url'
|
||||
},
|
||||
{
|
||||
'name' => 'group.text'
|
||||
}
|
||||
],
|
||||
fields => [
|
||||
],
|
||||
related => [
|
||||
|
|
|
|||
|
|
@ -5,6 +5,14 @@ our $HELP = {
|
|||
'group delete' => {
|
||||
title => 'group delete title',
|
||||
body => 'group delete body',
|
||||
variables => [
|
||||
{
|
||||
'name' => 'group.url'
|
||||
},
|
||||
{
|
||||
'name' => 'group.text'
|
||||
}
|
||||
],
|
||||
fields => [
|
||||
],
|
||||
related => [
|
||||
|
|
|
|||
|
|
@ -5,6 +5,14 @@ our $HELP = {
|
|||
'home link' => {
|
||||
title => 'home link title',
|
||||
body => 'home link body',
|
||||
variables => [
|
||||
{
|
||||
'name' => 'homeLink.url'
|
||||
},
|
||||
{
|
||||
'name' => 'homeLink.text'
|
||||
}
|
||||
],
|
||||
fields => [
|
||||
],
|
||||
related => [
|
||||
|
|
|
|||
|
|
@ -5,6 +5,63 @@ our $HELP = {
|
|||
'product' => {
|
||||
title => 'product title',
|
||||
body => 'product body',
|
||||
variables => [
|
||||
{
|
||||
'name' => 'variants.message'
|
||||
},
|
||||
{
|
||||
'name' => 'variantLoop',
|
||||
'variables' => [
|
||||
{
|
||||
'name' => 'variant.compositionLoop',
|
||||
'variables' => [
|
||||
{
|
||||
'name' => 'parameter'
|
||||
},
|
||||
{
|
||||
'name' => 'value'
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
'name' => 'variant.variantId'
|
||||
},
|
||||
{
|
||||
'name' => 'variant.price'
|
||||
},
|
||||
{
|
||||
'name' => 'variant.weight'
|
||||
},
|
||||
{
|
||||
'name' => 'variant.sku'
|
||||
},
|
||||
{
|
||||
'name' => 'variant.addToCart.url'
|
||||
},
|
||||
{
|
||||
'name' => 'variant.addToCart.label'
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
'name' => 'productId'
|
||||
},
|
||||
{
|
||||
'name' => 'title'
|
||||
},
|
||||
{
|
||||
'name' => 'description'
|
||||
},
|
||||
{
|
||||
'name' => 'price'
|
||||
},
|
||||
{
|
||||
'name' => 'weight'
|
||||
},
|
||||
{
|
||||
'name' => 'sku'
|
||||
}
|
||||
],
|
||||
fields => [
|
||||
],
|
||||
related => [
|
||||
|
|
|
|||
|
|
@ -5,6 +5,20 @@ our $HELP = {
|
|||
'subscription item' => {
|
||||
title => 'subscription item title',
|
||||
body => 'subscription item body',
|
||||
variables => [
|
||||
{
|
||||
'name' => 'url'
|
||||
},
|
||||
{
|
||||
'name' => 'name'
|
||||
},
|
||||
{
|
||||
'name' => 'description'
|
||||
},
|
||||
{
|
||||
'name' => 'price'
|
||||
}
|
||||
],
|
||||
fields => [
|
||||
],
|
||||
related => [
|
||||
|
|
|
|||
|
|
@ -5,6 +5,14 @@ our $HELP = {
|
|||
'printable' => {
|
||||
title => 'printable title',
|
||||
body => 'printable body',
|
||||
variables => [
|
||||
{
|
||||
'name' => 'printable.url'
|
||||
},
|
||||
{
|
||||
'name' => 'printable.text'
|
||||
}
|
||||
],
|
||||
fields => [
|
||||
],
|
||||
related => [
|
||||
|
|
|
|||
|
|
@ -12,6 +12,16 @@ our $I18N = {
|
|||
lastUpdated => 1112466408,
|
||||
},
|
||||
|
||||
'toggle.url' => {
|
||||
message => q|The URL to activate or deactivate Admin mode.|,
|
||||
lastUpdated => 1149218423,
|
||||
},
|
||||
|
||||
'toggle.text' => {
|
||||
message => q|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.|,
|
||||
lastUpdated => 1149218423,
|
||||
},
|
||||
|
||||
'editable toggle body' => {
|
||||
message => q|
|
||||
<p><b>^EditableToggle; or ^EditableToggle();</b><br />
|
||||
|
|
@ -21,15 +31,8 @@ Exactly the same as AdminToggle, except that the toggle is only displayed if the
|
|||
<p>The following variables are available in the template:
|
||||
</p>
|
||||
|
||||
<p><b>toggle.url</b><br />
|
||||
The URL to activate or deactivate Admin mode.
|
||||
</p>
|
||||
|
||||
<p><b>toggle.text</b><br />
|
||||
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.
|
||||
</p>
|
||||
|,
|
||||
lastUpdated => 1146679223,
|
||||
lastUpdated => 1149218452,
|
||||
},
|
||||
|
||||
'516' => {
|
||||
|
|
|
|||
|
|
@ -11,20 +11,22 @@ our $I18N = {
|
|||
message => q|Group Add Macro|,
|
||||
lastUpdated => 1112466408,
|
||||
},
|
||||
'group.url' => {
|
||||
message => q|The URL with the action to add the user to the group.|,
|
||||
lastUpdated => 1149218343,
|
||||
},
|
||||
|
||||
'group.text' => {
|
||||
message => q|The supplied text string for the user to click on.|,
|
||||
lastUpdated => 1149218343,
|
||||
},
|
||||
|
||||
|
||||
'group add body' => {
|
||||
message => q|
|
||||
|
||||
<p><b>^GroupAdd();</b><br />
|
||||
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:</p>
|
||||
|
||||
<p><b>group.url</b><br />
|
||||
The URL with the action to add the user to the group.
|
||||
</p>
|
||||
|
||||
<p><b>group.text</b><br />
|
||||
The supplied text string for the user to click on.
|
||||
</p>
|
||||
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.</p>
|
||||
|
||||
<p><b>NOTE:</b> All these conditions must be met for the link to be displayed:
|
||||
</p>
|
||||
|
|
@ -37,8 +39,11 @@ The supplied text string for the user to click on.
|
|||
<li>The group must be set up to allow auto adds.</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<p>These variables are available in the template:</p>
|
||||
|
||||
|,
|
||||
lastUpdated => 1146679385,
|
||||
lastUpdated => 1149218365,
|
||||
},
|
||||
};
|
||||
|
||||
|
|
|
|||
|
|
@ -12,18 +12,20 @@ our $I18N = {
|
|||
lastUpdated => 1112466408,
|
||||
},
|
||||
|
||||
'group.url' => {
|
||||
message => q|The URL with the action to add the user to the group.|,
|
||||
lastUpdated => 1149217736,
|
||||
},
|
||||
|
||||
'group.text' => {
|
||||
message => q|The supplied text string for the user to click on.|,
|
||||
lastUpdated => 1149217736,
|
||||
},
|
||||
|
||||
'group delete body' => {
|
||||
message => q|
|
||||
<p><b>^GroupDelete();</b><br />
|
||||
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:</p>
|
||||
|
||||
<p><b>group.url</b><br />
|
||||
The URL with the action to add the user to the group.
|
||||
</p>
|
||||
|
||||
<p><b>group.text</b><br />
|
||||
The supplied text string for the user to click on.
|
||||
</p>
|
||||
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.</p>
|
||||
|
||||
<p><b>NOTE:</b> All these conditions must be met for the link to be displayed:</p>
|
||||
|
||||
|
|
@ -36,8 +38,10 @@ The supplied text string for the user to click on.
|
|||
</ul>
|
||||
</div>
|
||||
|
||||
<p>>These variables are available in the template:</p>
|
||||
|
||||
|,
|
||||
lastUpdated => 1146679429,
|
||||
lastUpdated => 1149217752,
|
||||
},
|
||||
};
|
||||
|
||||
|
|
|
|||
|
|
@ -12,21 +12,22 @@ our $I18N = {
|
|||
lastUpdated => 1112466408,
|
||||
},
|
||||
|
||||
'homeLink.url' => {
|
||||
message => q|The URL to the home page.|,
|
||||
lastUpdated => 1149217666,
|
||||
},
|
||||
|
||||
'homeLink.text' => {
|
||||
message => q|The translated label for the link to the home page or the text that you supply to the macro.|,
|
||||
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. The following variables are available for use in the template:</p>
|
||||
|
||||
<p><b>homeLink.url</b><br />
|
||||
The URL to the home page.
|
||||
</p>
|
||||
|
||||
<p><b>homeLink.text</b><br />
|
||||
The translated label for the link to the home page or the text that you supply to the macro.
|
||||
</p>
|
||||
|
||||
|,
|
||||
lastUpdated => 1146686357,
|
||||
lastUpdated => 1149217683,
|
||||
},
|
||||
|
||||
'47' => {
|
||||
|
|
|
|||
|
|
@ -31,6 +31,94 @@ our $I18N = {
|
|||
lastUpdated => 1128965480,
|
||||
},
|
||||
|
||||
'variants.message' => {
|
||||
message => q|The internationalized text "^International("available product configurations","Macro_Product");"|,
|
||||
lastUpdated => 1149217564,
|
||||
},
|
||||
|
||||
'variantLoop' => {
|
||||
message => q|A loop containing information about all variants about the Product.|,
|
||||
lastUpdated => 1149217564,
|
||||
},
|
||||
|
||||
'variant.compositionLoop' => {
|
||||
message => q|A loop containing information about all variants about the Product.|,
|
||||
lastUpdated => 1149217564,
|
||||
},
|
||||
|
||||
'parameter' => {
|
||||
message => q|The parameter that defines this variant, for example, size.|,
|
||||
lastUpdated => 1149217564,
|
||||
},
|
||||
|
||||
'value' => {
|
||||
message => q|The value of the parameter, for the example of size, XL.|,
|
||||
lastUpdated => 1149217564,
|
||||
},
|
||||
|
||||
'variant.variantId' => {
|
||||
message => q|The Id for this variant of the Product.|,
|
||||
lastUpdated => 1149217564,
|
||||
},
|
||||
|
||||
'variant.price' => {
|
||||
message => q|The price for this variant of the Product.|,
|
||||
lastUpdated => 1149217564,
|
||||
},
|
||||
|
||||
'variant.weight' => {
|
||||
message => q|The weight for this variant of the Product.|,
|
||||
lastUpdated => 1149217564,
|
||||
},
|
||||
|
||||
'variant.sku' => {
|
||||
message => q|The SKU for this variant of the Product.|,
|
||||
lastUpdated => 1149217564,
|
||||
},
|
||||
|
||||
'variant.addToCart.url' => {
|
||||
message => q|A URL to add this variant of the Product to the user's shopping cart.|,
|
||||
lastUpdated => 1149217564,
|
||||
},
|
||||
|
||||
'variant.addToCart.label' => {
|
||||
message => q|An internationalized label, "^International("add to cart","Macro_Product");",
|
||||
to display to the user for adding this variant
|
||||
of the Product to their shopping cart.|,
|
||||
lastUpdated => 1149217564,
|
||||
},
|
||||
|
||||
'productId' => {
|
||||
message => q|The unique identifier of this Product.|,
|
||||
lastUpdated => 1149217564,
|
||||
},
|
||||
|
||||
'title' => {
|
||||
message => q|The title for this Product.|,
|
||||
lastUpdated => 1149217564,
|
||||
},
|
||||
|
||||
'description' => {
|
||||
message => q|The description of this Product.|,
|
||||
lastUpdated => 1149217564,
|
||||
},
|
||||
|
||||
'price' => {
|
||||
message => q|The Product's base cost.|,
|
||||
lastUpdated => 1149217564,
|
||||
},
|
||||
|
||||
'weight' => {
|
||||
message => q|The Product's base weight.|,
|
||||
lastUpdated => 1149217564,
|
||||
},
|
||||
|
||||
'sku' => {
|
||||
message => q|The Product's base SKU.|,
|
||||
lastUpdated => 1149217564,
|
||||
},
|
||||
|
||||
|
||||
'product body' => {
|
||||
message => q|
|
||||
|
||||
|
|
@ -40,85 +128,8 @@ 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>
|
||||
|
||||
<p><b>variants.message</b><br />
|
||||
The internationalized text "^International("available product configurations","Macro_Product");"
|
||||
</p>
|
||||
|
||||
<p><b>variantLoop</b><br />
|
||||
A loop containing information about all variants about the Product.
|
||||
</p>
|
||||
|
||||
<div class="helpIndent">
|
||||
|
||||
<p><b>variant.compositionLoop</b><br />
|
||||
A loop containing information about all variants about the Product.
|
||||
</p>
|
||||
|
||||
<div class="helpIndent">
|
||||
|
||||
<p><b>parameter</b><br />
|
||||
The parameter that defines this variant, for example, size.
|
||||
</p>
|
||||
|
||||
<p><b>value</b><br />
|
||||
The value of the parameter, for the example of size, XL.
|
||||
</p>
|
||||
|
||||
</div>
|
||||
|
||||
<p><b>variant.variantId</b><br />
|
||||
The Id for this variant of the Product.
|
||||
</p>
|
||||
|
||||
<p><b>variant.price</b><br />
|
||||
The price for this variant of the Product.
|
||||
</p>
|
||||
|
||||
<p><b>variant.weight</b><br />
|
||||
The weight for this variant of the Product.
|
||||
</p>
|
||||
|
||||
<p><b>variant.sku</b><br />
|
||||
The SKU for this variant of the Product.
|
||||
</p>
|
||||
|
||||
<p><b>variant.addToCart.url</b><br />
|
||||
A URL to add this variant of the Product to the user's shopping cart.
|
||||
</p>
|
||||
|
||||
<p><b>variant.addToCart.label</b><br />
|
||||
An internationalized label, "^International("add to cart","Macro_Product");",
|
||||
to display to the user for adding this variant
|
||||
of the Product to their shopping cart.
|
||||
</p>
|
||||
|
||||
</div>
|
||||
|
||||
<p><b>productId</b><br />
|
||||
The unique identifier of this Product.</p>
|
||||
|
||||
<p><b>title</b><br />
|
||||
The title for this Product.</p>
|
||||
|
||||
<p><b>description</b><br />
|
||||
The description of this Product.
|
||||
</p>
|
||||
|
||||
<p><b>price</b><br />
|
||||
The Product's base cost.
|
||||
</p>
|
||||
|
||||
<p><b>weight</b><br />
|
||||
The Product's base weight.
|
||||
</p>
|
||||
|
||||
<p><b>sku</b><br />
|
||||
The Product's base SKU.
|
||||
</p>
|
||||
|
||||
|,
|
||||
lastUpdated => 1146609252,
|
||||
lastUpdated => 1149217613,
|
||||
},
|
||||
|
||||
};
|
||||
|
|
|
|||
|
|
@ -12,6 +12,26 @@ our $I18N = {
|
|||
lastUpdated => 1112547248,
|
||||
},
|
||||
|
||||
'url' => {
|
||||
message => q|The URL to purchase a subscription to this item.|,
|
||||
lastUpdated => 1149217400,
|
||||
},
|
||||
|
||||
'name' => {
|
||||
message => q|The name of the item.|,
|
||||
lastUpdated => 1149217400,
|
||||
},
|
||||
|
||||
'description' => {
|
||||
message => q|The description of the item.|,
|
||||
lastUpdated => 1149217400,
|
||||
},
|
||||
|
||||
'price' => {
|
||||
message => q|The price of the item.|,
|
||||
lastUpdated => 1149217400,
|
||||
},
|
||||
|
||||
'subscription item body' => {
|
||||
message => q|
|
||||
|
||||
|
|
@ -22,25 +42,8 @@ template to use instead of the default template, specified by a template Id
|
|||
from the Macro/SubscriptionItem namespace.</p>
|
||||
|
||||
<p>These variables are available in the template:</p>
|
||||
|
||||
<p><b>url</b><br />
|
||||
The URL to purchase a subscription to this item.
|
||||
</p>
|
||||
|
||||
<p><b>name</b><br />
|
||||
The name of the item.
|
||||
</p>
|
||||
|
||||
<p><b>description</b><br />
|
||||
The description of the item.
|
||||
</p>
|
||||
|
||||
<p><b>price</b><br />
|
||||
The price of the item.
|
||||
</p>
|
||||
|
||||
|,
|
||||
lastUpdated => 1146607323,
|
||||
lastUpdated => 1149217429,
|
||||
},
|
||||
};
|
||||
|
||||
|
|
|
|||
|
|
@ -12,6 +12,16 @@ our $I18N = {
|
|||
lastUpdated => 1112503983,
|
||||
},
|
||||
|
||||
'printable.url' => {
|
||||
message => q|The URL to make the page printable.|,
|
||||
lastUpdated => 1149217459,
|
||||
},
|
||||
|
||||
'printable.text' => {
|
||||
message => q|The translated label for the printable link, or the text that you supply to the macro.|,
|
||||
lastUpdated => 1149217459,
|
||||
},
|
||||
|
||||
'printable body' => {
|
||||
message => q|
|
||||
<p><b>^r(<i>link text</i>)</b><br />
|
||||
|
|
@ -28,19 +38,11 @@ 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 name of the template. The following variables are available in the template:</p>
|
||||
|
||||
<p><b>printable.url</b><br />
|
||||
The URL to make the page printable.
|
||||
</p>
|
||||
|
||||
<p><b>printable.text</b><br />
|
||||
The translated label for the printable link, or the text that you supply to the macro.
|
||||
</p>
|
||||
|
||||
<p><b>NOTES:</b>The <i>.makePrintableLink</i> style sheet class is tied to the default template for this macro.
|
||||
</p>
|
||||
|
||||
|,
|
||||
lastUpdated => 1146760682,
|
||||
lastUpdated => 1149217505,
|
||||
},
|
||||
|
||||
'53' => {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue