Template Overview

This section will assist you on how to build an Aurora website.

Template Engine

Aurora runs on the Smarty template engine.  It is highly recommended that you please learn about this via their website before proceeding with any of this documentation.  Aurora supports both Smarty 3 and 2, with Smarty 3 being the recommended choice.  

Template Variable Escaping

Aurora will present all template variables in their raw unfiltered form by default, however when using Smarty 3 you can enable default variable escaping to help prevent Cross-site scripting (XSS) attacks. This can be enabled within the Aurora store settings here:

Store > Settings > Security > Template Engine > Escape all template variables by default?

When this is enabled the following special characters will be encoded when being rendered within a template:

CharacterReplacement
&(ampersand)&
" (double quote)"
' (single quote)'
< (less than)<
> (greater than)>

You may find situations where you require the unfiltered version of a variable, such as when you are rendering the output of another template or pre-rendered content such as snippets. This can be achieved by using the nofilter parameter as follows:

{$productList nofilter}

To explicitly escape a variable see:

{$productList|escape:'html' nofilter}

For reference see https://www.smarty.net/docsv2/en/language.modifier.escape

Overview of templates

More information is available regarding these files throughout the documentation, but this list is kept for the sake of clarity in where files are stored and what they do.  

Template FileDescriptionExample
index.tpl.htmlThe home pagehttps://demo.auroracommerce.com/
products/details.tpl.htmlProduct details pagehttps://demo.auroracommerce.com/00100023945/00100023945
products/attributes.tpl.htmlThe attributes of a product, e.g. Sizehttps://demo.auroracommerce.com/00100023945/00100023945
products/index.tpl.htmlProduct listings pagehttps://demo.auroracommerce.com/clothes/
_includes/navigation_dynamic_new.tpl.htmlSidebar menu used for filteringhttps://demo.auroracommerce.com/clothes/
products/listings-grid.tpl.htmlProduct listings page grid viewhttps://demo.auroracommerce.com/clothes/
products/reviews.tpl.htmlCustomer reviews area for product details pagehttps://demo.auroracommerce.com/00100008350/00100008350
products/reviews-single.tpl.htmlThe individual reviewhttps://demo.auroracommerce.com/products/reviews/
products/reviews-create.tpl.htmlThe form for writing reviewshttps://demo.auroracommerce.com/products/reviews/write/32595
products/reviews-permalink.tpl.htmlLink to the permanent place of a reviewhttps://demo.auroracommerce.com/products/reviews/permalink/42
products/quicklook.tpl.htmlThe Quick Look view - an easy way to view the product without clicking through to see it
products/ajax-quicksearch.tpl.htmlQuick search - when typing in a search it will autocomplete your resultshttps://demo.auroracommerce.com/ - type in "Heat" into the search
members/addresses.tpl.htmlThe address bookhttps://demo.auroracommerce.com/members/addresses
members/ajax-edit-address.tpl.htmlEditing/adding an address book entryhttps://demo.auroracommerce.com/members/addresses - click to edit an address
members/creditcards.tpl.htmlList of previously saved debit/credit cardshttps://demo.auroracommerce.com/members/creditcards
members/edit-order.tpl.htmlEdit an order before it is despatchedhttps://demo.auroracommerce.com/members/edit-order
members/forgotpassword.tpl.htmlForgotten password processhttps://demo.auroracommerce.com/members/forgotpassword
members/index.tpl.htmlLogin/register page for members areahttps://demo.auroracommerce.com/members
members/loyalty-points.tpl.htmlLoyalty pointshttps://demo.auroracommerce.com/members/loyalty-points
members/order-details.tpl.htmlThe details of the specific order used in members/orders.tpl.htmlhttps://demo.auroracommerce.com/members/orders
members/orders.tpl.htmlView all ordershttps://demo.auroracommerce.com/members/orders
members/returns.tpl.htmlRequest a reviewhttps://demo.auroracommerce.com/members/returns?order=200000046
members/reviews.tpl.htmlEdit submitted reviewshttps://demo.auroracommerce.com/members/reviews
members/settings.tpl.htmlChange email address or passwordhttps://demo.auroracommerce.com/members/settings
members/store-credit.tpl.htmlStore credit pagehttps://demo.auroracommerce.com/members/store-credit
members/summary.tpl.htmlSummary area - used when first logged into members areahttps://demo.auroracommerce.com/members/summary
basket/index.tpl.htmlBasket pagehttps://demo.auroracommerce.com/basket
basket/basket.tpl.htmlThe basket used on the basket pagehttps://demo.auroracommerce.com/basket
basket/dropdownbasket.tpl.htmlDropdown basket used across sitehttps://demo.auroracommerce.com/ - will only appear if you have any items in your basket
basket/minibasket-container.tpl.htmlDisplay a brief overview of basket contents. Mouseover/click to retrieve basket/dropdownbasket.tpl.htmlhttps://demo.auroracommerce.com
checkout/index.tpl.htmlCheckout areahttps://demo.auroracommerce.com/checkout
checkout/order-complete.tpl.htmlOrder completion pagehttps://demo.auroracommerce.com/checkout/order-complete
checkout/failed-order.tpl.htmlIf an order fails via an external 3rd party service, e.g. PayPal
generic/pagenumbersinfo.tpl.htmlPage numbers information, e.g. "1-20 of 40"
generic/pagenumbers.tpl.htmlPagination
content/page.tpl.htmlContent pagehttps://demo.auroracommerce.com/about-us
blog/main.tpl.htmlMain blog pagehttps://demo.auroracommerce.com/blog/
blog/single.tpl.htmlIndividual blog pagehttps://demo.auroracommerce.com/blog/2017/08/example-sub-blog
blog/comments.tpl.htmlBlog commentshttps://demo.auroracommerce.com/blog/2015/08/example-advice-article-1