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:
Character | Replacement |
---|---|
&(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 File | Description | Example |
index.tpl.html | The home page | https://demo.auroracommerce.com/ |
products/details.tpl.html | Product details page | https://demo.auroracommerce.com/00100023945/00100023945 |
products/attributes.tpl.html | The attributes of a product, e.g. Size | https://demo.auroracommerce.com/00100023945/00100023945 |
products/index.tpl.html | Product listings page | https://demo.auroracommerce.com/clothes/ |
_includes/navigation_dynamic_new.tpl.html | Sidebar menu used for filtering | https://demo.auroracommerce.com/clothes/ |
products/listings-grid.tpl.html | Product listings page grid view | https://demo.auroracommerce.com/clothes/ |
products/reviews.tpl.html | Customer reviews area for product details page | https://demo.auroracommerce.com/00100008350/00100008350 |
products/reviews-single.tpl.html | The individual review | https://demo.auroracommerce.com/products/reviews/ |
products/reviews-create.tpl.html | The form for writing reviews | https://demo.auroracommerce.com/products/reviews/write/32595 |
products/reviews-permalink.tpl.html | Link to the permanent place of a review | https://demo.auroracommerce.com/products/reviews/permalink/42 |
products/quicklook.tpl.html | The Quick Look view - an easy way to view the product without clicking through to see it | |
products/ajax-quicksearch.tpl.html | Quick search - when typing in a search it will autocomplete your results | https://demo.auroracommerce.com/ - type in "Heat" into the search |
members/addresses.tpl.html | The address book | https://demo.auroracommerce.com/members/addresses |
members/ajax-edit-address.tpl.html | Editing/adding an address book entry | https://demo.auroracommerce.com/members/addresses - click to edit an address |
members/creditcards.tpl.html | List of previously saved debit/credit cards | https://demo.auroracommerce.com/members/creditcards |
members/edit-order.tpl.html | Edit an order before it is despatched | https://demo.auroracommerce.com/members/edit-order |
members/forgotpassword.tpl.html | Forgotten password process | https://demo.auroracommerce.com/members/forgotpassword |
members/index.tpl.html | Login/register page for members area | https://demo.auroracommerce.com/members |
members/loyalty-points.tpl.html | Loyalty points | https://demo.auroracommerce.com/members/loyalty-points |
members/order-details.tpl.html | The details of the specific order used in members/orders.tpl.html | https://demo.auroracommerce.com/members/orders |
members/orders.tpl.html | View all orders | https://demo.auroracommerce.com/members/orders |
members/returns.tpl.html | Request a review | https://demo.auroracommerce.com/members/returns?order=200000046 |
members/reviews.tpl.html | Edit submitted reviews | https://demo.auroracommerce.com/members/reviews |
members/settings.tpl.html | Change email address or password | https://demo.auroracommerce.com/members/settings |
members/store-credit.tpl.html | Store credit page | https://demo.auroracommerce.com/members/store-credit |
members/summary.tpl.html | Summary area - used when first logged into members area | https://demo.auroracommerce.com/members/summary |
basket/index.tpl.html | Basket page | https://demo.auroracommerce.com/basket |
basket/basket.tpl.html | The basket used on the basket page | https://demo.auroracommerce.com/basket |
basket/dropdownbasket.tpl.html | Dropdown basket used across site | https://demo.auroracommerce.com/ - will only appear if you have any items in your basket |
basket/minibasket-container.tpl.html | Display a brief overview of basket contents. Mouseover/click to retrieve basket/dropdownbasket.tpl.html | https://demo.auroracommerce.com |
checkout/index.tpl.html | Checkout area | https://demo.auroracommerce.com/checkout |
checkout/order-complete.tpl.html | Order completion page | https://demo.auroracommerce.com/checkout/order-complete |
checkout/failed-order.tpl.html | If an order fails via an external 3rd party service, e.g. PayPal | |
generic/pagenumbersinfo.tpl.html | Page numbers information, e.g. "1-20 of 40" | |
generic/pagenumbers.tpl.html | Pagination | |
content/page.tpl.html | Content page | https://demo.auroracommerce.com/about-us |
blog/main.tpl.html | Main blog page | https://demo.auroracommerce.com/blog/ |
blog/single.tpl.html | Individual blog page | https://demo.auroracommerce.com/blog/2017/08/example-sub-blog |
blog/comments.tpl.html | Blog comments | https://demo.auroracommerce.com/blog/2015/08/example-advice-article-1 |
Updated over 2 years ago