Actions

Help33

Difference between revisions of "Extensions Module Manager Articles Category"

From Joomla! Documentation

(Advanced Options: Add section)
m (updated)
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RightTOC}}
 
==How to Access==
 
To ''''add'''' a new Articles Category module or ''''edit'''' an existing Articles Category module, navigate to the [[Help31:Extensions_Module_Manager|Module Manager]]:
 
* Select {{rarr|Extensions,Module Manager}}
 
 
Click the ''''New'''' button and click on Articles Category in the modal popup window.
 
 
To ''''Edit'''' an existing Articles Category module, in the Module Manager click on an '''Articles Category Modules Title''' or click the '''Articles Category modules check box''' and then click the '''Edit''' button in the Toolbar.
 
 
 
==Description==
 
==Description==
This module displays a list of articles from one or more categories.
+
This module displays a list of published articles from one or more categories.
  
==Screenshot==
+
==How to Access==
[[File:Help30-module-manager-articles-category-screenshot.png]]
+
{{Chunk30:ModuleManager-How-to-acces-module|module=Articles Category}}
  
==Details and Options==
+
{{Chunk30:Help-3x-module-site-articles-category}}
  
===Details===
+
===Common Details===
 
{{Chunk30:Module Details}}
 
{{Chunk30:Module Details}}
  
===Options===
+
===Common Tabs===
====Basic Options====
+
{{Chunk30:Help-3x-module-site-common-tabs}}
[[Image:Help30-module-manager-articles-category-basic-options.png]]
+
*'''Mode.''' (Normal/Dynamic) If Normal Mode is chosen, then simply configure the module and it will display a static list of Articles on the menu items you assign the module to. If Dynamic Mode is chosen, then you can still configure the module normally, however now the Category option will no longer be used. Instead, the module will dynamically detect whether or not you are on a Category view and will display the list of articles within that Category accordingly. When Dynamic Mode is chosen, it is best to leave the module set to display on all pages, as it will decide whether or not to display anything dynamically.
+
 
+
====Dynamic Mode Options====
+
[[Image:Help30-module-manager-articles-category-dynamic-options.png]]
+
*'''Show on Article Page.''' (Show/Hide) Choose whether to display the module on article pages or not. If hidden the module will only display itself dynamically on category pages.
+
 
+
====Filtering Options====
+
[[Image:Help30-module-manager-articles-category-filtering-options.png]]
+
{{Chunk30:colheader|Featured Articles}}
+
{{Chunk30:colheader|Count}}
+
{{Chunk30:Filtering Type|category}}
+
{{Chunk30:colheader|Filtering Category}}
+
{{Chunk30:colheader|Child Category Articles}}
+
{{Chunk30:colheader|Category Depth}}
+
{{Chunk30:Filtering Type|author}}
+
{{Chunk30:colheader|Authors Filtering}}
+
{{Chunk30:Filtering Type|author alias}}
+
{{Chunk30:colheader|Author Alias Filtering}}
+
{{Chunk30:colheader|ID to exclude}}
+
{{Chunk30:colheader|Date Filtering}}
+
{{Chunk30:colheader|Date Range Field}}
+
{{Chunk30:colheader|Start Date Range}}
+
{{Chunk30:colheader|To Date}}
+
{{Chunk30:colheader|Relative Date}}
+
 
+
====Ordering Options====
+
[[Image:Help30-module-manager-articles-category-ordering-options.png]]
+
{{Chunk30:colheader|Articles Field to Order By}}
+
{{Chunk30:colheader|Ordering Direction}}
+
 
+
====Grouping Options====
+
 
+
====Display Options====
+
 
+
====Advanced Options====
+
{{Chunk30:Module Advanced Options}}
+
 
+
===Menu Assignment===
+
{{Chunk30:Menu Assignment}}
+
  
 
==Toolbar==
 
==Toolbar==
Line 73: Line 24:
 
The Module Type name for this Module is "mod_articles_category". It is related to the content component.
 
The Module Type name for this Module is "mod_articles_category". It is related to the content component.
  
<noinclude>{{cathelp|3.0,3.1|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 22:38, 6 December 2013

Contents

Description

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

How to Access

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

  • Select Extensions  Module Manager

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

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

Screenshot

Help-3x-modules-site-module-manager-module-articles-category.png

Details

  • Title: Module must have a title

Module

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

  • Mode: (Normal/Dynamic). Please select the mode you would like to use. If Normal Mode is chosen, then simply configure the module and it will display a static list of Articles on the menu items you assign the module to. If Dynamic Mode is chosen, then you can still configure the module normally, however now the Category option will no longer be used. Instead, the module will dynamically detect whether or not you are on a Category view and will display the list of articles within that Category accordingly. When Dynamic Mode is chosen, it is best to leave the module set to display on all pages, as it will decide whether or not to display anything dynamically.

Dynamic Mode Options

Help-3x-modules-site-module-manager-module-articles-category-dynamic-mode-options.png
  • Show on Article Page: (Show/Hide). Select to Show or Hide Article List from Article Pages. This means that the module will only display itself dynamically on Category Pages.

Filtering Options

Help-3x-modules-site-module-manager-module-articles-category-filtering-options.png
  • Featured Articles: (Show/Hide/Only). Select to Show, Hide, or Only display Featured Articles.
  • Count: The number of items to display. The default value of 0 will display all articles.
  • Category Filtering Type: (Inclusive/Exclusive). Select Inclusive to Include the Selected Categories, Exclusive to Exclude the Selected Categories.
  • Category: Please select one or more categories.
  • Child Category Articles: (Include/Exclude). Include or Exclude Articles from Child Categories.
  • Category Depth: The number of child category levels to return.
  • Author Filtering Type: (Inclusive/Exclusive). Select Inclusive to Include the Selected Authors, Exclusive to Exclude the Selected Authors.
  • Authors: Select one or more authors from the list below.
  • Author Alias Filtering Type: (Inclusive/Exclusive). Select Inclusive to Include the Selected Author Aliases, Exclusive to Exclude the Selected Author Aliases.
  • Author Aliases: Select one or more author aliases from the list below.
  • Article IDs to Exclude: Please enter each Article ID on a new line.
  • Date Filtering: (Off/Date Range/Relative Date). Select Date Filtering Type.
  • Date Range Field: (Created Date/Modified Date/Start Publishing Date). Select which date field you want the date range to be applied to.
  • Start Date Range: If Date Range is selected above, please enter a Starting Date.
  • To Date: If Date Range is selected above, please enter an End Date.
  • Relative Date: If Relative Date is selected above, please enter in a numeric day value. Results will be retrieved relative to the current date and the value you enter.

Ordering Options

Help-3x-modules-site-module-manager-module-articles-category-ordering-options.png
  • Article Field to Order By: (Article Manager Order/Featured Articles Order/Hits/Title/ID/Alias/Created Date/...). Select which field you would like Articles to be ordered by. Featured Ordering should only be used when Filtering Option for Featured Articles is set to 'Only'.
  • Ordering Direction: (Descending/Ascending). Select the direction you would like Articles to be ordered by.

Grouping Options

Help-3x-modules-site-module-manager-module-articles-category-grouping-options.png
  • Article Grouping: (None/Year/Month and Year/Author/Category). Select how you would like the articles to be grouped.
  • Grouping Direction: (Descending/Ascending). Select the direction you would like the Article Groupings to be ordered by.
  • Month and Year Display Format: Please enter in a valid date format. See: http://php.net/date for formatting information.

Display Options

Help-3x-modules-site-module-manager-module-articles-category-display-options.png
  • Linked Titles: (Yes/No).
  • Date: (Show/Hide). Select Show if you would like the date displayed.
  • Date Field: (Created Date/Modified Date/Start Publishing Date). Select which date field you want to display.
  • Date Format: Please enter in a valid date format. See: http://php.net/date for formatting information.
  • Category: (Show/Hide). Select Show if you would like the category name displayed.
  • Hits: (Show/Hide). Select Show if you would like the hits for each article to be displayed.
  • Author: (Show/Hide). Select Show if you would like the author (or author alias instead, if available) to be displayed.
  • Introtext: (Show/Hide). Select Show if you would like the introtext to be displayed.
  • Introtext Limit: Please enter in a numeric character limit value. The introtext will be trimmed to the number of characters you enter.
  • Show "Read More": (Show/Hide). If set to Show, the Read more... Link will show if Main text has been provided for the Article.
  • Show Title with Read More: (Show/Hide). If set to show the Title of the Article will be shown on the Read More button
  • Read More Limit: Set a limit of number of characters in Article Title to show in Read More button

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.

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 Category module shown:

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

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