diff --git a/lib/WebGUI/Help/Asset_Matrix.pm b/lib/WebGUI/Help/Asset_Matrix.pm index 50446c86b..abd1e08a0 100644 --- a/lib/WebGUI/Help/Asset_Matrix.pm +++ b/lib/WebGUI/Help/Asset_Matrix.pm @@ -223,6 +223,72 @@ our $HELP = { 'compare template' => { title => 'comparison template help title', body => 'comparison template help body', + variables => [ + { + 'name' => 'isTooMany' + }, + { + 'name' => 'isTooFew' + }, + { + 'name' => 'compare.form' + }, + { + 'name' => 'product_loop', + 'variables' => [ + { + 'name' => 'name' + }, + { + 'name' => 'version' + }, + { + 'name' => 'url', + 'description' => 'details url' + } + ] + }, + { + 'name' => 'lastupdated_loop', + 'variables' => [ + { + 'name' => 'lastUpdated' + } + ] + }, + { + 'name' => 'category_loop', + 'variables' => [ + { + 'name' => 'category', + 'description' => 'tmplVar category' + }, + { + 'name' => 'columnCount' + }, + { + 'name' => 'row_loop', + 'variables' => [ + { + 'name' => 'column_loop', + 'variables' => [ + { + 'name' => 'value' + }, + { + 'name' => 'class' + }, + { + 'name' => 'description', + 'description' => 'tmplVar field.description' + } + ] + } + ] + } + ] + } + ], related => [ { tag => 'matrix add/edit', @@ -275,6 +341,159 @@ our $HELP = { 'main template' => { title => 'matrix template help title', body => 'matrix template help body', + variables => [ + { + 'name' => 'compare.form', + }, + { + 'name' => 'search.url' + }, + { + 'name' => 'isLoggedIn' + }, + { + 'name' => 'field.list.url' + }, + { + 'name' => 'listing.add.url' + }, + { + 'name' => 'best.views.url' + }, + { + 'name' => 'best.views.count' + }, + { + 'name' => 'best.views.name' + }, + { + 'name' => 'best.compares.url' + }, + { + 'name' => 'best.compares.count' + }, + { + 'name' => 'best.compares.name' + }, + { + 'name' => 'best.clicks.url' + }, + { + 'name' => 'best.clicks.count' + }, + { + 'name' => 'best.clicks.name' + }, + { + 'name' => 'best_rating_loop', + 'variables' => [ + { + 'name' => 'url', + 'description' => 'tmplVar best.url' + }, + { + 'name' => 'category', + 'description' => 'tmplVar best.category' + }, + { + 'name' => 'name', + 'description' => 'tmplVar best.name' + }, + { + 'name' => 'mean' + }, + { + 'name' => 'median' + }, + { + 'name' => 'count' + } + ] + }, + { + 'name' => 'worst_rating_loop', + 'variables' => [ + { + 'name' => 'url', + 'description' => 'tmplVar worst.url' + }, + { + 'name' => 'category', + 'description' => 'tmplVar worst.category' + }, + { + 'name' => 'name', + 'description' => 'tmplVar worst.name' + }, + { + 'name' => 'mean', + 'description' => 'tmplVar worst.mean' + }, + { + 'name' => 'median', + 'description' => 'tmplVar worst.median' + }, + { + 'name' => 'count', + 'description' => 'tmplVar worst.count' + } + ] + }, + { + 'name' => 'ratings.details.url' + }, + { + 'name' => 'best.posts.url' + }, + { + 'name' => 'best.updated.url' + }, + { + 'name' => 'best.updated.date' + }, + { + 'name' => 'best.updated.name' + }, + { + 'name' => 'last_update_loop', + 'variables' => [ + { + 'name' => 'url', + 'description' => 'tmplVar last.url' + }, + { + 'name' => 'name', + 'description' => 'tmplVar last.name' + }, + { + 'name' => 'lastUpdated', + 'description' => 'tmplVar last.lastUpdated' + } + ] + }, + { + 'name' => 'user.count' + }, + { + 'name' => 'current.user.count' + }, + { + 'name' => 'listing.count' + }, + { + 'name' => 'pending_list', + 'variables' => [ + { + 'name' => 'url', + 'description' => 'tmplVar pending.url' + }, + { + 'name' => 'productName', + 'description' => 'tmplVar pending.productName' + } + ] + } + ], related => [ { tag => 'matrix add/edit', @@ -301,6 +520,115 @@ our $HELP = { 'listing detail template' => { title => 'detail template help title', body => 'detail template help body', + variables => [ + { + 'name' => 'discussion' + }, + { + 'name' => 'screenshot', + 'description' => 'tmplVar screenshot' + }, + { + 'name' => 'thumbnail' + }, + { + 'name' => 'email.form' + }, + { + 'name' => 'email.wasSent' + }, + { + 'name' => 'edit.url' + }, + { + 'name' => 'user.canEdit' + }, + { + 'name' => 'user.canApprove' + }, + { + 'name' => 'approve.url' + }, + { + 'name' => 'delete.url' + }, + { + 'name' => 'isPending' + }, + { + 'name' => 'lastUpdated.epoch' + }, + { + 'name' => 'lastUpdated.date' + }, + { + 'name' => 'id' + }, + { + 'name' => 'description', + 'description' => 'listing description' + }, + { + 'name' => 'productName' + }, + { + 'name' => 'productUrl' + }, + { + 'name' => 'productUrl.click' + }, + { + 'name' => 'manufacturerName' + }, + { + 'name' => 'manufacturerUrl' + }, + { + 'name' => 'manufacturerUrl.click' + }, + { + 'name' => 'versionNumber' + }, + { + 'name' => 'views' + }, + { + 'name' => 'compares' + }, + { + 'name' => 'clicks' + }, + { + 'name' => 'ratings' + }, + { + 'name' => 'CATEGORY_NAME_loop', + 'variables' => [ + { + 'name' => 'value', + }, + { + 'name' => 'name', + 'description' => 'tmplVar name' + }, + { + 'name' => 'label' + }, + { + 'name' => 'description', + 'description' => 'listing description' + }, + { + 'name' => 'category', + 'description' => 'tmplVar category' + }, + { + 'name' => 'class', + 'description' => 'tmplVar class' + } + ] + } + ], related => [ { tag => 'matrix add/edit', diff --git a/lib/WebGUI/i18n/English/Asset_Matrix.pm b/lib/WebGUI/i18n/English/Asset_Matrix.pm index 9c601b98e..09a58abe7 100644 --- a/lib/WebGUI/i18n/English/Asset_Matrix.pm +++ b/lib/WebGUI/i18n/English/Asset_Matrix.pm @@ -29,112 +29,95 @@ our $I18N = { lastUpdated => 0 }, + 'isTooMany' => { + message => q|A condition indicating that the user has selected too many listings to compare. They may only compare Max Comparisons listings at a time.|, + lastUpdated => 1149783768, + }, + + 'isTooFew' => { + message => q|A condition indicating that the user has selected too few listings to compare. They must compare at least two listings.|, + lastUpdated => 1149783768, + }, + + 'compare.form' => { + message => q|The checkbox form that contains all the listings in this matrix.|, + lastUpdated => 1149783768, + }, + + 'product_loop' => { + message => q|A loop containing the product information (not contained in categories) for this listing.|, + lastUpdated => 1149783768, + }, + + 'name' => { + message => q|The name of the product.|, + lastUpdated => 1149783768, + }, + + 'version' => { + message => q|The version number or model number of the product.|, + lastUpdated => 1149783768, + }, + + 'details url' => { + message => q|The URL to the details page for this listing.|, + lastUpdated => 1149783768, + }, + + 'lastupdated_loop' => { + message => q|A loop containing the last updated dates for each listing.|, + lastUpdated => 1149783768, + }, + + 'lastUpdated' => { + message => q|The human readable date that this product was last updated.|, + lastUpdated => 1149783768, + }, + + 'category_loop' => { + message => q|A loop containing all of the category information for each listing.|, + lastUpdated => 1149783768, + }, + + 'tmplVar category' => { + message => q|The name of the current category.|, + lastUpdated => 1149783768, + }, + + 'columnCount' => { + message => q|The number of products being compared.|, + lastUpdated => 1149783768, + }, + + 'row_loop' => { + message => q|A loop containing the product data for this field in this category. |, + lastUpdated => 1149783768, + }, + + 'column_loop' => { + message => q|A loop containing the value data for this field for this product. The first value in this loop is always the field name.|, + lastUpdated => 1149783768, + }, + + 'value' => { + message => q|The value of this field.|, + lastUpdated => 1149783768, + }, + + 'class' => { + message => q|The name of the stylesheet class for this field. it is generated by the value with all the spaces replaced by underscores and all the special characters removed.|, + lastUpdated => 1149783768, + }, + + 'tmplVar field.description' => { + message => q|The description for this field.|, + lastUpdated => 1149783768, + }, + 'comparison template help body' => { lastUpdated => 0, message => q|
The following template variables are available in the comparison template.
- -
- isTooMany
- A condition indicating that the user has selected too many listings to compare. They may only compare Max Comparisons listings at a time.
-
-
- isTooFew
- A condition indicating that the user has selected too few listings to compare. They must compare at least two listings.
-
- compare.form
- The checkbox form that contains all the listings in this matrix.
-
-
- product_loop
- A loop containing the product information (not contained in categories) for this listing.
-
- name
- The name of the product.
-
- version
- The version number or model number of the product.
-
- url
- The URL to the details page for this listing.
-
- lastupdated_loop
- A loop containing the last updated dates for each listing.
-
- lastUpdated
-
- The human readable date that this product was last updated.
-
- category_loop
- A loop containing all of the category information for each listing.
-
- category
- The name of the current category.
-
- columnCount
- The number of products being compared.
-
- row_loop
- A loop containing the product data for this field in this category.
-
- column_loop
-
- A loop containing the value data for this field for this product. The first value in this loop is always the field name.
-
- value
- The value of this field.
-
-
- class
- The name of the stylesheet class for this field. it is generated by the value with all the spaces replaced by underscores and all the special characters removed.
-
- description
- The description for this field.
-
The following variables are available in the listing detail template.
- -
- discussion
- The forum attached to this listing.
-
- screenshot
- The URL to the uploaded photo or screenshot.
-
- thumbnail
- The URL to the thumbnail of the uploaded photo or screenshot
-
- email.form
-
- A form to use to send an email to the listing maintainer.
-
- email.wasSent
- A condition indicating whether an email message was sent or not.
-
- edit.url
-
- The URL to the edit page for this listing.
-
- user.canEdit
- A condition indicating whether the current user has the privileges necessary to edit this listing.
-
- user.canApprove
-
- A condition indicating whether the current user has the privileges necessary to approve this listing so it appears on site.
-
- approve.url
- The URL to approve this listing.
-
- delete.url
-
- The URL to delete this listing.
-
- isPending
- A condition indicating whether this listing has been approved or not.
-
- lastUpdated.epoch
-
- The epoch date of when this listing was last updated.
-
- lastUpdated.date
- A human readable date of when this listing was last updated.
-
- id
-
- The unique identifier of this listing.
-
- description
- The description of this listing.
-
- productName
-
- The name of this listing.
-
- productUrl
- The manufacturer's URL for this listing.
-
- productUrl.click
-
- The product URL to use if you want to register the click count for this listing.
-
- manufacturerName
- The name of the company that manufactuers theproduct or provides the service represented in this listing.
-
- manufacturerUrl
-
- The manufacturer's URL.
-
- manufacturerUrl.click
- The manufacturer URL to use if you want to register the click count for this listing.
-
- versionNumber
-
- The version number or model number of this product.
-
- views
- The total number of views this listing has received.
-
- compares
-
- The total number of compares this listing has received.
-
- clicks
- The total number of clicks this listing has received.
-
- ratings
-
- The ratings form (or results) for this listing.
-
- category_loop
- A loop is created for each category in this matrix. The name of the loop is the category name with spaces replaced with hypens and a _loop added to the end. So if you have a category called "Bells and Whistles" then the loop would be called "bells-and-whistles_loop".
-
-
- value
- The value of this field.
-
- name
- The name of this field.
-
-
- label
- The label of this field.
-
- description
- The description that tells the user what this field represents.
-
-
- category
- The name the category this field is in.
-
- class
- The stylesheet class name for this field. The class is the field value with spaces replaced with underscores and all non alphanumeric characters removed.
-
The following variables are available in the main Matrix template.
- -compare.form
-The checkbox form that lists all of the comparable items in this matrix.
-
search.url
-The URL to the matrix search page.
-
isLoggedIn
-A condition indicating whether the current user is logged in to the site.
-
field.list.url
-The URL to the page where you configure new fields for this matrix.
-
listing.add.url
-The URL to the page where a user can add a new listing to the matrix.
-
best.views.url
-The URL to the listing that has the most views.
-
best.views.count
-The total number of views of the listing that has the most views.
-
best.views.name
-The name of the listing that has the most views.
-
best.compares.url
-The URL to the listing that has the most compares.
-
best.compares.count
-The number of compares of the listing that has the most compares.
-
best.compares.name
-The name of the listing that has the most compares.
-
best.clicks.url
-The URL of the listing that has the most clicks.
-
best.clicks.count
-The number of clicks of the listing that has the most clicks.
-
best.clicks.name
-The name of the listing that has the most clicks.
-
best_rating_loop
-A loop containing all of the categories for this matrix and their best ratings.
-
url
-The URL of the listing that has the best rating for this category.
-
category
-The name of this cateogry.
-
name
-The name of the listing that has the best rating for this category.
-
mean
-The mean (or average) rating of the best listing in this category.
-
median
-The median (or middle) rating of the best listing in this category.
-
count
-The sum of all the votes of the best listing in this category.
-
worst_rating_loop
-A loop containing all of the categories for this matrix and their worst ratings.
-
url
-The URL of the listing that has the worst rating for this category.
-
category
-The name of this cateogry.
-
name
-The name of the listing that has the worst rating for this category.
-
mean
-The mean (or average) rating of the worst listing in this category.
-
median
-The median (or middle) rating of the worst listing in this category.
-
count
-The sum of all the votes of the worst listing in this category.
-
ratings.details.url
-The URL to the ratings details page.
-
best.posts.url
-The URL to the listing that has the most forum posts.
-
best.updated.url
-The URL to the listing that was updated most recently.
-
best.updated.date
-The date of the most recently updated listing.
-
best.updated.name
-The name of the listing that was most recently updated.
-
last_update_loop
-A loop containing the 20 most recently updated listings.
-
url
- The URL to view this listing.
-
name
- The name of the product.
-
lastUpdated
- The date this listing was updated.
-
user.count
-The total number of registered users on the site.
-
current.user.count
-The number of users browsing the site right now.
-
listing.count
-The number of listings in this matrix.
-
pending_list
-A loop containing the list of pending listing.
-
url
- The URL to the pending listing.
-
productName
- The product title of the pending listing.
-
The following variables are available in the main Matrix template.
| }, 'matrix template help title' => {