Actions

Help33

Difference between revisions of "Extensions Module Manager Banners"

From Joomla! Documentation

m (Menu Assignment: updating Help screens relevant versions)
m (Toolbar: clean up)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
==How to Access==
 
 
==Description==
 
==Description==
This Module allows you to show active Banners from the Banner Component created in the [[screen.banners.15|Banner Manager]] screen. The Module Type name for this is "mod_banners".
+
The Banner Module displays the active Banners from the Component.
  
==Screenshot==
+
==How to Access==
[[Image:Extensions-Module-Manager-Banners-screen.png]]
+
{{Chunk30:ModuleManager-How-to-acces-module|module=Banners}}
  
==Toolbar==
+
{{Chunk30:Help-3x-module-site-banners}}
{{Chunk30:Help_screen_module_manager_edit_toolbar}}
+
  
==Details==
+
===Common Details===
 +
{{Chunk30:Module Details}}
  
==Basic Options==
+
===Common Tabs===
[[Image:Extensions-Module-Manager-Banners-basic-options-parameters.png]]
+
{{Chunk30:Help-3x-module-site-common-tabs}}
{{colheader|Target}}
+
*'''Count.''' The number of Banners to display.
+
*'''Banner Client.''' The Client for this Banner Module. Select from the drop-down list box of Banner Clients. Banner Clients are created in the [[screen.banners.client.15|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 [[screen.bannercategories.15|Banner Category Manager]] screen.
+
*'''Search By Tags.''' Whether or not to select the Banner by matching the Banner Tags to the current Article 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.
+
{{colheader|Module Class Suffix}}
+
  
==Advanced Options==
+
==Toolbar==
[[Image:Extensions-Module-Manager-Banners-advanced-options-parameters.png]]
+
{{Chunk30:Help_screen_module_manager_edit_toolbar}}
{{colheader|Caching}}
+
{{colheader|Cache Time}}
+
  
==Menu Assignment==
 
  
<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

The Banner Module displays the active Banners from the Component.

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 the Banners Module's Title or click the Banners module's check box and then click the Edit button in the Toolbar.

Screenshot

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

Details

  • Title: Module must have a title

Module

The Banner Module displays the active Banners from the Component.

  • Target: (Open in parent window/Open in new window/Open in popup). Target window when the link is clicked
  • Count: (1/2/3/4/5/6/7/...). The number of banners to display (default 5)
  • Client: (No client/Bookstore/Joomla!/Shop). Select banners only from a single client.
  • Category: Select banners from a specific Category or a set of Categories. If no selection then it will show all categories as default.
  • Search by Meta Keyword: (Yes/No). Banner is selected by matching the banner tags to the current document meta keywords.
  • Randomise: (Sticky, Ordering/Sticky, Randomise). Randomise the ordering of the banners
  • Header Text: Text or HTML to display before the group of banners
  • Footer Text: Text or HTML to display after the group of banners

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.