- Overview
- How-To Access and Change Page Custom Properties
- The properties
- auto_menu_type
- content_in_sidebar
- css_inline
- css_link
- department_name
- department_name_and_page_category
- flash_menu
- footer_content
- footer_goto_top
- footer_mod_date
- has_right_component (Medicine 5.1 only)
- javascript_inline
- javascript_link
- left_background
- nav_trail_display
- on_load or onLoad
- page_baseTag_use
- page_title
- place_rightbar_content (Medicine 5.1 only)
- print_right_sidebar
- print_sidebar
- right_background
- right_sidebar
- qualifiers (Medicine 5.1 only)
- show_in_auto_menu
- sidebar_background
- use_auto_menu_in_sidebar
- use_sidebar
Overview
Page custom properties are settings that affect the individual page being authored in the Content Management Server (CMS). Each custom property has a different function that is outlined in this document. The custom properties on a page will vary depending on the template being used. If a property is not listed, then it is unavailable for the page. Some of the custom properties work together or affect the use of another property. Custom properties are listed in alphabetical order. Unless changed the default values of the custom properties are being applied to the page.
Some custom properties require an intermediate understanding of web programming and the underlining coding of web pages. Many of the properties though are easily used and can greatly ease authoring of web pages. There are two types of custom property, a selection list or free form text entry. No text custom property may have more than 2000 characters.
How-To Access and Change Page Custom Properties
- Navigate to the page in the CMS
- Ensure you are in edit site more
- Click the link "Page Properties" from the edit site menu
- Click the "Custom" tab from the page properties window that opened
- Select the property by clicking the icon (insert icon picture here)
- Enter or select the new value in the custom property window that opened
- Click okay to save the change to the custom property or cancel to abort changing the property
- When finished editing all custom properties, inside the page properties window, select save changes to save all changes to the page or cancel to abort changing all the custom properties.
- The page being edited will reload, be set to the state saved and the custom property changes will take effect.
The properties
auto_menu_type
Description: If an automatically generated menu is used within the left column of two or three column layout, this property determines what type of menu is output in the left column of the current page. These automatically generated menus have specific styles that can be altered to change their appearance.
Use: Determines which automatically generated navigation menu for a page will be
Property Type: Selection List
Property Values and Meanings:
-
1- Pages then subchannels
Outputs the pages contained within the current channel using the display name of the posting first. Then all the sub channels (folders) are output as part of the list. The order of this list is determined by the channel sorting order that can be modified by the moderator.
Example:
- Posting A
- Posting B
- Posting C
- Sub channel A
- Sub channel B
-
2- Subchannels then pages
Outputs the same type of listing as menu type one but the order is reversed.
Example:
- Sub channel A
- Sub channel B
- Sub channel C
- Posting A
- Posting B
- Posting C
-
3- Just subchannels
This menu type outputs the sub channels of the current channel as the only items of the automatically generated menu. The order can be determined by the sorting order of the current channel.
Example:
- Sub channel A
- Sub channel B
- Sub channel C
- Sub channel D
-
4- Channels w/ current channel sublist
This menu type outputs the all the peer channels and the current channel as the main list. The current channel has an indented listing of its contents displayed as just like menu type one. The sorting order of the sub list is determined by the current channel sorting order. The peer channels are sorted by the parent channel sorting order.
Example:
- Peer channel A
- Peer channel B
- Current channel
- Posting A
- Posting B
- Sub channel A
- Sub channel B
- Peer channel C
-
5- List
This menu type outputs only the postings of the current channel as tan menu buttons that highlight green when the cursor passes over the button. The postings are sorted according to the channel sorting order.
-
6- Custom
This menu type recursively searches in the current channel then the parent channels for a posting named "custommenu". This posting is created by a special template called "Custom Menu". When this posting is found, then whatever contents of the placeholder on the posting is displayed as the automatically generated menu. The contents can include images, text, links, and more. This feature is good for creating a single menu system for an entire web site.
content_in_sidebar
Description: This custom property toggles on or off two place holders in the left column of a multi-column layout. These place holders are placed above and below the automatically generated menu.
Use: These place holders enable the extension of the automatically generated menu or put content in place of the automatically generated menu. If the automatically generated menu is not used, one of these place holders must be used or the left column will be blank.
Property Type: Selection List
Property Values and Meanings:
- Above Menu – Inserts a content placeholder above the auto generated menu, or where it would appear if used, in the left column.
- Below Menu – Inserts a content placeholder below the auto generated menu, or where it would a
- Both – Both content placeholders are placed within the left column to be used.
Illustration of placeholder location in left column of page
css_inline
Description: Allows the inclusion of Cascading Style Sheet (CSS) rules within the page header.
Use: Enter the CSS rules that will apply to elements only on this page. An understanding of CSS 2 is required.
Property Type: Text
Property Values and Meanings: The value can be any entered text but should be well formed CSS rule declarations.
css_link
Description: Allows the inclusion of a link to a separate CSS document that will be used to format the current page.
Use: This allows the use of a single document to help keep a single format for multiple pages and to ease maintenance.
Property Type: Text
Property Values and Meanings: URI to style sheet (i.e. http://hsc.usf.edu/nocms/is/is.css
department_name
Description: This property is deprecated and may no longer be used in the near future. The page title place holder found on the CMS page has replaced this use. This property appeared as the main page title for level 2 and level 3 templates
Use: To have the department name appear as the page title in the HSC banner
Property Type: Text
Property Values and Meanings: The name of the department
department_name_and_page_category
Description: This property is deprecated and may no longer be used in the near future. Automatic generation of the page qualifiers in the HSC banner has replaced the need for this custom property. It is used to display the page qualifiers of the document.
Use: To enter in the values that will be displayed as the page qualifiers the document. Each item of the qualifiers should be separated by a mid dot
Property Type: Text
Property Values and Meanings: The mid dot separated list of qualifiers. i.e. department, division
flash_menu
Description: (Deprecated) This property only works on the "coph level 4" template. It is used to allow the user to type in the HTML code to embed a flash element inside the left sidebar.
Use: Enter the HTML code that would embed the flash menu in the page. Make sure that the flash size would not be larger than the sidebar.
Property Type: Text
Property Values and Meanings:
- No- (default) No flash object is emebedded.
- Entered Text- HTML code that would call and display a flash menu
footer_content
Description: Toggles between a standard footer text and a placeholder where footer information can be entered.
Use: Allows the use custom footers over the standard footer when necessary.
Property Type: Selection List
Property Values and Meanings:
- Default – Use the default footer for the page.
12901 Bruce B. Downs Blvd.
Tampa , Florida 33612
This page was last modified on 5/11/2005.
Top of Page
- Enter custom – A placeholder will appear at the footer location and allows the user to enter other content and that content replaces the default footer.
footer_goto_top
Description: Toggles the use of the link back to the top of the page in the default footer
Use: Turn on or off the link back up to the top of the page in the default footer. This property will only be active if the default footer is being used.
Property Type: Selection List
Property Values and Meanings:
- Hide – The link is not displayed.
12901 Bruce B. Downs Blvd.
Tampa , Florida 33612
This page was last modified on 5/11/2005.
- Show – The link is displayed.
12901 Bruce B. Downs Blvd.
Tampa , Florida 33612
This page was last modified on 5/11/2005.
Top of Page
footer_mod_date
Description: Toggles on and off the last modified date on the default footer.
Use: Turn on or off the last modified date line in the default footer. This property will only be active if the default footer is being used.
Property Type: Selection List
Property Values and Meanings:
- Hide – The date is not displayed
12901 Bruce B. Downs Blvd.
Tampa , Florida 33612
Top of Page
- Show – The date is displayed
12901 Bruce B. Downs Blvd.
Tampa , Florida 33612
This page was last modified on 5/11/2005.
Top of Page
has_right_component
Description: Toggles on and off whether the current web page will display the right component. The right component is analogous to the auto menu for the left column and can be used to house content that needs to be applied to the entire website.
Use: To display a component on the right column that should be seen throughout the entire site
Property Type: Selection List
Property Values and Meanings:
- Yes- include right component on page
- No- do not include right component on page
javascript_inline
Description: Used to place a small set of Javascript coding within the HTML document header for the web page.
Use: Allows the user to enter just the Javascript coding to create functions or execute code. This will native Javascript code without the script tags or HTML comments.
Property Type: Text
Property Values and Meanings: Javascript code syntax
javascript_link
Description: Used to page to an external Javascript file.
Use: Designate the URI of the file that will be linked for use in this web page.
Property Type: Text
Property Values and Meanings: URI (i.e. http://hsc.usf.edu/nocms/global_files/mm.js)
left_background
Description: Used to designate a background image of the left column in a multicolumn layout.
Use: Designate the URI of the image. Also make sure that the sidebar_background property is set to blank so that no image conflicts occur
Property Type: Text
Property Values and Meanings: (URI) is the default value and no image will be displayed. Entering the URI of a graphic file surrounded by parenthesis, i.e. (http://hsc.usf.edu/images/graphicfile.jpg), will display that file as the repeating background for the left column.
nav_trail_display
Description: This replaces the display name of the posting in the breadcrumbs (Nav Trail) and is the text displayed.
Use: Shortens long name and makes the nav trail smaller in size.
Property Type: Text
Property Values and Meanings: Text that will be displayed in the breadcrumb trail for the posting.
on_load or onLoad
Description: Sets the Javacript Code within the body onLoad event handler. Both can be used on pages that have both. On_load will soon be deprecated and removed. Use onLoad for future references.
Use: Call functions and execute javascript code when the page loads
Property Type: Text
Property Values and Meanings: Any single line javascript that would be put inside the quotation marks of the onLoad event handler.
page_baseTag_use
Description: Toggles on and off a BASE tag using the current page in relation to the main web server root for the basis of all the links on the web page.
Use: Turn on this custom property to ensure pages using Virtual URL and forwards on there site will have correct links to global resources. This property should be used when any URL forward or alias affects the web page.
Property Type: Selection
Property Values and Meanings:
- Yes – The base tag is output on the staged CMS page
- No – The base tag is not output on the staged CMS page
page_title
Description: Deprecated and replaced by page title place holder that is on web pages. Used on templates that do not have the place holder. The custom property inserts the page title text for the HSC banner and for the actual HTML page title.
Use: Enter the page title text for the HSC banner and for the actual HTML page title. This text may have HTML tags.
Property Type: Text
Property Values and Meanings: Text entered appears in the HSC Banner and HTML page title
place_rightbar_content
Description: This custom property toggles on or off two place holders in the right column of a multi-column layout. These place holders are placed above and below the right component if used throughout the site. Analogous to the content_in_sidebar property for the left column.
Use: These place holders enable two additional areas of content to be available in the right column. If the right component is not used, one of these place holders must be used or the right column will be blank.
Property Type: Selection List
Property Values and Meanings:
- Above Menu – Inserts a content placeholder above the right component, or where it would appear if used, in the right column.
- Below Menu – Inserts a content placeholder below the right component, or where it would appear if used, in the right column.
- Both – Both content placeholders are placed within the right column to be used.
Illustration of placeholder location in right column of page
print_right_sidebar
Description: Toggles the whether the content of the right hand column of a 2 or 3 column layout is output when the printer friendly link is clicked.
Use: Only turn this property on when the content of the right hand column needs to go with printed material.
Property Type: Selection List
Property Values and Meanings:
- yes - Right hand column is included in the printer friendly output.
- no – Right hand column is not included in the printer friendly output.
print_sidebar
Description: Toggles the whether the content of the left hand column of a 2 or 3 column layout is output when the printer friendly link is clicked.
Use: Only turn this property on when the content of the left hand column needs to go with printed material. Most often, the default no will be used. The left column is mostly used for Web navigation and not needed on printed documents.
Property Type: Selection List
Property Values and Meanings:
- yes - Left hand column is included in the printer friendly output.
- no – Left hand column is not included in the printer friendly output.
qualifiers
Description: Text below the Header Title.
Use: Usually used to include organization name below Header Title, but can be used to display any custom text. Was introduced because some long department names extended into the search tab.
Property Type: Text
Property Values and Meanings: Custom text
right_background
Description: Used to designate a background image of the right column in a multicolumn layout.
Use: Designate the URI of the image to be used as the background for the right column.
Property Type: Text
Property Values and Meanings: (URI) is the default value and no image will be displayed. Entering the URI of a graphic file surrounded by parenthesis, i.e. (http://hsc.usf.edu/images/graphicfile.jpg), will display that file as the repeating background for the left column.
right_sidebar
Description: Determines whether the right column will be used on a page and what width the column will be.
Use: Select a pixel width to turn on the column and set its size to that width.
Property Type: Selection List
Property Values and Meanings:
- none – column is off
- XXXpx – width of the column that will be displayed on the right hand side of the page layout.
show_in_auto_menu
Description: Toggles on and off whether the current web page or channel will be displayed in auto generated menus. This applies to all auto generating but the custom menu.
Use: To stop or display the current page in auto generating menus. A request must be made to IS to have the custom property added to a channel.
Property Type: Selection List
Property Values and Meanings:
- Yes- Display the current page or channel in auto generating menus
- No- Do not display the current page or channel in auto generating menus
sidebar_background
Description: Provides a theme for the left column of a multi column layout. The theme sets up the background and text colors of the left column.
Use: Select a prearranged theme for the left column. This theme needs to be "blank" if a custom menu or image are used for the background.
Property Type: Selection List
Property Values and Meanings:
- None- Sets up simple theme with no background and green links
- Green Logo – Green background with logo appropriate to HSC, or College. The text is white and links are white with rollover underlines.
- White Logo – White background with logo appropriate to HSC, or College. The text is black and links are dark green with rollover underlines.
- Blank- No theme is applied to the column. Use this value to not interfere with other custom properties.
use_auto_menu_in_sidebar
Description: Turns on and off the auto generating menu in the left column of a multicolumn layout.
Use: Turn on this property to enable an auto generating navigation menu in the left hand column. Use_sidebar must be set to enable the display of the left column for this property to be enabled.
Property Type: Selection List
Property Values and Meanings:
- Yes – Use the menu in the left column
- No – Do not use the menu in the left column
use_sidebar
Description: Determines whether the left column will be used on a page and what width the column will be.
Use: Select a pixel width to turn on the column and set its size to that width.
Property Type: Selection List
Property Values and Meanings:
- none – column is off
- XXXpx – width of the column that will be displayed on the right hand side of the page layout.