Actions

Help33

Difference between revisions of "Extensions Module Manager Articles Categories"

From Joomla! Documentation

(Menu Assignment)
(Advanced Options)
Line 21: Line 21:
 
{{colheader|Module Class Suffix}}
 
{{colheader|Module Class Suffix}}
  
===Advanced Options===
+
{{Chunk30:Module Advanced Options 2}}
[[Image:Extensions-Module-Manager-Articles-Categories-advanced-options-parameters.png]]
+
{{colheader|Caching}}
+
{{colheader|Cache Time}}
+
  
 
===Menu Assignment===
 
===Menu Assignment===

Revision as of 13:43, 2 July 2013

Contents

How to Access

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

  • Select Extensions  Module Manager

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

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

Description

This module displays a list of articles from one or more categories.

Screenshot

Help30-Extensions-Module-Manager-Articles-Categories-screen.png

Details

Basic Options

Extensions-Module-Manager-Articles-Categories-basic-options-parameters.png

  • Count. The number of Sections to display. The default value is 5.
  • 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! 1.5/1.6 for more information.

Help30-module-manager-advanced-options-screenshot-2.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.
  • Heading Style. (h1/h2/h3/h4/h5) Choose the heading style to use.
  • 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.

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

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.

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.

Articles Categories module shown:

Help30-module-manager-articles-categories-frontend-screenshot.png

The Module Type name for this Module is "mod_articles_categories". It is related to the content component.