Imported Feed Module

Version 1.0

Description

Imported RSS and atom feeds from other sites on the internet

Configuration

Below are the list of settings that the user can choose from for each configured data object of the Imported Feed Module module.

Configurable Settings
Number Configurable Variable Description Input Type Input Rules
1 Name The Name of this Imported Feed Module. - This will also appear as the HTML title on top of the browser and will appear as part of the page title in search engine listings - keep it short and meaningful! text Mandatory Field. Plain Text Only.
2 Description A short description of this Imported Feed Module. - This will be added into the HTML meta tag for the page in question and is important for search engines, so use several specifically descriptive words that match the content of the object. This will also appear on the management screens for this site. It is a good idea to give a brief description which will enable you to quickly identify which entries are which in lists of objects. textarea Mandatory Field. Plain Text Only.
3 Image An icon file associated with this Imported Feed Module. - This allows you to link to the Imported Feed Module with an image instead of a text string. Enter the name of a valid local file. text Optional Field. Plain Text Only.
Imported Feed Module Basic Information
4 Feed Link Text String Linking to the feed page text Mandatory Field. Plain Text Only.
5 Feed Title Replace Feed Title - Fill in this box if you want to override the title that is supplied by the feed with your own title text Optional Field. Plain Text Only.
Universal Feed Settings (not affected by display mode)
6 URL The URL of the feed - in the form of http://www.mysite.com/feed.xml text Mandatory Field. Plain Text Only.
7 Date Format Input the date format string (strftime format) - see strftime manual page text Optional Field. Plain Text Only.
8 Strip HTML Strip any html from feeds - Some feeds include html in the content that they export. Often this will just mess up your display. Check this box and all html will be cleared from your imported feeds. checkbox On / Off
9 UTF8 encoded Is the feed UTF8 encoded? - www.indymedia.org is checkbox On / Off
10 User republish Allow users to republish - If you check this box, an icon will appear beside each headline, inviting users to republish the story on your site. checkbox On / Off
11 Filter Languages? Check this box to filter the feed contents by language - If language is included in the feed info, you can choose to filter out all articles that are not in your desired language checkbox On / Off
12 Language Codes to Include A comma seperated list of languages to include. - If you want to include unclassified items, you have to include the 'ot' other language code. text Optional Field. Plain Text Only.
13 Publish Object The publish object for re-publications - which publish page will the republish link point to? reference A reference to a data object of type publish
Full Page Display Settings
Settings that apply to the feed when it is viewed in full page mode
14 Top Notice Allows you to make a piece of html appear at the top of the page - Can be useful to advertise important events textarea Optional Field. HTML / PHP input allowed.
15 End Note Allows you to make a piece of html appear at the bottom of every page - Can be useful to advertise important events textarea Optional Field. HTML / PHP input allowed.
16 No Stories Message The message the will be displayed to the user when no articles are in the feed textarea Optional Field. HTML / PHP input allowed.
17 Summary Pre-fill The text that will be prefilled into the summary box of the publish form textarea Optional Field. Plain Text Only.
18 Promote Text The word for promoting the article text Mandatory Field. Plain Text Only.
19 Page Layout The Layout of the Newswire Page reference A reference to a data object of type page
20 Page Size Number of articles to display in feed - Will override any feed settings select Numeric Option between: 1 and 99
21 Maximum Word Length Maximum Length in characters of a word in the text - This allows you to stop any long words without breaks from messing up the page layout. select Numeric Option between: 10 and 100
22 Title Size 1 is biggest, 5 smallest select Numeric Option between: 1 and 5
23 Republish Option Allow Editors to republish stories checkbox On / Off
24 Republish Full Text Republish entire contents (if available)? checkbox On / Off
25 Show Feed Date include date at top of feed checkbox On / Off
26 Show Feed Description Show the description of the feed? checkbox On / Off
27 Show Feed Image Show the image supplied by the feed? checkbox On / Off
28 Show Feed Language Show the language of the feed? checkbox On / Off
29 Show Item Date include date of each listing checkbox On / Off
30 Show Item Description Show the description of each item? checkbox On / Off
31 Show Item Content Show the full content of each item? checkbox On / Off
32 Show Item Language Show the language of each item? checkbox On / Off
33 Show Icon Show an icon for each item? checkbox On / Off
34 Show Item Author include Author of each listing checkbox On / Off
Headline Listing (newswire column) Display Settings
Settings that apply to the feed when it is viewed in a headlines listing mode (eg when it is in one of the menus or bars of the page)
35 Page Size Number of articles to display in feed menu - How many articles should be displayed at a time on the feed menu (1-99)? select Numeric Option between: 1 and 99
36 Maximum Headline Length Maximum Length of each Headline in characters - How many characters should be allowed per headline? select Numeric Option between: 0 and 200
37 Maximum Word Length Maximum Length in characters of a word in the text - This allows you to stop any long words without breaks from messing up the page layout. select Numeric Option between: 10 and 100
38 Maximum Image Width Maximum Width of an image in pixels - Larger images will have a smaller value set in the <img..> tag select Numeric Option between: 0 and 200
39 Title Size 1 is biggest, 5 smallest select Numeric Option between: 1 and 5
40 Republish Option Allow Editors to republish stories checkbox On / Off
41 Show Feed Date include date at top of feed checkbox On / Off
42 Show Feed Title Show the title of the feed? checkbox On / Off
43 Show Feed Description Show the description of the feed? checkbox On / Off
44 Show Feed Image Show the image supplied by the feed? checkbox On / Off
45 Show Feed Language Show the language of the feed? checkbox On / Off
46 Show Item Date include date of each listing checkbox On / Off
47 Show Item Description Show the description of each item? checkbox On / Off
48 Show Item Language Show the language of each item? checkbox On / Off
49 Show Icon Show an icon for each item? checkbox On / Off
50 Show Item Author include Author of each listing checkbox On / Off
Access Control for this Imported Feed Module
Protect this Imported Feed Module from unauthorised users and from being used in other sections of the site
51 Protected Should This Imported Feed Module be hidden from the public? - Check this box if you want this Imported Feed Module to be only visible to editors on the site. This can be useful for keeping certain pages hidden from public view. checkbox On / Off
52 Shared? Should This Imported Feed Module be available to add to menus etc on other sections of this site? - Shared Data Objects can be added to menus, lists, pages and so on throughout the site, no matter what section the page that includes them is from. Objects that are not shared are only available within the site section where they are owned. checkbox On / Off

Display Modes

  1. Link
  2. Headlines Listing
  3. Title and Headlines
  4. Full Page

Bugs

To do List and requested features

--Oscailt Auto-generated Documentation 09 Jan 2006
Topic revision: r2 - 09 Jan 2006, ChekovFeeney
This site is powered by FoswikiCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback