Help: Matrix Main Template Variables
For more help, visit the WebGUI Community Wiki.
- compareForm
- The compare box form. The list of matrix listings in this form is a yui datatable. See the yui docs for information about skinning yui datatables.
- isLoggedIn
- A condition indicating whether the current user is logged in to the site.
- listAttributes_url
- The URL to the page where you configure new listing attributes for this matrix.
- addMatrixListing_url
- The URL to the page where a user can add a new listing to the matrix.
- bestViews_url
- The URL to the listing that has the most views.
- bestViews_count
- The total number of views of the listing that has the most views.
- bestViews_name
- The name of the listing that has the most views.
- bestCompares_url
- The URL to the listing that has the most compares.
- bestCompares_count
- The number of compares of the listing that has the most compares.
- bestCompares_name
- The name of the listing that has the most compares.
- bestClicks_url
- The URL of the listing that has the most clicks.
- bestClicks_count
- The number of clicks of the listing that has the most clicks.
- bestClicks_name
- The name of the listing that has the most clicks.
- best_rating_loop
- A loop containing the best rated listings for each categories of this matrix.
- url
- The URL of the listing.
- category
- The category of the listing.
- name
- The name of the listing.
- mean
- The mean (or average) rating of the best/worst listing in this category.
- median
- The median (or middle) rating of the best/worst listing in this category.
- count
- The sum of all the votes of the best/worst listing in this category.
- worst_rating_loop
- A loop containing the worst rated listings for each categories of this matrix.
- url
- The URL of the listing.
- category
- The category of the listing.
- name
- The name of the listing.
- mean
- The mean (or average) rating of the best/worst listing in this category.
- median
- The median (or middle) rating of the best/worst listing in this category.
- count
- The sum of all the votes of the best/worst listing in this category.
- last_updated_loop
- A loop containing the 20 most recently updated listings.
- url
- The URL of the listing.
- name
- The name of the listing.
- lastUpdated
- The date this listing was updated.
- listingCount
- The number of listings in this matrix.
- pending_loop
- A loop containing the list of pending listing.
- url
- The URL of the listing.
- name
- The name of the listing.
- displayTitle
- A conditional variable for whether or not the title should be displayed.
- description
- The description of this wobject.
- styleTemplateId
- The assetId of the template for displaying the Asset.
- printableStyleTemplateId
- The assetId of the template for displaying the Asset for printing.
- 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.
- 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>
Admin Console
