Difference between revisions of "OHSU Navigation"

From ADF Docs
Jump to: navigation, search
(→‎Description)
 
(23 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
== About Navigation App ==
 
== About Navigation App ==
 
The [http://community.paperthin.com/projects/ohsu_navigation/ OHSU Navigation] application is built in the [[Overview|Application Development Framework (ADF)]].
 
The [http://community.paperthin.com/projects/ohsu_navigation/ OHSU Navigation] application is built in the [[Overview|Application Development Framework (ADF)]].
 +
 +
'''''IMPORTANT:''' This application has been deprecated. PaperThin strongly recommends that customers utilizing this application''
 +
''should migrate to the native CommonSpot Tree Navigation elements.''
  
 
== Overview ==
 
== Overview ==
 
The OHSU Navigation app handles your site navigation with ease. On page creation a metadata form allows the user to add their page to navigation and through an intuitive drag and drop interface move the page into their desired order. The navigation system handles navigation nesting (trees) by default through the use of subsites.
 
The OHSU Navigation app handles your site navigation with ease. On page creation a metadata form allows the user to add their page to navigation and through an intuitive drag and drop interface move the page into their desired order. The navigation system handles navigation nesting (trees) by default through the use of subsites.
  
−
== Requirements ==
+
== Pre-installation Considerations ==
−
CommonSpot Features:
+
The [[Overview|ADF]] must be setup and configured on the server for the site that will be implementing the Navigation application.  For detailed instructions follow the [[Overview|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.)
 +
 
 +
CommonSpot Required Features:
 
* Simple Forms/Datasheets
 
* Simple Forms/Datasheets
 
* Custom Metadata
 
* Custom Metadata
Line 15: Line 22:
 
The Content Creation API (CCAPI) must be configured for your site.  The [[CCAPI_Config|CCAPI Configuration]] wiki page has instructions for configuration.
 
The Content Creation API (CCAPI) must be configured for your site.  The [[CCAPI_Config|CCAPI Configuration]] wiki page has instructions for configuration.
  
−
== Contents ==
+
== Installation Guides ==
−
The Navigation application contains the following CommonSpot components in the /ohsu_nav/exported_objects/ directory:
+
<!-- '''Current Release:''' -->
−
* Custom Coding - various components and scripts.
+
'''Last ADF 2.0 Release Version:'''
−
* CommonSpot Components:
+
*v3.0:
−
** [[NavElement | Nav Element]] (Custom Element)
+
** [[OHSU_Navigation_Release_Notes_v3.0|Release Notes]]
−
** Navigation Custom Field Type
+
** [[OHSU_Navigation_Install_v3.0|Install Guide]]
−
 
+
** [[OHSU_Navigation_Upgrade_v3.0|Upgrade Guide]]
−
'Note:' Elements may contain one or more: Render Handlers or Custom Field Types. They do NOT use Display Templates.
+
  IMPORTANT: v2.0 of this application requires the '''ADF 2.0''' or greater
−
 
 
−
== Pre-installation Considerations ==
 
−
The [[Overview|ADF]] must be setup and configured on the server for the site that will be implementing the Navigation application.  For detailed instructions follow the [[Overview|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.)
+
'''Last ADF 1.8 Release Version:'''
 +
*v2.0:
 +
** [[OHSU_Navigation_Release_Notes_v2.0|Release Notes]]
 +
** [[OHSU_Navigation_Install_v2.0|Install Guide]]
 +
** [[OHSU_Navigation_Upgrade_v2.0|Upgrade Guide]]
 +
  IMPORTANT: v2.0 of this application requires the '''ADF 1.6''' up to '''ADF 1.8.x'''
  
−
?ResetSiteADF=1
 
  
−
Note: make sure that you are logged into CommonSpot before resetting the ADF
+
'''Previous Releases:'''
−
* Import the Nav Element
+
* v1.0:
−
* Import the Navigation Custom Field type
+
** [[OHSU_Navigation_Install_v1.0|Install Guide]]
−
* [[Navigation CCAPI Setup|CCAPI Setup]]
 
−
* Create the [[Navigation Management Page]]
 
−
* [[Navigation Element Configuration | Configure ]] the Navigation Element
 
−
* Add the [[Navigation Custom Field Type]] to a metadata form
 
  
 
== Guides ==
 
== Guides ==
Line 57: Line 50:
  
 
== Known Issues/Bugs ==
 
== Known Issues/Bugs ==
−
* Visit the Navigation project page in the Community site [http://community.paperthin.com/projects/ohsu_nav/]
+
* Visit the [http://community.paperthin.com/projects/ohsu_nav/ OHSU Navigation] project page in the Community site.
  
 
[[Category:Project]][[Category:OHSU Navigation]]
 
[[Category:Project]][[Category:OHSU Navigation]]

Latest revision as of 14:17, 18 May 2016

About Navigation App

The OHSU Navigation application is built in the Application Development Framework (ADF). 

IMPORTANT: This application has been deprecated. PaperThin strongly recommends that customers utilizing this application
should migrate to the native CommonSpot Tree Navigation elements.

Overview

The OHSU Navigation app handles your site navigation with ease. On page creation a metadata form allows the user to add their page to navigation and through an intuitive drag and drop interface move the page into their desired order. The navigation system handles navigation nesting (trees) by default through the use of subsites.

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.)

CommonSpot Required Features:

  • Simple Forms/Datasheets
  • Custom Metadata
  • CCAPI

The ADF must be configured correctly for your site. The Site Configuration (ADF.cfc) wiki page has instructions for configuration.

The Content Creation API (CCAPI) must be configured for your site. The CCAPI Configuration wiki page has instructions for configuration.

Installation Guides

Last ADF 2.0 Release Version: 

 IMPORTANT: v2.0 of this application requires the ADF 2.0 or greater


Last ADF 1.8 Release Version: 

 IMPORTANT: v2.0 of this application requires the ADF 1.6 up to ADF 1.8.x


Previous Releases:

Guides

Known Issues/Bugs

Retrieved from "http://community.paperthin.com/adf-docs/index.php?title=OHSU_Navigation&oldid=7265"