Actions

Help15

Screen.modules.15

From Joomla! Documentation

Revision as of 23:19, 13 May 2008 by Dextercowley (Talk | contribs)

Documentation all together tranparent small.png
Under Construction

This article or section is in the process of an expansion or major restructuring. You are welcome to assist in its construction by editing it as well. If this article or section has not been edited in several days, please remove this template.
This article was last edited by Dextercowley (talk| contribs) 6 years ago. (Purge)

Contents

How to Access

Select Extensions → Module Manager from the drop-down menu on the back-end of your Joomla! installation. Or click the "Site" link from the Module Manager / Administrator screen.

Description

The Module Manager is where you add and edit Joomla! Modules. In Joomla!, Modules are used to display things around the main page content. Some Modules, such as the Menu module ("mod_mainmenu"), are used in every Joomla! website. Other modules, such as Banners, "latest news", and "most read", are optional. Your website can have multiple instances of the same module. For example, all Joomla! menus are made using the "mod_mainmenu" module. So, if you have 5 menus, you will have 5 copies of the this module.

When you install Joomla!, 20 Modules are included. If you add extensions to your Joomla! installation, they may contribute additional modules.

Screenshot

Screen module manager 15.png

Column Headers

Click on the column heading to sort the list by that column's value.

  • #. An indexing number automatically assigned by Joomla! for ease of reference.
  • Checkbox. Check this box to select one or more items. To select all items, check the box in the column heading. After one or more boxes are checked, click a toolbar button to take an action on the selected item or items. Many toolbar actions, such as Publish and Unpublish, can work with multiple items. Others, such as Edit, only work on one item at a time. If multiple items are checked and you press Edit, the first item will be opened for editing.
  • Module Name. The name of the Module. You can click on the name to open the Module for editing.
  • Enabled. A green tick or a red X showing whether the use of the component is enabled/disabled. Click the icon to toggle the item between enabled and disabled.
  • Order. The order to display items. If the list is sorted by this column, you can change the order by clicking the arrows or by entering the sequential order and clicking 'Save Order'.
  • 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
You can change an item's Access Level by clicking on the icon in the column.
  • Position. The position on the page where this module is displayed. Positions are locations on the page where modules can be placed (for example, "left" or "right"). Positions are defined in the Template in use for the page. Positions can also be used to insert a Module inside an Article using the syntax "{loadposition xxx}", where "xxx" is a unique position for the module.
  • Pages. The Menu Items where this Module will be displayed. Options are "All" for all Menu Items, "None" for no Menu Items, and "Varies" for selected Menu Items. A Module will only display on Menu Items where it is selected.
  • Type. The system name of the Module. Joomla! installs 20 standard Modules. Many Joomla! Extensions contribute additional Modules. See Module Manager New/Edit for information about each of the standard Modules.
  • 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.
  • Display #. The number of items to display on one page. If there are more items than this number, you can use the page navigation buttons (Start, Prev, Next, End, and page numbers) to navigate between pages. Note that if you have a large number of items, it may be helpful to use the Filter options, located above the column headings, to limit which items display (where applicable).

Toolbar

At the top right you will see the toolbar:

Module manager toolbar.png

The functions are:

  • Enable. To enable one or more items, select them using the Checkbox and press this button. You may also toggle between Enabled and Disabled by clicking on the icon in the "Enabled" column.
  • Disable. To disable one or more items, select them using the Checkbox and press this button. You may also toggle between Enabled and Disabled by clicking on the icon in the "Enabled" column.
  • Copy. Select one or more items and click this button to copy them. A new screen will display showing the possible "Copy to" locations on the left and the list of item(s) being copied on the right. To complete the copy, select the desired "Copy to" location and press the Copy button. To cancel the operation, press Cancel.
  • Delete. To delete one or more items, select them and click this button. The selected items will be deleted. Note: only empty items can be deleted.
  • Edit. Select one item and click on this button to open it in edit mode. If you have more than one item selected (where applicable), the first item will be opened. You can also open an item for editing by clicking on its Title or Name.
  • New. Click on this button to create a new item. You will enter the New page for this item.
  • Help. Opens this Help Screen.

List Filters

Filter by Partial Title

You can filter the list of items by typing part of the title or the ID number. Or, you can select a combination of Category and Published State.

  • Filter. In the upper left corner just above the column headings is a Filter field and two buttons, as shown below:
    Article manager filter1.png
    If you have a large number of items on the list, you can use this filter to find the desired item(s) quickly. Enter either part of the title and press 'Go' to display the matching items. You can enter in whole words or part of a word. For example, "ooml" will match all titles with the word "Joomla!" in them. You can also search for a specific item id by entering "id:" followed by the id number. For example, "id:123" will find the item with an id of '123'.

Filter by Category and Published State

In the upper right area, above the column headings, are 2 drop-down list boxes as shown below:

Banner filter.png

The selections may be combined. Only items matching both selections will display in the list.

  • Select Category. Use the drop-down list box to select the desired Category. Only items in this Category will display.
  • Select State. Use the drop-down list box to select the published state: Published or Unpublished.

Quick Tips

Modules Sort

The modules are sorted by the Position column by default but you can sort them by any column, just click the column header.

Position of a New Module

A newly installed module is disabled by default and is the last one in the left module position. This way you can easily find it and move it to the desired place.

Support Old Modules in Legacy Mode

Some old 1.0.x modules support Joomla! 1.5 in Legacy Mode. To be able to install such extensions please open the Plugin Manager screen from the Extensions menu and enable plugin System - Legacy as it is disabled by the default.

Related Information

You can view the installed modules list on the Modules tab of the Extension Manager by clicking the Extensions -> Install/Uninstall menu item. You can remove them in this screen as well.

Version Changes

In Joomla! 1.5 the Module Manager was moved to the Extensions menu and got a tabbed interface for displaying the site and administrator modules. The below changes are related to both clients:

  • The Publish toolbar button was renamed to Enable.
  • The Unpublish toolbar button was renamed to Disable.
  • Go and Reset buttons were added to the Filter field.
  • Select Template drop down list was added.
  • Select State drop down list was added.
  • The Published column was renamed to Enabled.
  • Reorder and Order columns merged into one Order column.
  • The Access column is renamed to Access Level.
  • The ID and Type columns were swapped.
  • A column can be sorted ascending/descending by clicking the column header.
  • You can create another instance of a module using the New toolbar button.

Typical Usage

One module can be enabled/disabled by clicking the icon in the Enabled column. The enabled modules are marked with a green tick while the disabled ones are marked with a red X. When you want to enable/disable several modules, select their checkboxes and click the appropriate toolbar button.

When you want to create a copy of one or more modules select the checkbox(es) and click the Copy toolbar button. An information message will be displayed and you will find the module(s) with the name(s) "Copy of ..." inserted into the module name(s). The copies will have a disabled status.

When you want to delete one or more unnecessary modules select the checkbox(es) and click the Delete toolbar button. An information message will be displayed and the module(s) will be removed from the list.

You can create another instance of an installed or custom module using the New toolbar button. When you click it, the Module: [New] screen will be loaded. Select the desired module and click the Next toolbar button or simply click the module type.

Screen module manager new 15.png

You can enter the title, customize the details and the parameters and assign it to a menu in the loaded Module: [Edit] screen.

The four drop down lists make you easier to narrow the list of your choice, or you can enter a string in the Filter field and click the Go button to find the matching modules in the list.

The items can be moved up/down by clicking the arrows in the list, or they can be renumbered by entering a value in the field next to the arrow. In this case the order should be saved by clicking the floppy icon.

The access for a module can be changed simply by clicking the Public/Registered/Special value in the Access Level column.