Listing Box

Version 1.0

Description

A List of other objects (eg. documents, links...)

Configuration

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

Configurable Settings
Number	Configurable Variable	Description	Input Type	Input Rules
1	Name	The Name of this Listing 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 Listing 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 Listing Box. - This allows you to link to the Listing Box with an image instead of a text string. Enter the name of a valid local file.	text	Optional Field. Plain Text Only.
Listing Box Basic Information
4	List Title	The title that appears on top of the listing box - If you want your list to have a title on top of it, enter the text here	text	Optional Field. Plain Text Only.
5	Text Link	A longer text string that links to this list - If you want to be able to use a full description on top of the list, enter it here	text	Optional Field. Plain Text Only.
6	List Display	The type of bullets for the list entries - What type of bullets would you like to use for the entries in the list?	radio	Options: bullets, numbers, none
7	Link to full page?	Do you want the list header to link to a full-page view of the list?	checkbox	On / Off
8	List Page Header	Allows you to make a piece of html appear at the top of the list in full page display mode	textarea	Optional Field. HTML / PHP input allowed.
9	End Note	Allows you to make a piece of html appear at the bottom of the list in full page display mode	textarea	Optional Field. HTML / PHP input allowed.
10	Page Layout	The Layout of the List Page - Choose a page layout if you want this list to be viewable in full page mode.	reference	A reference to a data object of type page
Listing Box Contents
Listing Box is a container type. They generally just hold a list of other objects and pieces of content and a bit of information on how to display them.
11	contained	Can include objects from any modules except: menu, bar, page, article, feedexport	object-listing
Access Control for this Listing Box
Protect this Listing Box from unauthorised users and from being used in other sections of the site
12	Protected	Should This Listing Box be hidden from the public? - Check this box if you want this Listing 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
13	Shared?	Should This Listing 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

Bugs

To do List and requested features

--Oscailt Auto-generated Documentation 09 Jan 2006