Actions

Difference between revisions of "How do you add a new module position?"

From Joomla! Documentation

m (How do you add a new template position? moved to How do you add a new module position?: These positions are named "module positions" according to the Glossary entry; a template contains a <jdoc:include /> for modules.)
(Update Joomla Version from 1.6 to 2.5 - the Long term stable release)
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
=== Joomla! 1.5 {{JVer|1.5}} ===
+
{{version|1.0,1.5,2.5}}== Preface ==
The list of available positions where you can insert a [[module]] is controlled by the [[template]] you are using. It is possible to add new positions to a template. In this example, we will add a new position to the default rhuk_milkyway template. Here are the steps.
+
The list of available positions where you can insert a [[module]] is controlled by the [[template]] you are using. It is possible to add new positions to a template.
 +
 
 +
== Joomla! 2.5 {{JVer|2.5}} ==
 +
=== Inserting the code ===
 +
*Open the index.php file of the Template you wish to edit
 +
*Locate the place in the Template where you wish to put the new position. 
 +
*Insert
 +
<jdoc:include type="modules" name="newposition"  />
 +
*The variable can be used (between existing <div></div> tags) to replace an image by replacing the ''<img src="xxx" border="0" alt="">''.  Or By creating a new <div></div> tag with its own class/id.
 +
*Open the Template's TemplateDetails.xml file and locate the
 +
<positions></positions> Start and end tags
 +
*Then add
 +
<position>newposition</position>
 +
*Example
 +
<source lang="xml">
 +
<positions>
 +
<position>debug</position>
 +
<position>position-0</position>
 +
<position>position-1</position>
 +
<position>position-2</position>
 +
<position>position-3</position>
 +
<position>position-4</position>
 +
<position>position-5</position>
 +
<position>position-6</position>
 +
<position>position-7</position>
 +
<position>position-8</position>
 +
<position>position-9</position>
 +
<position>position-10</position>
 +
<position>position-11</position>
 +
<position>position-12</position>
 +
<position>position-13</position>
 +
<position>position-14</position>
 +
<position>position-15</position>
 +
<position>newposition</position>
 +
</positions>
 +
</source>
 +
 
 +
=== Viewing the changes ===
 +
With Joomla 2.5 to see all of the existing template locations in your browser  edit the Template manager options.[[File:Template_manager_options.png|left|Template manager options]] 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
Then append "?tp=1",to the end of your normal URL (for example, <nowiki>"http://www.yoursite.com/?tp=1"</nowiki>).
 +
 
 +
 
 +
 
 +
== Joomla! 1.5 {{JVer|1.5}} ==
 +
In this example, we will add a new position to the default rhuk_milkyway template. Here are the steps.
 
*Open the file "<your Joomla! home>/templates/rhuk_milkyway/index.php" for editing and determine where your new position will be on the page. Note that you can see all of the existing template locations in your browser by adding "?tp=1" to the end of your normal URL (for example, <nowiki>"http://www.yoursite.com/?tp=1"</nowiki>).  
 
*Open the file "<your Joomla! home>/templates/rhuk_milkyway/index.php" for editing and determine where your new position will be on the page. Note that you can see all of the existing template locations in your browser by adding "?tp=1" to the end of your normal URL (for example, <nowiki>"http://www.yoursite.com/?tp=1"</nowiki>).  
 
*In our example, we will add a new location after the "breadcrumb" position called "mynewposition". To do this, find the line in the file <code><nowiki><div id="whitebox"></nowiki></code> and insert a new line <code><jdoc:include type="modules" name="mynewposition" /></code> as shown below:
 
*In our example, we will add a new location after the "breadcrumb" position called "mynewposition". To do this, find the line in the file <code><nowiki><div id="whitebox"></nowiki></code> and insert a new line <code><jdoc:include type="modules" name="mynewposition" /></code> as shown below:
Line 40: Line 97:
 
[[Image:New_template_position1.png]]
 
[[Image:New_template_position1.png]]
  
=== Joomla! 1.0 {{JVer|1.0}} ===
+
== Joomla! 1.0 {{JVer|1.0}} ==
  
 
To create a "new" position, choose one of the names from the list of positions shown in Site > [[Template Manager]] > Module Positions.
 
To create a "new" position, choose one of the names from the list of positions shown in Site > [[Template Manager]] > Module Positions.
  
[[Category:FAQ]]
+
<noinclude>[[Category:FAQ]]
 
[[Category:Template FAQ]]
 
[[Category:Template FAQ]]
 
[[Category:Version 1.0 FAQ]]
 
[[Category:Version 1.0 FAQ]]
 
[[Category:Version 1.5 FAQ]]
 
[[Category:Version 1.5 FAQ]]
 +
[[Category:Template Development]]
 +
[[Category:Template Development]]</noinclude>

Revision as of 03:31, 15 November 2012

Contents

Preface

The list of available positions where you can insert a module is controlled by the template you are using. It is possible to add new positions to a template.

Joomla! 2.5 Joomla 2.5

Inserting the code

  • Open the index.php file of the Template you wish to edit
  • Locate the place in the Template where you wish to put the new position.
  • Insert
<jdoc:include type="modules" name="newposition"   />
  • The variable can be used (between existing tags) to replace an image by replacing the <img src="xxx" border="0" alt="">. Or By creating a new tag with its own class/id.
  • Open the Template's TemplateDetails.xml file and locate the
<positions></positions> Start and end tags 
  • Then add
<position>newposition</position>
  • Example
<positions>
         <position>debug</position>
         <position>position-0</position>
         <position>position-1</position>
         <position>position-2</position>
         <position>position-3</position>
         <position>position-4</position>
         <position>position-5</position>
         <position>position-6</position>
         <position>position-7</position>
         <position>position-8</position>
         <position>position-9</position>
         <position>position-10</position>
         <position>position-11</position>
         <position>position-12</position>
         <position>position-13</position>
         <position>position-14</position>
         <position>position-15</position>
         <position>newposition</position>
</positions>

Viewing the changes

With Joomla 2.5 to see all of the existing template locations in your browser edit the Template manager options.

Template manager options







Then append "?tp=1",to the end of your normal URL (for example, "http://www.yoursite.com/?tp=1").


Joomla! 1.5 Joomla 1.5

In this example, we will add a new position to the default rhuk_milkyway template. Here are the steps.
  • Open the file "<your Joomla! home>/templates/rhuk_milkyway/index.php" for editing and determine where your new position will be on the page. Note that you can see all of the existing template locations in your browser by adding "?tp=1" to the end of your normal URL (for example, "http://www.yoursite.com/?tp=1").
  • In our example, we will add a new location after the "breadcrumb" position called "mynewposition". To do this, find the line in the file <div id="whitebox"> and insert a new line <jdoc:include type="modules" name="mynewposition" /> as shown below:
<div id="pathway">
   <jdoc:include type="modules" name="breadcrumb" />
</div>
   <div class="clr"></div>
   <div id="whitebox">
      <jdoc:include type="modules" name="mynewposition" />
   <div id="whitebox_t">
  • Open the file "<your Joomla! home>/templates/rhuk_milkyway/templateDetails.xml" for editing and find the "<positions>" section of the file. Add the new entry for "mynewposition" as shown below:
<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>
   <position>mynewposition</position>
</positions>

Now, when you look at your site with the "?tp=1" URL, you should see the new position as shown below:

New template position2.png

In the Module:[Edit] screen, the new position should display in the drop-down list box of available positions, as shown below.

New template position1.png

Joomla! 1.0 Joomla 1.0

To create a "new" position, choose one of the names from the list of positions shown in Site > Template Manager > Module Positions.