Tutorial:Upgrading a Joomla! 1.0.x template
 |
This article is a small, well-defined item that could be completed by someone with a reasonable knowledge of the subject matter and a modest time commitment.
If you would like to try writing this article you're welcome to do so. The subject may be self-evident, but if not then further details should be available on the discussion page. Please add {{inuse}} at the top of this page while editing. For other small, well-defined tasks, please look in the Cookie jar.
|
Upgrading your index.php file
- Replace _VALID_MOS with _JEXEC
- Replace $mosConfig_absolute_path with $this->baseUrl
- Replace $mosConfig_live_site with $mainframe->getCfg( 'live_site' )
- Replace fixed strings with translatable strings. For example, replace echo 'Hello' with echo JText::_( 'Hello' )
- Replace calls to mosGetParam with calls to JRequest::getVar. For example, replace $id = mosGetParam( $_REQUEST, 'id', 0 ); with $id = JRequest::getVar( 'id', 0 );
- Replace mosShowHead(); with <jdoc:include type="head" />
- Replace mosMainBody() with <jdoc:include type="component" />
- Replace mosLoadModules( $position_name, $style ); with <jdoc:include type="modules" name=$position_name style=$style />
| |
This article is a small, well-defined item that could be completed by someone with a reasonable knowledge of the subject matter and a modest time commitment.
If you would like to try writing this article you're welcome to do so. The subject may be self-evident, but if not then further details should be available on the discussion page. Please add {{inuse}} at the top of this page while editing. For other small, well-defined tasks, please look in the Cookie jar.
|
| |
This article is a small, well-defined item that could be completed by someone with a reasonable knowledge of the subject matter and a modest time commitment.
If you would like to try writing this article you're welcome to do so. The subject may be self-evident, but if not then further details should be available on the discussion page. Please add {{inuse}} at the top of this page while editing. For other small, well-defined tasks, please look in the Cookie jar.
|
| |
This article is a small, well-defined item that could be completed by someone with a reasonable knowledge of the subject matter and a modest time commitment.
If you would like to try writing this article you're welcome to do so. The subject may be self-evident, but if not then further details should be available on the discussion page. Please add {{inuse}} at the top of this page while editing. For other small, well-defined tasks, please look in the Cookie jar.
|
A summary of new features introduced in Joomla! 1.5 templates:
- Model View Controller (MVC)
- This structure has been implemented in Joomla! 1.5, separating out logic, data and view of data. This means that the HTML, CSS and other code used to display Joomla! (to the browser or other device) is now completely separate from the Joomla! logic and is contained entirely within the templating system. This gives you greater control over how you wish to display the data, without having to access (hack!) core Joomla! code.
- Template positions
- The positions used in a template are now declared in templateDetails.xml. For example,
<positions> <position>top</position> <position>left</position> </positions>
- Joomla version
- The version number is now declared in the template. For example, <install version="1.5" type="template"> replaces 1.0.x <mosinstall type="template">.
- Template parameters
- Parameters may be defined in your template. These are declared in templateDetails.xml. Parameter default values can be set in params.ini, which is also referenced in templateDetails.XML as a template <file>. The parameters can be set in the Administrator Template Manager and also on the fly using the template's Javascript.
- Template overrides
- The default system chrome ('views') for any module or component can now be overridden by the template. Default system chrome for each module and component can now be found in directories modules/mod_modulename/tmpl and components/com_componentname/views/layout/tmpl. The pagination chrome can also be overridden in pagination.php.
- Objects and Methods
- The Joomla! 1.5 framework has been re-engineered and now includes the JApplication layer, which contains a number of objects and methods you can reference from the template index.php. For example, <jdoc:include type="head" /> replaces the 1.0.x <?php mosShowHead(); ?>;, <?php echo $mainframe->getCfg('sitename');?> replaces the 1.0.x <?php echo $mosConfig_sitename; ?> [N.B. This new method works for all configuration.php parameters], <?php // no direct access defined( '_JEXEC' ) or die( 'Restricted access' ); ?> replaces the 1.0.x <?php defined( '_VALID_MOS' ) or die( 'Direct Access to this location is not allowed.' ); ?>, <?php echo JURI::base();;?> replaces the 1.0.x <?php echo $mosConfig_live_site; ?>.
- Module Positions
- There is a new way of checking which module positions have content to display on the current page. This logic can be used for collapsible columns (e.g. collapse the left or right column if no content is present). The 1.0.x mosCountModules function has been replaced by the $this->countModules and conditions have been added: you can now use '+', '-', 'or' or 'and', e.g. if ($this->countModules('left or right') == 1).
- Template file structure
- ===Typical Template Directory Structure===
It is most common for a template to have at least four files:
- index.php
- Provides the logic for the display and positioning of modules and components.
- template.css
- Handles the presentational aspects of the template including specifications for margins, fonts, headings, image borders, list formatting, etc.
- templateDetails.xml
- Holds meta-information related to the template and used by the Installer and the Template Manager.
- 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.
A typical template for Joomla! 1.5 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
- Accessibility and Standards
- Using template overrides, it is possible to create tableless Joomla! The new parameters and overrides encourage improvements in web standards, accessbility, search engine optimisation (SEO) (source ordering and markup), language (left to right support) and browser optimisation (browser-dependent CSS).
- Default system template
- The system template (in the /templates directory) has been expanded to include more CSS files and a standard modules.php (module chrome) and component.php (component chrome). You can include some of the default CSS files in your template. For example,
<link rel="stylesheet" href="templates/system/css/system.css" type="text/css" /> <link rel="stylesheet" href="templates/system/css/general.css" type="text/css" />
- Additional Javascript
- There are some additional Javascript libraries available for use in your template. For example,
<script type="text/javascript" src="media/system/js/mootools.js"></script> <script type="text/javascript" src="media/system/js/caption.js"></script>
- These are included in <jdoc:include type="head" />
- Error handling
- More default error pages are included in the system template (403.php and 500.php) and a new error message call has been introduced, which must be referenced in your template by <jdoc:include type="message" />
