Newswire Module

Version 1.0

Description

A newswire with articles of multiple types / regions / languages / topics

Configuration

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

Configurable Settings
Number Configurable Variable Description Input Type Input Rules
1 Name The Name of this Newswire 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 Newswire 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 Newswire Module. - This allows you to link to the Newswire Module with an image instead of a text string. Enter the name of a valid local file. text Optional Field. Plain Text Only.
Newswire Module Basic Information
4 Short Newswire Title The title that appears on top of the Newswire Column - A typical title would be Latest News text Mandatory Field. Plain Text Only.
5 Full Newswire title The full title of the Newswire Page. text Optional Field. Plain Text Only.
Newswire Filter Settings
You can choose to show only certain categories on this newswire - choose the categories to show below
6 Category Filter A choice of multiple categories from the site multifilterselect A selection from the topic and region and type and language Tables
7 Specific Author? Enter the name of the specific author that this newswire will list - If you fill in something here, only those articles with a matching author will be listed - use with care text Optional Field. Plain Text Only.
Newswire Page Settings
Settings the govern the newswire when viewed in full page mode
8 Page Size Number of articles to display on newswire full-page view - How many articles should be displayed at a time on the newswire page (1-99)? select Numeric Option between: 1 and 99
9 Cut-off Days Cut off old articles after how many days (0 for no cutoff) - Set this value to the age in number of days that you want to be stories to be visible on this newswire select Numeric Option between: 0 and 50
Content Viewing Settings
Each Newswire can be set up so that they respect hidden settings and respect the stickiness of stories.
10 Unmoderated Is this newswire unmoderated? - If you check this setting, users will see all articles on the site, even those that have been hidden - use with care! checkbox On / Off
11 Allow Stickies Will you allow sticky articles to appear at the top of the newswire? - If you check this setting, any articles that have been made "sticky" by editors will appear at the top of the newswire. checkbox On / Off
Newswire Page Text Settings
12 Newswire Notice Allows you to make a piece of html appear at the top of the newswire page - Can be useful to advertise important events textarea Optional Field. HTML / PHP input allowed.
13 Newswire 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.
14 No Stories Message The message the will be displayed to the user when no articles are found that match their query - Try "Sorry, but no stories match your query" textarea Mandatory Field. HTML / PHP input allowed.
15 Read More Text The text string linking to the full article contents - try Full story / comments text Optional Field. Plain Text Only.
Page Layout and relationships
16 Page Layout The Layout of the Newswire Page reference A reference to a data object of type page
17 Article View Module The article viewing module linked to by this newswire (choose none to use primary site article viewer) reference A reference to a data object of type article
Editor View
These settings govern what information editors see about each story on the newswire page and whether they are allowed to edit multiple stories at once.
18 Show Hidden Stories Should Hidden Stories be highlighted for editors? - This setting allows editors to see hidden stories on the newswire page. checkbox On / Off
19 Show Locked Stories Should Locked Stories be highlighted for editors? - This setting allows editors to see locked stories on the newswire page. checkbox On / Off
20 Show Sticky Stories Should Sticky Stories be highlighted for editors? - This setting allows editors to see sticky stories on the newswire page. checkbox On / Off
21 Use Status Icons Should Hidden and locked Stories use icons instead of text? - This setting highlights hidden and sticky stories with icons instead of text. checkbox On / Off
22 Unstick Should Editors be able to unstick multiple articles at once? - This setting makes it easier for editors to do their work, but can also make it easier for malicious users to do damage if they can get access. If you trust your editors and are happy with your security, you can comfortably check this box checkbox On / Off
23 Hide Should Editors be able to hide multiple articles at once? - This setting makes it easier for editors to do their work, but can also make it easier for malicious users to do damage if they can get access. If you trust your editors and are happy with your security, you can comfortably check this box checkbox On / Off
24 Unhide Should Editors be able to unhide multiple articles at once? - This setting makes it easier for editors to do their work, but can also make it easier for malicious users to do damage if they can get access. If you trust your editors and are happy with your security, you can comfortably check this box checkbox On / Off
25 Lock Should Editors be able to lockck multiple articles at once? - This setting makes it easier for editors to do their work, but can also make it easier for malicious users to do damage if they can get access. If you trust your editors and are happy with your security, you can comfortably check this box checkbox On / Off
26 Unlocck Should Editors be able to unlock multiple articles at once? - This setting makes it easier for editors to do their work, but can also make it easier for malicious users to do damage if they can get access. If you trust your editors and are happy with your security, you can comfortably check this box checkbox On / Off
Page Header Navigation Settings
27 Story Context Show the topic / region / language / type of the stories? - This setting governs what navigation will appear on the top of the newswire page. checkbox On / Off
28 Next Pages Link Show links to following and subsequent pages of the newswire? - This setting governs what navigation will appear on the top of the newswire page. checkbox On / Off
29 Other Modules Links? Show links to the other modules of the site for alternative views? - This setting governs what navigation will appear on the top of the newswire page. checkbox On / Off
Page Footer Navigation Settings
30 Story Context Show the topic / region / language / type of the stories? - This setting governs what navigation will appear at the bottom of the newswire page. checkbox On / Off
31 Next Pages Link Show links to following and subsequent pages of the newswire? - This setting governs what navigation will appear at the bottom of the newswire page. checkbox On / Off
32 Other Modules Links? Show links to the other modules of the site for alternative views? - This setting governs what navigation will appear at the bottom of the newswire page. checkbox On / Off
Story Summary Display Settings
These settings govern how each individual story summary will appear on the full page view of the newswire.
33 Story Context Show story context in the article summary? - Choose where you want the context (category information) of the article to appear radio Options: subtitle, end, both, neither
34 Article Date Format Input the date format string (strftime format) - see strftime manual page text Optional Field. Plain Text Only.
35 Event Time Format Input the date format string (strftime format) - see strftime manual page text Optional Field. Plain Text Only.
36 Story Date Show story date in the article summary? - Choose where you want the date of the article to appear radio Options: subtitle, end, both, neither
37 Story Author Show story author in the article summary? - Choose where you want the article's author to appear radio Options: subtitle, end, both, neither
38 Story Comments Show number of comments on story in the story summary? - Choose where you want the information to appear radio Options: subtitle, end, both, neither
39 Story Attachments Show story attachment information in the story summary? - Choose where you want the information to appear radio Options: subtitle, end, both, neither
40 Show Icons Show Icons for story attachments - This setting governs whether the icons for each attachment type contained in the story appear beside the story. checkbox On / Off
41 Show Photo Show Included Photo in the newswire summary - This setting governs whether the pictures in stories appear in the summary view. checkbox On / Off
42 Show Related Link Show Related Link in the newswire summary - This setting governs whether the related link in stories appear in the summary. checkbox On / Off
43 Use Alternate Styles Select this to show stories with alternating styles - If you select this box, every second story will be rendered in a different style. checkbox On / Off
44 Related Link Text The text introduction to the related link - try "Related Link" text Optional Field. Plain Text Only.
Headline Listing (newswire column) Basic Settings
These settings apply to the newswire when it is viewed in headlines mode (eg when it is in a menu)
45 Unmoderated Is this newswire unmoderated? - If you check this setting, users will see all articles on the site, even those that have been hidden - use with care! checkbox On / Off
46 Allow Stickies Will you allow sticky articles to appear at the top of the headlines box? - If you check this setting, any articles that have been made "sticky" by editors will appear at the top of the listing. checkbox On / Off
47 Listing Size Number of articles to display in newswire box - How many articles should be displayed at a time in the newswire box (1-99)? select Numeric Option between: 1 and 99
48 Headline Cut-off Cut off old articles after how many days (0 for no cutoff) - Set this value to the age in number of days that you want to be stories to be visible on the newswire box select Numeric Option between: 0 and 50
49 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
Editorial View of Headlines
These settings govern how headlines will be highlighted for editors
50 Show Hidden Stories Should Hidden Stories be highlighted for editors? - This setting allows editors to see hidden stories in the newswire menu. checkbox On / Off
51 Show Locked Stories Should Locked Stories be highlighted for editors? - This setting allows editors to see locked stories on the newswire menu. checkbox On / Off
52 Show Sticky Stories Should Sticky Stories be highlighted for editors? - This setting allows editors to see sticky stories on the newswire menu. checkbox On / Off
53 Use Status Icons Should Hidden and locked Stories be highlighted by icons instead of text? checkbox On / Off
Newswire Column Header Settings
These Settings Govern what will appear at the top of the headlines listing (underneath the headlines title)
54 Include Context? Should the Relevant Type/Region/Topic/Language be included? - If you check this box, the current region / topic / etc will be displayed at the top of the newswire box checkbox On / Off
55 Include Date? Should the Date Be Listed at the Top of the Newswire? - see strftime manual page text Optional Field. Plain Text Only.
56 Include Media Icons? Should the Media Icons be Listed at the Top of the Newswire? - If you check this box, the list of media icons will be displayed at the top of the newswire column or box checkbox On / Off
Newswire Headlines Context Sensitivity
When newswires are viewed in headline mode, they can be context-sensitive, this means that they will only list stories that correspond with the category of the current page.
57 Sensitive to Type? Should the newswire show the current article type? checkbox On / Off
58 Sensitive to Region? Should the newswire show only the current article region? checkbox On / Off
59 Sensitive to Language? Should the newswire show only the current article language? checkbox On / Off
60 Sensitive to Topic? Should the newswire show only the current article topic? checkbox On / Off
61 Sensitive to Author? Should the newswire list the current author? checkbox On / Off
Headlines Display Settings
Settings governing the format of each headline in the listing
62 Article Media Icons? Should the Media Icons be Listed in front of each Article? - If you check this box, the list of media icons will be displayed in front of every headline with the appropriate attachments checkbox On / Off
63 Article Date Format Input the date format string (strftime format) - see strftime manual page text Optional Field. Plain Text Only.
64 Include Article Author? Should the author of the article be included after the title? checkbox On / Off
65 Include Author's organisation? Should the author of the article be included after the title? checkbox On / Off
66 Include Comment Count? Should the number of commons be included after the article's title? checkbox On / Off
67 Highlight Features? Should the headline use a special style for displaying features? checkbox On / Off
68 Include Thumbnails? Should a thumbnail be shown with the article if one is available? checkbox On / Off
Headline Listing Footer
What will appear at the bottom of the headline listing
69 Read More Text The text string linking to the full newswire page - Leave blank for no link text Optional Field. Plain Text Only.
Access Control for this Newswire Module
Protect this Newswire Module from unauthorised users and from being used in other sections of the site
70 Protected Should This Newswire Module be hidden from the public? - Check this box if you want this Newswire 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
71 Shared? Should This Newswire 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. Short Title
  2. Icon
  3. Icon And Title
  4. Long Title
  5. Headlines Listing
  6. Headlines Full List
  7. Full Page

Bugs

To do List and requested features

Format - task (will be in release 3.x)

  • template for display of headlines / summaries? (new lines etc) (3.1)
  • configuration options for headline html title (3.1)
  • >> read more links at bottom of headline listing (3.0)
  • make header not a link (?) (status - under consideration)
  • add author name to title text in full page view (3.0/3.1)
  • make features stand out in newswire column. (3.1)
  • view stories by data/archives by day/ (3.1)
  • clickable author name (3.1)

-- ChekovFeeney - 30 Aug 2005 --Oscailt Auto-generated Documentation 09 Jan 2006
Topic revision: r3 - 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