Archive Viewer Module

Version 1.0

Description

A calendar view into the database

Configuration

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

Configurable Settings
Number	Configurable Variable	Description	Input Type	Input Rules
1	Name	The Name of this Archive Viewer 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 Archive Viewer 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 Archive Viewer Module. - This allows you to link to the Archive Viewer Module with an image instead of a text string. Enter the name of a valid local file.	text	Optional Field. Plain Text Only.
Archive Viewer Module Basic Information
4	Short Title	The title that appears on top of the page - A typical title would be Archives	text	Mandatory Field. Plain Text Only.
5	Full Page title	The full title of the archive	text	Optional Field. Plain Text Only.
6	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.
7	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.
8	Archive Help Text	The text that appears as an explanation on the newswire archives page view - "Click on the links below to view all the stories published on a specific date."	textarea	Mandatory Field. HTML / PHP input allowed.
9	Newswire Link Text	The text linking to the newswire version of the archives - Newswire Archives is good!	text	Mandatory Field. HTML / PHP input allowed.
10	Gallery Archives Help Text	The text that appears as an explanation on the gallery archives page view - "Click on the links below to view all the images published on a specific date."	textarea	Mandatory Field. HTML / PHP input allowed.
11	Gallery Link Text	The text linking to the gallery version of the archives - "Gallery Archives" works!	text	Mandatory Field. HTML / PHP input allowed.
12	Year Text	Word for "year" - "Year" works!	text	Mandatory Field. HTML / PHP input allowed.
13	Next Text	Word for "next" - "Next" works!	text	Mandatory Field. HTML / PHP input allowed.
14	Previous Text	Word for "previous" - "Previous" works!	text	Mandatory Field. HTML / PHP input allowed.
15	Page Layout	The Layout of the Newswire Page	reference	A reference to a data object of type page
16	Newswire Module	The newswire module linked to by this archive (choose none to use primary site newswire)	reference	A reference to a data object of type newswire
17	Gallery Module	The gallery module linked to by this archive (choose none to use primary site gallery)	reference	A reference to a data object of type gallery
Access Control for this Archive Viewer Module
Protect this Archive Viewer Module from unauthorised users and from being used in other sections of the site
18	Protected	Should This Archive Viewer Module be hidden from the public? - Check this box if you want this Archive Viewer 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
19	Shared?	Should This Archive Viewer 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