Help25

Difference between revisions of "Extensions Module Manager Menu"

From Joomla! Documentation

(Added toolbar section.)
m (removing needs images)
 
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
==How to access==
+
{{RightTOC}}
You can access the Menu module by either opening an existing Menu module in the Module Manager or by creating a new Menu Module.
+
==How to Access==
You can access the Module Manager by going to '''Extensions > Module Manager'''
+
To ''''add'''' a new Menu or ''''edit'''' an existing Menu, navigate to the [[Help25:Extensions_Module_Manager|Module Manager]]:
 +
* Select {{rarr|Extensions,Module Manager}}
 +
 
 +
Click the ''''New'''' button and click on Menu in the modal popup window.
 +
 
 +
To ''''Edit'''' an existing Menu, in the Module Manager click on an '''Menus Title''' or click the '''Menus check box''' and then click the '''Edit''' button in the Toolbar.
  
 
==Description==
 
==Description==
This Module allows you to place your Menus on the page. Every Joomla! website has at least one Menu that is created in the [[screen.menumanager.15|Menu Manager]] screen. The Menu Module allows you place all or part of the selected Menu at the desired position and on the desired web pages.
+
This Module allows you to place your Menus on the page. Every Joomla! website has at least one Menu that is created in the [[Help25:Menus_Menu_Manager|Menu Manager]] screen. The Menu Module allows you place all or part of the selected Menu at the desired position and on the desired web pages.
  
 
==Screenshot==
 
==Screenshot==
[[Image:Help25_module_menu.jpg|frame|center]]
+
[[Image:Help25-module-manager-menu-screenshot.png]]
  
==Outline==
+
==Details and Options==
 +
===Details===
 +
{{Chunk25:Module Details}}
  
 
===Basic Options===
 
===Basic Options===
 
+
[[Image:Help25-module-manager-menu-basic-options-screenshot.png]]
The Menu Module has the following Module Paramters:
 
[[Image:help25_mod_menu_basic.JPG|frame|center]]
 
 
*'''Select Menu.''' Select a created menu to use for the module. The default is the menu with the lowest ID. Note that you can have more than one Menu Module with the same Menu Name
 
*'''Select Menu.''' Select a created menu to use for the module. The default is the menu with the lowest ID. Note that you can have more than one Menu Module with the same Menu Name
 
specified here (for example, if you are using Start and End Levels).
 
specified here (for example, if you are using Start and End Levels).
Line 21: Line 26:
 
*'''Show sub-menu Items.''' Whether or not to show sub-menu items when the parent is not active. If "No", a sub-menu Item will only display when the parent Item is clicked. If "Yes", sub-menu Items will always display in the menu.
 
*'''Show sub-menu Items.''' Whether or not to show sub-menu items when the parent is not active. If "No", a sub-menu Item will only display when the parent Item is clicked. If "Yes", sub-menu Items will always display in the menu.
  
===Advanced Parameters===
+
===Advanced Options===
 
+
[[Image:Help25-module-manager-menu-advanced-options.png]]
[[Image:help25_mod_menu_advanced.JPG|frame|center]]
 
 
 
 
*'''Menu tag ID''' Assign an ID to the menu item's root tag; when you want to apply specific CSS styling.
 
*'''Menu tag ID''' Assign an ID to the menu item's root tag; when you want to apply specific CSS styling.
 
*'''Menu Class Suffix''' Assign a suffix to the CSS class of the menu, to apply specific CSS styling.
 
*'''Menu Class Suffix''' Assign a suffix to the CSS class of the menu, to apply specific CSS styling.
 
*'''Target Position''' Define the position for a javascript-powered pop-up window.
 
*'''Target Position''' Define the position for a javascript-powered pop-up window.
*'''Alternative layout''' Apply an alternative layout or template override
+
{{Chunk25:colheader|Alternative Layout}}
*'''Module Class Suffix''' Apply a CSS suffix to the module
+
{{Chunk25:colheader|Module Class Suffix}}
{{colheader|Caching}}
+
{{Chunk25:colheader|Caching}}
{{colheader|Cache Time}}
+
{{Chunk25:colheader|Cache Time}}
  
==Quick Tips==
+
===Menu Assignment===
No tips have been added at this time.
+
{{Chunk25:Menu Assignment}}
  
 
==Toolbar==
 
==Toolbar==
 
{{Chunk25:Help_screen_module_manager_edit_toolbar}}
 
{{Chunk25:Help_screen_module_manager_edit_toolbar}}
  
<noinclude>{{cathelp|2.5|Module Manager|Extensions}}</noinclude>
+
==Front End Screenshot==
 +
{{Chunk25:Help screen screenshot disclaimer}}
 +
Menu module shown:
 +
 
 +
[[Image:Help25-module-manager-menu-frontend-screenshot.png]]
 +
 
 +
Alternative placement effects menu style based on template parameters.
 +
 
 +
[[Image:Help25-module-manager-menu-frontend-screenshot-2.png]]
 +
 
 +
The Module Type name for this Module is "mod_menu". It is related to the Menu component.
 +
 
 +
 
 +
<noinclude>{{cathelp|2.5|Module Manager Help Screens|Extensions Help Screens}}</noinclude>

Latest revision as of 08:56, 10 April 2013

How to Access[edit]

To 'add' a new Menu or 'edit' an existing Menu, navigate to the Module Manager:

  • Select Extensions  Module Manager

Click the 'New' button and click on Menu in the modal popup window.

To 'Edit' an existing Menu, in the Module Manager click on an Menus Title or click the Menus check box and then click the Edit button in the Toolbar.

Description[edit]

This Module allows you to place your Menus on the page. Every Joomla! website has at least one Menu that is created in the Menu Manager screen. The Menu Module allows you place all or part of the selected Menu at the desired position and on the desired web pages.

Screenshot[edit]

Help25-module-manager-menu-screenshot.png

Details and Options[edit]

Details[edit]

Help25-module-manager-details-screenshot.png

  • Title. The title of the module. This is also the title displayed in the front end for the module depending on the Show Title Form Field
  • Show Title. (Show/Hide) Choose whether to show or hide the modules title in the front end. The title will be the one in the Form Field above.
  • Module Position. Choose the module position you wish this module to be displayed in. A custom module position can be entered for use with the load position plugin or the position button can be pressed to select a module position from the template.
  • Status. (Published/Unpublished/Archived/Trashed) The published status of the item.
  • Access. The viewing level access for this item.
  • Module Ordering. This shows a drop down of every module in the position that the current module is in. This is the order that the modules will display in when displayed on in the front end as well as in the Module Manager.
  • Start Publishing. Date and time to start publishing. Use this field if you want to enter content ahead of time and then have it published automatically at a future time.
  • Finish Publishing. Date and time to finish publishing. Use this field if you want to have content automatically changed to Unpublished state at a future time (for example, when it is no longer applicable).
  • Language. Item language.
  • Note. Item note. This is normally for the site administrator's use (for example, to document information about this item) and does not show in the front end of the site.

Basic Options[edit]

Help25-module-manager-menu-basic-options-screenshot.png

  • Select Menu. Select a created menu to use for the module. The default is the menu with the lowest ID. Note that you can have more than one Menu Module with the same Menu Name

specified here (for example, if you are using Start and End Levels).

  • Start Level. Optional level to start the display of the Menu. Default is 0 for the Top Level.
  • End Level. Optional level to end the display of the Menu. Default is 0, which will display all levels of the menu.
  • Show sub-menu Items. Whether or not to show sub-menu items when the parent is not active. If "No", a sub-menu Item will only display when the parent Item is clicked. If "Yes", sub-menu Items will always display in the menu.

Advanced Options[edit]

Help25-module-manager-menu-advanced-options.png

  • Menu tag ID Assign an ID to the menu item's root tag; when you want to apply specific CSS styling.
  • Menu Class Suffix Assign a suffix to the CSS class of the menu, to apply specific CSS styling.
  • Target Position Define the position for a javascript-powered pop-up window.
  • Alternative Layout. If you have defined one or more alternative layouts for the Single Article menu item, you can select the layout to use for this article. See Layout Overrides in Joomla 2.5 for more information about alternative layouts.
  • Module Class Suffix. Setting this parameter causes Joomla! to either add a new CSS class or modify the existing CSS class for the div element for this specific module. See here for more information
  • Caching. (Use Global/No Caching) Choose whether you wish to cache the contents of the module.
  • Cache Time. The time before a module is recached.

Menu Assignment[edit]

Help25-module-manager-menu-assignment-screenshot.png

On the left there is a list of menu items. You can chose between None, All and Select Menu Item(s) from the List. To assign to some but not all pages choose the third option and select the menu links that you want the module associated with. See How do you assign a module to specific pages? for more information

Toolbar[edit]

At the top right you will see the toolbar:

Help25-Toolbar-Save-SaveClose-SaveNew-SaveCopy-Close-Help.png

The functions are:

  • Save. Saves the module and stays in the current screen.
  • Save & Close. Saves the module and closes the current screen.
  • Save & New. Saves the module and keeps the editing screen open and ready to create another module.
  • Save as Copy. Saves your changes to a copy of the current module. Does not affect the current module. This toolbar icon is not shown if you are creating a new module.
  • Cancel/Close. Closes the current screen and returns to the previous screen without saving any modifications you may have made.
  • Help. Opens this help screen.

Front End Screenshot[edit]

Example Front End Site images are generic images using Joomla! core installation supplied free Front End Templates. The actual view can depend on the installed custom template used and the template's style for those views on a Joomla! website. Menu module shown:

Help25-module-manager-menu-frontend-screenshot.png

Alternative placement effects menu style based on template parameters.

Help25-module-manager-menu-frontend-screenshot-2.png

The Module Type name for this Module is "mod_menu". It is related to the Menu component.