User Preferences

Version 1.0

Description

A User Preference Setting Object

Configuration

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

Configurable Settings
Number	Configurable Variable	Description	Input Type	Input Rules
1	Name	The Name of this User Preferences. - 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 User Preferences. - 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 User Preferences. - This allows you to link to the User Preferences with an image instead of a text string. Enter the name of a valid local file.	text	Optional Field. Plain Text Only.
User Preferences Basic Information
4	Short Title	A short text string that will link to the preference Page.	text	Mandatory Field. Plain Text Only.
5	Full Title	The String that will appear on top of the preferenc box	text	Optional Field. Plain Text Only.
User Menu Settings
Settings that apply to the Menu Display Mode
6	Show Font Size	Give users the option of changing the font size?	checkbox	On / Off
7	Font Size Text	The text inviting the user to change font	text	Mandatory Field. Plain Text Only.
8	Show Languages	Give users the option of changing the language?	checkbox	On / Off
9	Language Text	The text inviting the user to change language	text	Mandatory Field. Plain Text Only.
10	Show Set Home Page	Give users the option of setting their oscailt home page?	checkbox	On / Off
11	Oscailt Home Text	The text inviting the user to set their oscailt home page	text	Mandatory Field. Plain Text Only.
12	Show All Preferences Page	Give users a link to a page with all possible preference settings	checkbox	On / Off
13	All Preferences Text	The text inviting the user to view the page with all preferences	text	Mandatory Field. Plain Text Only.
Editor Menu Settings
Settings that only apply to logged in editors
14	Show Edit Mode Option	Give users the option of setting their edit mode?	checkbox	On / Off
15	Edit Mode Text	The text inviting the user to change edit mode	text	Mandatory Field. Plain Text Only.
16	Sitebuilder Mode Text	The text inviting the user to change edit mode to sitebuilder	text	Mandatory Field. Plain Text Only.
17	Content Mode Text	The text inviting the user to change edit mode to content	text	Mandatory Field. Plain Text Only.
18	All Mode Text	The text inviting the user to change edit mode to all	text	Mandatory Field. Plain Text Only.
19	Normal Mode Text	The text inviting the user to change edit mode to normal	text	Mandatory Field. Plain Text Only.
20	Show Logout Option	Give users the option of logging out?	checkbox	On / Off
21	Logout Text	The text inviting the user to log out	text	Mandatory Field. Plain Text Only.
22	Show Edit Profile	Give users the option of editing their profile?	checkbox	On / Off
23	Edit Profile Text	The text inviting the user to edit their profile	text	Mandatory Field. Plain Text Only.
24	Admin Link Text	The text inviting the user to view the admin page	text	Mandatory Field. Plain Text Only.
Full Page Settings
Settings that apply to the preferences object when viewed in full page mode
25	Page Header	Introductory text - Explain what the user can do on this page	textarea	Optional Field. HTML / PHP input allowed.
26	Page Footer	If you want to put some text at the bottom	textarea	Optional Field. HTML / PHP input allowed.
27	Successful Update Message	The message informing the user that their preferences have been updated	textarea	Mandatory Field. HTML / PHP input allowed.
28	Page Layout	The Layout of the Preference Page - Oscailt Data Objects are linked to page layout objects. This allows you to use a range of different page structures and different menus, bars etc. You create the page layout object that you want and then you simply link it from each of the objects that you want to use that layout.	reference	A reference to a data object of type page
29	Option	The text on the top of the option column on the preferences page	text	Mandatory Field. Plain Text Only.
30	Value	The text on the top of the value column on the preferences page	text	Mandatory Field. Plain Text Only.
31	Description	The text on the top of the description column on the preferences page	text	Mandatory Field. Plain Text Only.
32	Save Options Text	The text on the button inviting users to save their preferences	text	Mandatory Field. Plain Text Only.
33	Universal Section Text	The text on the top of the Universal Section on the preferences page	text	Mandatory Field. Plain Text Only.
34	Language Field Title	The title of the language field in the options table	text	Mandatory Field. Plain Text Only.
35	Language Field Description	The description of the language field in the options table	text	Mandatory Field. Plain Text Only.
36	Language Filter Title	The title of the language filter field in the options table - try "Mono-lingual filter"	text	Mandatory Field. Plain Text Only.
37	Language Filter Description	The description of the language filter field in the options table	text	Mandatory Field. Plain Text Only.
38	Language Filter On Text	The text beside the on button in the language filter field	text	Mandatory Field. Plain Text Only.
39	Language Filter Off Text	The text beside the off button in the language filter field	text	Mandatory Field. Plain Text Only.
40	Font Size Field Title	The title of the font size field in the options table	text	Mandatory Field. Plain Text Only.
41	Font Size Field Description	The description of the Font size field in the options table	text	Mandatory Field. Plain Text Only.
42	Article Section Text	The text on the top of the Article View Section on the preferences page	text	Mandatory Field. Plain Text Only.
43	Condense Comments Field	The title of the field that allows the user to condense comments in the option table	text	Mandatory Field. Plain Text Only.
44	Condense Comments Description	The description of the field that allows the user to condense comments in the option table	text	Mandatory Field. Plain Text Only.
45	Comment Order Field	the title of the field that allows the user to set the comment order in the option table	text	Mandatory Field. Plain Text Only.
46	Comment Order Description	the description of the field that allows the user to set the comment order in the option table	text	Mandatory Field. Plain Text Only.
47	Comment Page-size Field	The title of the field that allows the user to set the number of comments per page	text	Mandatory Field. Plain Text Only.
48	Comment Page-size Description	The description of the field that allows the user to set the number of comments per page	text	Mandatory Field. Plain Text Only.
49	Events Section Text	The text on the top of the Events Section on the preferences page	text	Mandatory Field. Plain Text Only.
50	Event Display Mode Field	The title of the field that allows the user to set the display mode of the event calendar in the options table	text	Mandatory Field. Plain Text Only.
51	Event Mode Description	The description of the event display mode entry in the options table	text	Mandatory Field. Plain Text Only.
52	Comments Section Text	The text on the top of the Comments Section on the preferences page	text	Mandatory Field. Plain Text Only.
53	Comment Titles Field	The title of the comment titles field in the options table	text	Mandatory Field. Plain Text Only.
54	Comment Titles Description	The description of the comment titles in the options table	text	Mandatory Field. Plain Text Only.
55	Show All Comments Field	The title of the show all comments field in the options table	text	Mandatory Field. Plain Text Only.
56	Show all comments Description	The description of the show all comments entry in the options table	text	Mandatory Field. Plain Text Only.
Access Control for this User Preferences
Protect this User Preferences from unauthorised users and from being used in other sections of the site
57	Protected	Should This User Preferences be hidden from the public? - Check this box if you want this User Preferences to be only visible to editors on the site. This can be useful for keeping certain pages hidden from public view.	checkbox	On / Off
58	Shared?	Should This User Preferences 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. Link
2. Icon
3. Icon And Link
4. Menu
5. Expandable Menu
6. Full Page

Bugs

To do List and requested features

--Oscailt Auto-generated Documentation 09 Jan 2006