Difference between revisions of "OHSU Navigation"
| Line 32: | Line 32: | ||
Each of the following steps should be completed fully and in the order presented: | Each of the following steps should be completed fully and in the order presented: | ||
* Download the Navigation app (two choices) | * Download the Navigation app (two choices) | ||
| − | ** Latest Zip Archive (http://community.paperthin.com/projects/ | + | ** Latest Zip Archive (http://community.paperthin.com/projects/ohsu_navigation/) |
| − | ** SVN (http:// | + | ** SVN (http://community.paperthin.com/svn/ohsu_nav/) |
* Place the code for the navigation (/ohsu_nav/) into the /ADF/apps/ directory | * Place the code for the navigation (/ohsu_nav/) into the /ADF/apps/ directory | ||
* Open the 'ADF.cfc' file for your site (located in the /site_folder/_cs_apps/ directory) in a text editor. Locate the 'Load the ADF Application into application space' comment in the file. Add (or uncomment) the following command under the comment section: | * Open the 'ADF.cfc' file for your site (located in the /site_folder/_cs_apps/ directory) in a text editor. Locate the 'Load the ADF Application into application space' comment in the file. Add (or uncomment) the following command under the comment section: | ||
| Line 44: | Line 44: | ||
Note: make sure that you are logged into CommonSpot before resetting the ADF | Note: make sure that you are logged into CommonSpot before resetting the ADF | ||
| − | * Import the Nav Element | + | * Import the Nav Element |
| − | * Import the Navigation Custom Field type | + | * Import the Navigation Custom Field type |
* [[Navigation CCAPI Setup|CCAPI Setup]] | * [[Navigation CCAPI Setup|CCAPI Setup]] | ||
* Create the [[Navigation Management Page]] | * Create the [[Navigation Management Page]] | ||
| Line 54: | Line 54: | ||
* [[Using the Navigation Application]] | * [[Using the Navigation Application]] | ||
* [[Customizing Navigation Rendering]] | * [[Customizing Navigation Rendering]] | ||
| + | * [[Navigation Element Best Practices]] | ||
== Known Issues/Bugs == | == Known Issues/Bugs == | ||
Revision as of 01:21, 20 April 2010
Contents
The Navigation application is built in the Application Development Framework (ADF).
Requirements
CommonSpot Features:
- Simple Forms/Datasheets
- Custom Metadata
ADF Library components that are required for the Profile:
- CEData_1_0
- CSData_1_0
- Scripts_1_0
- Data_1_0
- CCAPI
The ADF must be configured correctly for your site. The Site Configuration (ADF.cfc) wiki page has instructions for configuration.
Contents
The Navigation application contains the following CommonSpot components in the /ohsu_nav/exported_objects/ directory:
- Custom Coding - various components and scripts.
- CommonSpot Components:
- Nav Element (Custom Element)
- Navigation Custom Field Type
'Note:' Elements may contain one or more: Render Handlers or Custom Field Types. They do NOT use Display Templates.
Pre-installation Considerations
The ADF must be setup and configured on the server for the site that will be implementing the Navigation application. For detailed instructions follow the ADF Overview wiki page for Site Configurations.
This installation guide assumes that you have no Custom Elements/Metadata Forms with the names above. Before the install, remove any Custom Elements/Metadata Forms with the names listed in the "Contents" section above. (If you do not remove existing elements with these names, you may have difficulties during the installation.)
Installation/Setup
Each of the following steps should be completed fully and in the order presented:
- Download the Navigation app (two choices)
- Latest Zip Archive (http://community.paperthin.com/projects/ohsu_navigation/)
- SVN (http://community.paperthin.com/svn/ohsu_nav/)
- Place the code for the navigation (/ohsu_nav/) into the /ADF/apps/ directory
- Open the 'ADF.cfc' file for your site (located in the /site_folder/_cs_apps/ directory) in a text editor. Locate the 'Load the ADF Application into application space' comment in the file. Add (or uncomment) the following command under the comment section:
loadApp("ohsuNav");
- Reset the ADF for the site by adding the following URL parameter to any page within the site. (If the site is completely new, you may have to create an index.cfm page first.)
?ResetSiteADF=1
Note: make sure that you are logged into CommonSpot before resetting the ADF
- Import the Nav Element
- Import the Navigation Custom Field type
- CCAPI Setup
- Create the Navigation Management Page
- Configure the Navigation Element
- Add the Navigation Custom Field Type to a metadata form
Guides
Known Issues/Bugs
- Visit the Navigation project page in the Community site [1]
