Help25:Extensions Module Manager Banners

How to Access

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

• Select Extensions → Module Manager

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

To 'Edit' an existing Banners module, in the Module Manager click on an Banners Modules Title or click the Banners modules check box and then click the Edit button in the Toolbar.

Description

This Module allows you to show active Banners from the Banner Component created in the Banner Manager screen.

Screenshot

Details and Options

Details

• 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

• Target. How to open the link. Options are:
  • Parent Window with Browser Navigation. Open the link in the current browser window, allowing Back and Forward navigation.
  • New Window with Browser Navigation. Open the link in a new browser window, allowing Back and Forward navigation.
  • New Window without Browser Navigation. Open link in a new browser window, not allowing Back and Forward navigation.
• Count. (1-10) The number of Banners to display.
• Client. The Client for this Banner Module. Select from the drop-down list box of Banner Clients. Banner Clients are created in the Banner Client Manager screen.
• Category. The Category for this Banner Module. Select from the drop-down list box of Banner Categories. Banner Categories are created in the Banner Category Manager screen.
• Search By Tag. (Yes/No) Whether or not to select the Banner by matching the Banner Tags to the current document keywords.
• Randomise. (Sticky, Ordering / Sticky, Randomise) "Sticky, Ordering" means that the Banners will display sequentially. If any banners have been designated "sticky" only they will be shown sequentially until they use up their allotted impressions (unless they have unlimited impressions) and then non-sticky banners will be displayed in sequence. "Sticky, Randomise" means that the Banners will be displayed in random order, again with only sticky banners selected from in the random group as long as their are active sticky banners.
• Header Text. Text to display before the Banner group.
• Footer Text. Text to display after the Banner group.

Advanced Options

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

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

At the top right you will see the toolbar:

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

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. Banners module shown:

The Module Type name for this Module is "mod_banners". It is not related to any other component.