Gallery Module

Version 1.0

Description

Gallery Module - Allows you to browse the site's images

Configuration

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

Configurable Settings
Number	Configurable Variable	Description	Input Type	Input Rules
1	Name	The Name of this Gallery 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 Gallery 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 Gallery Module. - This allows you to link to the Gallery Module with an image instead of a text string. Enter the name of a valid local file.	text	Optional Field. Plain Text Only.
Gallery Module Basic Information
4	Text Link	The text that appears as a link to the gallery view page	text	Mandatory Field. Plain Text Only.
5	Page Title	The title that appears on top of the Gallery view page	text	Optional Field. Plain Text Only.
6	Gallery Notice	Allows you to make a piece of html appear at the top of every Gallery page - Can be useful to advertise important events	textarea	Optional Field. HTML / PHP input allowed.
7	Gallery 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	One Image per story?	Check this box if you want to only list one image per story. - Not Implemented Yet!	checkbox	On / Off
User Messages
9	No Document Message	The message that will be displayed to the user when no document is found - Try "Sorry, but there are no images that match your request"	textarea	Optional Field. HTML / PHP input allowed.
Category Filter Settings
You can specify filters so that the gallery will only include images from the selected categories below
10	Category Filter	A choice of multiple categories from the site	multifilterselect	A selection from the type and topic and region and language Tables
11	Specific Author?	Enter the name of the specific author that this gallery will list	text	Optional Field. Plain Text Only.
Gallery Full-page view settings
Settings that apply to the gallery object when it is viewed in full page mode.
12	Page Size	Number of images to display in gallery page - How many Images should be displayed at a time on the gallery view page (1-99)?	select	Numeric Option between: 1 and 99
13	Page Cut-off Days	Cut off old Images after how many days (0 for no cutoff) - Set this value to the age in number of days that you want to be galleries to be visible on this gallery page	select	Numeric Option between: 0 and 50
14	Page Resize Height	Resize the picture to this height in pixels (0 for no resize) - Leave blank or enter 0 for no resizing of height	text	Optional Field. Numeric Input between 0 and 10000.
15	Page Resize Width	Resize the picture to this width in pixels - Leave blank or enter 0 for no resizing of width	text	Optional Field. Numeric Input between 0 and 10000.
16	Page Maximum Filesize	Resize the picture file if it is over this size (KB) - Leave blank or enter 0 for no resizing of large files	text	Optional Field. Numeric Input between 0 and 100000.
Page Header Navigation Settings
17	Story Context	Show the topic / region / language / type of the stories? - This setting governs what navigation will appear on the top of the gallery view page.	checkbox	On / Off
18	Next Pages Link	Show links to following and subsequent pages of the gallery view? - This setting governs what navigation will appear on the top of the gallery view page.	checkbox	On / Off
19	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 gallery view page.	checkbox	On / Off
Page Footer Navigation Settings
20	Story Context	Show the topic / region / language / type of the gallery? - This setting governs what navigation will appear at the bottom of the gallery view page.	checkbox	On / Off
21	Next Pages Link	Show links to following and subsequent pages of the gallery view? - This setting governs what navigation will appear at the bottom of the gallery view page.	checkbox	On / Off
22	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 gallery view page.	checkbox	On / Off
References to other objects
23	Page Layout	The Layout of the gallery View Page	reference	A reference to a data object of type page
24	Article View	The Article View Object that will be used to view the images linked from the gallery	reference	A reference to a data object of type article
Gallery Menu and banner mode settings
Settings that apply to the gallery object when it is viewed in banner mode or in menu mode.
25	Menu Title	The title that appears on top of the Gallery when it is displayed in Menu Mode	text	Optional Field. Plain Text Only.
26	Banner Title	The title that appears on top of the Gallery when it is displayed in Banner Mode	text	Optional Field. Plain Text Only.
Menu and Banner Mode Context Sensitivity
Settings that allow your gallery objects to apply the filters from the main page to the gallery object when it is viewed in menu or banner mode.
27	Sensitive to Type?	Should the gallery show only images from the current article type?	checkbox	On / Off
28	Sensitive to Region?	Should the gallery show only images from the current article region?	checkbox	On / Off
29	Sensitive to Language?	Should the gallery show only images from the current article language?	checkbox	On / Off
30	Sensitive to Topic?	Should the gallery show only images from the current article topic?	checkbox	On / Off
31	Sensitive to Author?	Should the gallery list the current author's pictures?	checkbox	On / Off
Menu Settings
The various dimensions to apply to the gallery in menu mode
32	Menu Page Size	Number of Images to display in gallery view menu - How many Images should be displayed at a time on the gallery view page (1-99)?	select	Numeric Option between: 1 and 99
33	Menu Cut-off Days	Cut off old Images after how many days (0 for no cutoff) - Set this value to the age in number of days that you want to be images to be visible on this gallery menu	select	Numeric Option between: 0 and 50
34	Menu Resize Height	Resize the picture to this height in pixels (0 for no resize) - Leave blank or enter 0 for no resizing of height	text	Optional Field. Numeric Input between 0 and 10000.
35	Menu Resize Width	Resize the picture to this width in pixels - Leave blank or enter 0 for no resizing of width	text	Optional Field. Numeric Input between 0 and 10000.
36	Menu Maximum Filesize	Resize the picture file if it is over this size (KB) - Leave blank or enter 0 for no resizing of large files	text	Optional Field. Numeric Input between 0 and 100000.
Banner Settings
The various dimensions to apply to the gallery in banner mode
37	Banner Size	Number of Images to display in gallery banner - How many Images should be displayed at a time on the gallery banner (1-99)?	select	Numeric Option between: 1 and 99
38	Banner Cut-off Days	Cut off old Images after how many days (0 for no cutoff) - Set this value to the age in number of days that you want to be images to be visible on this gallery banner	select	Numeric Option between: 0 and 50
39	Banner Resize Height	Resize the picture to this height in pixels (0 for no resize) - Leave blank or enter 0 for no resizing of height	text	Optional Field. Numeric Input between 0 and 10000.
40	Banner Resize Width	Resize the picture to this width in pixels - Leave blank or enter 0 for no resizing of width	text	Optional Field. Numeric Input between 0 and 10000.
41	Banner Maximum Filesize	Resize the picture file if it is over this size (KB) - Leave blank or enter 0 for no resizing of large files	text	Optional Field. Numeric Input between 0 and 100000.
Access Control for this Gallery Module
Protect this Gallery Module from unauthorised users and from being used in other sections of the site
42	Protected	Should This Gallery Module be hidden from the public? - Check this box if you want this Gallery 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
43	Shared?	Should This Gallery 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. Banner
6. Menu Listing
7. Full Page

Bugs

To do List and requested features

--Oscailt Auto-generated Documentation 09 Jan 2006