Actions

Help33

Difference between revisions of "Extensions Module Manager Menu"

From Joomla! Documentation

(Fix typo)
m (Quick Tips: clean up)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
=Menu Module=
+
==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.
 +
==How to Access==
 +
{{Chunk30:ModuleManager-How-to-acces-module|module=Menu}}
  
==Overview==
+
{{Chunk30:Help-3x-module-site-menu}}
  
==How to access==
+
===Common Details===
You can access the Menu module by either opening an existing Menu module in the Module Manager or by creating a new Menu Module.
+
{{Chunk30:Module Details}}
You can access the Module Manager by going to '''Extensions > Module Manager'''
+
  
==Description==
+
===Common Tabs===
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.
+
{{Chunk30:Help-3x-module-site-common-tabs}}
 
+
==Screenshot==
+
[[Image:Help30-Extensions-Module-Manager-Menu-screen.png]]
+
  
 
==Toolbar==
 
==Toolbar==
 
{{Chunk30:Help_screen_module_manager_edit_toolbar}}
 
{{Chunk30:Help_screen_module_manager_edit_toolbar}}
 
==Details==
 
 
===Basic Options===
 
The Menu Module has the following Module Paramters:
 
[[Image:Help30-Extensions-Module-Manager-Menu-basic-options-parameters.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===
 
[[Image:Help30-Extensions-Module-Manager-Menu-advanced-options-parameters.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''' Apply an alternative layout or template override
 
*'''Module Class Suffix''' Apply a CSS suffix to the module
 
{{colheader|Caching}}
 
{{colheader|Cache Time}}
 
 
==Menu Assignment==
 
 
 
==Quick Tips==
 
==Quick Tips==
 
No tips have been added at this time.
 
No tips have been added at this time.
  
<noinclude>{{cathelp|3.0,3.1|Module Manager Help Screens|Extensions Help Screens}}</noinclude>
+
<noinclude>{{cathelp|3.0,3.1,3.2,3.3|Module Manager Help Screens|Extensions Help Screens}}</noinclude>

Latest revision as of 11:27, 30 April 2014

Contents

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 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.

How to Access

To 'add' a new Menu module or 'edit' an existing Menu module, 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 module, in the Module Manager click on the Menu Module's Title or click the Menu module's check box and then click the Edit button in the Toolbar.

Screenshot

Help-3x-modules-site-module-manager-module-menu.png

Details

  • Title: Module must have a title

Module

This module displays a menu on the frontend.

  • Select Menu: (About Joomla/Australian Parks/Fruit Shop/Main Menu/Top/User Menu). Select a menu in the list
  • Base Item: (Current/Getting Started/Using Joomla!/Using Extensions/Components/Content Component/...). Select a menu item to always be used as the base for the menu display. You must set the Start Level to the same level or higher than the level of the base item. This will cause the module to be displayed on all assigned pages. If Current is selected the currently active item is used as the base. This causes the module to only display when the parent menu item is active.
  • Start Level: (1/2/3/4/5/6/7/...). Level to start rendering the menu at. Setting the start and end levels to the same # and setting 'Show Sub-menu Items' to yes will only display that single level.
  • End Level: (All/1/2/3/4/5/6/...). Level to stop rendering the menu at. If you choose 'All', all levels will be shown depending on 'Show Sub-menu Items' setting.
  • Show Sub-menu Items: (Yes/No). Expand the menu and make its sub-menu items always visible.

Common Details

Help30-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/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.

Common Tabs

Menu Assignment

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

On this tab there is a list of menu items. You can choose between On All Pages, No Pages, Only on the pages selected and On all pages except those selected from the List.

If the latter two options are selected a list will show with all the menu items on as shown in the screenshot above. This allows you to assign modules to some but not all pages, and by selecting the menu links that you want the module associated with you can customize on what pages modules appear/don't appear. See How do you assign a module to specific pages? for more information

Module Permissions

Help30-module-manager-menu-permissions-screenshot.png

  • Delete: (Inherited/Allowed/Denied). Allow or deny Delete for users in the Public group. Delete Allows users in the group to delete any content in this extension.
  • Edit: (Inherited/Allowed/Denied). Allow or deny Edit for users in the Public group. Edit Allows users in the group to edit any content in this extension.
  • Edit State: (Inherited/Allowed/Denied). Allow or deny Edit State for users in the Public group. Edit State Allows users in the group to change the state of any content in this extension.

Advanced

Help30-module-manager-advanced-options-screenshot.png

  • Alternative Layout. If you have defined one or more alternative layouts for a module either in the template or Joomla! Core, you can select the layout to use for this module. See Layout Overrides in Joomla 2.5 for more information about alternative layouts.
  • Module Class Suffix. A suffix applied to the CSS class of the Module. This allows you to create customized CSS styles that will apply just to this module. You would then modify the "template.css" file of your template to apply styling to this new class.
    • Enter this parameter with a leading space to create a new CSS class for this module. Enter the parameter without a leading space to change the CSS class name for this module.
    • See the tutorial Using Class Suffixes in Joomla! for more information.
  • Caching. Use Global/No Caching. Whether or not to cache the content of this Module. A setting of "Use Global" will use the Cache Settings from the Global Configuration screen.
  • Cache Time. The length of time, in minutes, before the Module is re-cached.
  • Module Tag. The HTML tag for the module to be placed in. By default this is a div tag but other HTML5 elements can also be used.
  • Bootstrap Size. (Values 0 to 12) This allows you to choose the width of the module via the span element built into bootstrap. For more information see the bootstrap documentation.
  • Header Tag. The HTML tag to use for the modules header or title. This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must use a module style (chrome) of html5 or add your custom module styles in <mytemplate>/html/modules.php.
  • Header Class. Here you can add optional CSS classes to add to the modules header or title element.
  • Module Style. You can use this option to override the templates style for its position.

Toolbar

At the top left you will see the toolbar:

Help30-Save-SaveClose-SaveNew-SaveCopy-Close-Help-toolbar.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.

Quick Tips

No tips have been added at this time.