Picture Box

Version 1.0

Description

A picture box object

Configuration

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

Configurable Settings
Number	Configurable Variable	Description	Input Type	Input Rules
1	Name	The Name of this Picture 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 Picture 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.
Picture Box Basic Information
3	Picture Title	The title that appears on top of the picture box	text	Optional Field. Plain Text Only.
Picture Box Dimensions
4	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.
5	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.
6	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.
7	Force Resize	Should the image be resized when it is smaller than the specified height and width above or only when it is bigger. Check this box and it will be resized every time. - Often you do not want to make small images bigger due to the poor quality that you often get, but it is sometimes useful to get all pictures to the same size. check this box and small images will be blown up to fit.	checkbox	On / Off
Featured Photo
You can choose to display the site's featured photo with this picture box
8	Featured Image Options	Use the featured image on the site. - If you check this box, most of the information from the rest of this form will be ignored. The featured image is an image that editors have 'featurised'. It has a set width, height and size and normally appears in one of the columns on the front page.	checkbox	On / Off
9	Article View	The Article View Object that will be used to view that article that the featured photo links to - This is only relevant if you have checked the featured image box above.	reference	A reference to a data object of type article
Static Image Content Choices
These options will only be used if the image is not a featured photo
10	Image	The location of the graphics file itself (required unless you have selected featured image above) - The location of the file. You should use relative file paths (eg attachments/sites/site_1/myfile.gif) rather than URLs (that have http:// in front).	text	Optional Field. Plain Text Only.
11	Filtered File	Should the file be filtered by topic, region, language, type? Check this box and oscailt will attempt to find the best file. - Oscailt can automatically choose a categorised image for pages which have categories associated with them. Instead of simply loading the filename that you specify, oscailt will try to load files with category extensions on categorised pages. For example: If you have a site banner with different flavours for different regions covered by your sites, you can save each of them as banner_region.gif or even banner_region_topic.gif for specific topics within the region. If you check this box, oscailt will select the most appropriate categorised image available for each category.	checkbox	On / Off
12	Links to	Where does this picture link to (if any)?	text	Optional Field. Plain Text Only.
13	Image Caption	The text link beneath the picture (if any) - This allows you to place a caption beneath the image	text	Optional Field. Plain Text Only.
Access Control for this Picture Box
Protect this Picture Box from unauthorised users and from being used in other sections of the site
14	Protected	Should This Picture Box be hidden from the public? - Check this box if you want this Picture 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
15	Shared?	Should This Picture 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. Picture Inline
2. Picture
3. With Caption
4. With Title
5. With Caption And Title

Bugs

To do List and requested features

--Oscailt Auto-generated Documentation 09 Jan 2006