Page tree
Skip to end of metadata
Go to start of metadata

Overview

 

Home page is the first page that customer will see and represents the starting point on your site. Home page documentation also covers some common elements such as standard header and footer blocks.

Standard Home Page

 

Annotations

 

Element Template Configurations1Content include2Description 
C.1 Cookie Policy Alert Standard header Shop on/off flag "SHOP_COOKIE_POLICY_ENABLE" "cookie_policy_include" Enables cookie policy warning. Once "OK" is clicked "yccookiepolicy" cookie is set preventing message from appearing again. 
C.2 Home page body Empty central view  "homepage_content_include" Home page body 
F.0 Footer meta include Standard footer
Checkout footer 
 "footer_include" Additional page meta data e.g. additional javascript.
(warning)  This is rendered at the bottom of the page and is not intended for any visible elements 
F.1 Footer Standard footer  "footer_nav_include" Footer can include social links, additional menus, logos etc 
F.2 Copyright Standard footer  "footer_copy_include" Additional footer for copyright information 
F.3 Newsletter form content Standard footer "newsletter_newsletterform_content_include" Content for newsletter form (e.g. Header and info above the input) 
F.4 Newsletter form    Allows to send emails via "adm-newsletter-request" template to shop admin 
H.0 Header meta include Standard header
Checkout header 
 "header_include" Additional page meta data e.g. Google Analytics meta tag.
(warning)  This is rendered at the very top of the page and is not intended for any visible elements 
H.1 Shop logo Standard header Shop image "SHOP_IMAGE0"  Logo for shop is using first image attribute including localised versions 
H.2.1 Search form content Standard header  "header_search_include" Additional content above search form 
H.2.2 Search form Standard header   Form is non configurable but can be overridden in custom theme 
H.3 Mini cart Standard header   Mini cart view is non configurable but can be overridden in custom theme 
H.3.1 Mini cart tax Standard header "SHOP_PRODUCT_ENABLE_PRICE_TAX_INFO" - flag to display tax or not
"SHOP_PRODUCT_ENABLE_PRICE_TAX_INFO_SHOW_NET" - flag to who net or gross prices
"SHOP_PRODUCT_ENABLE_PRICE_TAX_INFO_SHOW_AMOUNT" - flag to show either percentage or amount of tax 
 Displaying tax information is configured at shop level 
M.1 Top navigation Standard header  "header_nav_include" Top site navigation e.g. tags, main categories, micro sites 
M.2 Customer login Standard header Shop customer name format "SHOP_CUSTOMER_FORMATTER"  Two views depending on whether customer is logged in or not. When not logged in shows a login/registration link. When logged in displays a welcome message and a drop down menu to access personal data. 
M.3 Language selector Standard header Shop language settings  Visible only if shop has more than one language option 
M.4 Currency selector Standard header Shop currency settings  Visible only if shop has more than one currency option 
M.5 Breadcrumbs Breadcrumbs   Automatically resolves current breadcrumbs path depending on the URI 
M.6 Category navigation Top categories   Displays current menu depending on current category selected. For home page displays shop top level categories. 
P.1 Featured products Featured products Category max items "CATEGORY_ITEMS_FEATURED".
Shop level is constant set at 15 
 Displays featured products carousel for currently selected category 
P.2 Product tabs    Each tab displays a list of specific products 
P.2.1 New arrivals tab New arrival products Category max items "CATEGORY_ITEMS_NEW_ARRIVAL".
Shop level is constant set at 5.
Category day offset "CATEGORY_NEW_ARRIVAL_DAYS_OFFSET".
Shop day offset "SHOP_NEW_ARRIVAL_DAYS_OFFSET". 
 Displays new arrival products. New arrivals either ones marked with "newarrival" tag or those for which created timestamp is less than day offset into past before now 
P.2.2 Recently viewed Recently viewed products Category max items "CATEGORY_ITEMS_NEW_ARRIVAL".
Shop level is constant set at 5.
Absolute maximum value for this is 10 in Spring context configuration for ViewProductSkuInternalCommandImpl command 
 Displays recently viewed (by customer) products. 

1Configurations refer to shop and category custom attributes that define behaviour of components
2Content include refers to shop URI suffix for content. For example if shop has code "SHOP10" and content include is specified as "custom_content" then URI of the content include that will be rendered is "SHOP10_custom_content"

  • No labels