diff --git a/lib/WebGUI/Help/Commerce.pm b/lib/WebGUI/Help/Commerce.pm index 88e1eb1a7..52e757ba4 100644 --- a/lib/WebGUI/Help/Commerce.pm +++ b/lib/WebGUI/Help/Commerce.pm @@ -67,6 +67,11 @@ our $HELP = { 'cancel template' => { title => 'help cancel checkout template title', body => 'help cancel checkout template body', + variables => [ + { + 'name' => 'message' + } + ], fields => [ ], related => [ @@ -82,6 +87,43 @@ our $HELP = { body => 'help checkout confirm template body', fields => [ ], + variables => [ + { + 'name' => 'title' + }, + { + 'name' => 'normalItems' + }, + { + 'name' => 'normalItemLoop', + 'variables' => [ + { + 'name' => 'quantity' + }, + { + 'name' => 'period' + }, + { + 'name' => 'name' + }, + { + 'name' => 'price' + }, + { + 'name' => 'totalPrice' + } + ] + }, + { + 'name' => 'recurringItems' + }, + { + 'name' => 'recurringItemLoop' + }, + { + 'name' => 'form' + } + ], related => [ { tag => 'template language', @@ -95,6 +137,31 @@ our $HELP = { body => 'help checkout error template body', fields => [ ], + variables => [ + { + 'name' => 'title', + }, + { + 'name' => 'statusExplanation' + }, + { + 'name' => 'resultLoop', + 'variables' => [ + { + 'name' => 'purchaseDescription' + }, + { + 'name' => 'status' + }, + { + 'name' => 'error' + }, + { + 'name' => 'errorCode' + } + ] + } + ], related => [ { tag => 'template language', @@ -108,6 +175,42 @@ our $HELP = { body => 'help select payment template body', fields => [ ], + variables => [ + { + 'name' => 'message', + 'description' => 'gateway message' + }, + { + 'name' => 'pluginsAvailable' + }, + { + 'name' => 'noPluginsMessage' + }, + { + 'name' => 'formHeader' + }, + { + 'name' => 'formFooter' + }, + { + 'name' => 'formSubmit' + }, + { + 'name' => 'pluginLoop', + 'variables' => [ + { + 'name' => 'name', + 'description' => 'plugin name' + }, + { + 'name' => 'namespace' + }, + { + 'name' => 'formElement' + } + ] + } + ], related => [ { tag => 'template language', diff --git a/lib/WebGUI/Help/TransactionLog.pm b/lib/WebGUI/Help/TransactionLog.pm index 127f2b07f..3fdab44fe 100644 --- a/lib/WebGUI/Help/TransactionLog.pm +++ b/lib/WebGUI/Help/TransactionLog.pm @@ -6,6 +6,75 @@ our $HELP = { body => 'help purchase history template body', fields => [ ], + variables => [ + { + 'name' => 'errorMessage' + }, + { + 'name' => 'historyLoop', + 'variables' => [ + { + 'name' => 'amount', + 'description' => 'amount.template' + }, + { + 'name' => 'recurring' + }, + { + 'name' => 'canCancel' + }, + { + 'name' => 'cancelUrl' + }, + { + 'name' => 'initDate' + }, + { + 'name' => 'completionDate' + }, + { + 'name' => 'status', + 'description' => 'status.template' + }, + { + 'name' => 'lastPayedTerm' + }, + { + 'name' => 'gateway' + }, + { + 'name' => 'gatewayId' + }, + { + 'name' => 'transactionId' + }, + { + 'name' => 'userId' + }, + { + 'name' => 'itemLoop', + 'variables' => [ + { + 'name' => 'amount', + 'description' => 'amount.template' + }, + { + 'name' => 'itemName' + }, + { + 'name' => 'itemId' + }, + { + 'name' => 'itemType' + }, + { + 'name' => 'quantity' + } + ] + } + ] + } + ], related => [ { tag => 'template language', diff --git a/lib/WebGUI/i18n/English/Commerce.pm b/lib/WebGUI/i18n/English/Commerce.pm index 67ebba9bf..4dd7412f0 100755 --- a/lib/WebGUI/i18n/English/Commerce.pm +++ b/lib/WebGUI/i18n/English/Commerce.pm @@ -332,56 +332,80 @@ our $I18N = { context => q|The title of the help page of the cancel checkout template.| }, + 'message' => { + message => q|The internationalized cancellation message.|, + lastUpdated => 1149221050, + }, + 'help cancel checkout template body' => { message => q|

The following template variable is available in this template:

- -

message
-The internationalized cancellation message. -

|, - lastUpdated => 1146802746, + lastUpdated => 1149221067, context => q|The body of the help page of the cancel checkout template.| }, + 'title' => { + message => q|The title to use for this template.|, + lastUpdated => 1149221320, + }, + + 'normalItems' => { + message => q|The number of normal items in the shopping cart.|, + lastUpdated => 1149221320, + }, + + 'normalItemLoop' => { + message => q|A loop containing the normal items in the shopping-cart. The following template variables are available in this loop:|, + lastUpdated => 1149221320, + }, + + 'quantity' => { + message => q| The quantity of the current item in the shopping cart.
|, + lastUpdated => 1149221320, + }, + + 'period' => { + message => q| The period of the recurring payment.
|, + lastUpdated => 1149221320, + }, + + 'name' => { + message => q| The name of this item.
|, + lastUpdated => 1149221320, + }, + + 'price' => { + message => q| The price of one item.
|, + lastUpdated => 1149221320, + }, + + 'totalPrice' => { + message => q| The price of the quantity of this item. (totalPrice = quantity * price)|, + lastUpdated => 1149221320, + }, + + 'recurringItems' => { + message => q|The number of recurring items in the shopping cart.|, + lastUpdated => 1149221320, + }, + + 'recurringItemLoop' => { + message => q|A loop containing the recurring items in the shopping cart. For available template variables seen

normalItemLoop|, + lastUpdated => 1149221320, + }, + + 'form' => { + message => q|The form that's generated by the selected payment plugin.|, + lastUpdated => 1149221320, + }, + 'help checkout confirm template body' => { message => q|

This template separates normal and recurring items. A normal item is an item that is payed only once. Recurring items are payed once a period, like a subscription.

- j -

The following template variables are available in this template: -

-title
-The title to use for this template.
-
-normalItems
-Th number of normal items in the shopping cart.
-
-normalItemLoop -A loop containing the normal items in the shopping-cart. The following template variables are available in this loop:
-
- quantity
- The quantity of the current item in the shopping cart.
-
- period
- The period of the recurring payment.
-
- name
- The name of this item.
-
- price
- The price of one item.
-
- totalPrice
- The price of the quantity of this item. (totalPrice = quantity * price)
-
-recurringItems
-The number of recurring items in the shopping cart.
-
-recurringItemLoop
-A loop containing the recurring items in the shopping cart. For available template variables seen normalItemLoop
-
-form
-The form that's generated by the selected payment plugin.
|, - lastUpdated => 1101772672, + +

The following template variables are available in this template:

+|, + lastUpdated => 1149221368, context => q|The body of the help page of the confirm checkout template.| }, @@ -392,31 +416,41 @@ The form that's generated by the selected payment plugin.
|, context => q|The title of the help page of the confirm checkout template.| }, + 'statusExplanation' => { + message => q|A message which explains the possible statuses an item can have|, + lastUpdated => 1149221449, + }, + + 'resultLoop' => { + message => q|A template loop containing the items that were checked out.|, + lastUpdated => 1149221449, + }, + + 'purchaseDescription' => { + message => q| The description of this transaction.
|, + lastUpdated => 1149221449, + }, + + 'status' => { + message => q| The status of this item.
|, + lastUpdated => 1149221449, + }, + + 'error' => { + message => q| The error text returned from the payment plugin.
|, + lastUpdated => 1149221449, + }, + + 'errorCode' => { + message => q| The error code returned from the payment plugin.
|, + lastUpdated => 1149221449, + }, + 'help checkout error template body' => { - message => q|The following template variables are available in this template:
-
-title
-The title of this template.
-
-statusExplanation
-A message which explains the possible statuses an item can have
-
-resultLoop
-A template loop containing the items that were checked out. The following template variables are available from within this loop:
-
- purchaseDescription
- The description of this transaction.
-
- status
- The status of this item.
-
- error
- The error text returned from the payment plugin.
-
- errorCode
- The error code returned from the payment plugin.
-
|, + message => q|

The following template variables are available in this template:

+ +|, lastUpdated => 0, context => q|The body of the help page of the checkout error template.| }, @@ -463,40 +497,60 @@ A template loop containing the items that were checked out. The following templa context => q|The title of the 'select payment gateway' help page.| }, + 'gateway message' => { + message => q|This is the message that ask the user to select a payment gateway.|, + lastUpdated => 1149221607, + }, + + 'pluginsAvailable' => { + message => q|A boolean value that is true when one or more payment plugins can be loaded and are enabled.|, + lastUpdated => 1149221607, + }, + + 'noPluginsMessage' => { + message => q|A message that says that there are no payment plugins that ca be used.|, + lastUpdated => 1149221607, + }, + + 'formHeader' => { + message => q|This contains the form header and all hidden form variables that are needed for a successful checkout.|, + lastUpdated => 1149221607, + }, + + 'formFooter' => { + message => q|The form footer.|, + lastUpdated => 1149221607, + }, + + 'formSubmit' => { + message => q|The submit button for this form.|, + lastUpdated => 1149221607, + }, + + 'pluginLoop' => { + message => q|A template loop containing all enabled payment plugins. Within this loop the following template variables are provided:|, + lastUpdated => 1149221607, + }, + + 'plugin name' => { + message => q|The name of the plugin.|, + lastUpdated => 1149221607, + }, + + 'namespace' => { + message => q|The namespace of the plugin. You only need this if you want to create your own custom form elements.|, + lastUpdated => 1149221607, + }, + + 'formElement' => { + message => q|A radio button tied to this plugin.|, + lastUpdated => 1149221607, + }, + 'help select payment template body' => { - message => q|In this template the following template variables are available:
-
-message
-This is the message that ask the user to select a payment gateway.
-
-pluginsAvailable
-A boolean value that is true when one or more payment plugins can be loaded and are enabled.
-
-noPluginsMessage
-A message that says that there are no payment plugins that ca be used.
-
-formHeader
-This contains the form header and all hidden form variables that are needed for a successful checkout.
-
-formFooter
-The form footer.
-
-formSubmit
-The submit button for this form.
-
-pluginLoop
-A template loop containing all enabled payment plugins. Within this loop the following template variables are provided: -
-name
-The name of the plugin.
-
-namespace
-The namespace of the plugin. You only need this if you want to create your own custom form elements.
-
-formElement
-A radio button tied to this plugin.
-
|, - lastUpdated => 1101881921, + message => q|

In this template the following template variables are available:

+|, + lastUpdated => 1149221754, context => q|The body of the help page of the select payment gateway template.| }, diff --git a/lib/WebGUI/i18n/English/TransactionLog.pm b/lib/WebGUI/i18n/English/TransactionLog.pm index cc544e6b3..9448d7817 100644 --- a/lib/WebGUI/i18n/English/TransactionLog.pm +++ b/lib/WebGUI/i18n/English/TransactionLog.pm @@ -13,71 +13,111 @@ our $I18N = { context => q|An error message that's shown when an attempt is made to cancel a non recurring transaction.| }, + 'errorMessage' => { + message => q|A message with an error concerning the cancellation of recurring payment.|, + lastUpdated => 1149222142, + }, + + 'historyLoop' => { + message => q|A loop containing the transactions in the transaction history. Within this loop these variables are also available:|, + lastUpdated => 1149222142, + }, + + 'amount.template' => { + message => q|The total amount of this transaction.|, + lastUpdated => 1149222142, + }, + + 'recurring' => { + message => q|A boolean that indicates whether this is a recurring transaction or not.|, + lastUpdated => 1149222142, + }, + + 'canCancel' => { + message => q|A boolean value indicating whether it's possible to cancel this transaction. This is only the case with recurring payments that haven't been canceled yet.|, + lastUpdated => 1149222142, + }, + + 'cancelUrl' => { + message => q|The URL to visit when you ant to cancel this recurring transaction.|, + lastUpdated => 1149222142, + }, + + 'initDate' => { + message => q|The date the transaction was initialized.|, + lastUpdated => 1149222142, + }, + + 'completionDate' => { + message => q|The date on which the transaction has been confirmed.|, + lastUpdated => 1149222142, + }, + + 'status.template' => { + message => q|The status for this transaction.|, + lastUpdated => 1149222142, + }, + + 'lastPayedTerm' => { + message => q|The most recent term that has been payed. This is an integer.|, + lastUpdated => 1149222142, + }, + + 'gateway' => { + message => q|The payment gateway that was used.|, + lastUpdated => 1149222142, + }, + + 'gatewayId' => { + message => q|The ID that is assigned to this transaction by the payment gateway.|, + lastUpdated => 1149222142, + }, + + 'transactionId' => { + message => q|The internal ID that is assigned to this transaction by WebGUI.|, + lastUpdated => 1149222142, + }, + + 'userId' => { + message => q|The internal WebGUI user ID of the user that performed this transaction.|, + lastUpdated => 1149222142, + }, + + 'itemLoop' => { + message => q|This loop contains all items the transaction consists of. These variables are available:|, + lastUpdated => 1149222142, + }, + + 'amount.template' => { + message => q|The amount of this item.|, + lastUpdated => 1149222142, + }, + + 'itemName' => { + message => q|The name of this item.|, + lastUpdated => 1149222142, + }, + + 'itemId' => { + message => q|The internal WebGUI ID tied to this item.|, + lastUpdated => 1149222142, + }, + + 'itemType' => { + message => q|The type that this item's of.|, + lastUpdated => 1149222142, + }, + + 'quantity' => { + message => q|The quantity in which this item is bought.|, + lastUpdated => 1149222142, + }, + + 'help purchase history template body' => { - message => q|The following template variables are available in this template:
-
-errorMessage
-A message with an error concerning the cancellation of recurring payment.
-
-historyLoop
-A loop containing the transactions in the transaction history. Within this loop these variables are also available:
-
- amount
- The total amount of this transaction.
-
- recurring
- A boolean that indicates whether this is a recurring transaction or not.
-
- canCancel
- A boolean value indicating whether it's possible to cancel this transaction. This is only the case with recurring payments that haven't been canceled yet.
-
- cancelUrl
- The URL to visit when you ant to cancel this recurring transaction.
-
- initDate
- The date the transaction was initialized.
-
- completionDate
- The date on which the transaction has been confirmed.
-
- status
- The status for this transaction.
-
- lastPayedTerm
- The most recent term that has been payed. This is an integer.
-
- gateway
- The payment gateway that was used.
-
- gatewayId
- The ID that is assigned to this transaction by the payment gateway.
-
- transactionId
- The internal ID that is assigned to this transaction by WebGUI.
-
- userId
- The internal WebGUI user ID of the user that performed this transaction.
-
- itemLoop - This loop contains all items the transaction consists of. These variables are available:
-
- amount
- The amount of this item.
-
- itemName
- The name of this item.
-
- itemId
- The internal WebGUI ID tied to this item.
-
- itemType
- The type that this item's of.
-
- quantity
- The quantity in which this item is bought.
-
-
|, - lastUpdated => 1101753027, + message => q|

The following template variables are available in this template:

+|, + lastUpdated => 1149222379, context => q|The body of the help page of the purchase history template.| }, 'help purchase history template title' => {