View source for X-Cart:Editing Skin Files

==Introduction==

An X-Cart skin typically includes PHP Smarty templates, CSS files, JavaScript files and, in some cases, HTML files.

The PHP Smarty templates of your store's skin are files out of which your store's pages are built. Each template file defines how a specific element of the site appears. Template files are made up of  HTML/CSS and Smarty; all of them have the <u>.tpl</u> file extension.

The screenshot of the customer area below provides an example of how a page is created using templates:

: [[Image:manual_scheme_for_4_2.gif|680px]]

The CSS files of your store's skin are style sheets that define the presentation of your store's pages. They use the extension <u>.css</u>.

The JavaScript files of your store's skin are files that contain JavaScript code which can be called on your store's pages. They use the extension <u>.js</u>.

If you wish to change the look of a specific element of your store site, you need to edit the skin files that control this element. Most typically, you will need to edit X-Cart's template and CSS files. To be able to edit X-Cart's template and CSS files, you must possess substantial knowledge of HTML, CSS and Smarty. Here is a list of online resources that might be helpful:

'''HTML:'''
* W3C HTML start page: http://www.w3c.org/MarkUp/
* HTML Validation Service: http://validator.w3.org/

'''CSS:'''
* W3C Cascading Style Sheets homepage: http://www.w3.org/Style/CSS/
* Validation service: http://jigsaw.w3.org/css-validator/

'''Smarty:'''
* Smarty resources: http://www.smarty.net/
* Smarty online documentation: http://www.smarty.net/docs.php

All the files of your X-Cart skin are stored in the directory <u>/xcart/skin1</u>, where <u>/xcart</u> stands for the X-Cart installation directory. Your store's Admin area provides a section that allows you to view and manage the contents of this directory (see the section [[#Managing Skin Files]]).

The number of skin files in X-Cart is really large, so finding out which file controls what elements may require a great deal of effort. We recommend you begin by studying the chapters [[#Overview of Templates]] and [[#Overview of CSS Files]]. When you begin working on the skin files more closely, we also recommend you use the Debugging Console, a tool that will help you to find out the skin files for each page of the your X-Cart based store (See the section [[#Using X-Cart's Debugging Console]]).

X-Cart's skin files can be edited in X-Cart's built-in template editor (see the section [[#Using Template Editor]]), or in any decent external text editor.

==Managing  Skin Files==

You can manage the contents of X-Cart's <u>/xcart/skin1</u> directory using the '<u>Browse templates</u>' section of your store's Admin area (<u>Administration menu->Edit templates</u>). The functionality of this section is similar to that of the '<u>Browse files</u>' section (<u>Management menu->Files</u>): it provides a file browser that you can use to view the contents of the directory /xcart<u>/skin1</u>, to upload your own files, to copy and delete existing files, to create and delete sub-directories. In addition to the said operations, the file browser in this section allows you to compile templates (See the section [[#Compiling templates | Compiling templates]] and to restore any skin files that have been edited to their original state (See [[#Restoring all files | Restoring all files]]).

: [[Image:templates.gif|584px]]

The Quick access menu above the '<u>Browse templates</u>' dialog box allows you to quickly access specific files/groups of files in /xcart<u>/skin1</u>:

: [[Image:quick_access_menu.gif|270px]]

=== Compiling templates ===

X-Cart allows you to "compile" templates, i.e. to replace the language variables used in your store's templates with the values of these variables. When your store's templates are compiled, the text stored in the language variables used in this template is inserted directly into the template code. This feature is useful for stores using only one language: compiling templates significantly reduces the time needed for template processing, because X-Cart does not need to use language variables.

If you choose to compile your store's templates, you will be able to edit any textual elements of your store's user interface in X-Cart's built-in template editor, but you will not be able to edit them using the '<u>Edit languages</u>' section (<u>Administration menu->Languages</u>) or Webmaster mode.

To compile your store's templates, do the following:

# Go to the '<u>Browse templates</u>' section of your store's Admin area (<u>Administration menu->Edit templates</u>). You should see a dialog box titled '<u>Browse templates</u>'. At the bottom of the '<u>Browse templates</u>' dialog box, you should see a button labeled '''Compile templates''' and a drop-down box labeled '<u>Language</u>'. The '<u>Language</u>' drop-down box contains a list of languages enabled at your store.
# From the '<u>Language</u>' drop-down box, select the language you wish to use in the compiled templates.
# Click the '''Compile templates''' button. When prompted, confirm the deletion.

When you do that, X-Cart begins the compiling process. While X-Cart is compiling, you will be able to see the progress on the screen. Please be patient and allow sufficient time for the procedure to be completed.

At the end, a message should appear indicating the successful completion of the process: 'All templates are successfully compiled'. Shortly after the success message is displayed, you should be redirected back to the '<u>Browse templates</u>' page.

=== Restoring all files ===

At any time you can restore your store's skin files to their original state (as in a fresh X-Cart installation). This is possible because X-Cart's directory <u>/xcart/skin1_original</u> stores a backup of the original skin files. When you perform the restoration procedure, any modified files of your store's skin are overwritten by the original files from this directory.

To enable X-Cart to restore the files of your store's skin from <u>/xcart/skin1_original</u>, you must ensure that the user under which PHP runs on your server has read and write permissions for the directory <u>/xcart/skin1</u>, as well as read and write permissions for all the files of the current skin stored in this directory.

To restore all the files of your X-Cart store, do the following:

# Go to the '<u>Browse templates</u>' section of your store's back end (<u>Administration menu->Edit templates</u>). You should see a dialog box titled '<u>Browse templates</u>'.
# In the '<u>Browse templates</u>' dialog box, click the '''Restore All''' button.

When you click on '''Restore All''', the skin files of your X-Cart stored in <u>/xcart/skin1</u> are replaced by the original files from the directory <u>/xcart/skin1_original</u>.

==Overview of Templates==

{{XC_4.3}}

=== Templates stored in the directory /xcart/skin1 ===

The templates stored in the directory <u>/xcart/skin1</u>, except for <u>product_thumbnail.tpl</u> and <u>currency.tpl</u>, are used only for the store's back end. Some of the major templates in this directory are the following:

* <u>rectangle_top.tpl</u> - controls the overall width and height of the store's layout (affects only the store's back end).
* <u>dialog.tpl</u> - provides the main 'wrapper' of all content in the main window of X-Cart (affects only the store's back end).
* <u>menu.tpl</u> - provides the 'wrapper' for the side menu boxes.
* <u>head_admin.tpl</u> - controls the 'header' row for the Admin and Provider areas. It contains the logo and the language selector.
* <u>head.tpl</u> - controls the 'header' row for the Partner area. It contains the logo and the language selector.
* <u>bottom.tpl</u> - controls the 'footer' of the site. It contains the 'Powered by' (<u>poweredby.tpl</u>) and 'Copyright' text (<u>copyright.tpl</u>).
* <u>rectangle_bottom.tpl</u> - counterpart to <u>rectangle_top.tpl</u> (affects only the store's back end).
* <u>dialog_message.tpl</u> - controls the top message box that pops up at the top of the main window in the store's back end.
* <u>auth.tpl</u> - controls the side menu login box (affects only the store's back end).
* <u>authbox.tpl</u> - controls the side menu login box for logged in users (affects only the store's back end).
* <u>help.tpl</u> - controls the side menu help box containing links to the help pages. This template also contains the code that automatically adds a link when you add a new embedded static page.
* <u>location.tpl</u> - contains the code for the breadcrumb navigation (at the top of the main content area).
* <u>news.tpl</u> - controls the side menu newsletter sign-up box.
* <u>today_news.tpl</u> - controls the side menu that shows the current news.

The templates <u>product_thumbnail.tpl</u> and <u>currency.tpl</u> are used both for the back end and the Customer area:

* <u>product_thumbnail.tpl</u> - controls the thumbnail of a product.
* <u>currency.tpl</u> - controls the format of the currency.

===Templates stored in the sub-directories of /xcart/skin1===

The template files contained in the sub-directories of <u>/xcart/skin1</u> are the following:

* <u>skin1/admin</u> and <u>skin1/provider</u> - Templates for the store's back end.
* <u>skin1/single</u> - Templates for the store's Admin area, X-Cart GOLD.
* <u>skin1/customer</u> - Templates for the store's Customer area.
* <u>skin1/partner</u> - Templates for the store's Partner area (X-Affiliate add-on module).
* <u>skin1/fulfilment</u> - Templates for the pages intended for fulfillment staff users.
* <u>skin1/main</u> - Miscellaneous templates for the main content area.
* <u>skin1/mail</u> - Mail templates.
* <u>skin1/buttons</u> - Button templates for all areas.
* <u>skin1/help</u> - Templates for help pages (like FAQ, Contact us, Terms and conditions, etc).
* <u>skin1/pages</u> - Templates for embedded static pages.
* <u>skin1/payments</u> - Templates for payment processors' pages.
* <u>skin1/images</u> - Images.
* <u>skin1/modules</u> - Templates for X-Cart's modules and add-ons.

Some of the template files contained in the sub-directory <u>/xcart/skin1/customer are</u> the following:

* <u>customer/home.tpl</u> - The main template for the Customer area of the store.
* <u>customer/head.tpl</u> - The template that controls the 'header' row for the Customer area. By default, it contains the logo, the Speed bar tabs, the search box (<u>customer/search.tpl</u>) and the language selector.
* <u>customer/auth.tpl</u> - The template that controls the side menu login box for the Customer area.
* <u>customer/authbox.tpl</u> - The template that controls the side menu login box for logged in customers.
* <u>customer/categories.tpl</u> - The side menu category template.
* <u>customer/dialog.tpl</u> - The template that provides the main 'wrapper' of all content in the main window of X-Cart in the Customer area.
* <u>customer/home_main.tpl</u> - The template that controls what is displayed in the main content area.
* <u>customer/menu_cart.tpl</u> - The template that controls the side menu cart.
* <u>customer/search.tpl</u> - The search box template.
* <u>customer/special.tpl</u> - The side menu Special template.

Some of the template files contained in the sub-directory <u>/xcart/skin1/customer/main are</u> the following:

* <u>customer/main/cart.tpl</u> - The template that controls the main shopping cart structure page.
* <u>customer/main/checkout.tpl</u> - The template that controls the checkout process structure.
* <u>customer/main/subcategories.tpl</u> - The template that controls the sub-category display, and also is the 'wrapper' for the products display.
* <u>customer/main/products.tpl</u> - The template that includes either <u>products_list.tpl</u> or <u>products_t.tpl</u> depending on how the setting '<u>Display products list in multiple columns (1-3) (leave empty to use standard format)</u>'  is adjusted in the section <u>General Settings/Appearance options</u>.
* <u>customer/main/products_list.tpl - </u>The template that controls the products display under a category for a single column layout.
* <u>customer/main/products_t.tpl</u> - The template that controls the products display under a category for a multi-column layout.
* <u>customer/main/product.tpl</u> - The template that controls the product details page.
* <u>customer/main/order_message.tpl</u> - The template that controls the confirmation screen for checkout.

Some of the template files contained in the sub-directory <u>/xcart/skin1/mail are</u> the following:

* <u>mail/html/order_invoice.tpl</u> - The template that controls the invoice on the order confirmation screen and order emails.
* <u>mail/html/order_data.tpl</u> - The template that controls the product data on the invoice.

The template files contained in the sub-directory /xcart/<u>skin1/modules/Fast_Lane_Checkout</u> are used to control the look of cart and checkout pages if the Fast Lane Checkout module is enabled. Some of the templates are the following:

* <u>Fast_Lane_Checkout/home.tpl</u> - The template that controls the structure of cart and checkout pages.
* <u>Fast_Lane_Checkout/home_main.tpl</u> - The template that controls what is displayed in the main content area - the cart itself and checkout steps (authorization/registration, shipping method selection, payment method selection, preview).
* <u>Fast_Lane_Checkout/head.tpl</u> - The template that controls the 'header' row for cart and checkout pages.

==Overview of CSS Files==

{{XC_4.3}}

CSS files for the Customer area are the following:

* <u>skin1/main.css</u> - Main CSS file for the Customer area.
* <u>skin1/main.FF.css</u> - Browser-specific CSS for Mozilla FireFox, Customer area.
* <u>skin1/main.IE6.css</u> - Browser-specific CSS for Microsoft Internet Explorer 6, Customer area.
* <u>skin1/main.IE7.css</u> - Browser-specific CSS for Microsoft Internet Explorer 7, Customer area.
* <u>skin1/main.popup.css</u> - CSS for layer-based popups, Customer area.
* <u>skin1/main.popup.IE6.css</u> - Browser-specific CSS for layer-based popups in Microsoft Internet Explorer 6, Customer area.

CSS files for the store's back end  (Admin and Provider areas) are the following:

* <u>skin1/skin1_admin.css</u> - Main CSS file for the Admin area.
* <u>skin1/skin1_printable.css</u> - CSS file for the printable version of the Admin area.

CSS files for modules are the following:

* <u>skin1/modules/Fast_Lane_Checkout/main.css</u> - Main CSS file for the Customer area, Fast Lane Checkout module.
* <u>skin1/modules/Gift_Certificates/template_sample_1.css</u> - CSS file for template_sample_1.tpl, Gift certificates module.
* <u>skin1/modules/Gift_Certificates/template_sample_2.css</u> - CSS file for template_sample_2.tpl, Gift certificates module.
* <u>skin1/modules/HTML_Editor/scripts/style/editor.css</u> - CSS file for the WYSIWYG editor, Admin area, HTML Editor module (editing not recommended).
* <u>skin1/modules/Subscriptions/calendar.css</u> - CSS file for the calendar in the Admin area, Subscriptions module.
* <u>skin1/modules/XAffiliate/main.css</u> - Main CSS file for the Customer area, X-Affiliate add-on.
* <u>skin1/modules/Product_Configurator/main.css</u> - Main CSS file for the Customer area, X-Configurator add-on.
* <u>skin1/modules/Fancy_Categories/main.css</u>  - Main CSS file for the Customer area, X-FancyCategories add-on.
* <u>skin1/modules/Feature_Comparison/main.css</u> - Main CSS file for the Customer area, X-FeatureComparison add-on.
* <u>skin1/modules/Feature_Comparison/main.IE6.css</u> - Browser-specific CSS for Microsoft Internet Explorer 6, Customer area, X-FeatureComparison add-on.
* <u>skin1/modules/Gift_Registry/main.css</u> - Main CSS file for the Customer area, X-GiftRegistry add-on.
* <u>skin1/modules/Magnifier/main.css</u> - Main CSS file for the Customer area, X-Magnifier add-on.
* <u>skin1/modules/RMA/main.css</u> - Main CSS file for the Customer area, X-RMA add-on.
* <u>skin1/modules/Special_Offers/main.css</u> - Main CSS file for the Customer area, X-SpecialOffers add-on.
* <u>skin1/modules/Survey/main.css</u> - Main CSS file for the Customer area, X-Survey add-on.

[[Category:X-Cart user manual]]

==Using Debugging Console==

When working on X-Cart's templates, you may want to use X-Cart's Debugging console. It is a tool that enables you to view the template structure of the page you are currently viewing.

X-Cart's Debugging console can be launched by enabling the option '<u>Enable debugging console</u>' in <u>General settings->General options</u>. It is also enabled automatically when you start Webmaster mode.

When enabled, the Debugging console is displayed in a separate browser window. This window contains a list of templates and config files used for the current page. Note that this list is organized hierarchically, so you can see which template includes what. For example, if you use the Debugging console to explore the template structure of the Customer area front page, the result may be something like this:

: [[Image:debug_console1.gif|442px]]

As you move about the store, the contents of the Debugging console window gets updated for each page.

In Webmaster mode, X-Cart's Debugging console allows you not only to view the template structure of a page, but also to quickly access any of the templates involved in this structure: clicking on the name of a template opens the respective file in X-Cart's template editor (See [[#Using Template Editor]]).

==Using  Template Editor==

X-Cart provides a built-in template editor. This editor allows you to view and edit your store's skin files.

To open a skin file in X-Cart's template editor, use one of the following methods:

* With X-Cart's Debugging console enabled, locate the file you wish to edit and click on its name in the Debugging console window.

: or

* Go to the section '<u>Browse templates</u>' (<u>Administration menu->Edit templates</u>), use the file browser to locate the file you wish to edit and click on its name.

As a result, the contents of the selected file opens in X-Cart's template editor as follows:

: [[Image:edit_template.gif|498px]]

Now you can edit this file as necessary.

To save the changes after the editing has been completed, click the '''Save''' button. To quit editing without saving your changes, click on '''Cancel'''. To restore the original file, click on '''Restore'''.

If the file opened in the template editor is a template, you can preview the element whose appearance is defined by this template the way it will appear in your store. To do so, use the '''Preview''' button. If you click on '''Preview '''with the check box '<u>Use default stylesheet for template preview</u>' selected, the presentation of the element corresponding to the template will be defined by the main CSS file for the respective X-Cart area.

Typically, any changes you make to X-Cart's templates become visible in your store immediately after you click on '''Save'''. However, in some cases, some of the changes may not appear in the store because an older version of the template was cached. If you know you edited a specific template, but the changes do not appear in your store after the file has been saved, you must clear your store's templates cache (the contents of the directory <u>/templates_c</u>). You can either remove the entire contents of the directory <u>/templates_c</u> manually, or use X-Cart's '<u>Clear templates cache</u>' tool (See [[X-Cart:Advanced Tools]]).

==Replacing X-Cart's Logo==

One of the most popular and necessary tasks about the skins is to replace the default company logo on the Customer area with a real logo of your company/store. Before you start replacing the logo, ensure that the skin is installed correctly and you have an appropriate image file for your company logo. The recommendations for the image files are listed in the table below.

The name of the image file with your company logo can either coincide with the filename of the default logo or have a different name. If both the default logo and your company logo have the same filename, you only need to replace the default image file with your image file. If these files have different names, you need to edit the template which controls the storefront header. The exact filename of the default company logo depends on the skin that you use.

{| class="wikitable"
! Skin Name
! Default Logo Path and Filename*
! File Format
! Logo Size
|-
| Light & Lucid
| <u>/xlogo.gif</u>
| GIF
| 244 x 67 px
|-
| Artistic Tunes
| <u>/custom/company_logo.gif</u>
| GIF
| 190 x 27 px
|-
| Fashion Mosaic
| <u>/fashion_mosaic/company_logo.gif</u>
| GIF
| 228 x 50 px
|-
| Neon Lights
| <u>/neon_lights/xlogo.gif</u>
| GIF
| 205 x 26 px
|-
| Vivid Dreams
| <u>/vivid_dreams/logo.gif</u>
| GIF
| 275 х 61 px
|}



<nowiki>*</nowiki> - a path relative to the main X-Cart's image directory <u><xcart_dir>/skin1/images</u>.


'''To replace the logo:'''

If the filename of your company logo is the same as the filename of the default logo.

# Log in to the Admin area and go to the <u>Edit templates</u> section (Administration menu -> Edit templates<u>)</u>.
# Use the <u>Browse templates</u> form to locate the folder with the default logo file (see the table).<br><br>For example, if you are replacing the logo of the <u>Artistic Tunes</u> skin, in the <u>Browse templates</u> form first move to the folder <u>images/</u> and then move to the folder <u>custom/</u>. In the same manner, for the <u>Fashion Mosaic</u> skin first move to folder <u>images/</u> and then move to folder <u>fashion_mosaic/</u>, etc.
# Find section <u>Upload file to the current directory</u> at the bottom of the form and click the <u>Browse</u> button to open a file upload dialog window.
# Locate the image file with your company logo and choose it for the upload.
# Make sure the <u>Replace file if exists</u> check box is selected.
# Click the <u>Upload</u> button to upload the file to the current directory.

Now the logo on the Customer area is replaced with your company logo.

{{Note|IMPORTANT! To see the changes you may nee to clear your browser cache.}}

If the filename of your company logo is different to the filename of the default logo.

# Log in to the Admin area and go to the <u>Edit templates</u> section (Administration menu -> Edit templates<u>)</u>.
# Use the <u>Browse templates</u> form to locate the folder where you want to keep the file with logo. It can be either the directory with the default logo file (see the table) or any other location inside the <u>images/</u> directory.
# After you choose where to keep your company logo, find section <u>Upload file to the current directory</u> at the bottom of the form and click the <u>Browse</u> button to open a file upload dialog window.
# Locate the image file with your company logo and choose it for the upload.
# Click the <u>Upload</u> button to upload the file to the current directory.
# Click on the <u>Edit templates</u> breadcrumbs link at the top of the page to go back to the root skin directory <u>skin1/</u>.
# In the <u>Browse templates</u> form go to the folder <u>customer</u> and click on the <u>head.tpl</u> link to open the respective file for editing.
# In the <u>Edit file</u> form, find the following code:

<pre>
<div class="logo">
<a href="{$catalogs.customer}/home.php">
<img src="{$ImagesDir}LOGO_PATH_AND_FILENAME" alt="" />
</a>
</div>
</pre>

: and replace the<u> LOGO_PATH_AND_FILENAME </u>part with the the relative path to the directory where your company logo is located and the logo filename. For example, if the image file with the logo is located in the directory <u><xcart_dir>/skin1/images/custom</u> and its name is <u>custom_logo.gif</u>, the<u> LOGO_PATH_AND_FILENAME </u>part must be replaced with <u>/custom/custom_logo.gif</u>.

: Click the '''Save''' button for the changes to take effect.

Now the logo on the Customer area is replaced with your company logo.

{{Note|IMPORTANT! To see the changes you may nee to clear your browser cache.}}

==See also==

* [[X-Cart:Customizing_storefront]]
* http://www.w3schools.com/css/css_intro.asp - profound information to learn about CSS

[[Category:X-Cart user manual]]