This document lists and explains all the Avactis tags curently available. Before consulting the Avactis Tag Library, you should also review the following help documents:
Local tags are used only inside templates and are auxiliary tags. They are not listed here. Local tags for individual store blocks are provided in the corresponding sections of Avactis Store Blocks Customization help document.
Store Block Tags
Store block tags are versatile tools for building an online store quickly and easily. Store blocks display online storefront components - Navigation Bar, Product Info, Shopping Cart, etc, which are all integral parts of an online store. The difference between block tags and info tags is that a store block tag calls a template (an html page) where any number of tags can be used, including other block tags as well as info tags.
The structure of folders containing the store block templates is shown below.
A helpful aid for working with store block tags is the document Avactis Store Blocks Customization. It provides detailed information about customizing store blocks.
The customer's current location in the category tree.
<?php Checkout(); ?>
The tag outputs a URL which links to the site page that is specified in section [Checkout] in the file storefront-layout.ini. Clicking this link starts the the checkout process.
<?php NavigationBar(); ?>
The tree of categories. This block is the main navigational component of an online store.
<?php PaginatorDropdown(); ?>
A drop-down list in which the user can select the number of products displayed per page. This block is not a stand-alone tag and can only be called from the template-container of a ProductList block.
<?php PaginatorLine(); ?>
A line containing the page numbers for situations when more than one page is required for displaying the list of products. This block is not a stand-alone tag and can only be called from the template-container of a ProductList block.
<?php ProductInfo(); ?>
The detailed product information.
<?php ProductList(); ?>
The list of products in the current category.
<?php PromoCodeForm(); ?>
The form for entering promo codes to get a discount.
<?php SearchForm(); ?>
The form for entering keywords to search for products in the catalog.
<?php SearchResult(); ?>
Search results displayed as a list of products.
<?php ShoppingCart(); ?>
The contents of the shopping cart.
The contents of the shopping cart (items currently added to the cart).
<?php Subcategories(); ?>
The list of subcategories in the current category.
Info Tags
Avactis info tags are the most basic kind of tag. Info tags display product attributes, category attributes, links and so on. They usually display only one link, attribute or image at a time.
All info-tags mentioned below are "global" tags. This means they can be called from anywhere on the website: any site page or any template of any block-tag.
All of the info tags currently available in Avactis Shopping Cart software are listed below.
Category Info Tags
Category Info Tag
Category Info Tag Description
<?php CategoryID() ?>
The category ID.
<?php CategoryName(); ?>
The category name.
<?php CategoryDescription(); ?>
The category description.
<?php CategoryLargeImage(); ?>
The full <img> HTML tag including image size and alternate text.
<?php CategoryLargeImageSrc(); ?>
Only the image source path. The tag can be inserted into an <img> HTML tag.
<?php CategoryLargeImageWidth(); ?>
The image width in pixels. The tag can be inserted into an <img> HTML tag.
<?php CategoryLargeImageHeight(); ?>
The image height in pixels. The tag can be inserted into an <img> HTML tag.
<?php CategorySmallImage(); ?>
The full <img> HTML tag including image size and alternate text.
<?php CategorySmallImageSrc(); ?>
Only the image source path. The tag can be inserted into an <img> HTML tag.
<?php CategorySmallImageWidth(); ?>
The image width in pixels. The tag can be inserted into an <img> HTML tag.
<?php CategorySmallImageHeight(); ?>
The image height in pixels. The tag can be inserted into an <img> HTML tag.
<?php CategoryImageAltText(); ?>
The alternate text for the image. The tag can be inserted into an <img> HTML tag.
<?php CategoryPageTitle(); ?>
The text specified for Page Title on the category creation page. The tag can be inserted into a <title> HTML tag to specify the title of a site page.
<?php CategoryMetaKeywords(); ?>
The text specified for Meta Keywords on the category creation page. The tag can be inserted into a <meta> HTML tag of a site page.
<?php CategoryMetaDescription(); ?>
The text specified for Meta Description on the category creation page. The tag can be inserted into a <meta> HTML tag of a site page.
<?php CategoryProductsNumber(); ?>
The number of products in a category.
<?php CategoryProductsNumberRecursively(); ?>
The number of products in a category and all its subcategories.
<?php CategorySubcategoriesNumber(); ?>
The number of subcategories in a category.
<?php CategoryLink(); ?>
The category's URL. The tag outputs a URL which links to the product list page that is specified in section [ProductList] in the file storefront-layout.ini. The tag can be used in HTML tag <A> for creating a hyperlink. Clicking this link brings up the list of products in the selected category.
Product Info Tags
Product Info Tag
Product Info Tag Description
<?php ProductID(); ?>
The product ID.
<?php ProductTypeID(); ?>
The product type ID for the specified product.
<?php ProductTypeName(); ?>
The product type name for the specified product.
<?php ProductUpdated(); ?>
The date of the last product update.
<?php ProductAdded(); ?>
The date the product was added to the catalog.
<?php ProductName(); ?>
The product name.
<?php ProductSalePrice(); ?>
The product sale price. The product is sold to customers at this price.
<?php ProductListPrice(); ?>
The product list price. The list price is not used for sales and purchases.
<?php ProductQuantityInStock(); ?>
The stock quantity for the product.
<?php ProductSKU(); ?>
The product SKU.
<?php ProductMinQuantity(); ?>
The minimum allowed quantity of the product that can be purchased.
<?php ProductLowStockLevel(); ?>
The minimum allowed product quantity in stock. Once the product stock level reaches this figure, notifications of low stock levels are e-mailed to the administrator on a regular basis.
<?php ProductAvailable(); ?>
"Yes" if the product is available for purchase, otherwise "No".
<?php ProductTaxClass(); ?>
The product tax class name.
<?php ProductLargeImage(); ?>
The full <img> HTML tag including image size and alternate text.
<?php ProductLargeImageSrc(); ?>
Only the image source path. The tag can be inserted into an <img> HTML tag.
<?php ProductLargeImageWidth(); ?>
The image width in pixels. The tag can be inserted into an <img> HTML tag.
<?php ProductLargeImageHeight(); ?>
The image height in pixels. The tag can be inserted into an <img> HTML tag.
<?php ProductSmallImage(); ?>
The full <img> HTML tag including image size and alternate text.
<?php ProductSmallImageSrc(); ?>
Only the image source path. The tag can be inserted into an <img> HTML tag.
<?php ProductSmallImageWidth(); ?>
The image width in pixels. The tag can be inserted into an <img> HTML tag.
<?php ProductSmallImageHeight(); ?>
The image height in pixels. The tag can be inserted into an <img> tag.
<?php ProductImageAltText(); ?>
The alternate text for the image. The tag can be inserted into an <img> HTML tag.
<?php ProductShortDescription(); ?>
The short product description.
<?php ProductDetailedDescription(); ?>
The full product description.
<?php ProductPerItemShippingCost(); ?>
The shipping cost of the product (per item shipping cost), which is specified on
the product creation page.
<?php ProductPerItemHandlingCost(); ?>
The handling cost of the product (per item handling cost), which is specified on
the product creation page.
<?php ProductWeight(); ?>
The weight of the product.
<?php ProductFreeShipping(); ?>
Defines whether the product is free shipping.
<?php ProductPageTitle(); ?>
The text specified for Page Title on the product creation page. The tag can be inserted into a <title> HTML tag to specify the title of a site page.
<?php ProductMetaKeywords(); ?>
The text specified for Meta Keywords on the product creation page. The tag can be inserted into a <meta> HTML tag of a site page.
<?php ProductMetaDescription(); ?>
The text specified for Meta Description on the product creation page. The tag can be inserted into a <meta> HTML tag of a site page.
<?php ProductInfoLink(); ?>
Outputs the URL of the detailed product description page. This URL can be used in HTML tag <A> for creating a link. Clicking this URL brings up a page with the descriptions of products. The page to which the URL links is specified in section [ProductInfo] in the configuration file storefront-layout.ini.
<?php ProductBuyLink(); ?>
The URL of the page displaying the customer's current shopping cart. The product is added to the cart. This URL can be used in HTML tag <A> for creating a link to customer's current shopping cart and simultaneously adding the product to the cart. The page to which the URL links is specified in section [Cart] in the configuration file storefront-layout.ini.
<?php ProductCategoryLink(); ?>
Outputs the URL of the list of products in this product's category. This URL can be used in HTML tag <A> for creating a link. The page to which the URL links is specified in section [ProductList] in the configuration file storefront-layout.ini.
<?php Product*Custom (); ?>
The value of a custom attribute. Replace the asterisk * with the name of the custom attribute. Custom attributes are created within the product type.
Shopping Cart Info Tags
Shopping Cart Info Tag
Shopping Cart Info Tag Description
<?php ShoppingCartProductsQuantity(); ?>
Products quantity in the shopping cart, that is, the total number of product items in the cart.
<?php ShoppingCartSubtotal(); ?>
Shopping cart subtotal amount. The cost of the shopping cart calculated using the Product Options Sale Price modifiers and the product quantities.
<?php ShoppingCartGlobalDiscount(); ?>
Global discount amount. This amount will be subtracted from Shopping Cart Subtotal. Global Discounts can be defined on Marketing -> Global Discounts.
<?php ShoppingCartPromoCodeDiscount(); ?>
Promo code discount amount. This amount will be subtracted from Shopping Cart Subtotal after the customer enters a coupon number. Promo Codes can be defined on Marketing -> Promo Codes.
<?php ShoppingCartDiscountedSubtotal(); ?>
Shopping cart discounted subtotal amount. This sum of Global Discount and Promo Code Discount will be subtracted from Shopping Cart Subtotal.
Store Owner Info Tags
StoreOwner Info Tag
StoreOwner Info Tag Description
<?php StoreOwnerName(); ?>
Displays the name of the online store. This setting is defined on the page Store Settings -> Store Owner's Profile, in the Name field.
<?php StoreOwnerWebsite(); ?>
Displays the URL of the online store. This setting is defined on the page Store Settings -> Store Owner's Profile, in the Web site field.
<?php StoreOwnerPhones(); ?>
The store owner's phone number. This setting is defined on the page Store Settings-> Store Owner's Profile.
<?php StoreOwnerFax(); ?>
The store owner's fax number. This setting is defined on the page Store Settings -> Store Owner's Profile.
<?php StoreOwnerStreetLine1(); ?>
The first line of the store owner's postal address. This setting is defined on the page Store Settings -> Store Owner's Profile.
<?php StoreOwnerStreetLine2(); ?>
The second line of the store owner's postal address. This setting is defined on the page Store Settings -> Store Owner's Profile.
<?php StoreOwnerCity(); ?>
The store owner's city. This setting is defined on the page Store Settings -> Store Owner's Profile.
<?php StoreOwnerState(); ?>
The store owner's state. This setting is defined on the page Store Settings -> Store Owner's Profile.
<?php StoreOwnerPostcode(); ?>
The store owner's zip code/postal code. This setting is defined on the page Store Settings -> Store Owner's Profile.
<?php StoreOwnerCountry(); ?>
The store owner's country. This setting is defined on the page Store Settings -> Store Owner's Profile.
<?php StoreOwnerEmail(); ?>
The store owner's e-mail address. This setting is defined on the page Store Settings -> Store Owner's Profile.
<?php StoreOwnerSiteAdministratorEmail(); ?>
The store administrator's e-mail address. This setting is defined on the page Store Settings -> Store Owner's Profile.
<?php StoreOwnerOrdersDepartmentEmail(); ?>
The e-mail address of the orders department. This setting is defined on the page Store Settings -> Store Owner's Profile.