Actions

Help25

Difference between revisions of "Extensions Module Manager Most Read"

From Joomla! Documentation

(Added toolbar section.)
m (removing needs images)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
===Most Read Content===
+
{{RightTOC}}
This Module displays a list of Articles with the highest hit counts. An example is shown below:[[Image:most_read_example.png|frame|center]]
+
==How to Access==
 +
To ''''add'''' a new Menu or ''''edit'''' an existing Most Read Module, navigate to the [[Help25:Extensions_Module_Manager|Module Manager]]:
 +
* Select {{rarr|Extensions,Module Manager}}
  
The Module Type name for this is "mod_mostread". This Module is not related to any other component.  
+
Click the ''''New'''' button and click on Most Read Content in the modal popup window.
  
'''Module Parameters'''
+
To ''''Edit'''' an existing Most Read Module, in the Module Manager click on an '''Most Read Modules Title''' or click the '''Most Read Modules check box''' and then click the '''Edit''' button in the Toolbar.
[[Image:most_read_parameters.png|frame|center]]
+
{{colheader|Module Class Suffix}}
+
*'''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 [[screen.contentcategories.15|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 [[screen.sections.15|Section Manager]] screen.
+
  
'''Advanced Parameters'''
+
==Description==
[[Image:most_read_advanced.png|frame|center]]
+
This Module displays a list of Articles with the highest hit counts.
{{colheader|Caching}}
+
 
{{colheader|Cache Time}}
+
==Screenshot==
 +
[[Image:Help25-module-manager-most-read-screenshot.png]]
 +
 
 +
==Details and Options==
 +
===Details===
 +
{{Chunk25:Module Details}}
 +
 
 +
===Basic Options===
 +
[[Image:Help25-module-manager-most-read-basic-options-screenshot.png]]
 +
{{Chunk25:colheader|category}}
 +
{{Chunk25:colheader|Article Count}}
 +
*'''Featured Articles.''' (Show/Hide) Show or Hide articles published to the front page.
 +
 
 +
===Advanced Options===
 +
{{Chunk25:Module Advanced Options}}
 +
 
 +
===Menu Assignment===
 +
{{Chunk25:Menu Assignment}}
  
 
==Toolbar==
 
==Toolbar==
 
{{Chunk25:Help_screen_module_manager_edit_toolbar}}
 
{{Chunk25:Help_screen_module_manager_edit_toolbar}}
  
<noinclude>{{cathelp|2.5|Module Manager|Extensions}}</noinclude>
+
==Front End Screenshot==
 +
{{Chunk25:Help screen screenshot disclaimer}}
 +
Most Read Content module shown:
 +
 
 +
[[Image:Help25-module-manager-most-read-frontend-screenshot.png]]
 +
 
 +
The Module Type name for this Module is "mod_articles_popular". It is related to the Content component.
 +
 
 +
<noinclude>{{cathelp|2.5|Module Manager Help Screens|Extensions Help Screens}}</noinclude>

Latest revision as of 13:56, 10 April 2013

Contents

How to Access

To 'add' a new Menu 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 Content in the modal popup window.

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

Description

This Module displays a list of Articles with the highest hit counts.

Screenshot

Help25-module-manager-most-read-screenshot.png

Details and Options

Details

Help25-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/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

Help25-module-manager-most-read-basic-options-screenshot.png

  • Category. Choose one or more categories for the articles to be displayed from.
  • Count. The number of Articles to show.
  • Featured Articles. (Show/Hide) Show or Hide articles published to the front page.

Advanced Options

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

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

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:

Help25-Toolbar-Save-SaveClose-SaveNew-SaveCopy-Close-Help.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. Most Read Content module shown:

Help25-module-manager-most-read-frontend-screenshot.png

The Module Type name for this Module is "mod_articles_popular". It is related to the Content component.