Help: Folder Template

For more help, visit the WebGUI Community Wiki.

The following variables are available in Folder Templates:

addFile.url
The url for adding files to the Folder.
addFile.label
The internationalized label for adding files to the Folder.
canAddFile
Is true if the user can add a file to the Folder
canEdit
Is true if the user can edit the folder
subfolder_loop
A loop containing all Folder assets which are children of the Folder. The order of the Folders will be determined by the Sort Alphabetically flag in the edit screen.
id
The assetId of the Folder.
url
The url of the Folder.
title
The title of the Folder.
menuTitle
The menu title of the Folder.
icon.small
The URL to a small icon of the appropriate type for this Asset.
icon.big
The URL to a big icon of the appropriate type for this Asset.
file_loop
A loop containing all non-Folder assets which are children of the Folder. The order of the Folders will be determined by the Sort Alphabetically flag in the edit screen.
id
The assetId of the Asset.
canView
A conditional indicating if the current user can view this Asset.
title
The title of the Asset.
menuTitle
The menu title of the Asset.
synopsis
The synopsis of the Asset.
size
The size of the Asset, formatted.
date.epoch
The date the Asset was last updated, relative to the epoch.
icon.small
A URL to a small icon that represents the Asset.
icon.big
A URL to an icon that represents the Asset.
type
The type, or the name, of this Asset, such as Post, Article, Collaboration System, etc.
url
The URL of the Asset.
isImage
A conditional indicating if this Asset is an Image Asset.
canEdit
A conditional indicating if this Asset can be edited by the current user.
controls
The editing control bar for this child.
isFile
A conditional indicating if this Asset is a File Asset.
thumbnail.url
If this Asset is an Image, the URL to the thumbnail for it.
file.url
If this Asset is a File Asset (File, Image or Zip Archive), the URL to the actual file for downloading. Otherwise, this variable will be empty.
sortAlphabetically
A conditional that indicates that subfolders and files will be sorted alphabetically.
templateId
The ID of the template used to display the Folder contents.
visitorCacheTimeout
In seconds, how long output from this Asset will be cached.
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.
 
 
Admin Console
Help: Folder Template
*
Admin Console