Filter Box

Version 1.0

Description

A set of filter selectors for filtering pages by type / topic / region / language / media type. Reloads the current page with filtered settings

Configuration

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

Configurable Settings
Number	Configurable Variable	Description	Input Type	Input Rules
1	Name	The Name of this Filter 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 Filter 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.
Filter Box Basic Information
3	Filter Box Title	The title that appears on top of the filter box	text	Optional Field. Plain Text Only.
4	Type Filter	Include type filter box	checkbox	On / Off
5	Language Filter	Should a filter box for language appear?	checkbox	On / Off
6	Media Type Filter	Include Media type filter box	checkbox	On / Off
7	Special Filter	Include special filters for editors	checkbox	On / Off
8	Submit Filter Automatically	Check the box if you want to submit the form on change	checkbox	On / Off
9	Use search button image	Check the box if you want to use an image instead of the submit button	checkbox	On / Off
10	Button Text	The text that will be displayed on the search button	text	Optional Field. Plain Text Only.
11	Replace search button with image	The path to the graphics file to use	text	Optional Field. Plain Text Only.
Access Control for this Filter Box
Protect this Filter Box from unauthorised users and from being used in other sections of the site
12	Protected	Should This Filter Box be hidden from the public? - Check this box if you want this Filter 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 Filter 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. Horizontal
2. Horizontal Button First
3. Vertical
4. Vertical Button First
5. Titled Horizontal
6. Titled Horizontal Button First
7. Titled Vertical
8. Titled Vertical Button First

Bugs

To do List and requested features

--Oscailt Auto-generated Documentation 09 Jan 2006