plainblack.com
Username Password
search
Bookmark and Share
Subscribe

File Template Variables

The following variables are available in File Templates (7.3.x):

fileSize

The size (in bytes/kilobytes/megabytes, etc) of the file.

fileIcon

The icon which describes the type of file.

fileUrl

The URL to the file. controlsA toolbar for working with the file.

cacheTimeout

The length of time set for the cache timeout. filenameThe 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. titleThe 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.

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.company

NameFrom the WebGUI settings, the company name.

session.setting.anonymousRegistration

From the WebGUI settings, whether or not anonymous registration has been enabled.

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>

Keywords: file Templates

Search | Most Popular | Recent Changes | Wiki Home
© 2018 Plain Black Corporation | All Rights Reserved