Actions

Help33

Difference between revisions of "Extensions Module Manager Feed Display"

From Joomla! Documentation

m (Menu Assignment: categorisation for 3.2 help screens)
(introduced how-to-access-module)
Line 1: Line 1:
=Feed Display Module=
+
{{Chunk30:ModuleManager-How-to-acces-module|module=Feed Display}}
==Overview==
+
=Overview=
 
This Module shows an RSS News Feed from a website. An example is shown below:[[Image:Help30-Extensions-Module-Manager-Feed-Display-example-output.png]] The Module Type name for this Module is "mod_feed". This Module is not related to the News Feeds Component or the News Feeds Layouts in the [[Screen.menus.edit.15#Single Feed Layout|Menu Items - New/Edit]] screen but is an alternative that allows a feed to display in a Module position.
 
This Module shows an RSS News Feed from a website. An example is shown below:[[Image:Help30-Extensions-Module-Manager-Feed-Display-example-output.png]] The Module Type name for this Module is "mod_feed". This Module is not related to the News Feeds Component or the News Feeds Layouts in the [[Screen.menus.edit.15#Single Feed Layout|Menu Items - New/Edit]] screen but is an alternative that allows a feed to display in a Module position.
  
==Toolbar==
+
=Toolbar=
 
{{Chunk30:Help_screen_module_manager_edit_toolbar}}
 
{{Chunk30:Help_screen_module_manager_edit_toolbar}}
  
==Details==
+
=Basic Options=
 
+
==Basic Options==
+
 
[[Image:Help30-Extensions-Module-Manager-Feed-Display-basic-options-parameters.png]]
 
[[Image:Help30-Extensions-Module-Manager-Feed-Display-basic-options-parameters.png]]
 
{{colheader|Module Class Suffix}}
 
{{colheader|Module Class Suffix}}
Line 19: Line 17:
 
*'''Word Count.''' The maximum number of words to display in the Item Description. A value of 0 will display the entire Item Description.
 
*'''Word Count.''' The maximum number of words to display in the Item Description. A value of 0 will display the entire Item Description.
  
==Advanced Options==
+
=Advanced Options=
 
[[Image:Help30-Extensions-Module-Manager-Feed-Display-advanced-options-parameters]]
 
[[Image:Help30-Extensions-Module-Manager-Feed-Display-advanced-options-parameters]]
 
{{colheader|Caching}}
 
{{colheader|Caching}}
 
*'''Cache Time.''' The length of time, in seconds, before the Module is re-cached.
 
*'''Cache Time.''' The length of time, in seconds, before the Module is re-cached.
  
==Menu Assignment==
+
=Menu Assignment=
  
 
<noinclude>{{cathelp|3.0,3.1,3.2|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 20:16, 6 December 2013

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

  • Select Extensions  Module Manager

Click the 'New' button and click on Feed Display in the modal popup window.

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

Contents

Overview

This Module shows an RSS News Feed from a website. An example is shown below:File:Help30-Extensions-Module-Manager-Feed-Display-example-output.png The Module Type name for this Module is "mod_feed". This Module is not related to the News Feeds Component or the News Feeds Layouts in the Menu Items - New/Edit screen but is an alternative that allows a feed to display in a Module 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.

Basic Options

File:Help30-Extensions-Module-Manager-Feed-Display-basic-options-parameters.png

  • 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.
  • Feed URL. The URL address of the RSS news feed.
  • Feed Title. Whether or not to display the Feed Title.
  • Feed Description. Whether or not to display the Feed Description.
  • Feed Image. Whether or not to display the Feed Image.
  • Items. The number of news feed items to display.
  • Item Description. Whether or not to show the Description or Into Text of individual items.
  • Word Count. The maximum number of words to display in the Item Description. A value of 0 will display the entire Item Description.

Advanced Options

File:Help30-Extensions-Module-Manager-Feed-Display-advanced-options-parameters

  • 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 seconds, before the Module is re-cached.

Menu Assignment