Help: Zip Archive, Template Variables

For more help, visit the WebGUI Community Wiki.

The following variables are available in Zip Archive Templates:

controls
Asset controls for administrators.
error
Any errors reported during upload or unzip
noInitialPage var
An internationalized label for an error when no initial page was specified.
noFileSpecified var
An internationalized label for an error when no file was specified.
fileUrl
URL to the initial file
fileIcon
Initial file file type icon
showPage
The name of the file from the Zip Archive that will be displayed when this Asset is viewed.
templateId
The ID of the template used to display the contents of the Zip Archive.
cacheTimeout
The length of time set for the cache timeout.
filename
The name of the file this Asset holds. It does not include the path to the file.
storageId
The ID of the WebGUI storage element used to store the file.
templateId
The ID of the template used to display the file.
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
Help: Zip Archive, Template Variables
*
Admin Console