WebGUI - Admin Console

For more help, visit the WebGUI Community Wiki.

karma.transfer.form

A variable that displays a small form that allows a user to transfer an amount of karma from their account to the thread.

karma

Indicates the amount of karma this thread has.

karmaScale

A weighting factor for difficulty, complexity, or handicap in contests.

karmaRank

This is karma divided by karma scale.

thumbsUp.icon.url

The URL to the thumbs up icon.

thumbsDown.icon.url

The URL to the thumbs down icon.

user.isVisitor

A conditional indicating that the current user is a Visitor.

user.isModerator

A conditional indicating that the current user is a Moderator.

user.canPost

A conditional indicating that the current user can add posts to this thread.

user.canReply

A conditional indicating that the current user can reply to posts in this thread.

repliesAllowed

A conditional indicating that replies are allowed in this thread.

userProfile.url

A URL to the profile of the owner of the Post.

layout.nested.url

A URL to change the layout to nest posts. This lists all posts with indentation to show which posts are replies to posts and which posts are new topics in a thread.

layout.flat.url

A URL to change the layout to flatten posts. This lists all posts in the thread in order of date submitted.

layout.threaded.url

A URL to change the layout to threaded posts. This is the default setting. Posts will be shown one at a time.

layout.isFlat

A conditional indicating if the current layout is flat.

layout.isNested

A conditional indicating if the current layout is nested.

layout.isThreaded

A conditional indicating if the current layout is threaded.

user.isSubscribed

A conditional that is true if the current user is subscribed to the thread.

subscribe.url

A URL to subscribe the current user to the thread.

unsubscribe.url

A URL to subscribe the current user from the thread.

isArchived

A conditional indicating if the current thread is archived.

archive.url

The URL to archive this thread.

unarchive.url

The URL to unarchive this thread.

isSticky

A conditional indicating if the current thread is sticky.

stick.url

The URL to make this thread sticky. Sticky threads will stay at the top of the list of threads.

unstick.url

The URL to unstick this thread.

isLocked

A conditional indicating if the current thread is locked. Locked threads can no longer be edited.

lock.url

The URL to lock this thread.

unlock.url

The URL to unlock this thread.

post_loop

A loop containing all the posts for this thread. Each post in the loop also contains a set of its own Post Template variables.

isCurrent

A conditional indicating that this Post is the one currently being viewed in the Thread.

isThreadRoot

A conditional indicating that this Post is the start of the Thread.

depth

A number indicating the loop count of the indent_loop.

depthX10

The depth times 10.

indent_loop

A loop that runs depth times.

depth: A number indicating the loop count of the indent_loop.

add.url

The URL to add a new thread.

previous.url

The URL to take you to the previous thread.

next.url

The URL to take you to the next thread.

search.url

The URL to take you to a form to search the forum.

collaboration.url

The URL to take you back to the collaboration system that this post is a part of.

collaboration.title

The title of the collaboration system that this post is a part of.

collaboration.description

The description of the collaboration system that this post is a part of.

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>

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.

add.label

The word "Add".

addlink.label

The phrase "Add a link".

addquestion.label

The phrase "Add a question".

answer.label

The word "Answer".

attachment.label

The word "Attachment".

by.label

The word "By".

body.label

The word "Body".

back.label

The word "Back".

compensation.label

The word "Compensation".

open.label

The word "Open".

captcha_label

The word "Captcha".

close.label

The word "Close".

closed.label

The word "Closed".

critical.label

The word "Critical (mostly not working)".

minor.label

The word "Minor (annoying, but not harmful)".

cosmetic.label

The word "Cosmetic (misspelling, formatting problems)".

fatal.label

The word "Fatal (can't continue until this is resolved)".

severity.label

The word "Severity".

date.label

The word "Date".

delete.label

The word "Delete".

description.label

The word "Description".

edit.label

The word "Edit".

image.label

The word "Image".

job.header.label

The phrase "Edit Job Posting".

job.title.label

The phrase "Job Title".

job.description.label

The phrase "Job Description".

job.requirements.label

The phrase "Job Requirements".

karmascale.label

The phrase "Karma Scale".

karmaRank.label

The phrase "Karma Rank".

keywords.label

The word "Keywords".

location.label

The word "Location".

layout.flat.label

The word "Flat".

link.header.label

The phrase "Edit Link".

lastReply.label

The phrase "Last Reply".

lock.label

The word "Lock".

layout.label

The word "Layout".

message.header.label

The phrase "Edit Message".

message.label

The word "Message".

next.label

The word "Next".

newWindow.label

The phrase "Open in new window?".

layout.nested.label

The word "Nested".

previous.label

The word "Previous".

post.label

The word "Post".

question.label

The word "Question".

question.header.label

The phrase "Edit Question".

rating.label

The word "Rating".

rate.label

The word "Rate".

reply.label

The word "Reply".

replies.label

The word "Replies".

readmore.label

The phrase "Read More".

responses.label

The word "Responses".

search.label

The word "Search".

subject.label

The word "Subject".

subscribe.label

The word "Subscribe".

submission.header.label

The phrase "Edit Submission".

stick.label

The phrase "Make Sticky".

status.label

The word "Status".

synopsis.label

The word "Summary".

thumbnail.label

The word "Thumbnail".

title.label

The word "Title".

transferkarma.label

The phrase "Transfer Karma".

unlock.label

The word "Unlock".

unstick.label

The word "Unstick".

unsubscribe.label

The word "Unsubscribe".

url.label

The word "URL".

user.label

The word "User".

views.label

The word "Views".

visitorName.label

The phrase "Visitor Name".

pagination.firstPage

A link to the first page in the paginator.

pagination.firstPageUrl

The url component of pagination.firstPage broken out.

pagination.firstPageText

The text component of pagination.firstPage broken out.

pagination.isFirstPage

A boolean indicating whether the current page is the first page.

pagination.lastPage

A link to the last page in the paginator.

pagination.lastPageUrl

The url component of pagination.lastPage broken out.

pagination.lastPageText

The text component of pagination.lastPage broken out.

pagination.isLastPage

A boolean indicating whether the current page is the last page.

pagination.nextPage

A link to the next page in the paginator relative to the current page.

pagination.nextPageUrl

The url component of pagination.nextPage broken out.

pagination.nextPageText

The text component of pagination.nextPage broken out.

pagination.previousPage

A link to the previous page in the paginator relative to the current page.

pagination.previousPageUrl

The url component of pagination.previousPage broken out.

pagination.previousPageText

The text component of pagination.previousPage broken out.

pagination.pageNumber

The current page number.

pagination.pageCount

The total number of pages.

pagination.pageCount.isMultiple

A boolean indicating whether there is more than one page.

pagination.pageList

A list of links to every page in the paginator.

pagination.pageLoop

Same as pagination.pageList except broken into individual elements.

pagination.url: The URL of a page in the page loop.
pagination.text: The number of a page in the page loop.
pagination.range: Displays the range of available pages, in a start - end format.
pagination.activePage: A boolean which will be true if the this page in the pageLoop is the currently viewed page.

pagination.pageList.upTo20

A list of links to the 20 nearest in the paginator relative to the current page. So if you're on page 60, you'll see links for 50-70.

pagination.pageLoop.upTo20

Same as pagination.pageList.upTo20 except broken into individual elements.

pagination.url: The URL of a page in the page loop.
pagination.text: The number of a page in the page loop.
pagination.range: Displays the range of available pages, in a start - end format.
pagination.activePage: A boolean which will be true if the this page in the pageLoop is the currently viewed page.

pagination.pageList.upTo10

A list of links to the 10 nearest in the paginator relative to the current page. So if you're on page 20, you'll see links for 15-25.

pagination.pageLoop.upTo10

Same as pagination.pageList.upTo10 except broken into individual elements.

pagination.url: The URL of a page in the page loop.
pagination.text: The number of a page in the page loop.
pagination.range: Displays the range of available pages, in a start - end format.
pagination.activePage: A boolean which will be true if the this page in the pageLoop is the currently viewed page.