Help: Message Board Template
For more help, visit the WebGUI Community Wiki.
The following is the list of template variables available in message board templates:
- forum.add.url
- A url that will add a forum to this message board.
- forum.add.label
- The default label for forum.add.url.
- title.label
- The default label for the title column.
- views.label
- The default label for the views column.
- rating.label
- The default label for the ratings column.
- threads.label
- The default label for the threads column.
- replies.label
- The default label for the replies column.
- lastpost.label
- The default label for the last post column.
- forum_loop
- A loop containing the data for each of the forums contained in this message board.
- forum.controls
- The editing controls for this forum.
- forum.count
- An integer displaying the forum count as it goes through the loop.
- forum.title
- The title of this forum.
- forum.description
- The description of this forum.
- forum.replies
- The number of replies all the threads in this forum have received.
- forum.rating
- The average rating of all the posts in the forum.
- forum.views
- The total number of views of all the posts in the forum.
- forum.threads
- The total number of threads in this forum. This does not include those that have been archived.
- forum.url
- The url to view this forum.
- forum.lastpost.url
- The url to view the last post in this forum.
- forum.lastpost.date
- The human readable date of the last post in this forum.
- forum.lastpost.time
- The human readable time of the last post in this forum.
- forum.lastpost.epoch
- The epoch date of the last post in this forum.
- forum.lastpost.subject
- The subject of the last post in this forum.
- forum.lastpost.user.hasread
- A boolean indicating whether the user has read the last post in the forum.
- forum.lastpost.user.id
- The userid of the last poster.
- forum.lastpost.user.name
- The username of the last poster.
- forum.lastpost.user.alias
- The current alias of the last poster.
- forum.lastpost.user.profile
- The url to the last poster's profile.
- forum.lastpost.user.isVisitor
- A conditional indicating whether the last poster was a visitor.
- forum.user.canView
- A conditional indicating whether the user can view this forum.
- forum.user.canPost
- A conditional indicating whether the user can post to this forum.
- default.listing
- A full forum rendered using the forum template.
- areMultipleForums
- A conditional indicating whether there is more than one forum.
- visitorCacheTimeout
- The amount of time this article will be cached for the Visitor user.
- templateId
- The Id of the template used to display this Asset.
- 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>
- controls
- These are the icons and URLs that allow editing, cutting, copying, deleting and reordering the Asset.
Admin Console
