User Guide

Modules Anywhere

Download Free Buy Pro   € 20

1) Introduction

This guide provides in-depth information about Modules Anywhere and will tell you:

  • what it does
  • how to install it
  • how to set-up and use it

2) What is Modules Anywhere?

Modules Anywhere is a Joomla! system plugin (and editor button plugin).
You can place modules anywhere in your site, including within 3rd party components, modules and even inside other articles.

You can, for instance, place the module ‘My Module’ in an article by simply placing:

{module My Module}

3) How to use it (syntax)

You can place modules via Modules Anywhere by using plugin style tags right into your WYSIWYG editor.

To place a single article, you can use the {module} tag.

You can also place complete module positions by using the {modulepos} tag.

Note: You should place the tags into the normal WYSIWYG view of your editor and NOT in the HTML/code view.

3.1) Single module

The syntax is very simple. You tell the {module} tag which module to show simply by using the title or id of the module:

{module Some module}
{module 123}

3.2) Module positions

The {modulepos} tag works very much like the {loadposition} plugin in Joomla's core. But it works better :)
The main difference is that you can use the {modulepos} tag anywehre you can enter text, so not only in articles.

Just add the position name inside the {modulepos} tag, like:

{modulepos position-7}

3.3) Overruling HTML styles

You can easily place the module (or module position) with another style than you have set as default (default is 'none'). Just add it after the name, separated with a bar:
{module Main Menu|division}

What HTML styles (chrome) you can use, depends on your template.

The Joomla template Beez comes with the HTML styles division and tabs.
The Joomla 3 template Prostar comes with the HTML style well.

3.4) Overruling Module parameters PRO ONLY

You can also overrule module parameters via the {module} tag. This way you can have one module displayed in different ways, with different settings just by overruling the settings via the tag.
You can overrule any parameters you can find in the module edit screen (in the administrator).

{module Main Menu|moduleclass_sfx=red|some_other_setting=123}

So you can easily switch on/off the title with:

{module Articles from Category|showtitle=0}

Or change the number of displayed items in a listing module with something like:

{module Latest News|count=10}

You should use the ids of the parameter fields. This is the part in the brackets in the field name: jform[xxx]

4) Editor Button

You can enter the tags directly into your content. However, to save time typing and remembering what the exact syntax is, Modules Anywhere comes with a handy editor button.

You can use this editor button (located below the text input area) to place an {module} or modulepos tag into your article (or other editor fields).

You can customise the default tag settings in the Modules Anywhere system plugin settings.

5) Settings

Modules Anywhere is packed with options, giving you control over how it works and behaves. Here is the full list of the options you can find in the Modules Anywhere system plugin settings:

Tag Syntax

MA_TAG The word to be used in the tags.

Note: If you change this, all existing tags will not work anymore.
Modulepos tag The word to be used in the tags.

Note: If you change this, all existing tags will not work anymore.
Handle {loadposition} tags Select to also handle the {loadposition} tags from the Joomla core plugin Load Module.

It is recommended to disable the Load Module plugin.

Styling

Default style Select the module style (chrome) to use by default. If no style is given in the module tag, this style is used.
Styles List A comma separated list of styles (chromes) that will be available as a list in the Editor Button popup window.
Enable style overriding If selected, you can add a style parameter in the tag like:

{module Main Menu|horz}

You can choose from:
table, horz, xhtml, rounded, none.

Behaviour

Enable parameter overriding PRO ONLY If selected, you can override the modules parameters in the tag like:

{module Main Menu|​moduleclass_sfx=red|​some_other_setting=123}

This only works for the module tag (not the modulepos tag).

You can find the parameter names in the html of the modules settings page (name="param[...]") or look in the modules xml file.
Ignore Module Access Level If selected, the module access level selection will be ignored.
Ignore Module State If selected, unpublished modules will still be placed by the tag.
Ignore Module Assignments If selected, module assignments (like date and menu item assignments) will be ignored.
Ignore Caching By default, modules that have module caching switched off, will not be handled by Modules Anywhere on the article level, but at a later stage. This is to prevent Joomla from caching the module's output when caching the article.

If selected, the module will be handled on article level even when caching is switched off for the module. Enable this if certain modules have problems with placing their css/javascript files and you need to keep their caching setting disabled.
Place HTML comments By default HTML comments are placed arround the output of this extension.

These comments can help you troubleshooting when you don't get the output you expect.

If you prefer to not have these comments in your HTML output, turn this option off.

Security Options PRO ONLY

Articles

These settings have effect on Articles and Categories.

Enable in articles Select whether to enable the use of the syntax in articles.
Security Level Set the level of security. Modules Anywhere tags will be stripped from articles with an owner (creator) below this group level.

Components

These settings have effect on the component area.
You can select in which components Modules Anywhere should not be enabled. Advise is to not allow Modules Anywhere in components that non-backend users can post content in.

Enable in components Select whether to enable the use of the syntax in components.
Disable on Components Select in which components NOT to enable the use of the syntax in. This is a list of your installed frontend components.

Other Areas

These settings have effect on areas outside the component area (so in Modules and the rest of the website).
Enable other areas Select whether to enable the use of the syntax in all remaining areas, like the modules. The tag will not be handled/shown in the html head (META tags and such).

Editor Button Options

Button Text This text will be shown in the Editor Button.
Show Button Icon J2.5 ONLY If selected, the icon will be displayed in the Editor Button.
Enable in frontend If enabled, it will also be available in the frontend.

Default Data Tag settings PRO ONLY

Set the default values of the Data Tag selections for the Modules Anywhere popup

Embed in a DIV Select to wrap the output in a div tag.
You can use this to align the article and add extra styling to it.
Width Enter a desired width if necessary.
You can use any valid css width value (auto, ...px, ...%).
Numeric values are interpreted as px.
Height Enter a desired height if necessary.
You can use any valid css height value (auto, ...px, ...%).
Numeric values are interpreted as px.
Alignment Define the alignment of the div.
Div Classname Enter a classname for the div.
You can use this to style the div and it contents through css.

6) Requirements

Modules Anywhere will only work correctly if your setup meets these requirements:

  • Up-to-date version of Joomla:
    • Joomla 2.5.10 or higher
    • Joomla 3.2.2 or higher
  • PHP 5.3+ ( No PHP 5.2 support! )
  • PHP mbstring (Multibyte String) functions enabled
  • MySQL 5+

Important: I can only provide support for setups that:

  • meet the above requirements;
  • do not have extension files or Joomla! core files which have been altered in any way.

7) Installation

You can either install Modules Anywhere by using the core extension manager available in the Joomla! Administrator Control Panel, or by using the powerful NoNumber Extension Manager.

Note: When updating Modules Anywhere, you do not need to uninstall it first. The package will update all the files automatically.

Keep in mind that when you update to a major new version (or uninstall first), you might lose some configuration settings.

7.1) NoNumber Extension Manager

It is very easy to install/update any NoNumber Extension using the NoNumber Extension Manager.

Please see the User Guide for the NoNumber Extension Manager for more detailed information...

NoNumber Extension Manager

7.2) Joomla! Extension Manager

To install via the Joomla! Extension Manager, just follow these steps (based on Joomla 2.5 setup):

  1. Download the extension zip.
  2. Log into your Joomla administrator
  3. In the menu, choose: Extensions >> Extension Manager
  4. Under 'Upload Package File' select the extension zip.
  5. Click on 'Upload & Install'
Joomla! Installer

If you have problems installing Modules Anywhere, please try the manual installation process as described here: docs.joomla.org/Installing_an_extension

8) Uninstallation

You can either uninstall Modules Anywhere by using the core extension manager available in the Joomla! Administrator Control Panel, or by using the powerful NoNumber Extension Manager.

If you no longer use any NoNumber extensions, you can also uninstall the NoNumber Framework plugin by using the Joomla! core extension manager.

Quick Menu

Peter van Westen

Hosted by

SiteGround.com