Comments View Module

Version 1.0

Description

A Message Board View into the site

Configuration

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

Configurable Settings
Number	Configurable Variable	Description	Input Type	Input Rules
1	Name	The Name of this Comments View 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 Comments View 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 Comments View Module. - This allows you to link to the Comments View Module with an image instead of a text string. Enter the name of a valid local file.	text	Optional Field. Plain Text Only.
Comments View Module Basic Information
4	Short Title	The title that appears on top of the page - A typical title would be Latest Comments	text	Mandatory Field. Plain Text Only.
5	Full Page title	The full title of the comments page	text	Optional Field. Plain Text Only.
6	Page Notice	Allows you to make a piece of html appear at the top of the comments page - Can be useful to advertise important events	textarea	Optional Field. HTML / PHP input allowed.
7	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.
8	Comments Page Intro Text	The text that appears as an explanation to the comments page view	textarea	Mandatory Field. HTML / PHP input allowed.
9	Comment titles	The text string inviting the user to view the comment titles - comment titles is good!	text	Mandatory Field. Plain Text Only.
10	No Comment Titles	The text inviting the user to view only the story titles - story titles only!	text	Mandatory Field. Plain Text Only.
11	All Comments Text	The text inviting the user to view all comments - View All comments	text	Mandatory Field. Plain Text Only.
12	Per Story Text	The text inviting the user to view comments on a per-story basis - View Comments Per Story	text	Mandatory Field. Plain Text Only.
13	Show All Comments	Show all comments by default	checkbox	On / Off
14	Show Comment Titles	Show the comment titles by default	checkbox	On / Off
15	Show Hidden Stories	Should Hidden items be highlighted for editors? - This setting allows editors to see sticky stories on the newswire page.	checkbox	On / Off
16	Use Status Icons	Should Hidden items use icons instead of text? - This setting allows editors to see hidden stories highlighted with icons on this newswire.	checkbox	On / Off
Comment Filter Settings
17	Category Filter	A choice of multiple categories from the site	multifilterselect	A selection from the topic and region and type and language Tables
18	Specific Author?	Enter the name of the specific author whose comments will be listed	text	Optional Field. Plain Text Only.
Page Header Navigation Settings
19	Story Context	Show the topic / region / language / type of the stories? - This setting governs what navigation will appear on the top of the newswire column.	checkbox	On / Off
20	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 column.	checkbox	On / Off
21	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 column.	checkbox	On / Off
Page Footer Navigation Settings
22	Story Context	Show the topic / region / language / type of the stories? - This setting governs what navigation will appear at the bottom of the newswire column.	checkbox	On / Off
23	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 column.	checkbox	On / Off
24	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 column.	checkbox	On / Off
References to other objects
25	Page Layout	The Layout of the Newswire Page	reference	A reference to a data object of type page
26	Article	The Article View Object that this module links to	reference	A reference to a data object of type article
Access Control for this Comments View Module
Protect this Comments View Module from unauthorised users and from being used in other sections of the site
27	Protected	Should This Comments View Module be hidden from the public? - Check this box if you want this Comments View 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
28	Shared?	Should This Comments View 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. Full Page

Bugs

To do List and requested features

--Oscailt Auto-generated Documentation 09 Jan 2006