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 Smarty 4.  

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 Smarty escape modifier

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 pagedemo.auroracommerce.com/
products/details.tpl.htmlProduct details pagedemo.auroracommerce.com/00100023945/00100023945
products/attributes.tpl.htmlThe attributes of a product, e.g. Sizedemo.auroracommerce.com/00100023945/00100023945
products/index.tpl.htmlProduct listings pagedemo.auroracommerce.com/clothes/
_includes/navigation_dynamic_new.tpl.htmlSidebar menu used for filteringdemo.auroracommerce.com/clothes/
products/listings-grid.tpl.htmlProduct listings page grid viewdemo.auroracommerce.com/clothes/
products/reviews.tpl.htmlCustomer reviews area for product details pagedemo.auroracommerce.com/00100008350/00100008350
products/reviews-single.tpl.htmlThe individual reviewdemo.auroracommerce.com/products/reviews/
products/reviews-create.tpl.htmlThe form for writing reviewsdemo.auroracommerce.com/products/reviews/write/32595
products/reviews-permalink.tpl.htmlLink to the permanent place of a reviewdemo.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 resultsdemo.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 entrydemo.auroracommerce.com/members/addresses - click to edit an address
members/creditcards.tpl.htmlList of previously saved debit/credit cardsdemo.auroracommerce.com/members/creditcards
members/edit-order.tpl.htmlEdit an order before it is despatcheddemo.auroracommerce.com/members/edit-order
members/forgotpassword.tpl.htmlForgotten password processdemo.auroracommerce.com/members/forgotpassword
members/index.tpl.htmlLogin/register page for members areademo.auroracommerce.com/members
members/loyalty-points.tpl.htmlLoyalty pointsdemo.auroracommerce.com/members/loyalty-points
members/order-details.tpl.htmlThe details of the specific order used in members/orders.tpl.htmldemo.auroracommerce.com/members/orders
members/orders.tpl.htmlView all ordersdemo.auroracommerce.com/members/orders
members/returns.tpl.htmlRequest a reviewdemo.auroracommerce.com/members/returns?order=200000046
members/reviews.tpl.htmlEdit submitted reviewsdemo.auroracommerce.com/members/reviews
members/settings.tpl.htmlChange email address or passworddemo.auroracommerce.com/members/settings
members/store-credit.tpl.htmlStore credit pagedemo.auroracommerce.com/members/store-credit
members/summary.tpl.htmlSummary area - used when first logged into members areademo.auroracommerce.com/members/summary
basket/index.tpl.htmlBasket pagedemo.auroracommerce.com/basket
basket/basket.tpl.htmlThe basket used on the basket pagedemo.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 areademo.auroracommerce.com/checkout
checkout/order-complete.tpl.htmlOrder completion pagedemo.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 pagedemo.auroracommerce.com/about-us
blog/main.tpl.htmlMain blog pagedemo.auroracommerce.com/blog/
blog/single.tpl.htmlIndividual blog pagedemo.auroracommerce.com/blog/2017/08/example-sub-blog
blog/comments.tpl.htmlBlog commentsdemo.auroracommerce.com/blog/2015/08/example-advice-article-1