Appendix: Widgets & Objects
 

Items in red and without syntax signify not currently active/available in P2.

Items in black are in place.

GLOBAL

  
[#SEARCH#] Returns a search form - consisting of text field and submit button.
[#ACCOUNT#] Returns the 'My Account' widget, allowing the user to quickly navigate to order history, statements etc.
[#CART#] Returns the shopping cart summary. Can be passed comma-separated values specifying which elements are available within and in what order:
  • Cart empty
0 items £0.00 View cart Checkout
[#LOGIN_LINK#] Returns text-only login links ("Welcome. Sign in or create an account."). Output is a language item so completely configurable.
[#LOGIN#] Returns a login form - email/password textfields and a submit button.
[#BRANDS_MENU#] Not available presently - in testing
[#BRANDS#] Returns an unordered list of all product brands set up in the system (and set to live), linking to child products.
[#RELATED?x#] Returns related items list. x is the number of products to show. -- related will only work on a product page
[#FEATURED?x#] Returns featured items list. x is the number of products to show.
[#SPECIALS?x#] Returns item list of products set up as special offers. x is the number of products to show.
[#NEW?x#] Returns new items list. x is the number of products to show.
[#BEST_SELLERS?x#] Returns best seller item list. x is the number of products to show.
[#ALSO_BOUGHT?x#] Returns 'customer also bought' product list. x is the number of products to show. Only works on product pages
[#DYNAMIC_MENU?y#] Returns the dynamic (pop-out/drop-down) menu. Javascript file c_config.js is also required, and can be found in the default template directory via the styles uploader. y is the start id
[#PEARL_MENU?y#] Returns the megamenu. y is the start id - not currently available, in testing
[#STATIC_MENU?y#] Returns a static menu as an unordered list. y is the start id
[%BREADCRUMB%] Returns the breadcrumb trail
[#LANGUAGE#] Language select
[#RSS?url=x#] Insert RSS feed where x is the url in the format http://feeds.feedburner.com/PearlSoftwareBlog

 
[%COMPANY_NAME%]  
[%COMPANY_ADDRESS%]  
[%COMPANY_TELEPHONE%]  
   
[%CONTENT%] Content object. Outputs the main website body, ie the pages, products, account area etc.
[%CATxxx%] Used for library items - inserts the content of another category. Replace xxx with Category ID (eg., CAT299).
[#LINK?Cxxx#] Link to another category on your website, ensuring that the SEO URL is maintained. Specifiy the category ID in place of xxx
[%PRINTLINK%] Link to a printable version of the page. Outputs a URL, eg usage: <a href="[%PRINTLINK%]"
   

PRODUCT SPACE

 To be used on the product detail page
[%NAME%] Product title
[%PRICE%] Product price
[%SKU%] Product SKU
[%BRAND%] Manufacturer
[%SAVINGS%] Description to follow
[%DESCRIPTION%] Product description
[%BUNDLE%] Description to follow
[%OTHERBUNDLES%] Description to follow
[%AVAILABILITY%] Description to follow
[%BUY%] This replaces P1 'Options', 'Availability' and 'Add to cart' - Description to follow
   
[%IMAGES%] Returns the image 'set' as thumbs, with lightbox functionality. Product.html template only.
[%IMAGES_MINI%] Returns all of the images in 'mini' dimensions, with lightbox functionality. Product.html template only
[%IMAGE_MINI%] Returns only the default image in 'mini' dimensions. Links to product detail page when used in product_listing.html template, lightbox functionality on product.html template.
[%IMAGE_THUMB%] Returns only the default image in 'thumb' dimensions. Links to product detail page when used in product_listing.html template, lightbox functionality on product.html template.
[%IMAGE_LARGE%] Returns only the default image in 'large' dimensions. No links, no lightbox functionality.
 
[#REVIEWS#] Returns the reviews table
[%CATLINK%] Returns a link to the parent category.
[%TABS%] Custom field tabs
[%CF_PCF_name%] Returns the string in whichever custom field is called ('name'). - CURRENTLY IGNORES SQUARE BRACKETS

 
[%INFO%] 'More Info' button on product_listing
[%ADDTOCART%] 'Add to Cart' button on product_listing