Headlines Box

Version 1.0

Description

A headline box with articles of a single type / region / topic / language

Configuration

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

Configurable Settings
Number	Configurable Variable	Description	Input Type	Input Rules
1	Name	The Name of this Headlines Box. - 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 Headlines Box. - 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 Headlines Box. - This allows you to link to the Headlines Box with an image instead of a text string. Enter the name of a valid local file.	text	Optional Field. Plain Text Only.
Headlines Box Basic Information
4	Short Box Title	The title that appears on top of the Box - If you set this box to be context sensitive (below) the context string of the page will be added to this title. For example, if the box is sensitive to the region, the name of the current region will be added to the end of the title.	text	Mandatory Field. Plain Text Only.
5	Long Title	The full title of the Box.	text	Optional Field. Plain Text Only.
Headline Filter Settings
You can choose to show only certain categories on this headline list - choose the categories to show below
6	Category Filter	A choice of single categories from the site.	filterselect	A selection from the topic and region and type and language Tables
7	Unmoderated	Is this headline box unmoderated? - If you check this setting, users will see all articles in the headline box, even those that have been hidden - use with care!	checkbox	On / Off
8	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 listing.	checkbox	On / Off
9	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	Optional Field. HTML / PHP input allowed.
10	Newswire Link	The Newswire module or event calendar that this box links to	reference	A reference to a data object of type newswire or events
11	Page Size	Number of articles to display in box - How many articles should be displayed at a time on the box (1-30)?	select	Numeric Option between: 1 and 30
12	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 in this box	select	Numeric Option between: 0 and 50
13	Maximum Headline Length	Maximum Length of each Headline in characters - How many characters should be allowed per headline? Any longer headlines will be clipped to this limit. This allows you to stop people who write excessively long headlines from taking all the space in the listing.	select	Numeric Option between: 0 and 200
Editor View Settings
14	Show Hidden Stories	Should Hidden Stories be highlighted for editors? - This setting allows editors to see hidden stories in the headline box.	checkbox	On / Off
15	Show Locked Stories	Should Locked Stories be highlighted for editors? - This setting allows editors to see locked stories in the headline box.	checkbox	On / Off
16	Show Sticky Stories	Should Sticky Stories be highlighted for editors? - This setting allows editors to see sticky stories in the headline box.	checkbox	On / Off
17	Use Status Icons	Should Hidden and locked Stories use icons instead of text? - This setting means that images will be used to highlight stories in the headline box.	checkbox	On / Off
Headlines Introduction Decoration
18	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 headline box	checkbox	On / Off
19	Include Date?	Newswire date format string (strftime - leave blank for no date display) - see strftime manual page	text	Optional Field. Plain Text Only.
20	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
Headline Decoration Settings
21	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
22	Include Article Author?	Should the author of the article be included after the title?	checkbox	On / Off
23	Include Author's organisation?	Should the author of the article be included after the title?	checkbox	On / Off
24	Include Comment Count?	Should the number of comments be included after the article's title?	checkbox	On / Off
25	Include Thumbnail?	Should a thumbnail accompany the headline (if available)?	checkbox	On / Off
26	Article Time?	Input the date format string (leave blank if you do not want to include the article date) - see strftime manual page	text	Optional Field. Plain Text Only.
27	Events Listing?	Is this a listing of events? - Check this box to list headlines by event time. Events will be listed with today's events first, then tomorrow's events and so on.	checkbox	On / Off
28	Event Time Format	Input the date format string (strftime format) - see strftime manual page	text	Optional Field. Plain Text Only.
29	Read More Text	The text string linking to the full article contents - try Full story / comments	text	Optional Field. Plain Text Only.
Newswire Headlines Context Sensitivity
30	Sensitive to Type?	Should the newswire show only the current article type? - Context sensitivity allows headline boxes to react to the page that they are on. The box can display only the type of article that is relevant to the current page.	checkbox	On / Off
31	Sensitive to Region?	Should the newswire show only the current article region? - Context sensitivity allows headline boxes to react to the page that they are on. The box can display only the region of article that is relevant to the current page.	checkbox	On / Off
32	Sensitive to Language?	Should the newswire show only the current article language? - Context sensitivity allows headline boxes to react to the page that they are on. The box can display only articles in the language of the current page.	checkbox	On / Off
33	Sensitive to Topic?	Should the newswire show only the current article topic? - Context sensitivity allows headline boxes to react to the page that they are on. The box can display only articles with the topic of the current page.	checkbox	On / Off
34	Sensitive to Author?	Should the headlines box only list the current author's work? - Context sensitivity allows headline boxes to react to the page that they are on. The box can display only articles with the same author as the current page.	checkbox	On / Off
Access Control for this Headlines Box
Protect this Headlines Box from unauthorised users and from being used in other sections of the site
35	Protected	Should This Headlines Box be hidden from the public? - Check this box if you want this Headlines Box to be only visible to editors on the site. This can be useful for keeping certain pages hidden from public view.	checkbox	On / Off
36	Shared?	Should This Headlines Box 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. Contextual Headlines Listing
7. Headlines Full List

Bugs

To do List and requested features

--Oscailt Auto-generated Documentation 09 Jan 2006