Help25

Difference between revisions of "Extensions Module Manager Syndication Feeds"

From Joomla! Documentation

(Added toolbar section.)
m (→‎Quick Tips: category reorganizing)
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
===Syndicate===
+
=Syndication Feeds Module=
 +
 
 +
==Overview==
  
 
==How to access==
 
==How to access==
Line 10: Line 12:
 
[[Image:Syndicate_module_example.png|frame|center]]
 
[[Image:Syndicate_module_example.png|frame|center]]
  
 +
==Toolbar==
 +
{{Chunk25:Help_screen_module_manager_edit_toolbar}}
  
==Options==
+
==Details==
 
 
===Basic Options===
 
  
 +
==Basic Options==
 
[[Image:J25_mod_syndicationfeeds_basic.JPG|frame|center]]
 
[[Image:J25_mod_syndicationfeeds_basic.JPG|frame|center]]
 
*'''Item Text.''' Text to be displayed next to the RSS Link button. If left blank, the default text "Feed Entries" will display. If you do not want to display any text, type a space inside double quotes (" ").
 
*'''Item Text.''' Text to be displayed next to the RSS Link button. If left blank, the default text "Feed Entries" will display. If you do not want to display any text, type a space inside double quotes (" ").
 
*'''Feed Format.''' Format of the newsfeed. Options are RSS 2.0 or Atom 1.0.
 
*'''Feed Format.''' Format of the newsfeed. Options are RSS 2.0 or Atom 1.0.
  
===Advanced Options===
+
==Advanced Options==
 
 
 
[[Image:J25_mod_advanced_3.JPG|frame|center]]
 
[[Image:J25_mod_advanced_3.JPG|frame|center]]
 
*'''Alternative layout''' Apply an alternative layout or template override
 
*'''Alternative layout''' Apply an alternative layout or template override
 
*'''Module Class Suffix''' Apply a CSS suffix to the module
 
*'''Module Class Suffix''' Apply a CSS suffix to the module
 
{{colheader|Caching}}
 
{{colheader|Caching}}
 +
 +
==Menu Assignment==
  
 
==Quick Tips==
 
==Quick Tips==
 +
Not all menu items types actually provide for an RSS feed.  This will be displayed on types of Category Blog and on Featured Articles menu types (probably others).
 +
On pages for which no feed is available this module will not display.
  
No tips have been added at this time.
+
<noinclude>{{cathelp|2.5|Module Manager Help Screens|Extensions Help Screens}}</noinclude>
 
 
==Toolbar==
 
{{Chunk25:Help_screen_module_manager_edit_toolbar}}
 
 
 
<noinclude>{{cathelp|2.5|Module Manager|Extensions}}</noinclude>
 

Revision as of 17:53, 4 August 2012

Syndication Feeds Module[edit]

Overview[edit]

How to access[edit]

You can access this module by creating a new module of this type. Alternatively, you can open an existing module of this type. Both are done in the Module Manager, under Extensions > Module Manager.

Description[edit]

This Module creates a RSS Feed link for the page. This allows a User to create a newsfeed for the current page. An example is shown below.

Screenshot[edit]

Syndicate module example.png

Toolbar[edit]

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[edit]

Basic Options[edit]

  • Item Text. Text to be displayed next to the RSS Link button. If left blank, the default text "Feed Entries" will display. If you do not want to display any text, type a space inside double quotes (" ").
  • Feed Format. Format of the newsfeed. Options are RSS 2.0 or Atom 1.0.

Advanced Options[edit]

  • Alternative layout Apply an alternative layout or template override
  • Module Class Suffix Apply a CSS suffix to the module
  • 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[edit]

Quick Tips[edit]

Not all menu items types actually provide for an RSS feed. This will be displayed on types of Category Blog and on Featured Articles menu types (probably others). On pages for which no feed is available this module will not display.