This module enables you to develop a template made-to-measure based on your own HTML, CSS and Javascript. It allows you to leave out traditional themes and widget layouts and develop a unique, conversion upgraded theme. Using this module will help you understand the phrases doctype declaration, semantics and cross browser compability . If you do not know what is meant by these phrases, it might be better to opt for the layout theme Enoza. .
Using your own HTML, CSS and Javascript
By allowing you to use your own HTML, CSS and Javascript you will be responsible yourself for the correct rendering of your webshop.
Besides we are giving you a free hand to fit in the elements from the traditional widgets in a position where you want them. This makes you responsible for the correct implementation and functioning of these widgets.
Attention! In order to make sure your webshop will continue to function correctly after each update, it is vital that the content is not adapted by means of CSS and Javascript.
Webshop logic? By this expression the technical functioning of ( certain parts of) the webshop is meant. For example the display of a bestseller list.
Webshoplogic can be implemented in various ways:
All logic you will be able to use is Smarty-logic. Smarty is the underlying template system this module was built on. You can also consult the Smarty-website documentation for creating foreach-loops, sections and e.g. cycles. Besides you can adapt variable modifiers on variables containing textual content.
As stated, it is possible to implement logic yourself. To simplify this process, a number of code fragments are available. Code fragments can be found on the left in the middle of the module. By clicking on the code fragment, this fragment will be positioned in the code of the file Index.tpl on the spot where your cursor is or was the last time you moved it.
The documentation List of objects specifies for each object in which code fragment a specific object is available and in which variable.
OIn order to help you recognize the type of data your are dealing with in a variable, a certain coding standard was used. All variables have a batch character that specifies the data type of that variable. If you are using the code fragments, you will see that batch characters are also used to inform you which data type is implemented in a certain variable. Below list gives you an overview of the different batch characters and informs you which data type the variable contains.
| Batch character | Description |
| _ | Logics, adapted for including files. |
| a | Array. |
| b | Boolean. |
| f | Float. |
| i | Integer. |
| m | Mixed, the variable may contain several data types, depending on a result. |
| o | Object. |
| s | String. |
In order to guarantee the compability with existing webshop logic, CSS-declarations and Javascript functionalities, the use of prefixes for all HTML-elements, CSS-declarations and Javascript functionality is strongly advised. A prefix may consist of any characters or letters you wish, e.g. the abbreviation of your company name combined with a year. This will prevent accidental double declarations. An example: Your company name is “Jansen Jeweler's “ : if you create your theme in 2013, your structure including prefixes may look like this:
<!DOCTYPE>This module has an automatic theme validation system. Every time the theme is filed, it is tested first by the validation system. Alterations will only be filed if the validation system does not detect fatal syntax errors. A ny syntax error is reported by the validation system so that the error can be solved. If the validation system does not discover any fatal syntax errors, the alterations will be filed.
As the validation system approaches the webshop invisibly, these tests will be included in your statistics. Each time the template is filed, the validation system will be activated.
To keep the code clean, compact and orderly a number of javascript functions were made available. Naturally it is possible to add an extra functionality such as javascript functions and event handlers to Scripts.js or in the file Index.tpl.
Function that will check if the key pressed is indeed the “enter” key.
Function that will select the value of an input field.
| Parameter | Datatype | Description |
| sDOMId | String | The ID of the input field. E.g. <input type="text" id="SearchField" value=""/> |
Function that forwards user to location indicated.
| Parameter | Datatype | Description |
| Location | String | Location to which user is forwarded. |
Signing on a visitor to the newsletter by means of this method is outdated. Use the action hook SubscribeToNewsletter..
To simply add a button in the selected style and colour, a span element with the declaration PredefinedButton should be implemented. This span is automatically converted to a stylized button.
ExampleVariables are small pieces of code with a specific name ( the variable name) that represent a specific functionality. This functionality may vary from displaying a piece of text to loading the content modules of the webshops. Below you will find the available variables and their description.
| Variable | Description |
| {$_IncludeHead} | Include of global head data, Template.css and Scripts.js. |
| {$_IncludeContent} | Include of the contentpage in question (homepage, category, guestbook, productdetails, order route etc. etc.). |
| {$_IncludeTail} | Include of global tail-data, such as measuring pixels and statistics. |
| Variable | Description |
| {$sProtocol} | Gives 'http://' or'https://' back depending on the reserved page. |
| {$sAbsoluteMediaLocation} | Absolute path to the map to which the files were uploaded. HTP or HTPS is automatically specified depending on the reserved page. |
| {$sRelativeMediaLocation} | Relative path to the map to which files were uploaded. This variable is meant for usage in the file Template.css to prevent security conflicts. |
| {$sCustomerLoginPageDeeplink} | Link to the login page. |
| {$sCustomerLogoutPageDeeplink} | Link that provides log-out if customer presses the “log-out” button. |
| {$sCustomerRegistrationPageDeeplink} | Link to the registration page. This link is only available if the choice for the login system is switched on and registration is possible. |
| {$sCurrentPage} |
Gives back what type of page is reserved. Based on this several layout pages can be developed. This variable may contain following values:
|
| {$sSearchPageDeeplink} | The URL to the search page. This variable should be used to forward your own search functionality to the right page. The search words entered should be added to this variable. The construction of SearchPageDeeplink} consists of {$sProtocol} + website main domain + '/website/index.php?Show=Search&KeyWord='. |
| {$sBasketPageDeeplink} | The URL to the shopping basket. This variable should be used to forward a shopping cart overview developed by yourself to the correct page. |
| Variable | Setting |
| {$bShowPricesToGuests} |
Setting: Show prices to guests Location: Starting point/My webshop/Settings/ Loginsystems Value: true of false. |
| {$bCustomerLoginActive} |
Setting: Users Login Location: Startingpoint/My webshop/ Settings/ Loginsystems Value: false if 'off', otherwise true. |
| {$sCustomerLoginSystemType} |
Setting: Users Login Location: Startingpoint/My webshop/ Settings/ Loginsystems Value: - Inactive, loginsystem is off. - ActiveWithRegistration, loginsysteem staat aan met de mogelijkheid tot registreren. - ActiveNoRegistration, loginsysteem is on but no option of registering. Attentention {$sCustomerRegistrationPageDeeplink} does not contain a value. - ActiveAutomaticRegistration, loginsysteem is on , after placing an order an account is created automatically. |
| {$sCurrency} |
Setting: Valuta Location: Startingpoint/My webshop/Settings/ Order proces settings. Value: - USA, American Dollar - CAD, Canadian Dollar - DKK, Danish Crowns - EU, Euro - UK, English Pound - RON, Romanian Lei - SRD, Surinam Dollar - TL, Turkish Lira - SEK, Swedish Crown - CHF, Swiss Franc |
| Variable | Description |
| {$sBodyLogic} | Adds logic to the <body>-tag for processing the electronic payments . This variable should be used as follows: <body {$sBodyLogic}>. |
| {$sPageTitleH1} | <h1>-tag for the current page. This variable structures the crumb path within the category structure and product detail page. |
| {$iSelectedCategoryId} | Gives back the ID of the selected product category. |
| {$iSelectedSubCategoryId} | Gives back the ID of the selected product subcategory. |
| {$iSelectedPageId} | Gives back the ID of the selected page. |
| {$sResellerName} | Gives back the name of the reseller. |
| {$sResellerDeeplink} | Gives back the link of the reseller's website. |
| {$sPoweredBy} | Gives back the reseller's HTML-code 'Powered by'. |
| {$bCustomerLoggedIn} | Geeft aan met true of false of de klant is ingelogd. |
| {$sCustomerName} | Gives back the customer name of the logged in customer. |
| {$fCustomerDiscount} | Indicates the discount percentage of the customergroup of the customer. This variable only contains a value if the customer in question is in a customergroup. |
| Property | Description |
| Title | Title of blog item. |
| Content | Textual content of blog item. |
| ImageDeeplink | Link to the image that was added to the blog item. |
| Deeplink | Link to the blog item. |
| CreateDate | Date when blog item was created. |
| Author | Author of blog item. |
| AuthorWebsiteDeeplink | Link to author's website. |
| CommentCount | Number of reactions to blog item. |
| Code fragment | Variable | Description |
| Last blogs | {$aBlogs} | An array of Blog-objects ( last 10). |
| Property | Description |
| Name | Brand name. |
| Codefragment | Variable | Description |
| List of brands | {$aBrands} | An array of Brand-objects. |
| Property | Description |
| Title | Title of category or page. |
| Deeplink | Deeplink to the category or page in question. Value of the last crumb is empty. |
| Codefragment | Variable | Description |
| Crumb path | {$aCrumbs} | An array of Crumb-objects. |
| Property | Description |
| FlagIcon | Deeplink to the standard flag icon, to be used in <img />. |
| Code | Country code, two digits (ISO 3166-1). |
| Domain | Domain of the language. |
| Codefragment | Variable | Description |
| Language flags | {$aLanguages} | An array of Language-objects. |
| Property | Description |
| Title | Title of newsitem. |
| Content | Content of newsitem. |
| Date | Date of precessing. |
| Deeplink | Link to news item. |
| Codefragment | Variable | Description |
| List of newsitems | {$aNewsItems} | An array of NewsItem-objects. |
| Property | Description |
| ProductNumber | Product number/Article number. |
| ProductName | Name of products. |
| Count | Number of products. E.g. 2 if two identical products are in the shopping cart. |
| Tax | VAT-value as integer. E.g. 0,6 or 21. |
| Unit | Product unit. |
| Price | Selling price (if a discount is applicable, it is deducted ) Examples values: 10, 10.1 and 10.95. |
| FromPrice | The original price (if discount is applicable is will differ from Price) Example values: 10, 10.1 en 10.95. |
| Discount | Discount on a product (if applicable) . Value contains discountvalue. Example values: 10, 10.1 en 10.95. |
| TotalPrice | Total price of this product (Count * Price). Example values: 10, 10.1 en 10.95. |
| PriceFormatted | Formatted selling price (if a discount is applicable is is deducted). Example values: 10,00, 10,10 en 10,95. |
| FromPriceFormatted | Formatted original price (if a discount is applicable it differs from Price ). Example values: 10,00, 10,10 en 10,95. |
| DiscountFormatted | Formatted discount on a product (if applicable). Example values: 10,00, 10,10 en 10,95. |
| TotalPriceFormatted | Formatted total price of this product (Count * Price). Example values: 10,00, 10,10 en 10,95. |
| Deeplink | Deeplink to product detail page. |
| MainImageDeeplink | Deeplink to main image of product. |
| MainImageThumbnailDeeplink | Deeplink to thumbnail of main image of product. |
| Codefragment | Variable | Description |
| Small shopping basket | {$aOrderRows} | An array of OrderRow-objects. |
| Property | Description |
| Id | Unique page ID. |
| Title | Page title (also used as link name). |
| PageType |
Page type of the page. Optional page types:
|
| Deeplink | Link to linked page. |
| Codefragment | Variable | Description |
| Pages | {$aPages} | An array of Page-objects. |
| Property | Description |
| ProductName | Name of product. |
| ProductNumber | Productnumber/article number. |
| ShortDescription | Short description (max. 200 characters). |
| Description | Full description. |
| Unit | Unity of product. |
| Tax | VAT-value as integer. E.g. 0, 6 of 21. |
| Stock | Current stock. |
| StockDeliveryStandard | Standard delivery time for the product |
| BrandID | Product brand |
| Weight | Current weight of product |
| Specs | Specification URL |
| Attributes | Product attributes |
| EANNumber | EAN Number |
| MPNNumber | MPN Number |
| Price | Selling price (if a discount is applicable, it is deducted). Example values: 10, 10.1 en 10.95. |
| FromPrice | Original price (if discount is applicable it will differ from Price. Example values: 10, 10.1 en 10.95 |
| Discount | Discount on a product (if applicable). Value contains discount value. Example values: 10, 10.1 en 10.95. |
| PriceFormatted | Formatted selling price (if a discount is applicable, it is deducted). Example values: 10,00, 10,10 en 10,95. |
| FromPriceFormatted | Formatted original price (if discount is applicable it differs from Price). Example values: 10,00, 10,10 en 10,95. |
| DiscountFormatted | Formatted discount on a product (if applicable). Example values: 10,00, 10,10 en 10,95 |
| Deeplink | Deeplink to product page. |
| MainImageDeeplink | Deeplink to main image of product. As standard a measurement of 500px wide with matching space. The platform offers a render farm that allows you to scale to any measure you desire. This may make quite a difference in bandwidth. To scale an mage ( and automatically saving it, following code is used: {$oProduct->MainImageDeeplink|replace:'/Large':'/150'}. Using this code that normally was served as 500 px width – the image will be served as an image of 150px width. If the image of 150px width did not exist as yet, it is automatically created. Images cannot be made larger than the orginal uploaded file. |
| MainImageThumbnailDeeplink | Deeplink to the thumbnail of the main image of the product. |
| ImageDeeplink | Deeplink to all the images of product. As standard a measurement of 500px wide with matching space. The platform offers a render farm that allows you to scale to any measure you desire. This may make quite a difference in bandwidth. To scale an mage ( and automatically saving it, following code is used: {$oProduct->ImageDeeplink|replace:'/Large':'/150'}. Using this code that normally was served as 500 px width – the image will be served as an image of 150px width. If the image of 150px width did not exist as yet, it is automatically created. Images cannot be made larger than the orginal uploaded file. |
| ImageThumbnailDeeplink | Deeplink to the thumbnail of all the images of the product. |
| CreateDate | Y-m-d H:i:s Date when product was created. |
| OrderButtonType | Type of button that was advised in product management: - OrderButton, orderbutton (consult hook_AddProductToCart for implementation documentation). - OfferButton, offerbutton - NoButton, no button |
| ShowOrderButton | true of false |
| ReviewsTotal | Product reviews available |
| ReviewsAverage | Average review rating |
| ReviewsMin | Min. rating available string '0' |
| ReviewsMax | Max. rating available string '5' |
| Setting | Location |
| Show prices to guest | Starting point/My webshop/Settings/General/Login systems |
| Hide orderbutton if no more stock is available | Starting point / My webshop / Settings / Orderprocess and stock / Stockmanagement / Stock options |
| Product has stock | Starting point / My products/Product management / product in question/Tab Stock |
| Stocktype | Starting point / My products / Product management / Product in question / Tab Stock |
| Stock | Starting point / My products / Product management / Product in question / Tab stock |
| Show order / offer button at product | Starting point / My products / Productmanagement / Product in question / Tab Options |
| Codefragment | Variable | Description |
| BestSellers | {$aBestSellers} | An array of Product-object maximum 25. |
| Product on offer | {$oSpecialOffer} | A Product-object |
| Example product category image | {$aProductCategoryProducts} | An array of Product-objects. This code fragment is available in the filesProductCategory1.sub.tpl, ProductCategory2.sub.tpl, ProductCategory3.sub.tpl and ProductCategory4.sub.tpl and be used as layout for category pages and certain elements on the modular page. |
Within the platform, product categories can be used in several places , however, it depends on the location what object properties a ProductCategory-object has. ProductCategory-objects are available in following places:
ProductCategory-objects in the file Index.tpl are usually used to build the navigation structure within the theme. In below tables the object properties are named and it is mentioned in which code fragments these object properties are available.
Objectproperties| Property | Description |
| Id | Unique ID of product category. |
| ParentId | ID of upper category. |
| Name | Name of category. |
| Description | Description of category |
| ShowOrderButton | true of false.This attribute may be used to determine if an order button should be shown or not. This depends on the setting chosen for the category in question in the catalogue module. |
| ApplyPhotoEnlargement | true of false.This attribute may be used to determine if a large picture should be shown or not. This depends on the setting chosen for the category in question in the catalogue module. |
| ApplyPhotoCanvas | true of false.This attribute may be used to determine if a canvas image shoud be used or not. This depends on the setting chosen for the category in question in the catalogue module. |
| ProductsPerPage | Number of products that is shown per page within the category in question. This depends on the setting chosen for the category in question in the catalogue module. |
| Deeplink | Link to the product category page. |
| SubCategories | An array of ProductCategory-objects, within the main category if the main category contains sub categories. With in a sub categorie is possible to loop the sub categories again. This can up to three deep. |
| Codefragment | Variable | Description |
| Catalogue (with subcategories) | {$aCategories} | An array of ProductCategory- objects. |
| Catalogue (without subcategories) | {$aCategories} | An array of ProductCategory- objects. |
ProductCategory-objects within the files ProductCategory1.sub.tpl, ProductCategory2.sub.tpl, ProductCategory3.sub.tpl and productCategory4.sub.tpl are used to give supplementary information within a product category description. In below tables the object properties are mentioned as well as the code fragments in which the object properties are available.
Object properties| Property | Description |
| ProductCount | Total number of products in the product category. |
| CurrentSubPage | Currently active subpage. |
| ProductsPerPage | The number of products that can be displayed for each page. |
| ShowOrderButton | true of false. This attribute can be used to determine if an order button should be shown or not. This depends on the chosen setting for the category in question in the catalogue module. |
| ApplyPhotoEnlargement | true of false. This attribute can be used to determine if a large picture should be shown or not. This depends on the setting chosen for the category in question in the catalogue module. |
| ApplyPhotoCanvas | true of false. This attribute can be used to determine if a canvas image should be used or not. This depends on the setting chosen for the category in question in the catalogue module. |
| Codefragment | Variable | Description |
| Example product category image | {$oProductCategory} | A Productcategory-object. |
ProductCategory-objects in the files SubCategory1.sub.tpl and SubCategory2.sub.tpl are used to show the subcategories within a product category image. In below tables the object properties are named. and also in which code fragments these object properties are available.
Objectproperties| Property | Description |
| Name | Name of subcategory. |
| Description | Description of subcategory. |
| ShowOrderButton | true of false. This attribute can be used to determine if an order button should be shown or not. This depends on the chosen setting for the category in question in the catalogue module true of false. |
| ApplyPhotoEnlargement | true of false. This attribute can be used to determine if a large picture should be shown or not. This depends on the setting chosen for the category in question in the catalogue module. |
| ApplyPhotoCanvas | true of false. This attribute can be used to determine if a canvas image should be used or not. This depends on the setting chosen for the category in question in the catalogue module. |
| Deeplink | Link to the product category page. |
| MainImageDeeplink | Link to the image of the product category. |
| Codefragment | Variable | Description |
| Example subcategories within category | {$aProductCategorySubCategories} | An array of ProductCategory-objects. |
| Property | Description |
| Name |
Name of feed:
|
| Deeplink | Link to RSS feed in question. |
| Codefragment | Variable | Description |
| List of RSS feeds | {$aRSSFeeds} | An array of RSSFeed-objects |
| Property | Description |
| Platform |
Name of platform:
|
| AccountName | Accountnaam on platform |
| Deeplink | Link to account in question. |
| Codefragment | Variable | Description |
| Social Media Accounts | {$aSocialMediaAccounts} | An array van SocialMediaAccount-objects. |
If you develop a theme for an end user who does not have any knowledge of web development, you can add end user settings to your theme. End user settings are managed through the dialogue window “End user settings”. A minimum of one end user category setting should be created to be able to create end user settings. The end user himself does not need to make any changes in the source code of the theme, but is shown a dialogue window based on the categories and settings, where these settings can be given values. Every category created is presented as a separate tab for the end user.
In order to create structure and overview end user settings should be distinguished into categories. Each category is represented as a separate tab for the end user, where for each tab/category the settings created for the end user can be represented. Examples of categories may be: “General”, “Colours”, Main page” etc.
| Inputfield | Description |
| Label | Label of the setting. This is the naming of the setting in the dialogue window for the end user. |
| Variable name | Name of the variable the value can be read out with. The chosen variable name should be unique for each separate theme. In order to print the value of a variable the entering {$oEndUserSetting->VariableName} is used, 'VariableName' being the chosen variable name. The variable name may exclusively contain alfa numeric characters. |
| Type |
|
| Standard value | The standard value for the setting if end user has not selected a a value. |
The end user settings that were created are shown in the item “Code fragments” as a special item. By clicking an end user setting it is placed in the active editor. If the work field layout “Theme file as well as separate CSS window” is used, this means that the implementation code is placed in the editor for theme file or CSS file. The end user settings may be used in the theme files Index.tpl, Template.css and Scrtipts.js.
If your webshop uses multilingual spport you may want to include multiligual variables in the theme you develop. E.g. a shoppingcart image you developed yourself. You may wish to show “Shopping basket”, but to your English visitors you may like to show “Shoppingcart”. Following documentation and examples will teach you how to realise this.
If you do not specify a translation for a certain language ( read following syntax-structure) , and the webshop is represented in that language, the translation you specified first will be shown automatically. It makes no difference in which order the translations are placed.
Each text you wish to present multilangually, should get a multilingual definition.
The syntax of such a definition consists of a number of elements:
| Syntax | Description |
| {* ml | This indicates that a multilingual translation will start. Attention: spacing at the end is obligatory!. |
| sPlaceHolderName | Name of the variable that is defined. |
|
:nl[Vertaling] :en[Translation] :de[Uebersetzung] :fr[Traduction] :tr[Çeviri] |
Here the translation is given for each language. A language starts with a semicolon followed by the language code. The translation per language is represented by square brackets. |
| /ml *} | This indicates the end of a multilingual translation. |
| Language code | Language |
| nl | Dutch. |
| en | English. |
| de | German. |
| fr | French. |
| tr | Turkish. |
AJAX Widgets are widgets that can contain a certain content and can be restored “below water” (showing formatting and styles) without the page the visitor is on at that moment having to be loaded again. AJAX stands for Asynchronous Javascript And XML meaning that the data will be retrieved asynchronously from the webserver. This is a technique that allows you to make pages interactive without having to restore a whole page. Below is described how to recognize and apply an AJAX Widget, followed by the description of AJAX Widgets available.
| Syntax | Description |
| {* plugin *} | This indicates the start of an AJAX Widget. |
| <div id=""> | The div in which the AJAX Widget-code is placed. The ID of the div should be a valid AJAX Widget-name (see available AJAX Widgets). If no valid ID is specified and the syntax is correct, the theme is filed but there is no callback-function in the webshop that will trigger this AJAX Widget. |
| </div> | The closing tag of the div in which the AJAZX widget-code is placed. |
| {* /plugin *} | This indicates that an AJAX Widget ends. |
Following AJAX Widgets are available:
The shopping basket is a typical example of anAJAX Widget. It is often an item that you wish to present clean-cut, well-organized and well-considered. A shopping basket as AJAX Widget is very user friendly because the option “Show dialogue window shopping cart”( My webshop/Settings/Orderproces and stock/Order proces settings) is available. The shopping basket information is automatically updated as soon as a visitor places a product in the shopping basket, without the page reloading again.
| Variable | Content and data type of variable |
| {$aOrderRows} | An array of OrderRow-objects (see 'List of objects') |
Action Hooks are the link between your Pro-Tom design and the internal functionality of the webshop platform. Action Hooks are marked out because they are hooked via the class-attribute.
Adds a product to the visitor's shopping basket.
Conditional functioning based on settings.| Settings “Functioning order button & shoppingcart' | |
| Location | Startingpoint / My webshop / Settings / Order proces settings |
| Behaviour based on value |
|
| Attribute | Obligatory | Description |
| data-product-id | Yes | Unique product id (Product::Id) |
| data-quantity | No | Quantity ordered. The action hook only accepts an integer-value, all other values are converted to '1'. |
Sign on a visitor for the newsletter on the mailing list “Logged on via website”. In input-elements the action hook will check if enter was pressed and will try to sign on the visitor. The action hook reacts on click-events on all other element types. A succesful log on ensues if a name and valid email address have been entered.
Attention: the implementation code should be nested in an element with the id NewsMailRegistration, otherwise the action hook logic required will not be loaded!
| Element | Obligatory | Description |
| input#NewsEmailEmail | Yes | Mail address of the subschriber. |
| input#NewsEmailName | No | Name of subscriber. |
| input#NewsEmailBName | No | Company name of subscriber. |
| Element | Description |
| #NewsLetterEmailError |
Is filled with the result of the logon: - You were succesfully signed on for the newsletter - This email address was added to the list - This is an invalid email address |
The url that is used too connect to the WebDAV instance of your CCV Shop is generated as followed: https://{webshopssldomain}/API/EndPoint/Server.php. You can use this url in any webdav client you like.
Before you can use this feature you have too generate a username and password. You can find this feature after enabling the Protom module listed below the tab "own theme's". After clicking on "start connecting" you will get a username and password. This password is saved encrypted and thusfore listed once.
Unlucky theme names are not unique in CCV Shop and therefore an unique number will be part of the directory listing.
There are a couple of limitations and features we do not support (yet?). It is not possible too create files, or upload images. Also the settings must be created in CCV Shop.