oqapi/webgui
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Commerce, Product, Subscription, and AuthWebGUI help pruning

Browse source
This commit is contained in:
Colin Kuskie 2007-07-18 20:58:26 +00:00
parent 40a49bc913
commit b11b36aa39
8 changed files with 21 additions and 553 deletions
Download patch file Download diff file Expand all files Collapse all files

18
lib/WebGUI/Help/AuthWebGUI.pm
View file

@ -3,7 +3,7 @@ package WebGUI::Help::AuthWebGUI;
our $HELP = {
'webgui authentication display account template' => {
title => 'display account template title',
body => 'display account template body',
body => '',
isa => [
{
namespace => "Auth",
@ -44,9 +44,10 @@ our $HELP = {
related => [
]
},
'webgui authentication login template' => {
title => 'login template title',
body => 'login template body',
body => '',
isa => [
{
namespace => "Auth",
@ -72,9 +73,10 @@ our $HELP = {
related => [
]
},
'webgui authentication anonymous registration template' => {
title => 'anon reg template title',
body => 'anon reg template body',
body => '',
fields => [
],
isa => [
@ -121,9 +123,10 @@ our $HELP = {
related => [
]
},
'webgui authentication password recovery template' => {
title => 'recovery template title',
body => 'recovery template body',
body => '',
variables => [
{
'name' => 'title',
@ -200,9 +203,10 @@ our $HELP = {
related => [
]
},
'webgui authentication password expiration template' => {
title => 'expired template title',
body => 'expired template body',
body => '',
variables => [
{
'name' => 'expired.form.header'
@ -246,9 +250,10 @@ our $HELP = {
related => [
]
},
'webgui deactivate account template' => {
title => 'deactivate account template title',
body => 'deactivate account template body',
body => '',
isa => [
{
namespace => "Auth",
@ -259,6 +264,7 @@ our $HELP = {
fields => [ ],
related => [ ],
},
};
1;

75
lib/WebGUI/Help/Commerce.pm
View file

@ -1,77 +1,10 @@
package WebGUI::Help::Commerce;
our $HELP = {
'commerce manage' => {
title => 'help manage commerce title',
body => 'help manage commerce body',
fields => [
{
title => 'confirm checkout template',
description => 'confirm checkout template description',
namespace => 'Commerce',
},
{
title => 'transaction error template',
description => 'transaction error template description',
namespace => 'Commerce',
},
{
title => 'checkout canceled template',
description => 'checkout canceled template description',
namespace => 'Commerce',
},
{
title => 'checkout select payment template',
description => 'checkout select payment template description',
namespace => 'Commerce',
},
{
title => 'checkout select shipping template',
description => 'checkout select shipping template description',
namespace => 'Commerce',
},
{
title => 'view shopping cart template',
description => 'view shopping cart template description',
namespace => 'Commerce',
},
{
title => 'daily report email',
description => 'daily report email description',
namespace => 'Commerce',
},
{
title => 'payment plugin',
description => 'payment plugin description',
namespace => 'Commerce',
},
{
title => 'shipping plugin label',
description => 'shipping plugin label description',
namespace => 'Commerce',
},
{
title => 'enable sales tax',
description => 'enable sales tax description',
namespace => 'Commerce',
},
],
related => [
]
},
'list pending transactions' => {
title => 'list pending transactions',
body => 'help manage pending transactions body',
fields => [
],
related => [
]
},
'cancel template' => {
title => 'help cancel checkout template title',
body => 'help cancel checkout template body',
body => '',
variables => [
{
'name' => 'message'
@ -89,7 +22,7 @@ our $HELP = {
'confirm template' => {
title => 'help checkout confirm template title',
body => 'help checkout confirm template body',
body => '',
fields => [
],
variables => [
@ -148,7 +81,7 @@ our $HELP = {
'error template' => {
title => 'help checkout error template title',
body => 'help checkout error template body',
body => '',
fields => [
],
variables => [
@ -186,7 +119,7 @@ our $HELP = {
'select payment gateway template' => {
title => 'help select payment template title',
body => 'help select payment template body',
body => '',
fields => [
],
variables => [

4
lib/WebGUI/Help/Macro_Product.pm
View file

@ -65,10 +65,6 @@ our $HELP = {
fields => [
],
related => [
{
tag => 'manage product',
namespace => 'ProductManager'
},
]
},

142
lib/WebGUI/Help/ProductManager.pm
View file

@ -1,149 +1,7 @@
package WebGUI::Help::ProductManager;
our $HELP = {
'list products' => {
title => 'help list products title',
body => 'help list products body',
fields => [
],
related => [
]
},
'manage product' => {
title => 'help manage product title',
body => 'help manage product body',
fields => [
],
related => [
]
},
'edit product' => {
title => 'help edit product title',
body => 'help edit product body',
fields => [
{
title => 'title',
description => 'title description',
namespace => 'ProductManager',
},
{
title => 'description',
description => 'description description',
namespace => 'ProductManager',
},
{
title => 'price',
description => 'price description',
namespace => 'ProductManager',
},
{
title => 'weight',
description => 'weight description',
namespace => 'ProductManager',
},
{
title => 'sku',
description => 'sku description',
namespace => 'ProductManager',
},
{
title => 'template',
description => 'template description',
namespace => 'ProductManager',
},
{
title => 'sku template',
description => 'sku template description',
namespace => 'ProductManager',
},
],
related => [
{
tag => 'template language',
namespace => 'Asset_Template'
},
]
},
'edit parameter' => {
title => 'help edit parameter title',
body => 'help edit parameter body',
fields => [
{
title => 'edit parameter name',
description => 'edit parameter name description',
namespace => 'ProductManager',
},
],
related => [
]
},
'edit option' => {
title => 'help edit option title',
body => 'help edit option body',
fields => [
{
title => 'edit option value',
description => 'edit option value description',
namespace => 'ProductManager',
},
{
title => 'edit option price modifier',
description => 'edit option price modifier description',
namespace => 'ProductManager',
},
{
title => 'edit option weight modifier',
description => 'edit option weight modifier description',
namespace => 'ProductManager',
},
{
title => 'edit option sku modifier',
description => 'edit option sku modifier description',
namespace => 'ProductManager',
},
],
related => [
]
},
'list variants' => {
title => 'help list variants title',
body => 'help list variants body',
fields => [
],
related => [
]
},
'edit variant' => {
title => 'help edit variant title',
body => 'help edit variant body',
fields => [
{
title => 'price override',
description => 'price override description',
namespace => 'ProductManager',
},
{
title => 'weight override',
description => 'weight override description',
namespace => 'ProductManager',
},
{
title => 'sku override',
description => 'sku override description',
namespace => 'ProductManager',
},
{
title => 'available',
description => 'available description',
namespace => 'ProductManager',
},
],
related => [
]
},
'edit sku template' => {
title => 'help edit sku template title',
body => 'help edit sku template body',

42
lib/WebGUI/i18n/English/AuthWebGUI.pm
View file

@ -161,13 +161,6 @@ our $I18N = {
lastUpdated => 1149220294,
},
'login template body' => {
message => q|<p>The following template variables are available for WebGUI Authentication Login templates.
</p>
|,
lastUpdated => 1149220323
},
'18' => {
message => q|Allow Users to Change Passwords?|,
lastUpdated => 1076357595
@ -233,13 +226,6 @@ our $I18N = {
lastUpdated => 1149220347,
},
'expired template body' => {
message => q|
<p>The following template variables are available for WebGUI Authentication Password Expiration templates.</p>
|,
lastUpdated => 1149220376
},
'16' => {
message => q|Password Timeout|,
lastUpdated => 1071885309
@ -350,13 +336,6 @@ our $I18N = {
lastUpdated => 1165440841,
},
'recovery template body' => {
message => q|<p>The following template variables are available for WebGUI Authentication Password Recovery templates.</p>
|,
lastUpdated => 1149220524
},
'20' => {
message => q|Allow User to Change Password?|,
lastUpdated => 1076358606
@ -432,13 +411,6 @@ our $I18N = {
lastUpdated => 1149220575,
},
'display account template body' => {
message => q|<p>The following template variables are available for WebGUI Authentication Display Account templates. </p>
|,
lastUpdated => 1149220652
},
'create.form.hidden' => {
message => q|Hidden form fields required for form submittal.|,
lastUpdated => 1149220721,
@ -479,13 +451,6 @@ our $I18N = {
lastUpdated => 1149220721,
},
'anon reg template body' => {
message => q|<p>The following template variables are available for WebGUI Authentication Anonymous Registration templates. </p>
|,
lastUpdated => 1149220828
},
'19' => {
message => q|Allow Users to Change Username?|,
lastUpdated => 1076358029
@ -511,13 +476,6 @@ our $I18N = {
lastUpdated => 1164394401
},
'deactivate account template body' => {
message => q|<p>The following template variables are available for the WebGUI Authentication Deactivate account templates.
</p>
|,
lastUpdated => 1164394398
},
'topicName' => {
message => q|WebGUI Authentication|,
lastUpdated => 1128919828,

68
lib/WebGUI/i18n/English/Commerce.pm
View file

@ -84,13 +84,6 @@ our $I18N = {
},
'help manage commerce title' => {
message => q|Commerce, Manage|,
lastUpdated => 0,
context => q|The title of the manage commerce help page.|
},
'confirm checkout template description' => {
message => q|<p>This template is shown when a user is asked to confirm his purchase. The form data for the payment gateway is also shown here.</p>|,
lastUpdated => 1138922899,
@ -146,13 +139,6 @@ our $I18N = {
},
'help manage commerce body' => {
message => q|<p>The commerce system of WebGUI is highly configurable. You can set the following properties:</p>|,
lastUpdated => 1138922965,
context => q|The content of the manage commerce help page.|
},
'manage commerce settings' => {
message => q|Manage commerce settings.|,
lastUpdated => 1101772609,
@ -320,26 +306,14 @@ our $I18N = {
context => q|Label for the link that allows you to complete a pending transaction.|
},
'help manage pending transactions title' => {
message => q|List pending transactions|,
lastUpdated => 0,
context => q|The title of the help page of the list pending transactions screen.|
},
'list pending transactions' => {
message => q|List pending transactions|,
lastUpdated => 0,
},
'help manage pending transactions body' => {
message => q|<p>All transactions that are marked as 'Pending' are listed here. Transactions are marked pending if some extra review is required. For instance when a transaction is suspected of fraud. Pending transactions can also be transactions that have yet to be confirmed by something as or similar to PayPal's APN. If you have checked that the transaction is legit you can click on the 'Complete transaction' link.</p>|,
lastUpdated => 1165518203,
context => q|The body of the help page of the list pending transactions screen.|
},
'help cancel checkout template title' => {
message => q|Cancel checkout template|,
lastUpdated => 0,
message => q|Cancel checkout template variables|,
lastUpdated => 1184790373,
context => q|The title of the help page of the cancel checkout template.|
},
@ -348,13 +322,6 @@ our $I18N = {
lastUpdated => 1149221050,
},
'help cancel checkout template body' => {
message => q|<p>The following template variable is available in this template:</p>
|,
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,
@ -426,18 +393,8 @@ our $I18N = {
},
'help checkout confirm template body' => {
message => q|<p>This template separates normal and recurring items. A normal item is an item that is paid only once. Recurring items are paid once a period, like a subscription.</p>
<p>The following template variables are available in this template:</p>
|,
lastUpdated => 1165449926,
context => q|The body of the help page of the confirm checkout template.|
},
'help checkout confirm template title' => {
message => q|Confirm checkout template|,
message => q|Confirm checkout template variables|,
lastUpdated => 0,
context => q|The title of the help page of the confirm checkout template.|
},
@ -473,16 +430,8 @@ our $I18N = {
},
'help checkout error template body' => {
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.|
},
'help checkout error template title' => {
message => q|Checkout error template|,
message => q|Checkout error template variables|,
lastUpdated => 1101791348,
context => q|The title of the help page of the checkout error template.|
},
@ -518,7 +467,7 @@ our $I18N = {
},
'help select payment template title' => {
message => q|Select payment gateway template|,
message => q|Select payment gateway template variables|,
lastUpdated => 0,
context => q|The title of the 'select payment gateway' help page.|
},
@ -573,13 +522,6 @@ our $I18N = {
lastUpdated => 1149221607,
},
'help select payment template body' => {
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.|
},
'shipping tab' => {
message => q|Shipping|,
lastUpdated => 0,

219
lib/WebGUI/i18n/English/ProductManager.pm
View file

@ -220,49 +220,6 @@ our $I18N = {
context => q|Label of the edit variant screen.|
},
'help list products title' => {
message => q|List products|,
lastUpdated => 0,
context => q|The title of the list products help page|
},
'help list products body' => {
message => q|<span style="font-weight: bold;">Overview</span><br />
<br />
In addition to subscriptions, WebGUI features products. Products allow you to
sell your products with considerable ease. Just define a base product
and add parameters to it if you need to. WebGUI generates all possible
product configurations for you and automatically sets the price, weight and sku values.<br />
<br />
For example you want to sell T-shirts in the sizes S, M, L and XL and
the colors blue and grey. Also an XL costs $ 1.50 extra. <br />
<br />
To do this just add a product called T-shirt and add parameters color
and size to it. Add to the color parameter the options 'blue' and
'grey', and add 'S', 'M', 'L' and 'XL' to the size parameter. Set the
price modifier of the 'XL' option to 1.50.<br />
<br />
Now you have created eight variants of your T-shirt product and only in
about a minute. <br />
<br />
If you are out of blue large T-shirts, just disable this variant. You
are in full control.<br />
<br />
<span style="font-weight: bold;">Usage</span><br />
<br />
You can add new products with the 'Add a new product' link in the
righthand menu. To manage an existing product click on the edit button
left of it. Use the delete button to remove it.<br />
<br />|,
lastUpdated => 0,
context => q|The body of the list products help page|
},
'help manage product title' => {
message => q|Manage Product|,
lastUpdated => 0,
context => q|The title of the manage product help page|
},
'title description' => {
message => q|The name of the product.|,
lastUpdated => 1120449422,
@ -310,125 +267,11 @@ normal templates.|,
lastUpdated => 1120449422,
},
'help manage product body' => {
message => q|The manage product menu allows you to inspect and edit the properties
of your product.
<p>Overview<br />
Products consist of base Properties along with Parameters with various
Options. The properties are the base of your product. They define the
the default price, weight, sku and sku composition of the product and
all its variants.
</p>
<p><b>Properties</b><br />
The properties section shows the base values for your product. Every
product configuration you sell is based on these values. Modifiers set
in options are relative to these values. You can edit properties by
clicking the edit button above them.
</p>
<p><b>Parameters</b></p>
<p>Parameters are the different forms in which your product comes,
like 'Color' and 'Size' for a T-shift. You can add a parameter to define
these forms by clicking on the 'Add parameter' link. Editing or deleting
a parameter can be accomplished by clicking on the edit or delete button
on the left of the parameter respectively.
</p>
<p>If you add a parameter, you will be taken to the SKU Template edit
screen when you click on 'Save'. This allows you to add this parameter
to the SKU Template of the product.
</p>
<p>If you edit a parameter to change its name, the SKU Template should be
updated automatically and you will be taken back to the Manage product
screen after clicking 'Save'.
</p>
<p><b>Options</b></p>
<p>An option is a value a parameter can
take, such as 'Blue' or 'Grey', and 'Large' or 'Small'. Options also allow you to
set modifiers for price, weight and sku. These modifiers add to the the
base price, weight and sku defined in the properties of your product. A
price modifier of 5.00 for 'Rainbow' increases the price with
$5.00 for rainbow-colored shirts.
</p>
<p>To add an Option to an existing Parameter, click on the 'Add option'
link directly below it.
</p>
<p>Editing an option can be done by clicking the 'edit' button left of it.
The delete button left of an option allows you to delete that option.
</p>
<p><b>List variants</b><br />
This menu option can be found in the righthand side menu, and allows
you to view all product variants that are possible with the given
options. Also, this is the place to change the automatically generated
price, weight and sku values and set availability of a product variant.
</p>
|,
lastUpdated => 1165518436,
context => q|The body of the manage product help page|
},
'help edit product title' => {
message => q|Edit product|,
lastUpdated => 0,
context => q|The title of the edit product help page|
},
'help edit product body' => {
message => q|<p>The properties section shows the base values for your product. Every
product configuration you sell is based on these values. Modifiers set
in options are relative to these values. The properties of a product
are:</p>
|,
lastUpdated => 1120449342,
context => q|The body of the edit product help page|
},
'help edit parameter title' => {
message => q|Edit parameter|,
lastUpdated => 0,
context => q|The title of the edit parameter help page|
},
'help edit parameter body' => {
message => q|<p>Parameters define the variables of your product, like 'Color' or
'Size'. A parameter only has a name. This name will also be used
for the name of the template variable pointing to this parameter in the
SKU Template.</p>
<p>If you add a new parameter, you will be taken to the SKU Template edit
screen when you click on 'Save'. This allows you to add this parameter
to the SKU Template of the product.</p>
<p>If you edit an existing parameter the SKU Template should be
updated automatically and you will be taken back to the Manage product
screen after clicking 'Save'.</p>
|,
lastUpdated => 1146606343,
context => q|The body of the edit parameter help page|
},
'edit parameter name description' => {
message => q|<p>The name of this parameter.</p>|,
lastUpdated => 1122609059,
},
'help edit option title' => {
message => q|Edit option|,
lastUpdated => 0,
context => q|The title of the edit option help page|
},
'help edit option body' => {
message => q|<p>Options are the values a parameter can take, like 'Blue', 'Red' or
'Grey'.</p>
<p>Options consist of several modifiers.</p>
|,
lastUpdated => 1146606353,
context => q|The body of the edit option help page|
},
'edit option value description' => {
message => q|<p>The value of this option (ie. 'Blue').</p>|,
lastUpdated => 1122609417,
@ -450,68 +293,6 @@ default weight for product variants consisting of this option.</p>|,
message => q|<p>When this option is called in the SKU template as a template variable, the value that will be displayed.</p>|,
lastUpdated => 1165513384,
},
'help list variants title' => {
message => q|List product variants|,
lastUpdated => 0,
context => q|The title of the list variants help page|
},
'help list variants body' => {
message => q|<span style="font-weight: bold;">Overview</span><br />
<br />
Product variants are what customers can actually buy. This screen
shows all possible configurations of parameters and options and
therefore define the product variants you can actually sell.<br />
<span style="font-weight: bold;"></span><br />
<span style="font-weight: bold;">The variant list<br />
</span><br />
The list shows all product variants. The columns on the left indicate
the configuration of the product variant, those on the right show its
price, weight, SKU and availability. Values marked with a asterisk
('*') are overridden via the edit mode of the variant (see below).<br />
<br />
<span style="font-weight: bold;">Usage</span><br />
<br />
Aside from inspecting the variants you can do two things in this
screen. <br />
<br />
First you can set the availability of certain variants. This is done by
using the checkboxes in the column available. If a box is checked it
means that the product it's next to is available for purchase. Of
course it's not available if the box is unchecked. If you make any
changes to the checkboxes you'll need to click the 'Save' button that's
at the bottom and the top of the screen.<br />
<br />
Also you can edit variants to override their automatically generated
values for price, weight and SKU. To do this simply click on the edit
button next to the variant you want to edit.<br />|,
lastUpdated => 1165518232,
context => q|The body of the list variants help page|
},
'help edit variant title' => {
message => q|Edit product variant|,
lastUpdated => 0,
context => q|The title of the edit variant help page|
},
'help edit variant body' => {
message => q|<p>Product variants have their price, weight and SKU automatically
generated by WebGUI. Mostly this is exactly what you want, but
sometimes you'll want to override one or more of these properties. For
example if you want to discount some variants. </p>
<p>This is the place to set those overrides. Form fields that are empty
have their value automatically calculated by WebGUI where those that
contain data will set the corresponding property to that value.</p>
<p>If you have overridden a field but want to return it to the generated
value simply empty it and WebGUI will regenerate the value for it.
Please note that a field containing only spaces is not empty.</p>
<p>The overrides you can set for a product variant are:</p>
|,
lastUpdated => 1146607083,
context => q|The body of the edit variant help page|
},
'price override description' => {
message => q|The price for this variant.|,

6
lib/WebGUI/i18n/English/Subscription.pm
View file

@ -102,12 +102,6 @@ our $I18N = {
context => q|Shows up in the selection part of listSubscriptionCodes.|
},
# 'help edit subscription title' => {
# message => q|Subscription, Add/Edit|,
# lastUpdated => 1101228391,
# context => q|The Add/Edit subscription help page title.|
# },
'subscription name description' => {
message => q|<p>Name of the subscription.</p>|,
lastUpdated => 1120861450,