Actions

Help25

Extensions Module Manager Feed Display

From Joomla! Documentation

Revision as of 07:46, 8 April 2013 by Wilsonge (Talk | contribs)

Contents

Copyedit.png
This Page Needs Your Help

This page is tagged because it NEEDS IMAGES. You can help the Joomla! Documentation Wiki by contributing to it.
More pages that need help similar to this one are here. NOTE-If you feel the need is satistified, please remove this notice.


How to Access

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

  • Select Extensions  Module Manager

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

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

Description

This Module shows an RSS News Feed from a website. This Module is not related to the News Feeds Component or the News Feeds Layouts in the Newsfeed Manager screen but is an alternative that allows a feed to display in a Module position.

Screenshot

Help25-module-manager-feed-screenshot.png

Details and Options

Details

Help25-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/Archived/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.

Basic Options

Help25-module-manager-feed-basic-options.png

  • Feed URL. The URL address of the RSS news feed.
  • RTL Feed. (Yes/No) Whether or not to display the Feed in Right-To-Left direction.
  • Feed Title. (Yes/No) Whether or not to display the Feed Title.
  • Feed Description. (Yes/No) Whether or not to display the Feed Description.
  • Feed Image. (Yes/No) Whether or not to display the Feed Image.
  • Items. The number of news feed items to display.
  • Item Description. (Yes/No) 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

Help25-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. Setting this parameter causes Joomla! to either add a new CSS class or modify the existing CSS class for the div element for this specific module. See here for more information
  • Caching. (Use Global/No Caching) Choose whether you wish to cache the contents of the module.
  • Cache Time. The time before a module is recached.

Menu Assignment

Help25-module-manager-menu-assignment-screenshot.png

On the left there is a list of menu items. You can chose between None, All and Select Menu Item(s) from the List. To assign to some but not all pages choose the third option and select the menu links that you want the module associated with. See How do you assign a module to specific pages? for more information

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.

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. Feed module shown:

Help25-module-manager-feed-frontend-screenshot.png

The Module Type name for this Module is "mod_feed". It is not related to any other component.