Difference between revisions of "How do you put a module inside an article?"

From Joomla! Documentation

m (Undo revision 13319 by Dpminusa (Talk))
m (heading reduction as for FAQ inclusion DPL test)
(13 intermediate revisions by 11 users not shown)
Line 1: Line 1:
−
You can insert a module inside an article using the "{loadposition xx}" command, as follows:
+
{{JVer|1.5}} {{JVer|1.6}} {{JVer|1.7}} {{JVer|2.5}}
−
#Use the menu manager to create a new unique menu name. This will be used in the module manager to assign the mainmenu module you instantiate.  Its name will appear in the basic parameters menu name list. --[[User:Dpminusa|Dpminusa]] 10:34, 1 March 2009 (UTC)
 
−
#Create a module and set its position to any value that doesn't conflict an existing template position. You can type in the position value instead of selecting it from the drop-down list. For example, use the position "myposition".
 
−
#Assign the module to the Menu Items that contain the articles that you want the module to show in. You can also just assign the module to "All" Menu Items.
 
−
#Edit the articles where you want this module to show and insert the text "{loadposition myposition}" in the article, at the place where you want the module to show.
 
−
The module will show at that point in the article.
 
  
−
[[Category:FAQ]]
+
You will usually want to associate modules with articles in some way.  The modules are allocated to module positions and the module positions appear somewhere on the Web page as determined by the template.  However, it is sometimes useful to have a module actually embedded within the article.
 +
 
 +
To insert a module inside an article, use the ''{loadposition xx}'' command, as follows:
 +
#Create a module and set its position to any value that doesn't conflict with an existing template position. You can type in the position value instead of selecting it from the drop-down list. For example, use the position ''myposition''.
 +
#Assign the module to the Menu Items that contain the articles that you want the module to show in. You can also just assign the module to '''all''' Menu Items.
 +
#Edit the articles where you want this module to appear and insert the text ''{loadposition myposition}'' in the article at the place where you want the module.
 +
 
 +
Note that this only works when the [[Screen.plugins.edit.15#Content_-_Load_Module|''Content - Load Module'' plugin is enabled]]. If this plugin is disabled, the text ''{loadposition myposition}'' shows unchanged in the article.
 +
 
 +
 
 +
===loadmodule===
 +
An alternative to "{loadposition xx}" is the "{loadmodule yyy}" variation which is handled by the same plugin.
 +
 
 +
In this case the plugin looks for the first module that who's '''type''' matches the string 'yyy'. So, you could load a "mod_login" module by placing {loadmodule login} in your text.
 +
 
 +
===Modules within Modules===
 +
It is possible in Joomla! 2.5+ to include a module within a "Custom HTML" module as they are processed by content plugins in the same way as articles.
 +
 
 +
You should remember when doing this that you may experience formatting issues as the "chrome" of the "Custom HTML" module will surround the "chrome" of the included module potential having undesirable effects of the formatting or layout.
 +
 
 +
<noinclude>[[Category:FAQ]]
 
[[Category:Version 1.5 FAQ]]
 
[[Category:Version 1.5 FAQ]]
 +
[[Category:Version 1.6 FAQ]]
 +
[[Category:Version 1.7 FAQ]]
 +
[[Category:Version 2.5 FAQ]]
 
[[Category:Administration FAQ]]
 
[[Category:Administration FAQ]]
 +
[[Category:Article Management]]
 +
[[Category:Module Management]]</noinclude>

Revision as of 23:18, 1 September 2012

Joomla 1.5 Joomla 1.6 Joomla 1.7 Joomla 2.5

You will usually want to associate modules with articles in some way. The modules are allocated to module positions and the module positions appear somewhere on the Web page as determined by the template. However, it is sometimes useful to have a module actually embedded within the article.

To insert a module inside an article, use the {loadposition xx} command, as follows:

  1. Create a module and set its position to any value that doesn't conflict with an existing template position. You can type in the position value instead of selecting it from the drop-down list. For example, use the position myposition.
  2. Assign the module to the Menu Items that contain the articles that you want the module to show in. You can also just assign the module to all Menu Items.
  3. Edit the articles where you want this module to appear and insert the text {loadposition myposition} in the article at the place where you want the module.

Note that this only works when the Content - Load Module plugin is enabled. If this plugin is disabled, the text {loadposition myposition} shows unchanged in the article.


loadmodule[edit]

An alternative to "{loadposition xx}" is the "{loadmodule yyy}" variation which is handled by the same plugin.

In this case the plugin looks for the first module that who's type matches the string 'yyy'. So, you could load a "mod_login" module by placing {loadmodule login} in your text.

Modules within Modules[edit]

It is possible in Joomla! 2.5+ to include a module within a "Custom HTML" module as they are processed by content plugins in the same way as articles.

You should remember when doing this that you may experience formatting issues as the "chrome" of the "Custom HTML" module will surround the "chrome" of the included module potential having undesirable effects of the formatting or layout.

Retrieved from "https://docs.joomla.org/index.php?title=How_do_you_put_a_module_inside_an_article%3F&oldid=73727"