Actions

Help15

Difference between revisions of "Screen.modules.15"

From Joomla! Documentation

(create new sections)
m (Related Information: category reorganizing)
 
(27 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{underconstruction}}
 
 
==How to Access==
 
==How to Access==
You can open the Module Manager by clicking the Extensions -> Module Manager menu item.  
+
Select '''Extensions → Module Manager''' from the drop-down menu on the back-end of your Joomla! installation.
 +
 
 
==Description==
 
==Description==
The function of the Module Manager is to control the installed or custom site and administrator modules.
+
The Module Manager is where you add and edit Joomla! Modules. In Joomla!, Modules are used to display content and/or media around the main content.
 +
 
 +
<b>Module Facts:</b>
 +
#All Joomla! websites require at least 1 Menu Module
 +
#All Other Module Types are Optional. (Examples: News, Banner, Latest News, Polls)
 +
#Every Menu is accompanied by a menu module. (Example mod_mainmenu)
 +
#Multiple occurrences of similar module types.
 +
#Some Modules are linked to components. For example, each Menu Module is related to one Menu component. To define a Menu in Joomla!, you need to create the Menu and Menu Items using the Menus screens and then create the Module for the Menu using this screen. Other Modules, such as Custom HTML and Breadcrumbs, do not depend on any other content. See [[screen.modules.edit.15|Module Manager - New/Edit]] for information about the different Module Types.
 +
 
 +
The Joomla! installation is accompanied with 20 module types, additional 3rd party modules can be located at the [http://extensions.joomla.org/ JED].
 +
 
 
==Screenshot==
 
==Screenshot==
[[Image:Screen_module_manager_15.png |center|thumb|800x539px]]
+
[[Image:Module_manager.png]]
  
 
==Column Headers==
 
==Column Headers==
 +
Click on the column heading to sort the list by that column's value.
 +
{{colheader|Number}}
 +
{{colheader|Checkbox}}
 +
*'''Module Name.''' The name of the Module. You can click on the name to open the Module for editing.
 +
{{colheader|Enabled}}
 +
*'''Order.''' The order to display modules within a Position. If the list is sorted by this column, you can change the display order of modules within a Position by selecting a Position in the "Select Position" filter and then clicking the arrows or by entering the sequential order and clicking 'Save Order'.
 +
{{colheader|Access Level}}
 +
{{colheader|Position}}
 +
{{colheader|Pages}}
 +
{{colheader|Type}}
 +
{{colheader|Id}}
 +
{{colheader|Display #}}
  
 
==Toolbar==
 
==Toolbar==
 +
At the top right you will see the toolbar:
  
 +
[[Image:Module_manager_toolbar.png]]
  
==Quick Tips==
+
The functions are:
'''Modules Sort'''
+
{{toolbaricon|Enable}}
 +
{{toolbaricon|Disable}}
 +
{{toolbaricon|Copy Module}}
 +
{{toolbaricon|Delete}}
 +
{{toolbaricon|Edit}}
 +
{{toolbaricon|New Module}}
 +
{{toolbaricon|Help}}
  
The modules are sorted by the ''Position'' column by default but you can sort them by any column, just click the column header.
+
'''Site and Administrator Links'''
 +
At the top left, above the Filter, you will see the following two links:[[Image:Module_manager_links.png|frame|center]]
 +
*'''Site.''' Opens the Site tab. This is the default tab and allows you to manage the Modules for the front end of the web site.
 +
*'''Administrator.''' This tab allows you to manage the Modules for the back end administration of the web site. If you do not need to change the Joomla! administrator menus, no modifications are required here.
  
'''Position of a New Module'''
+
==List Filters==
 +
'''Filter by Partial Title'''
  
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.
+
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.
 +
{{colheader|List Filter}}
  
'''Support Old Modules in Legacy Mode'''
+
'''Filter by Template, Position, Type and Published State'''
 +
In the upper right area, above the column headings, are following drop-down list boxes as shown below:[[Image:Module_manager_filters.png|center]] The selections may be combined. Only items matching both selections will display in the list.
 +
{{colheader|Select Template}}
 +
{{colheader|Select Position}}
 +
{{colheader|Select Type}}
 +
{{colheader|Select Enabled State}}
  
Some old 1.0.x modules support Joomla! 1.5 in Legacy Mode. To be able to install such extensions please open the [[screen.plugins.15|Plugin Manager]] screen from the Extensions menu and enable plugin System - Legacy as it is disabled by the default.
+
==Quick Tips==
 +
*You can change the order of Modules within a Module Position as follows:
 +
**Select the desired Position using the Position Filter. This will limit the list to Modules that are assigned to this Position.
 +
**Change the order using the Up or Down arrows or by typing the order number and pressing the Save Order icon. The Modules will display in the new order within the Position.
 +
*You can open a Module for editing by clicking on the Module Name. This opens the [[screen.modules.edit.15|Module Manager - New/Edit]] screen.
  
 
==Related Information==
 
==Related Information==
You can view the installed modules list on the ''Modules'' tab of the [[screen.installer.15|Extension Manager]] by clicking the Extensions -> Install/Uninstall menu item. You can remove them in this screen as well.
+
*To create or edit Modules: [[screen.modules.edit.15|Module Manager - New/Edit]]
 
+
*To see the function and Parameters for all available front-end Modules: [[screen.modulessite.edit.15|Modules Site]]
==Version Changes==
+
*To see the function and Parameters for all available back-end (administrator) Modules: [[screen.modulesadministrator.edit.15|Modules Administrator]]
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:
+
*To view a list of all installed Modules and install or uninstall Modules: [[screen.installer.15#Modules Screen|Extension Manager - Modules Screen]]
 
+
*To work with Menus: [[screen.menumanager.15|Menu Manager]]
* The Publish toolbar button was renamed to ''Enable''.
+
*To work with Banners: [[screen.banners.15|Banner Manager]]
* The Unpublish toolbar button was renamed to ''Disable''.
+
<noinclude>{{cathelp|1.5|Module Manager Help Screens|Extensions Help Screens}}</noinclude>
* ''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.  
+
 
+
[[Image:Screen_module_manager_new_15.png|center|thumb|800x505px]]
+
 
+
You can enter the title, [[screen.modules.edit.15|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.
+
 
+
[[Category:DocCamp]]
+

Latest revision as of 22:19, 4 August 2012

Contents

How to Access

Select Extensions → Module Manager from the drop-down menu on the back-end of your Joomla! installation.

Description

The Module Manager is where you add and edit Joomla! Modules. In Joomla!, Modules are used to display content and/or media around the main content.

Module Facts:

  1. All Joomla! websites require at least 1 Menu Module
  2. All Other Module Types are Optional. (Examples: News, Banner, Latest News, Polls)
  3. Every Menu is accompanied by a menu module. (Example mod_mainmenu)
  4. Multiple occurrences of similar module types.
  5. Some Modules are linked to components. For example, each Menu Module is related to one Menu component. To define a Menu in Joomla!, you need to create the Menu and Menu Items using the Menus screens and then create the Module for the Menu using this screen. Other Modules, such as Custom HTML and Breadcrumbs, do not depend on any other content. See Module Manager - New/Edit for information about the different Module Types.

The Joomla! installation is accompanied with 20 module types, additional 3rd party modules can be located at the JED.

Screenshot

Module manager.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 modules within a Position. If the list is sorted by this column, you can change the display order of modules within a Position by selecting a Position in the "Select Position" filter and then 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. To copy one or more Modules, select them using the Checkbox and press this button. A new Module will be created for each selected Module. The new Module will have the name "Copy of" plus the original Module name. Note that the new copies are initially disabled.
  • 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. To create a new instance of a Module, press this button. You will be taken to a screen that lists all of the available Modules. See Module Manager - New/Edit for information about adding Modules.
  • Help. Opens this Help Screen.

Site and Administrator Links

At the top left, above the Filter, you will see the following two links:

Module manager links.png
  • Site. Opens the Site tab. This is the default tab and allows you to manage the Modules for the front end of the web site.
  • Administrator. This tab allows you to manage the Modules for the back end administration of the web site. If you do not need to change the Joomla! administrator menus, no modifications are required here.

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 Template, Position, Type and Published State

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

Module manager filters.png

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

  • Select Template. Select the Template from the drop-down list box of available Templates. Only Templates that are enabled for this site will display.
  • Select Position. Select a Position from the drop-down list box of available Positions.
  • Select Type. Select the Module Type from the drop-down list box of available Module Types. Joomla! installs with 20 available Module Types. Additional ones may be available if you have installed any Joomla! Extensions. See Module Manager - New/Edit for information about the available Module Types.
  • Select State. Use the drop-down list box to select the published state: Enabled or Disabled.

Quick Tips

  • You can change the order of Modules within a Module Position as follows:
    • Select the desired Position using the Position Filter. This will limit the list to Modules that are assigned to this Position.
    • Change the order using the Up or Down arrows or by typing the order number and pressing the Save Order icon. The Modules will display in the new order within the Position.
  • You can open a Module for editing by clicking on the Module Name. This opens the Module Manager - New/Edit screen.

Related Information