Help: Matrix Listing Detail Template Variables

For more help, visit the WebGUI Community Wiki.

canEdit
A boolean indicating whether the user can edit this listing.
editUrl
The url to this listing's edit screen.
canApprove
A boolean indicating whether the user can approve or deny this listing.
approveOrDenyUrl
The url to this listing's approve or deny screen.
screenshots
This listings screenshots displayed using the ukplayer.
emailForm
A form to use to send an email to the listing maintainer.
emailSent
A condition indicating whether or not an email message was sent.
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.
description
The description of this listing.
productName
The name of this listing. This is the same as this matrix listing's asset title.
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 manufactures the product 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.
version
The version of this listing.
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
An overview of the ratings this listing has received and a form to rate this listing if the user hasn't rated it already.
CATEGORY_NAME_loop
A loop containing attributes, and values for those attributes, is created for each category in this matrix. The name of the loop is the category name with spaces replaced with hyphens 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".
categoryLabel
The label of this category.
attribute_loop
A loop containing matrix attributes.
label
The label of this attribute.
value
The value of this attribute.
fieldType
The fieldType of this attribute.
webgui.version
The version of WebGUI on your site.
webgui.status
The release status for this version of WebGUI (stable, beta, gamma, etc.)
session.user.username
The current user's username.
session.user.firstDayOfWeek
From the current user's profile, the day they selected to be the first day of the week.
session.config.extrasurl
From the WebGUI config, the URL for the extras directory.
session.var.adminOn
This variable will be true if the user is in Admin mode.
session.setting.companyName
From the WebGUI settings, the company name.
session.setting.anonymousRegistration
From the WebGUI settings, whether or not anonymous registration has been enabled.
session form variables
Session Form Variables
Any form variables will be available in the template with this syntax:
<tmpl_var session.form.variable>
If there is more than 1 value in a form variable, only the last will be returned.
session scratch variables
Session Scratch Variables
Any scratch variables will be available in the template with this syntax:
<tmpl_var session.scratch.variable>
assetId
The unique identifier for this Asset, in base64 encoding.
assetIdHex
The unique identifier for this Asset, in hexadecimal format.
title
The title of the Asset
menuTitle
The title of the Asset used in Navigations.
url
The Asset's URL.
isHidden
A boolean that will be true if this Asset is set not be displayed in Navigations.
newWindow
A boolean that will be true if this Asset is set open in a new browser window.
encryptPage
A boolean that will be true if this Asset is set to be served over SSL.
ownerUserId
The ID of the user who owns this Asset.
groupIdView
The ID of the group that is allowed to view this Asset.
groupIdEdit
The ID of the group that is allowed to edit this Asset.
synopsis
A short description of the contents of the Asset.
extraHeadTags
Extra tags that will be added to the header of the page containing the Asset. These will be included by default so you do not need to add them youself, unless you want them to be in there twice.
isPackage
A boolean that will be true if this Asset is set to be a Package.
isPrototype
A boolean that will be true if this Asset is set to be a prototype.
status
With respect to version control, the status of this Asset. Typically these are the English strings "approved", "pending", "committed".
assetSize
How big this asset is in bytes. The sum of all database fields and attachments.
keywords
This will be a string with the keywords for this asset. Individual keywords will be joined with spaces, unless the keyword contains spaces, in which case it will be quoted.
 
 
Admin Console
Help: Matrix Listing Detail Template Variables
*
Admin Console