Help310

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
 
(51 intermediate revisions by 4 users not shown)
Line 1: Line 1:
=Most Read Content Module=
+
<noinclude><languages /></noinclude>
  
==Overview==
+
{{Chunk30:Help_screen_Description_Header/<translate><!--T:31--> en</translate>}}
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]]
+
{{Chunk30:Extensions Module Manager Articles Most Read Description/<translate><!--T:28--> en</translate>}}
  
The Module Type name for this is "mod_mostread". This Module is not related to any other component.  
+
{{Chunk30:Help_screen_How_To_Access_Header/<translate><!--T:32--> en</translate>}}
 +
{{Chunk30:Help_screen_How_To_Access_Module_Add/<translate><!--T:34--> en</translate>|<translate><!--T:35--> Articles - Most Read</translate>}}
 +
{{Chunk30:Help_screen_How_To_Access_By_Menu/<translate><!--T:36--> en</translate>|<translate><!--T:37--> Extensions,Modules</translate>}}.
 +
{{Chunk30:Help_screen_How_To_Access_By_Button/<translate><!--T:38--> en</translate>|<translate><!--T:39--> New</translate>|<translate><!--T:40--> toolbar</translate>}}
 +
{{Chunk30:Help_screen_How_To_Access_Module_Select/<translate><!--T:41--> en</translate>|<translate><!--T:42--> Articles - Most Read</translate>}}
 +
{{Chunk30:Help_screen_How_To_Access_Module_Edit/<translate><!--T:43--> en</translate>|<translate><!--T:44--> Articles - Most Read</translate>}}
 +
{{Chunk30:Help_screen_How_To_Access_Module_By_Title/<translate><!--T:45--> en</translate>}}
  
==Toolbar==
+
{{Chunk30:Help_screen_Screenshot_Header/<translate><!--T:33--> en</translate>}}
{{Chunk30:Help_screen_module_manager_edit_toolbar}}
+
[[Image:help-3x-modules-site-module-manager-module-most-read-content-<translate><!--T:7--> en</translate>.png|800px|border]]
  
==Details==
+
{{Chunk30:Help_screen_Form_Header/<translate><!--T:46--> en</translate>}}
 +
{{Chunk30:Help_screen_Module_Title/<translate><!--T:118--> en</translate>}}
 +
{{Chunk30:Help_screen_Form_Module_Header/<translate><!--T:49--> en</translate>}}
 +
<translate><!--T:11--> *'''Category'''. Select Articles from a specific Category or a set of Categories. If no selection will show all categories as default.</translate>
  
==Basic Options==
+
<translate><!--T:12--> *'''Count''' The number of Articles to display (the default is 5).</translate>
[[Image:Help30-Extensions-Module-Manager-Most-Read-basic-options-parameters.png]]
 
{{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 Options==
+
<translate><!--T:13--> *'''Featured Articles'''. (''Show''/''Hide'') Show or hide Articles designated as Featured.</translate>
[[Image:Help30-Extensions-Module-Manager-Most-Read-advanced-options.png]]
 
{{colheader|Caching}}
 
{{colheader|Cache Time}}
 
  
==Menu Assignment==
+
<translate><!--T:14--> *'''Date Filtering'''. (''Off''/''Date Range''/''Relative Date'') Select Date Filtering Type.</translate>
 +
<translate><!--T:15--> **'''Date Range'''.</translate>
 +
<translate><!--T:16--> ***'''Date Field'''. (''Created Date''/''Modified Date''/''Start Publishing Date'') Select which date field you want the date filter to be applied to.</translate>
 +
<translate><!--T:17--> ***'''Start Date Range'''. Please enter a Starting Date.</translate>
 +
<translate><!--T:18--> ***'''End Date'''. Please enter an End Date.</translate>
 +
<translate><!--T:19--> **'''Relative Date'''.</translate>
 +
<translate><!--T:20--> ***'''Date Field'''. (''Created Date''/''Modified Date''/''Start Publishing Date'') Select which date field you want the date filter to be applied to.</translate>
 +
<translate><!--T:21--> ***'''Relative Date'''. Please enter a numeric day value. Results will be retrieved relative to the current date and the value you enter.</translate>
 +
----
 +
:[[File:Help30-module-manager-details-screenshot-<translate><!--T:131--> en</translate>.png|265px|border|right|<translate><!--T:132--> Module sidebar</translate>]]
 +
{{Chunk30:Help_screen_Module_Show_Title/<translate><!--T:133--> en</translate>}}
 +
{{Chunk30:Help_screen_Module_Position/<translate><!--T:134--> en</translate>}}
 +
{{Chunk30:Help_screen_Status/<translate><!--T:135--> en</translate>|2=}}
 +
{{Chunk30:Help_screen_Start_Publishing/<translate><!--T:125--> en</translate>}}
 +
{{Chunk30:Help_screen_Finish_Publishing/<translate><!--T:126--> en</translate>}}
 +
{{Chunk30:Help_screen_Access/<translate><!--T:127--> en</translate>}}
 +
{{Chunk30:Help_screen_Module_Ordering/<translate><!--T:128--> en</translate>}}
 +
{{Chunk30:Help_screen_Language/<translate><!--T:129--> en</translate>}}
 +
{{Chunk30:Help_screen_Note/<translate><!--T:130--> en</translate>}}
 +
{{Chunk30:Help_screen_Form_Module_Menu_Assignment/<translate><!--T:64--> en</translate>}}
 +
:[[File:Help30-module-manager-menu-assignment-screenshot-<translate><!--T:65--> en</translate>.png|800px|none]]
 +
{{Chunk30:Help_screen_Module_Menu_Assignment/<translate><!--T:66--> en</translate>}}
 +
{{Chunk30:Help_screen_Form_Advanced_Header/<translate><!--T:112--> en</translate>}}
 +
:[[File:Help30-module-manager-advanced-options-screenshot-<translate><!--T:68--> en</translate>.png|300px|none]]
 +
{{Chunk30:Help_screen_Module_Layout/<translate><!--T:69--> en</translate>}}
 +
{{Chunk30:Help_screen_Module_Class_Suffix/<translate><!--T:70--> en</translate>}}
 +
{{Chunk30:Help_screen_Caching/<translate><!--T:71--> en</translate>}}
 +
{{Chunk30:Help_screen_Cache_Time/<translate><!--T:72--> en</translate>}}
 +
{{Chunk30:Help_screen_Module_Tag/<translate><!--T:73--> en</translate>}}
 +
{{Chunk30:Help_screen_Bootstrap_Size/<translate><!--T:74--> en</translate>}}
 +
{{Chunk30:Help_screen_Header_Tag/<translate><!--T:75--> en</translate>}}
 +
{{Chunk30:Help_screen_Header_Class/<translate><!--T:76--> en</translate>}}
 +
{{Chunk30:Help_screen_Module_Style/<translate><!--T:77--> en</translate>}}
 +
{{Chunk30:Help_screen_Form_Permissions_Header/<translate><!--T:78--> en</translate>}}
 +
{{Chunk30:Help_screen_Permissions_Manage/<translate><!--T:79--> en</translate>}}
 +
:[[File:Help30-module-manager-menu-permissions-screenshot-<translate><!--T:80--> en</translate>.png|800px|none]]
 +
{{Chunk30:Help_screen_Permissions_Change/<translate><!--T:81--> en</translate>|<translate><!--T:82--> this module</translate>}}
 +
{{Chunk30:Help_screen_Permissions_Select_Group/<translate><!--T:83--> en</translate>}}
 +
{{Chunk30:Help_screen_Permissions_Find_Action/<translate><!--T:84--> en</translate>}}
 +
{{Chunk30:Help_screen_Permissions_Delete/<translate><!--T:85--> en</translate>|<translate><!--T:86--> this module</translate>}}
 +
{{Chunk30:Help_screen_Permissions_Edit/<translate><!--T:87--> en</translate>|<translate><!--T:88--> this module</translate>}}
 +
{{Chunk30:Help_screen_Permissions_Edit_State/<translate><!--T:89--> en</translate>|<translate><!--T:90--> this module</translate>}}
 +
{{Chunk30:Help_screen_Permissions_Frontend_Editing/<translate><!--T:91--> en</translate>}}
 +
{{Chunk30:Help_screen_Permissions_Select/<translate><!--T:92--> en</translate>}}
 +
{{Chunk30:Help_screen_Permissions_Inherited/<translate><!--T:93--> en</translate>|<translate><!--T:94--> this site</translate>|<translate><!--T:95--> module options</translate>}}
 +
{{Chunk30:Help_screen_Permissions_Allowed/<translate><!--T:113--> en</translate>}}
 +
{{Chunk30:Help_screen_Permissions_Denied/<translate><!--T:114--> en</translate>}}
 +
{{Chunk30:Help_screen_Permissions_Save/<translate><!--T:115--> en</translate>}}
  
<noinclude>{{cathelp|3.0|Module Manager Help Screens|Extensions Help Screens}}</noinclude>
+
{{Chunk30:Help_screen_Toolbar_Header/<translate><!--T:47--> en</translate>}}
 +
{{Chunk30:Help_screen_Toolbar_Position/<translate><!--T:99--> en</translate>}}
 +
:[[File:Help32-Save-SaveClose-SaveNew-SaveAsCopy-Close-toolbar-<translate><!--T:100--> en</translate>.png|800px|none]]
 +
{{Chunk30:Help_screen_Toolbar_Function/<translate><!--T:101--> en</translate>}}
 +
{{Chunk30:Help_screen_toolbar_icon_Save/<translate><!--T:102--> en</translate>|<translate><!--T:103--> module</translate>}}
 +
{{Chunk30:Help_screen_toolbar_icon_SaveAndClose/<translate><!--T:104--> en</translate>|<translate><!--T:105--> module</translate>}}
 +
{{Chunk30:Help_screen_toolbar_icon_SaveAndNew/<translate><!--T:106--> en</translate>|<translate><!--T:107--> module</translate>}}
 +
{{Chunk30:Help_screen_toolbar_icon_SaveAsCopy/<translate><!--T:108--> en</translate>|<translate><!--T:109--> module</translate>}}
 +
{{Chunk30:Help_screen_toolbar_icon_Close/<translate><!--T:110--> en</translate>}}
 +
{{Chunk30:Help_screen_toolbar_icon_Help/<translate><!--T:111--> en</translate>}}
 +
 
 +
{{Chunk30:Help_screen_Related_Information_Header/<translate><!--T:48--> en</translate>}}
 +
{{Chunk30:Extensions Module Manager Related Information/<translate><!--T:30--> en</translate>}}
 +
 
 +
<noinclude>{{cathelp|3.0,3.1,3.2,3.3,3.4,3.5,3.6,3.7,3.8,3.9,3.10|Module Manager Help Screens|Extensions Help Screens}}</noinclude>

Latest revision as of 04:44, 28 March 2022

Other languages:
Deutsch • ‎English • ‎français


Description[edit]

This Module shows a list of the currently published Articles which have the highest number of page views.


How to Access[edit]

Add a new module 'Articles - Most Read'

  • Select Extensions  Modules from the dropdown menu of the Administrator Panel.
  • Click the New button in the toolbar
  • Select the Module Type Articles - Most Read.

Edit an existing module 'Articles - Most Read'

  • Click on the module's Title in Module.


Screenshot[edit]

Help-3x-modules-site-module-manager-module-most-read-content-en.png


Form Fields[edit]

  • Title. The title of the module. This is also the title displayed in the Frontend for the module.

Module[edit]

  • Category. Select Articles from a specific Category or a set of Categories. If no selection will show all categories as default.
  • Count The number of Articles to display (the default is 5).
  • Featured Articles. (Show/Hide) Show or hide Articles designated as Featured.
  • Date Filtering. (Off/Date Range/Relative Date) Select Date Filtering Type.
    • Date Range.
      • Date Field. (Created Date/Modified Date/Start Publishing Date) Select which date field you want the date filter to be applied to.
      • Start Date Range. Please enter a Starting Date.
      • End Date. Please enter an End Date.
    • Relative Date.
      • Date Field. (Created Date/Modified Date/Start Publishing Date) Select which date field you want the date filter to be applied to.
      • Relative Date. Please enter a numeric day value. Results will be retrieved relative to the current date and the value you enter.

Module sidebar
  • Show Title. (Show/Hide) Show or hide module title on display. Note: Effect will depend on the module style (chrome) in the template.
  • Position. You may select a module position from the list of pre-defined positions or enter your own module position by typing the name in the field and pressing enter.
  • Status. (Published/Unpublished/Trashed) The published status of the module.
  • 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).
  • Access. Who has access to this module.
    • Public: Everyone has access.
    • Guest: Everyone has access.
    • Registered: Only registered users have access.
    • Special: Only users with author status or higher have access.
    • Super Users: Only super users have access.
  • Ordering. This shows a dropdown 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 Frontend as well as in Modules.
  • Language. Select the language for this module. If you are not using the multi-language feature of Joomla, keep the default of All.
  • Note. Module note. This is normally for the site administrator's use (for example, to document information about this module) and does not show in the Frontend of the site.

Menu Assignment[edit]

Help30-module-manager-menu-assignment-screenshot-en.png
  • Module Assignment.
    • On all pages: Module is shown on all pages.
    • No pages: Module is not shown on any page.
    • Only on the pages selected: 'Menu Selection' will show with all the menu items on. You can assign modules by selecting the menu links that you want the module associated with on what pages modules appear.
    • On all pages except those selected: 'Menu Selection' list will show with all the menu items on. This allows you to assign modules by selecting the menu links that you want the module associated with on what pages modules don't appear.
    Learn how to assign a module to specific pages.

Advanced[edit]

Help30-module-manager-advanced-options-screenshot-en.png
  • 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.
  • 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 or custom.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.
  • Caching. (Use Global/No Caching) Whether or not to cache the content of this module. "Use Global" will use the settings from Global Configuration.
  • Cache Time. The number of minutes for which to cache the module locally. It can safely be left at the default.
  • Module Tag. The HTML tag for the module to be placed in. By default this is a div tag but other HTML5 elements (address, article, …) can also be used.
  • Bootstrap Size. (0/…/12) This allows you to choose the width of the module via the span element built into bootstrap.
  • Header Tag. (h1/h2/h3/h4/h5/h6/p/div) The HTML tag to use for the modules header or title. Note: You must use a module style (chrome) of html5 or add your custom module styles in [yourtemplate]/html/modules.php.
  • Header Class. Add optional CSS classes to the modules header or title element.
  • Module Style. Override the templates style for its position.

Permissions[edit]

Manage the permission settings for user groups.

Help30-module-manager-menu-permissions-screenshot-en.png

To change the permissions for this module, do the following.

1. Select the Group by clicking its title located on the left.
2. Find the desired Action. Possible Actions are:
  • Delete. Users can delete content of this module.
  • Edit. Users can edit content of this module.
  • Edit State. Users can change the published state and related information for content of this module.
  • Frontend Editing. Allows users in the group to edit in Frontend.
3. Select the desired Permission for the action you wish to change. Possible settings are:
  • Inherited: Inherited for users in this Group from the module options permissions of this site.
  • Allowed: Allowed for users in this Group. Note that, if this action is Denied at one of the higher levels, the Allowed permission here will not take effect. A Denied setting cannot be overridden.
  • Denied: Denied for users in this Group.
4. Click Save in Toolbar at top. When the screen refreshes, the Calculated Setting column will show the effective permission for this Group and Action.


Toolbar[edit]

At the top left you will see the toolbar.

Help32-Save-SaveClose-SaveNew-SaveAsCopy-Close-toolbar-en.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.
    Note: This toolbar icon is only shown if you edit an existing module.
  • Close. Closes the current screen and returns to the previous screen without saving any modifications you may have made.
  • Help. Opens this help screen.


Related Information[edit]

  • More about Modules: what is a module position, Description of the default Site and Administrator Modules.