You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

This article aims to describe the different property fields that are involved when creating a new template. 

 

Step-by-step guide

1) Template Type: 

Group Templates

Group templates are used to display lists of products when browsing categories. When viewing a list of products in a category then way the products are listed is defined using a 'Group Template'. a Group Template can be set at the following levels:

    • System Default Category Template. The template that is used to display lists of products across the whole site.
    • Role Level Default Category Template. The template that is used for the role. If this is not set, the 'System Default Category Template' is used.
    • Product Category Template. The template that is used for the category. If this is not set, the 'Role Level Default Category Template' is used.
    • Catalogue Category Template. The template that is used for the catalogue category. If this is not set, the 'Role Level Default Category Template' is used.

 

Product Templates

Product Templates are used to display the product details. When viewing a product, the layout of the product's details is defined using a 'Product Template'. A product template can be set at the following levels:

    • System Default Product Template. The product template that is used to display product details across the whole site.
    • Role Level Product Template. The product template that is used for the role. If this is not set, the 'System Default Product Template' is used.
    • Product Category Template. The product template that is used for the products in the category. If this is not set, the 'Role Level Default Product Template' is used.
    • Product Template. The product template that is used for the product. If this is not set, the 'Product Category Template' is used.
    • Campaign Product Template. The product template that is used for the products in the campaign. If this is not set, the 'Role Level Default Product Template' is used.
    • Auction Product Template. The product template that is used for the products in the Auction. If this is not set, the 'Role Level Default Product Template' is used.

 

Navigation Templates

Navigation templates are used for defining the menu and navigational links around the content on the site. The navigation templates can be set at the following levels.

    • The following settings are used to define the template that is used for navigation. The navigation sections are the frame around the content that is displayed in the middle of the screen.
      • System Default Header Template.
      • System Default Footer Template.
      • System Default Left Nav Template.
      • System Default Right Nav Template.
    • The following settings are used to define the navigation around the payment pages.
      • System Default Top Payment Template.
      • System Default Bottom Payment Template.
    • The following settings are used to define the the navigation within the content frame.
      • System Default Page Bottom Template.
      • System Default Page Left Template.
      • System Default Page Right Template.
      • System Default Page Title Template.
    • The following settings are used to override the system navigation settings at a role level.
      • Role Level Header Template.
      • Role Level Footer Template.
      • Role Level Left Nav Template.
      • Role Level Right Nav Template.

Page Templates

Page templates are used for Custom pages and content pages such as the home page. Custom pages can be displayed with or without navigation controls, this allows a custom page to be displayed with a completely different look to the rest of the site.

Email Templates

All system generated emails can be templated using an Email type template. This allows the email to be customised with company logo and fonts or to match emails from another system.



2) Version: 

  • Version 1: Old style "[CSS:<name>]" - (legacy, should be avoided where possible)
  • Version 2: CSSRepeat capable - [<datasource>.<PropertyName>] - eg: [Order.OrderID]
  • Version 3: like version 2 but supports XSLT - (legacy, should be avoided where possible)
  • Version 4: Razor templates based on MVC Razor engine

3) Parsed Template Caching Mode:

  • Application Mode: This means that the template will be parsed once and used by ALL subsequent uses of this template regardless of the user. This might be useful for a Home page, Menu structure or Product Category structure on B2C sites.
  • Session Mode: This means that the template will be parsed once per user session. If another user needs that template it will be parsed for them specifically and will not use the cached version. This might be useful for a Home page, Menu structure or Product Category structure on B2B sites.

    The TemplateCache table contains all the details and parsed content that is served up. The distinction between these two modes is done via the TemplateCache.SessionID column. If it has a value it is a session specific entry, if it is empty (cannot be null as it is a primary key) then it is considered an application mode cached entry.


4) Data Sources: 

  • Gives access to a record set via a token.
  • Semicolon separates list of datasources e.g. <datasource>;<datasource>
  • Datasource must be strongly typed business object e.g. Products.All 

 

5) Widget names:

  •  To automatically load widget's settings, add all javascript widget used on the template here separated by commas. 

 

6) Invoke Type: Allows campaigns to be setup as Sub Templates. 

  • Campaigns that are dependent on FormProcessPostBack to handle the button clicks / add to cart postback.

 

7) PDF Orientation: Layout orientation of either Portrait or Landscape.

 

8) Word Template: Specific documents generated in Microsoft Word may be added here to generate templates.

 

9) Disable Design Mode: If selected design mode tab of the editor will be disabled and switched to html view. 


10) Request Cached Data Source Mode: Specifies if and how this template will cache it's data sources, either 'cache all data' or just from 'sources'.


11) Content Type: The template editor page should only be allowed to run templates of a certain "content type", this restriction can be managed in this field. User can set the content type of the template to either be 'Content' or 'Layout'.


 

  • No labels

© Copyright 2001-2023 Commerce Vision Pty Ltd. Use of this site signifies your acceptance of Commerce Vision’s Terms & Conditions. CV Connect, the Commerce Vision logos, and other Commerce Vision marks are assets of Commerce Vision Pty Ltd.