From c0dd288dfc0339fb5de85e0d8e36d9802ba2bcf0 Mon Sep 17 00:00:00 2001 From: Colin Kuskie Date: Fri, 2 Jun 2006 03:27:36 +0000 Subject: [PATCH] all macro template docs broken into variable entries --- lib/WebGUI/Help/Macro_EditableToggle.pm | 8 + lib/WebGUI/Help/Macro_GroupAdd.pm | 8 + lib/WebGUI/Help/Macro_GroupDelete.pm | 8 + lib/WebGUI/Help/Macro_H_homeLink.pm | 8 + lib/WebGUI/Help/Macro_Product.pm | 57 ++++++ lib/WebGUI/Help/Macro_SubscriptionItem.pm | 14 ++ lib/WebGUI/Help/Macro_r_printable.pm | 8 + .../i18n/English/Macro_EditableToggle.pm | 19 +- lib/WebGUI/i18n/English/Macro_GroupAdd.pm | 25 +-- lib/WebGUI/i18n/English/Macro_GroupDelete.pm | 24 +-- lib/WebGUI/i18n/English/Macro_H_homeLink.pm | 21 +-- lib/WebGUI/i18n/English/Macro_Product.pm | 167 ++++++++++-------- .../i18n/English/Macro_SubscriptionItem.pm | 39 ++-- lib/WebGUI/i18n/English/Macro_r_printable.pm | 20 ++- 14 files changed, 283 insertions(+), 143 deletions(-) diff --git a/lib/WebGUI/Help/Macro_EditableToggle.pm b/lib/WebGUI/Help/Macro_EditableToggle.pm index 9c43edcc7..b34da963d 100644 --- a/lib/WebGUI/Help/Macro_EditableToggle.pm +++ b/lib/WebGUI/Help/Macro_EditableToggle.pm @@ -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 => [ diff --git a/lib/WebGUI/Help/Macro_GroupAdd.pm b/lib/WebGUI/Help/Macro_GroupAdd.pm index f0f7f4b93..408cc8444 100644 --- a/lib/WebGUI/Help/Macro_GroupAdd.pm +++ b/lib/WebGUI/Help/Macro_GroupAdd.pm @@ -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 => [ diff --git a/lib/WebGUI/Help/Macro_GroupDelete.pm b/lib/WebGUI/Help/Macro_GroupDelete.pm index cbf8e42f0..c7c185a69 100644 --- a/lib/WebGUI/Help/Macro_GroupDelete.pm +++ b/lib/WebGUI/Help/Macro_GroupDelete.pm @@ -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 => [ diff --git a/lib/WebGUI/Help/Macro_H_homeLink.pm b/lib/WebGUI/Help/Macro_H_homeLink.pm index b9549771f..35cc08bb2 100644 --- a/lib/WebGUI/Help/Macro_H_homeLink.pm +++ b/lib/WebGUI/Help/Macro_H_homeLink.pm @@ -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 => [ diff --git a/lib/WebGUI/Help/Macro_Product.pm b/lib/WebGUI/Help/Macro_Product.pm index 6417a2bec..9fa504451 100644 --- a/lib/WebGUI/Help/Macro_Product.pm +++ b/lib/WebGUI/Help/Macro_Product.pm @@ -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 => [ diff --git a/lib/WebGUI/Help/Macro_SubscriptionItem.pm b/lib/WebGUI/Help/Macro_SubscriptionItem.pm index 1f81f4fda..fd97e54cb 100644 --- a/lib/WebGUI/Help/Macro_SubscriptionItem.pm +++ b/lib/WebGUI/Help/Macro_SubscriptionItem.pm @@ -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 => [ diff --git a/lib/WebGUI/Help/Macro_r_printable.pm b/lib/WebGUI/Help/Macro_r_printable.pm index b762b1092..4a40e61ea 100644 --- a/lib/WebGUI/Help/Macro_r_printable.pm +++ b/lib/WebGUI/Help/Macro_r_printable.pm @@ -5,6 +5,14 @@ our $HELP = { 'printable' => { title => 'printable title', body => 'printable body', + variables => [ + { + 'name' => 'printable.url' + }, + { + 'name' => 'printable.text' + } + ], fields => [ ], related => [ diff --git a/lib/WebGUI/i18n/English/Macro_EditableToggle.pm b/lib/WebGUI/i18n/English/Macro_EditableToggle.pm index 14ef491ed..c0bf60a1f 100644 --- a/lib/WebGUI/i18n/English/Macro_EditableToggle.pm +++ b/lib/WebGUI/i18n/English/Macro_EditableToggle.pm @@ -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|

^EditableToggle; or ^EditableToggle();
@@ -21,15 +31,8 @@ Exactly the same as AdminToggle, except that the toggle is only displayed if the

The 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. -

|, - lastUpdated => 1146679223, + lastUpdated => 1149218452, }, '516' => { diff --git a/lib/WebGUI/i18n/English/Macro_GroupAdd.pm b/lib/WebGUI/i18n/English/Macro_GroupAdd.pm index 0c887d7f0..bab863f74 100644 --- a/lib/WebGUI/i18n/English/Macro_GroupAdd.pm +++ b/lib/WebGUI/i18n/English/Macro_GroupAdd.pm @@ -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|

^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:

- -

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. -

+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.

NOTE: All these conditions must be met for the link to be displayed:

@@ -37,8 +39,11 @@ The supplied text string for the user to click on.
  • The group must be set up to allow auto adds.
    • + +

    These variables are available in the template:

    + |, - lastUpdated => 1146679385, + lastUpdated => 1149218365, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_GroupDelete.pm b/lib/WebGUI/i18n/English/Macro_GroupDelete.pm index a0618fce3..bdd6f4805 100644 --- a/lib/WebGUI/i18n/English/Macro_GroupDelete.pm +++ b/lib/WebGUI/i18n/English/Macro_GroupDelete.pm @@ -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|

    ^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. -

    - -

    group.text
    -The supplied text string for the user to click on. -

    +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.

    NOTE: All these conditions must be met for the link to be displayed:

    @@ -36,8 +38,10 @@ The supplied text string for the user to click on. +

    >These variables are available in the template:

    + |, - lastUpdated => 1146679429, + lastUpdated => 1149217752, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_H_homeLink.pm b/lib/WebGUI/i18n/English/Macro_H_homeLink.pm index aed321110..fde203941 100644 --- a/lib/WebGUI/i18n/English/Macro_H_homeLink.pm +++ b/lib/WebGUI/i18n/English/Macro_H_homeLink.pm @@ -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|

    ^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. -

    - |, - lastUpdated => 1146686357, + lastUpdated => 1149217683, }, '47' => { diff --git a/lib/WebGUI/i18n/English/Macro_Product.pm b/lib/WebGUI/i18n/English/Macro_Product.pm index 87003086a..0e6fc2c4c 100644 --- a/lib/WebGUI/i18n/English/Macro_Product.pm +++ b/lib/WebGUI/i18n/English/Macro_Product.pm @@ -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.

    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:

    - -

    variants.message
    -The internationalized text "^International("available product configurations","Macro_Product");" -

    - -

    variantLoop
    -A loop containing information about all variants about the Product. -

    - -
    - -

    variant.compositionLoop
    -A loop containing information about all variants about the Product. -

    - -
    - -

    parameter
    -The parameter that defines this variant, for example, size. -

    - -

    value
    -The value of the parameter, for the example of size, XL. -

    - -
    - -

    variant.variantId
    -The Id for this variant of the Product. -

    - -

    variant.price
    -The price for this variant of the Product. -

    - -

    variant.weight
    -The weight for this variant of the Product. -

    - -

    variant.sku
    -The SKU for this variant of the Product. -

    - -

    variant.addToCart.url
    -A URL to add this variant of the Product to the user's shopping cart. -

    - -

    variant.addToCart.label
    -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. -

    - -
    - -

    productId
    -The unique identifier of this Product.

    - -

    title
    -The title for this Product.

    - -

    description
    -The description of this Product. -

    - -

    price
    -The Product's base cost. -

    - -

    weight
    -The Product's base weight. -

    - -

    sku
    -The Product's base SKU. -

    - |, - lastUpdated => 1146609252, + lastUpdated => 1149217613, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_SubscriptionItem.pm b/lib/WebGUI/i18n/English/Macro_SubscriptionItem.pm index 2569ee462..edf7f7ddc 100644 --- a/lib/WebGUI/i18n/English/Macro_SubscriptionItem.pm +++ b/lib/WebGUI/i18n/English/Macro_SubscriptionItem.pm @@ -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.

    These variables are available in the template:

    - -

    url
    -The URL to purchase a subscription to this item. -

    - -

    name
    -The name of the item. -

    - -

    description
    -The description of the item. -

    - -

    price
    -The price of the item. -

    - |, - lastUpdated => 1146607323, + lastUpdated => 1149217429, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_r_printable.pm b/lib/WebGUI/i18n/English/Macro_r_printable.pm index e0d330357..334dc27e1 100644 --- a/lib/WebGUI/i18n/English/Macro_r_printable.pm +++ b/lib/WebGUI/i18n/English/Macro_r_printable.pm @@ -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|

    ^r(link text)
    @@ -28,19 +38,11 @@ Creates a link to alter the style from a page to make it printable.

    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:

    -

    printable.url
    -The URL to make the page printable. -

    - -

    printable.text
    -The translated label for the printable link, or the text that you supply to the macro. -

    -

    NOTES:The .makePrintableLink style sheet class is tied to the default template for this macro.

    |, - lastUpdated => 1146760682, + lastUpdated => 1149217505, }, '53' => {