Featurewire Module

Version 1.0

Description

Featurewire module - For displaying prominent stories on a special page

Configuration

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

Configurable Settings
Number	Configurable Variable	Description	Input Type	Input Rules
1	Name	The Name of this Featurewire 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 Featurewire 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 Featurewire Module. - This allows you to link to the Featurewire Module with an image instead of a text string. Enter the name of a valid local file.	text	Optional Field. Plain Text Only.
Featurewire Module Basic Information
4	Short featurewire Title	The title that appears on top of the featurewire Column - A typical title would be Latest News	text	Mandatory Field. Plain Text Only.
5	Full featurewire title	The full title of the featurewire Page.	text	Optional Field. Plain Text Only.
featurewire Filter Settings
You can choose to only display features in certain categories
6	Category Filter	A choice of multiple categories from the site	multifilterselect	A selection from the topic and region and language Tables
7	Specific Author?	Enter the name of the specific author that this feature-wire will list	text	Optional Field. Plain Text Only.
8	Unmoderated	Is this featurewire 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
9	Allow Stickies	Will you allow sticky articles to appear at the top of the featurewire? - If you check this setting, any articles that have been made "sticky" by editors will appear at the top of the featurewire.	checkbox	On / Off
featurewire Page Text Settings
10	featurewire Notice	Allows you to make a piece of html appear at the top of the featurewire page - Can be useful to advertise important events	textarea	Optional Field. HTML / PHP input allowed.
11	featurewire 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.
12	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.
13	Read More Text	The text string linking to the full article contents - try Full story / comments	text	Optional Field. Plain Text Only.
14	Editor Note Text	The text string that starts a note to the editor - try "Editor Note"	text	Mandatory Field. Plain Text Only.
15	Self Link Text	The text string announcing that the item contains a link to its own attachment and that the attachment won't appear again. - try Full story / comments	textarea	Mandatory Field. HTML / PHP input allowed.
Content Limits
How many features will appear on the feature page at once and for how long.
16	Page Size	Number of articles to display in featurewire menu - How many articles should be displayed at a time on the featurewire page (1-99)?	select	Numeric Option between: 1 and 99
17	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 featurewire	select	Numeric Option between: 0 and 50
Page Header Navigation Settings
18	Story Context	Show the topic / region / language / type of the stories? - This setting governs what navigation will appear on the top of the featurewire column.	checkbox	On / Off
19	Next Pages Link	Show links to following and subsequent pages of the featurewire? - This setting governs what navigation will appear on the top of the featurewire column.	checkbox	On / Off
20	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 featurewire column.	checkbox	On / Off
Page Footer Navigation Settings
21	Story Context	Show the topic / region / language / type of the stories? - This setting governs what navigation will appear at the bottom of the featurewire column.	checkbox	On / Off
22	Next Pages Link	Show links to following and subsequent pages of the featurewire? - This setting governs what navigation will appear at the bottom of the featurewire column.	checkbox	On / Off
23	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 featurewire column.	checkbox	On / Off
References to other objects
24	Page Layout	- The Layout of the featurewire Page	reference	A reference to a data object of type page
25	Article View Module	The article viewing module linked to by this feature wire (choose none to use primary site article viewer)	reference	A reference to a data object of type article
Story Summary Display Settings
Settings that govern how each individual Story will appear on the featurewire page
26	Story Date Format	Input the date format string (strftime format) - see strftime manual page	text	Optional Field. Plain Text Only.
27	Story Context	Show story context in the article summary? - Choose where you want the context to appear	radio	Options: subtitle, end, both, neither
28	Story Date	Show story date in the article summary? - Choose where you want the date to appear	radio	Options: subtitle, end, both, neither
29	Story Author	Show story author in the article summary? - Choose where you want the author to appear	radio	Options: subtitle, end, both, neither
30	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
31	Story Attachments	Show story attachment information in the story summary? - Choose where you want the information to appear	radio	Options: subtitle, end, both, neither
32	Show Icons	Show Icons for story attachments - This setting governs whether the icons for each attachment type appear beside the story.	checkbox	On / Off
33	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
34	Related Link Text	The text introduction to the related link - try "Related Link"	text	Optional Field. Plain Text Only.
Editor View Settings
These settings define what information the editor will see about each feature
35	Show Hidden Stories	Should Hidden Stories be highlighted for editors? - This setting allows editors to see hidden stories on the featurewire page.	checkbox	On / Off
36	Show Locked Stories	Should Locked Stories be highlighted for editors? - This setting allows editors to see locked stories on the featurewire page.	checkbox	On / Off
37	Show Sticky Stories	Should Sticky Stories be highlighted for editors? - This setting allows editors to see sticky stories on the featurewire page.	checkbox	On / Off
38	Use Status Icons	Should Hidden and locked Stories use icons instead of text? - This setting allows editors to see hidden stories on this featurewire.	checkbox	On / Off
39	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
40	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
41	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
42	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
43	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
Access Control for this Featurewire Module
Protect this Featurewire Module from unauthorised users and from being used in other sections of the site
44	Protected	Should This Featurewire Module be hidden from the public? - Check this box if you want this Featurewire 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
45	Shared?	Should This Featurewire 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. Full Page

Bugs

To do List and requested features

--Oscailt Auto-generated Documentation 09 Jan 2006