Actions

Help15

Screen.modules.edit.15

From Joomla! Documentation

Revision as of 05:41, 11 October 2012 by Tom Hutchison (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Contents

How to Access

Navigate to the Module Manager. To create a new Module, press the "New" button on the toolbar. To edit an existing Module, click on the Module Name or click on the Module's checkbox and press the Edit button on the toolbar.

Description

This is where you create new Modules or edit existing Modules. This screen has two links in the upper left: Site and Administrator. The Site link is selected by default. The Site link allows you to work with Modules that will be visible on your web site's Front-end. This is where you will place most of your Modules.

The Administrator link allows you to work with Modules that show on your web site's Back-end. In many cases, it is not necessary to modify the back-end Modules for Joomla!. All of the standard Joomla! administrator functions are available with no modifications here. You only need to make changes here if you want to change the standard administrator functions.

When you create a new Module, you will select the Module Type. This will determine what type of content this Module can display. If you edit an existing Module, the Module Type will already be determined. Note that you cannot change the Module Type of an existing Module.

For detailed information about each Module type for your web site, see the Modules Site screen. For detailed information about modifying the Modules for the back end of your site, see Modules Administrator.

All Modules have two sections that are the same: Details and Menu Assignment. The Parameters are different for each Module Type.

Screenshot

Module new details.png

Details

  • Module Type. This displays the system name of the module. No entry is allowed.
  • Title. The Title of the Module.
  • Show Title. Whether or not to show the Title of the Module.
  • Enabled. Whether or not the Module is enabled. If "No", the Module will not be shown on the page.
  • Position. The Position on the page to show the Module. There are two types of Positions you can use.
    1. You can select a Position from the drop-down list box. The Positions in the list box are those provided by your Template. You can see the available Positions on the page by adding the letters "?tp=1" to the end of any front-end Joomla! URL. For example, if your home page is "www.mysite.com", you can type the URL "www.mysite.com?tp=1". The page will display with labeled rectangles indicating each pre-defined Position for the current Template.
    2. You can type in a Position that is different from the pre-defined positions (for example, "myposition1"). This type of Position can be used to insert a Module into an Article. If you enter the code "{loadposition xxx}" inside the text of an Article, where "xxx" matches the Position of a Module, and if the Module is assigned to the the Menu Selection where the Article is displayed (see Menu Assignment below), then the Module will be displayed at that point in the Article.
  • Order. The Order that this Module will be displayed within the Position. If more than one Module is displayed at the same position, this will determine the order of display. The drop-down list box shows all Modules displaying at the current Position. Select the Module that you want the current Module to follow.
    • You can also change the order of display in the Module Manager.
    • The Module Order is only important when two or more Modules are displaying at the same Position and on the same Menu Selections.
  • Access Level. Who has access to this item. Current options are:
    • Public: Everyone has access
    • Registered: Only registered users have access
    • Special: Only users with author status or higher have access
Enter the desired level using the drop-down list box.
  • ID. The ID number. This is a unique identification number for this item assigned automatically by Joomla!. It is used to identify the item internally, for example in internal links. You can not change this number.
  • Description. A description of what the Module does. No entry is allowed.

Menu Assignment

This is where you tell Joomla! which pages to show this Module on. This Module will show on the page when this Menu Item is selected. If the Menu Item allows the user to navigate to sub-pages, then this Module will also show on these sub-pages. For example, if the Menu item is a Blog Layout, the Module will also show when the user clicks on a "Read more..." link, an Article Link, or a Page Navigation link from that Blog Layout.

  • Menus. "All" means show the current Module on all Menu Items. "None" means don't show the Module on any Menu Items. "Select Menu Item(s) from the List" allows you to select which Menu Items to show the Module on.
  • Menu Selection. If "Select Menu Items(s) from the List" above is selected, select individual Menu Items that will display the Module.
    • Use Ctrl+Click to select multiple Menu Items.
    • Use Shift+Click to select a range of Menu Items.
    • If you want to select most of the Menu Items, first click "All" above under Menus and then click "Select Menu Items(s) from the List". All of the Menu Items will be selected. Then use Ctrl+Click to deselect the Menu Items you don't want to include.

Toolbar

Banner edit toolbar.png

  • Save. Save it and return to editing the menu details.
  • Apply. Save it, but stay in the same screen. If you have been working on a screen for a long time and don't want to risk losing your work, pressing Apply saves your work and lets you continue working. If, for example, you lost your Internet connection, your work will be saved up this point.
  • Close. Return to the previous screen without saving your work. If you press Close while adding a new item, this new item will not be created. If you were modifying an existing item, the modifications will not be saved.
  • Help. Opens this Help Screen.

Quick Tips

  • You can insert a Joomla! Module inside an Article by typing "{loadposition xxx}", where "xxx" is the position entered for the desired Module. Note that the position name must not conflict with a position used by your Joomla! template. It can be any name (e.g., "mymoduleposition1") as long as it matches the position name typed in for the Module. The Menu Assignment for the Module must include the Menu Item where the Article is displayed, and the Plugin called "Content - Load Module" must be enabled (which it is by default). This feature allows you, for example, to insert a Custom HTML Module anywhere in an Article. See Article Manager - New/Edit for information about adding and editing Articles.
  • You can easily change the order of display of Modules using the Module Manager.

Related Information

  • To see a description and Parameters for the different front-end Module types: Modules Site
  • To see a description and Parameters for the different back-end Module types: Modules Administrator
  • To work with existing Modules: Module Manager