Help: Shelf Template
For more help, visit the WebGUI Community Wiki.
- shelves
- A loop containing the list of shelves that are children of this one in the asset tree. Each record in the loop contains all the properties of a shelf. Only shelves that the user can see will be in the loop.
- title
- The title of this shelf
- url
- The url of this shelf
- products
- A loop containing the list of products that match the keywords specified in this shelf, or that are children of this shelf. Only products that the user can see will be in the loop. Each record in the loop contains all the properties of the matching sku, plus the following variables.
- url
- The URL to this sku.
- thumbnailUrl
- The URL for a thumbnail image of this sku. If it has no thumbnail, then this variable will be empty.
- price
- The price of this sku, formatted to 2 decimal places using a decimal point (not comma), and with no monetary symbol.
- addToCartForm
- If this product supports it, the form to add this product to the cart. It will contain a submit button and all required form elements needed to add the product to the cart.
- templateId
- Choose the template that will display the list of products associated with this shelf.
- noViewableSkus
- A boolean which is true if there are no products on this shelf which the current user can view.
- emptyShelf
- A boolean which is true if this shelf has any Products at all.
- 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.
- 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.
Admin Console
