Help: Notification Template
For more help, visit the WebGUI Community Wiki.
In addition to the common Post Template variables, the Notification Template has these variables:
- url
- The URL to the post that triggered the notification.
- relativeUrl
- Provides the URL of the post relative to the server (/path/to/post) rather than fully qualified (http://host/path/to/post), which is the default.
- notify.subscription.message
- A new message has been posted to one of your subscriptions.
- unsubscribeUrl
- The URL for the user to unsubscribe.
- unsubscribeLinkText
- The internationalized word "Unsubscribe", to be used a text for the link to unsubscribe.
- userId
- The User ID of the owner of the Post.
- user.isPoster
- A conditional that is true if the current user is the owner of this Post.
- avatar.url
- A URL to the avatar for the owner of the Post, if avatars are enabled in the parent Collaboration System and the user has an avatar.
- userProfile.url
- A URL to the profile of the owner of the Post.
- dateSubmitted.human
- The date that the post was sumbitted, in a readable format.
- dateUpdated.human
- The date that the post was last updated, in a readable format.
- title.short
- The title of the Post, limited to 30 characters.
- content
- The formatted and filtered content of the post, if a thread containing the Post exists. This variable will override any other variables with this name in the list of template variables.
- user.canEdit
- A conditional that is true if the user is adding a new Post, as opposed to editing an existing Post, and a thread containing the Post exists.
- delete.url
- A URL to delete this Post.
- edit.url
- A URL to edit this Post.
- status
- The status of this Post: "Approved", "Pending" or "Archived".
- reply.url
- The URL to reply to this Post without quoting it.
- reply.withQuote.url
- The URL to initiate a quoted reply to this Post.
- url
- The URL to download this attachment.
- url.raw
- The URL to the post asset without the #id... at the end. Useful for performing other functions on the post like func=promote or func=demote
- rating.value
- The current rating for this Post.
- rate.url.thumbsUp
- A positive rating.
- rate.url.thumbsDown
- A negative rating.
- hasRated
- A conditional that is true if the user has already rated this Post.
- image.url
- The URL to the first image attached to the Post.
- image.thumbnail
- A thumbnail for the image attached to the Post.
- attachment.url
- The URL to download the first attachment attached to the Post.
- attachment.icon
- An icon showing the file type of this attachment.
- attachment.name
- The name of the first attachment found on the Post.
- attachment_loop
- A loop containing all file and image attachments to this Post.
- url
- The URL to download this attachment.
- icon
- The icon representing the file type of this attachment.
- filename
- The name of this attachment.
- thumbnail
- A thumbnail of this attachment, if applicable.
- isImage
- A conditional indicating whether this attachment is an image.
- meta_loop
- A loop containing metadata lables and fields for this Post. If metadata is not enabled for the site, or if metadata is not enabled for this CS, or if there's no metadata defined for the site, the loop will be empty.
- name
- The label for this metadata field. Metadata labels are not internationalized.
- value
- The value of this metadata field for this post.
- meta_X_value
- The value for a particular metadata field, picked by name. X is the name of the metadata field, where any spaces in the name have been changed into underscores.
- storageId
- The Asset ID of the storage node for the Post, where the attachments are kept.
- threadId
- The ID of the thread that contains this Post.
- dateSubmitted
- The date the Post was submitted, in epoch format.
- dateUpdated
- The date the Post was last updated, in epoch format.
- username
- The name of the user who last updated or submitted the Post.
- rating
- Another name for rating.value
- views
- The number of times that this post has been viewed.
- contentType
- The type of content in the post, typically "code", "text", "HTML", "mixed".
- content
- The content, or body, of the Post.
- title
- The title of the Post.
- menuTitle
- The menu title of the Post, often used in navigation.
- synopsis
- The synopsis of the Post. If no synopsis has been set, then it will try to grab text from the description, up to the ^-; marker. If no marker is found, then it takes everything up to the first newline in the description
- extraHeadTags
- Extra tags that the user requested by added to the HTML header.
- groupIdEdit
- The ID of the group with permission to edit this Post.
- groupIdView
- The ID of the group with permission to view this Post.
- ownerUserId
- An alias for userId.
- assetSize
- The formatted size of this Post.
- isPackage
- A conditional indicating whether this Post is a package.
- isPrototype
- A conditional indicating whether this Post is a Content Prototype.
- isHidden
- A conditional indicating whether this Post should be hidden from navigation.
- newWindow
- A conditional indicating whether this Post should be opened in a new window.
- userDefined1
- The value contained in the first user defined variable.
- userDefined2
- The value contained in the second user defined variable.
- userDefined3
- The value contained in the third user defined variable.
- userDefined4
- The value contained in the fourth user defined variable.
- userDefined5
- The value contained in the fifth user defined variable.
- 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
