Actions

Help33

Difference between revisions of "Extensions Module Manager Most Read"

From Joomla! Documentation

m (1 revision: Initial import of 3.0 help screens (derived from 2.5 help screens))
m (forgot to change module name)
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
=Most Read Content Module=
+
{{Chunk30:ModuleManager-How-to-acces-module|module=Most Read}}
 
+
=Overview=
==Overview==
+
 
This Module displays a list of Articles with the highest hit counts. An example is shown below:[[Image:Help30-Extensions-Module-Manager-Most-Read-example-output.png]]
 
This Module displays a list of Articles with the highest hit counts. An example is shown below:[[Image:Help30-Extensions-Module-Manager-Most-Read-example-output.png]]
  
 
The Module Type name for this is "mod_mostread". This Module is not related to any other component.  
 
The Module Type name for this is "mod_mostread". This Module is not related to any other component.  
  
==Toolbar==
+
=Toolbar=
 
{{Chunk30:Help_screen_module_manager_edit_toolbar}}
 
{{Chunk30:Help_screen_module_manager_edit_toolbar}}
  
==Details==
+
=Basic Options=
 
+
==Basic Options==
+
 
[[Image:Help30-Extensions-Module-Manager-Most-Read-basic-options-parameters.png]]
 
[[Image:Help30-Extensions-Module-Manager-Most-Read-basic-options-parameters.png]]
 
{{colheader|Module Class Suffix}}
 
{{colheader|Module Class Suffix}}
Line 19: Line 16:
 
*'''Section ID.''' Optional list of Section ID's. This will include only Articles in the listed Sections. Type a list of Section ID's, separated by a comma (for example, "1,4"). You can find the Section ID in the ID column of the [[screen.sections.15|Section Manager]] screen.
 
*'''Section ID.''' Optional list of Section ID's. This will include only Articles in the listed Sections. Type a list of Section ID's, separated by a comma (for example, "1,4"). You can find the Section ID in the ID column of the [[screen.sections.15|Section Manager]] screen.
  
==Advanced Options==
+
=Advanced Options=
 
[[Image:Help30-Extensions-Module-Manager-Most-Read-advanced-options.png]]
 
[[Image:Help30-Extensions-Module-Manager-Most-Read-advanced-options.png]]
 
{{colheader|Caching}}
 
{{colheader|Caching}}
 
{{colheader|Cache Time}}
 
{{colheader|Cache Time}}
  
==Menu Assignment==
+
=Menu Assignment=
  
<noinclude>{{cathelp|3.0|Module Manager Help Screens|Extensions Help Screens}}</noinclude>
+
<noinclude>{{cathelp|3.0,3.1,3.2|Module Manager Help Screens|Extensions Help Screens}}</noinclude>

Revision as of 20:04, 6 December 2013

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

  • Select Extensions  Module Manager

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

To 'Edit' an existing Most Read module, in the Module Manager click on the Most Read Module's Title or click the Most Read module's check box and then click the Edit button in the Toolbar.

Contents

Overview

This Module displays a list of Articles with the highest hit counts. An example is shown below:File:Help30-Extensions-Module-Manager-Most-Read-example-output.png

The Module Type name for this is "mod_mostread". This Module is not related to any other component.

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.

Basic Options

File:Help30-Extensions-Module-Manager-Most-Read-basic-options-parameters.png

  • 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.
  • Front Page Articles. Whether to Show or Hide Front Page Articles in the list.
  • Count. The number of Articles to display in the list. The default value is 5.
  • Category ID. Optional list of Category ID's. This will include only Articles in the listed Categories. Type a list of Category ID's, separated by a comma (for example, "29,31"). You can find the Category ID in the ID column of the Category Manager screen.
  • Section ID. Optional list of Section ID's. This will include only Articles in the listed Sections. Type a list of Section ID's, separated by a comma (for example, "1,4"). You can find the Section ID in the ID column of the Section Manager screen.

Advanced Options

File:Help30-Extensions-Module-Manager-Most-Read-advanced-options.png

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

Menu Assignment