Actions

Difference between revisions of "What is the typical template directory structure?"

From Joomla! Documentation

m (formatting)
m (Typical Template Directory Structure: improvements)
Line 6: Line 6:
 
: Provides the logic for the display of the printer friendly page, "E-mail this link to a friend." etc.
 
: Provides the logic for the display of the printer friendly page, "E-mail this link to a friend." etc.
 
* '''template.css'''
 
* '''template.css'''
: Handles the presentational aspects of the template including specifications for margins, fonts, headings, image borders, list formatting, etc.
+
: Handles the presentational aspects of the template including specifications for margins, fonts, headings, image borders, list formatting, etc. The .css files may also be located in the <code>/css</code> directory.
 
* '''templateDetails.xml'''
 
* '''templateDetails.xml'''
 
: Holds meta-information related to the template and is used by the Installer and the Template Manager.
 
: Holds meta-information related to the template and is used by the Installer and the Template Manager.
 +
* '''template_preview.ext''' - replace .ext with the extension format of the image (.jpg, .png, .gif)
 +
: Generally a 600x400 pixel image that is shown when the cursor is clicked on the thumbnail image in Template Manager:Templates, not Template Manager:Styles.  This gives the Administrator a pop up modal window of the template before applying it to the Site.
 
* '''template_thumbnail.ext''' - replace .ext with the extension format of the image (.jpg, .png, .gif)
 
* '''template_thumbnail.ext''' - replace .ext with the extension format of the image (.jpg, .png, .gif)
: Generally a 200x150 pixel image that is shown when the cursor is held over the template name in the Template Manager.  This gives the Administrator a snapshot view of the template before applying it to the Site.
+
: Generally a 200x150 pixel thumbnail image that is shown when viewing the Template list in Template Manager:Templates, not Template Manager:Styles .  This gives the Administrator a thumbnail view of the template before applying it to the Site.
 
+
===Template directories===
 
+
 
{{:Typical template directory structure}}
 
{{:Typical template directory structure}}
  

Revision as of 21:21, 22 June 2013

Typical Template Directory Structure

It is most common for a template to have at least the following files:

  • index.php
Provides the logic for the display and positioning of modules and components.
  • component.php
Provides the logic for the display of the printer friendly page, "E-mail this link to a friend." etc.
  • template.css
Handles the presentational aspects of the template including specifications for margins, fonts, headings, image borders, list formatting, etc. The .css files may also be located in the /css directory.
  • templateDetails.xml
Holds meta-information related to the template and is used by the Installer and the Template Manager.
  • template_preview.ext - replace .ext with the extension format of the image (.jpg, .png, .gif)
Generally a 600x400 pixel image that is shown when the cursor is clicked on the thumbnail image in Template Manager:Templates, not Template Manager:Styles. This gives the Administrator a pop up modal window of the template before applying it to the Site.
  • template_thumbnail.ext - replace .ext with the extension format of the image (.jpg, .png, .gif)
Generally a 200x150 pixel thumbnail image that is shown when viewing the Template list in Template Manager:Templates, not Template Manager:Styles . This gives the Administrator a thumbnail view of the template before applying it to the Site.

Template directories

<translate> A typical template for Joomla! will include the following directories:

  • css - contains all the .css files
  • html - contains template override files for core output and module chrome
  • images - contains all images used by the template
  • language - contains additional language files used by the template</translate>

<translate> Depending on the complexity and design of the template is may also contain:

  • javascript - contains supporting JavaScript used by the template for added functionality</translate>

<translate>====Example structure with files==== </translate> <translate> Typical path of a template is <root>/public_html/domain-name/template/<name of your template> which will contain the following directories and files based on your template.</translate>

/css
/html
/images
/javascript
/language
component.php
error.php
favicon.ico
index.php
templateDetails.xml
template_preview.png
template_thumbnail.png