Actions

Help25

Difference between revisions of "Extensions Module Manager Articles Archive"

From Joomla! Documentation

(Added toolbar section.)
Line 1: Line 1:
===Archived Content===
+
=Archived Articles Module=
 +
==Overview==
 
This Module shows Articles that have been set to Archived. The Articles are available behind a Month/Year directory list, as shown in the example below.[[Image:Archive_module1.png|frame|center]] Selecting a month link shows a screen like the one below.[[Image:Archive_module2.png|frame|center]]
 
This Module shows Articles that have been set to Archived. The Articles are available behind a Month/Year directory list, as shown in the example below.[[Image:Archive_module1.png|frame|center]] Selecting a month link shows a screen like the one below.[[Image:Archive_module2.png|frame|center]]
 
Articles are stored by creation date not archival date. Only those months and years with archived Articles will be displayed. This list is generated automatically.
 
Articles are stored by creation date not archival date. Only those months and years with archived Articles will be displayed. This list is generated automatically.
Line 5: Line 6:
 
The Module Type name for this is "mod_archive". This module does not relate to any other component. This Module provides functionality that is similar to the Archived Article List Layout available on the [[screen.menus.edit.15#Archived Article List|Menu Item Manager New / Edit]] screen.
 
The Module Type name for this is "mod_archive". This module does not relate to any other component. This Module provides functionality that is similar to the Archived Article List Layout available on the [[screen.menus.edit.15#Archived Article List|Menu Item Manager New / Edit]] screen.
  
'''Module Parameters'''
+
==Toolbar==
 +
{{Chunk25:Help_screen_module_manager_edit_toolbar}}
 +
 
 +
==Details==
 +
 
 +
==Basic Options==
 
[[Image:Archive_module_parameters1.png|frame|center]]
 
[[Image:Archive_module_parameters1.png|frame|center]]
 
*'''Count.''' The number of months to show in the module. When the Archived Articles filter shows, you may retrieve archived Articles from any month by changing the filter settings.
 
*'''Count.''' The number of months to show in the module. When the Archived Articles filter shows, you may retrieve archived Articles from any month by changing the filter settings.
 
{{colheader|Module Class Suffix}}
 
{{colheader|Module Class Suffix}}
  
'''Advanced Parameters'''
+
==Advanced Options==
 
[[Image:Archive_module_parameters2.png|frame|center]]
 
[[Image:Archive_module_parameters2.png|frame|center]]
 
{{colheader|Caching}}
 
{{colheader|Caching}}
  
==Toolbar==
+
==Menu Assignment==
{{Chunk25:Help_screen_module_manager_edit_toolbar}}
+
  
 
<noinclude>{{cathelp|2.5|Module Manager|Extensions}}</noinclude>
 
<noinclude>{{cathelp|2.5|Module Manager|Extensions}}</noinclude>

Revision as of 16:33, 31 December 2011

Contents

Archived Articles Module

Overview

This Module shows Articles that have been set to Archived. The Articles are available behind a Month/Year directory list, as shown in the example below.

Archive module1.png

Selecting a month link shows a screen like the one below.

Archive module2.png

Articles are stored by creation date not archival date. Only those months and years with archived Articles will be displayed. This list is generated automatically.

The Module Type name for this is "mod_archive". This module does not relate to any other component. This Module provides functionality that is similar to the Archived Article List Layout available on the Menu Item Manager New / Edit screen.

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.

Details

Basic Options

Archive module parameters1.png
  • Count. The number of months to show in the module. When the Archived Articles filter shows, you may retrieve archived Articles from any month by changing the filter settings.
  • 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.

Advanced Options

Archive module parameters2.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.

Menu Assignment