Actions

Help33

Difference between revisions of "Extensions Module Manager Articles Category"

From Joomla! Documentation

(Ordering Options: Add section)
(Advanced Options: Add section)
(One intermediate revision by one user not shown)
Line 29: Line 29:
  
 
====Filtering Options====
 
====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====
 
====Ordering Options====
Line 40: Line 57:
  
 
====Advanced Options====
 
====Advanced Options====
 +
{{Chunk30:Module Advanced Options}}
  
 
===Menu Assignment===
 
===Menu Assignment===

Revision as of 09:26, 14 July 2013

Contents

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 an Articles Category Modules Title or click the Articles Category 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-module-manager-articles-category-screenshot.png

Details and Options

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.

Options

Basic Options

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

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

Help30-module-manager-articles-category-filtering-options.png

  • Featured Articles. (Show/Hide/Only) Choose whether featured articles are displayed or not in the list of articles. Selecting only means only featured articles are displayed.

Chunk30:Help screen column header Count Chunk30:Filtering Type Chunk30:Help screen column header Filtering Category Chunk30:Help screen column header Child Category Articles Chunk30:Help screen column header Category Depth Chunk30:Filtering Type Chunk30:Help screen column header Authors Filtering Chunk30:Filtering Type Chunk30:Help screen column header Author Alias Filtering Chunk30:Help screen column header ID to exclude Chunk30:Help screen column header Date Filtering Chunk30:Help screen column header Date Range Field Chunk30:Help screen column header Start Date Range Chunk30:Help screen column header To Date Chunk30:Help screen column header Relative Date

Ordering Options

Help30-module-manager-articles-category-ordering-options.png

  • Articles Field to Order By. Order of articles in this Layout. The following options are available.
    • Article Manager Order: Use the default value from the component options screen.
    • Featured Articles Order: Articles are ordered according to the Order column entered in Article Manager: Featured Article.
    • Hits: Articles are ordered by the number of hits
    • Title: Articles are ordered by Title
    • ID: Articles are ordered by their ID
    • Alias: Articles are ordered by their Alias
    • Created Date: Articles are ordered by their created date.
    • Modified Date: Articles are ordered by their modified date.
    • Start Publishing Date: Articles are ordered by their start publish date.
    • Finish Publishing Date: Articles are ordered by their end publish date.
  • Ordering Direction. Order of articles in this Layout. The following options are available.
    • Ascending: Order the above option in an ascending order. If a field is selected with a name then this is in alphabetical order.
    • Descending: Order the above option in an descending order. If a field is selected with a name then this is in reverse alphabetical order.

Grouping Options

Display Options

Advanced Options

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.

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