Difference between revisions of "What is the purpose of the templateDetails.xml file?"

Revision as of 14:46, 19 February 2008

The templateDetails.xml file holds a variety of meta-data used by the Template Manager in installation and maintenance. It is helpful to recognize the different sections of the file. Typically, each section of data is indented to make the file more readable, but this indentation is not necessary.

Basic Details[edit]

The initial display of the Template Manager shows a list of available templates and basic details relating to the template. Each of these bits of information is gathered from the templateDetails.xml file.

File:Template details basic.png

<install version="1.5" type="template">
    <name>rhuk_milkyway</name>
    <creationDate>11/20/06</creationDate>
    <author>Andy Miller</author>
    <authorEmail>rhuk@rockettheme.com.com</authorEmail>
    <authorUrl>http://www.rockettheme.com</authorUrl>
    <copyright></copyright>
    <license>GNU/GPL</license>
    <version>1.0.2</version>
    <description>TPL_RHUK_MILKYWAY</description>

File Structure[edit]

All files related to the template are listed. Each filename contains full path information starting at the template root. The Administrator's Installer uses this information when storing the files during installation.

A small portion of the files listed in the rhuk_milkyway template is given below.

    <files>
	<filename>index.php</filename>
	<filename>templateDetails.xml</filename>
	<filename>template_thumbnail.png</filename>
	<filename>params.ini</filename>
	<filename>images/arrow.png</filename>
	<filename>images/indent1.png</filename>
    <files>

Languages[edit]

Some templates may include language files to allow translation of static text in the template. Notice that two language files are shown below. The first holds the language file for text that will be viewed by the User. The second, placed within <administration> tags, is for text that will be viewed by the Administrator.

    <languages>
	<language tag="en-GB">en-GB.tpl_beez.ini</language>
    </languages>
    <administration>
	<languages folder="admin">
	    <language tag="en-GB">en-GB.tpl_beez.ini</language>
	</languages>
    </administration>

Module Positions[edit]

The available Module Positions that can be used in the template are defined.

    <positions>
	<position>breadcrumb</position>
	<position>left</position>
	<position>right</position>
	<position>top</position>
	<position>user1</position>
	<position>user2</position>
	<position>user3</position>
	<position>user4</position>
	<position>footer</position>
	<position>debug</position>
	<position>syndicate</position>
    </positions>

Parameters[edit]

A template may offer display options that can be chosen by the Administrator in the Template Manager. For instance, the rhuk_milkyway template allows the Administrator to change the border colors, change the background color, and define the display width.

File:Template details params.png

An example of adding a parameter and its values is shown below.

    <params>
	<param name="colorVariation" type="list" default="white" label="Color Variation" description="Color variation to use">
	    <option value="blue">Blue</option>
	    <option value="red">Red</option>
	    <option value="green">Green</option>
	    <option value="orange">Orange</option>
	    <option value="black">Black</option>
	    <option value="white">White</option>
	</param>
    </params>

For more information about working with Parameters, see: Defining a parameter in templateDetails.xml Retrieving parameter data in a template file

@@ Line 1: / Line 1: @@
 {{RightTOC}}
-The templateDetails.xml file holds a variety of meta-data used by the Template Manager in installation and maintenance. It is helpful to recognize the different sections of the file.  Typically, each section of data is indented to make the file more readable, but this indentation is not necessary.
+The templateDetails.xml file holds a variety of meta-data used by the [[Screen.templates.15|Template Manager]] in installation and maintenance. It is helpful to recognize the different sections of the file.  Typically, each section of data is indented to make the file more readable, but this indentation is not necessary.
 ===Basic Details===
@@ Line 21: / Line 21: @@
 ===File Structure===
-All files related to the template are listed.  Each filename contains full path information starting at the
+All files related to the template are listed.  Each filename contains full path information starting at the template root.  The Administrator's Installer uses this information when storing the files during installation.
-site root.  The Administrator's Installer uses this information when storing the files during installation.
 A small portion of the files listed in the rhuk_milkyway template is given below.
@@ Line 51: / Line 50: @@
 </pre>
-===Positions===
+===Module Positions===
-The possible positions that can be used in the template are defined.
+The available [[module_positions|Module Positions]] that can be used in the template are defined.
 <pre>
@@ Line 89: / Line 88: @@
      </params>
 </pre>
+For more information about working with Parameters, see:
+[[Defining_a_parameter_in_templateDetails.xml|Defining a parameter in templateDetails.xml]]
+[[Retrieving_parameter_data_in_a_template_file|Retrieving parameter data in a template file]]
+<noinclude>[[Category:Templates]][[Category:Topics]][[Category:Beginners]]</noinclude>