Documentation Menu

1.5 Template Project

The Joomla! Documentation Working Group is running a project to develop detailed reference and tutorial material on Joomla! 1.5 templates.  There is a project page on the documentation wiki where you can see the work in progress and help us by contributing your knowledge.

Who's Online

We have 5 guests online

Help Site License

The Joomla! Help Site content is copyright © 2005 - 2008 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution NonCommercial ShareAlike 2.5. Some parts of this website may be subject to other licenses.
Home arrow Manual arrow Appendix arrow A. Updates for 4.5.1

A. Updates for 4.5.1 PDF Print E-mail
Mambots

Mambots are changing format. The format for Mambo 4.5 is still supported but will be deprecated in the next version. See the chapter on Mambots for more information on performance and feature enhancements for event driven Mambots.

A notable addition is that searching is now done via Mambots. This allows any component to craft their own search bot and have it added to the results of the search component.

In this version, Mambots cannot be enabled or disabled by the Administrator. If they are present they will be functioning. To remove the functionality of a Mambot you must delete the file.
Installer Parameters

You can now format your parameters in modules and components that appear as menu items. XML files are now copied with modules to support this feature.

Two types of parameter tags are currently supported, a textbox and a list box.

Let's use the Main Menu module as an example. The XML file looks like the following:

<?xml version="1.0" encoding="iso-8859-1"?>
<mosinstall type="module">
  <name>Main Menu</name>
  <author>Joomla</author>
  <copyright>(C) 2005 Open Source Matters. All rights reserved.</copyright>
  <license>http://www.gnu.org/copyleft/gpl.html GNU/GPL</license>
  <authorEmail>admin@joomla.org</authorEmail>
  <authorUrl>www.joomla.org</authorUrl>
  <description>Displays a menu.</description>
  <files>
    <filename module="mod_mainmenu">mod_mainmenu.php</filename>
  </files>
  <params>
   <param name="menutype" type="text" default="" label="Menu Type"
        description="The name of the menu (default mainmenu)" />
   <param name="class_sfx" type="text" default="" label="Class Suffix"
        description="A suffix to be applied to the css class" />
   <param name="menu_style" type="list" default="vert_indent" label="Menu Style"
        description="The menu style">
    <option value="vert_indent">Vertical</option>
    <option value="horiz_flat">Horizontal</option>
   </param>
  </params>
</mosinstall>

The new params collection tag is highlighted. For each parameter you add a params tag. The following attributes are allowed:

name: The name of the parameter

type: The type of edit control. Refer to the Appendix on Parameters for a detailed list.

default: The default value for the parameter

label: The text to place to the left of the edit control

description: The text to place to the right of the edit control

Where the parameter type is a list, you may add any number of standard HTML option tags. You must provide a closing option tag!
Site Templates
Module containers

A hardcoded <br/> tag has been removed from the bottom of each module. To compensate for this, a bottom-margin of 15px has been added to the table.moduletable css style in the templates distributed with Joomla.
Pathway Arrows

The pathway will look to see if an images/arrow.png file exists in the current template directory. If it finds that this file exists, it will use it as the separator for the pathway. If not, it will default to the > character.
CSS

Several new style tags are available: frontpage, frontpageheader and blogpageheader
Media installer tag

A new <media> tag is available for templates setup files. Files listed under this tag will be installed in the /images/stories directory.
Modules

See the notes on module parameters above.

Modules written for version 4.5 that use parameters will not work correctly in version 4.5.1. See the appendix on Parameters for more information.

Modules are also supported for Administrator. Modules with an "iscore" field value of 2 or 3 and an access level of 99 are considered Administrator modules.
API Changes
Page Navigation

A new method called getLimitBox has been added to the pageNav class which returns the html for the limit box. The writeLimitBox method is still provided for backward compatibility but this method simply returns the return string from getLimitBox.

In the Administrator version of the Page Navigation class, there is a new method called getListFooter. This method returns an HTML table of the Paging links, the list limit selection box and the Page X - Y of Z results.

The methods rowNumber, orderUpIcon and orderDownIcon have also been added.
mosHTML

Some extra methods have been added to the mosHTML class to support radio lists.
Tabs

Following is a skeletal example of how to implement the new style of tabs:

<?php
  // Construct the object
  // Call class, set persistant (useCookies) to no (0) or yes (1)
  $tabs = new mosTabs( 0 );

  // Start a new pane
  // Note, you can have more than one pane on a page (think wrapper)
  $tabs->startPane( "module" );

  // Start first tab with TabText of Details
  // and the 2nd var can be anything UNIQUE
  $tabs->startTab("Details","Details-page");
?>
Put some Content here !!!!!!!!
<?php
  // end this first tab
  $tabs->endTab();

  // Create a new tab!!
  // Same vars as before (but different names)
  $tabs->startTab("Parameters","params-page");
?>
More content
<?php
  //end this tab
   $tabs->endTab();

  // end this pane (wrapper)
  $tabs->endPane();
?>

DON'T FORGET to remove legacy calls as follows (normally right at the end of the file).

<script language="javascript" type="text/javascript">
       dhtml.cycleTab('tab1');
</script>

Administrator
Templates and Modules

The template and module support in the Administrator should be considered experimental and may change before the final release of 4.5.1. It is intended that in coming versions the templating engines for both the Site and the Administrator combine. By all means play with the current system and suggest improvements and point out strategic deficiencies. The active template may be changed by directly editing the configuration.php file.
Banners

The useBanner configuration variable has been dropped from Global Configuration.
Help Component

The help component has been dropped from the 4.5.1 distribution. A new system based on XML DocBook files has been implemented. Refer to the Documentation Manual for how you add compile help files for your applications.
Backup to mosDBTable

A new option exists in the Database Backup screen. You may select a mosDBTable as a format. This is useful when designing new components. After you have created your database table, select this function and a skeleton PHP class will be provided for you.
WYSIWYG Editors

Editors are now Mambots installable in the "editors" group.
Miscellaneous

TODO
Future Versions

The MENU_Default class will be deprecated in the next version.
Problems with XML Installer Files

DOMIT is more strict with XML parsing than was the MiniXML library. If you are receiving complaints that your package file cannot be installed because an installer file cannot be found, it's likely that the file is not well formed. You can quickly test this by opening the XML file in any modern browser.

If you want to have html or other special characters in any field you will need to enclose the contents of the tag CDATA tags, for example:

  <copyright><![CDATA[ © Copyright Me - 2004 ]]></copyright>


Last Updated ( Thursday, 15 September 2005 )
 
< Prev   Next >