variable sectioning for all non namespaced Help
This commit is contained in:
Colin Kuskie
parent
65a79bfb41
commit
8fad593e08
4 changed files with 427 additions and 161 deletions
|
|
@ -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',
|
||||
|
|
|
|||
|
|
@ -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',
|
||||
|
|
|
|||
|
|
@ -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|<p>The following template variable is available in this template:</p>
|
||||
|
||||
<p><b>message</b><br />
|
||||
The internationalized cancellation message.
|
||||
</p>
|
||||
|,
|
||||
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.<br />|,
|
||||
lastUpdated => 1149221320,
|
||||
},
|
||||
|
||||
'period' => {
|
||||
message => q| The period of the recurring payment.<br />|,
|
||||
lastUpdated => 1149221320,
|
||||
},
|
||||
|
||||
'name' => {
|
||||
message => q| The name of this item.<br />|,
|
||||
lastUpdated => 1149221320,
|
||||
},
|
||||
|
||||
'price' => {
|
||||
message => q| The price of one item.<br />|,
|
||||
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 <p><b>normalItemLoop</b>|,
|
||||
lastUpdated => 1149221320,
|
||||
},
|
||||
|
||||
'form' => {
|
||||
message => q|The form that's generated by the selected payment plugin.|,
|
||||
lastUpdated => 1149221320,
|
||||
},
|
||||
|
||||
|
||||
'help checkout confirm template body' => {
|
||||
message => q|<p>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.</p>
|
||||
j
|
||||
<p>The following template variables are available in this template:
|
||||
</p>
|
||||
<b>title</b><br />
|
||||
The title to use for this template.<br />
|
||||
<br />
|
||||
<b>normalItems</b><br />
|
||||
Th number of normal items in the shopping cart.<br />
|
||||
<br />
|
||||
<b>normalItemLoop</b>
|
||||
A loop containing the normal items in the shopping-cart. The following template variables are available in this loop:<br />
|
||||
<div class="helpIndent">
|
||||
<b>quantity</b><br />
|
||||
The quantity of the current item in the shopping cart.<br />
|
||||
<br />
|
||||
<b>period</b><br />
|
||||
The period of the recurring payment.<br />
|
||||
<br />
|
||||
<b>name</b><br />
|
||||
The name of this item.<br />
|
||||
<br />
|
||||
<b>price</b><br />
|
||||
The price of one item.<br />
|
||||
<br />
|
||||
<b>totalPrice</b><br />
|
||||
The price of the quantity of this item. (totalPrice = quantity * price)<br />
|
||||
</div>
|
||||
<b>recurringItems</b><br />
|
||||
The number of recurring items in the shopping cart.<br />
|
||||
<br />
|
||||
<b>recurringItemLoop</b><br />
|
||||
A loop containing the recurring items in the shopping cart. For available template variables seen <b>normalItemLoop</b><br />
|
||||
<br />
|
||||
<b>form</b><br />
|
||||
The form that's generated by the selected payment plugin.<br />|,
|
||||
lastUpdated => 1101772672,
|
||||
|
||||
<p>The following template variables are available in this template:</p>
|
||||
|,
|
||||
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.<br />|,
|
|||
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.<br />|,
|
||||
lastUpdated => 1149221449,
|
||||
},
|
||||
|
||||
'status' => {
|
||||
message => q| The status of this item.<br />|,
|
||||
lastUpdated => 1149221449,
|
||||
},
|
||||
|
||||
'error' => {
|
||||
message => q| The error text returned from the payment plugin.<br />|,
|
||||
lastUpdated => 1149221449,
|
||||
},
|
||||
|
||||
'errorCode' => {
|
||||
message => q| The error code returned from the payment plugin.<br />|,
|
||||
lastUpdated => 1149221449,
|
||||
},
|
||||
|
||||
|
||||
'help checkout error template body' => {
|
||||
message => q|The following template variables are available in this template:<br />
|
||||
<br />
|
||||
<b>title</b><br />
|
||||
The title of this template.<br />
|
||||
<br />
|
||||
<b>statusExplanation</b><br />
|
||||
A message which explains the possible statuses an item can have<br />
|
||||
<br />
|
||||
<b>resultLoop</b><br />
|
||||
A template loop containing the items that were checked out. The following template variables are available from within this loop:<br />
|
||||
<div class="helpIndent">
|
||||
<b>purchaseDescription</b><br />
|
||||
The description of this transaction.<br />
|
||||
<br />
|
||||
<b>status</b><br />
|
||||
The status of this item.<br />
|
||||
<br />
|
||||
<b>error</b><br />
|
||||
The error text returned from the payment plugin.<br />
|
||||
<br />
|
||||
<b>errorCode</b><br />
|
||||
The error code returned from the payment plugin.<br />
|
||||
</div>|,
|
||||
message => q|<p>The following template variables are available in this template:</p>
|
||||
|
||||
|,
|
||||
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:<br />
|
||||
<br />
|
||||
<b>message</b><br />
|
||||
This is the message that ask the user to select a payment gateway.<br />
|
||||
<br />
|
||||
<b>pluginsAvailable</b><br />
|
||||
A boolean value that is true when one or more payment plugins can be loaded and are enabled.<br />
|
||||
<br />
|
||||
<b>noPluginsMessage</b><br />
|
||||
A message that says that there are no payment plugins that ca be used.<br />
|
||||
<br />
|
||||
<b>formHeader</b><br />
|
||||
This contains the form header and all hidden form variables that are needed for a successful checkout.<br />
|
||||
<br />
|
||||
<b>formFooter</b><br />
|
||||
The form footer.<br />
|
||||
<br />
|
||||
<b>formSubmit</b><br />
|
||||
The submit button for this form.<br />
|
||||
<br />
|
||||
<b>pluginLoop</b><br />
|
||||
A template loop containing all enabled payment plugins. Within this loop the following template variables are provided:
|
||||
<div class="helpIndent">
|
||||
<b>name</b><br />
|
||||
The name of the plugin.<br />
|
||||
<br />
|
||||
<b>namespace</b><br />
|
||||
The namespace of the plugin. You only need this if you want to create your own custom form elements.<br />
|
||||
<br />
|
||||
<b>formElement</b><br />
|
||||
A radio button tied to this plugin.<br />
|
||||
</div>|,
|
||||
lastUpdated => 1101881921,
|
||||
message => q|<p>In this template the following template variables are available:</p>
|
||||
|,
|
||||
lastUpdated => 1149221754,
|
||||
context => q|The body of the help page of the select payment gateway template.|
|
||||
},
|
||||
|
||||
|
|
|
|||
|
|
@ -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:<br />
|
||||
<br />
|
||||
<b>errorMessage</b><br />
|
||||
A message with an error concerning the cancellation of recurring payment.<br />
|
||||
<br />
|
||||
<b>historyLoop</b><br />
|
||||
A loop containing the transactions in the transaction history. Within this loop these variables are also available:<br />
|
||||
<div class="helpIndent">
|
||||
<b>amount</b><br />
|
||||
The total amount of this transaction.<br />
|
||||
<br />
|
||||
<b>recurring</b><br />
|
||||
A boolean that indicates whether this is a recurring transaction or not.<br />
|
||||
<br />
|
||||
<b>canCancel</b><br />
|
||||
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.<br />
|
||||
<br />
|
||||
<b>cancelUrl</b><br />
|
||||
The URL to visit when you ant to cancel this recurring transaction.<br />
|
||||
<br />
|
||||
<b>initDate</b><br />
|
||||
The date the transaction was initialized.<br />
|
||||
<br />
|
||||
<b>completionDate</b><br />
|
||||
The date on which the transaction has been confirmed.<br />
|
||||
<br />
|
||||
<b>status</b><br />
|
||||
The status for this transaction.<br />
|
||||
<br />
|
||||
<b>lastPayedTerm</b><br />
|
||||
The most recent term that has been payed. This is an integer.<br />
|
||||
<br />
|
||||
<b>gateway</b><br />
|
||||
The payment gateway that was used.<br />
|
||||
<br />
|
||||
<b>gatewayId</b><br />
|
||||
The ID that is assigned to this transaction by the payment gateway.<br />
|
||||
<br />
|
||||
<b>transactionId</b><br />
|
||||
The internal ID that is assigned to this transaction by WebGUI.<br />
|
||||
<br />
|
||||
<b>userId</b><br />
|
||||
The internal WebGUI user ID of the user that performed this transaction.<br />
|
||||
<br />
|
||||
<b>itemLoop</b>
|
||||
This loop contains all items the transaction consists of. These variables are available:<br />
|
||||
<div class="helpIndent">
|
||||
<b>amount</b><br />
|
||||
The amount of this item.<br />
|
||||
<br />
|
||||
<b>itemName</b><br />
|
||||
The name of this item.<br />
|
||||
<br />
|
||||
<b>itemId</b><br />
|
||||
The internal WebGUI ID tied to this item.<br />
|
||||
<br />
|
||||
<b>itemType</b><br />
|
||||
The type that this item's of.<br />
|
||||
<br />
|
||||
<b>quantity</b><br />
|
||||
The quantity in which this item is bought.<br />
|
||||
</div>
|
||||
</div>|,
|
||||
lastUpdated => 1101753027,
|
||||
message => q|<p>The following template variables are available in this template:</p>
|
||||
|,
|
||||
lastUpdated => 1149222379,
|
||||
context => q|The body of the help page of the purchase history template.|
|
||||
},
|
||||
'help purchase history template title' => {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue