Difference between revisions of "PT Comments"

From ADF Docs
Jump to: navigation, search
(Installation/Setup)
(Installation Guides)
 
(20 intermediate revisions by 4 users not shown)
Line 1: Line 1:
== About Comments App ==
+
== Overview ==
 +
The Comments application provides the flexibility to add comments to any custom element within the CommonSpot site.  Functionality to dynamically add a comments block to news articles, publications, etc. 
 +
 
 
The Comments application is built in the [[Overview|Application Development Framework (ADF)]].
 
The Comments application is built in the [[Overview|Application Development Framework (ADF)]].
  
== Overview ==
+
== Pre-installation Considerations ==
The Comments application provides the flexibility to add comments to any custom element within the CommonSpot siteFunctionality to dynamically add a comments block to news articles, publications, etc.
+
[[Overview|Application Development Framework (ADF)]] must be setup and configured on the server for the site.  For detailed instructions, see the [[Overview|Application Development Framework (ADF)]] wiki page for Site Configurations.
 +
 
 +
The CCAPI must be configured for the site.  Follow the steps to set up the [[CCAPI Config|CCAPI Config]] file for the site.
 +
 
 +
== Installation Guides ==
 +
 
 +
'''Current Release Version:'''
 +
* v2.4
 +
** [[PT_Comments_v2.4_Release_Notes|Version 2.4 Release Notes]]
 +
** [[PT_Comments_v2.4_Install|Version 2.4 Install Guide]]
 +
** [[PT_Comments_v2.4_Upgrade|Version 2.4 Upgrade Guide]]
 +
 
 +
'''IMPORTANT''': The above versions of this application require '''ADF 2.5''' or greater and '''CommonSpot 10.5.2 or 10.6.1''' or greater.
 +
 
 +
'''Previous Versions:'''
 +
* v2.3
 +
** [[PT_Comments_v2.3_Release_Notes|Version 2.3 Release Notes]]
 +
** [[PT_Comments_v2.3_Install|Version 2.3 Install Guide]]
 +
** [[PT_Comments_v2.3_Upgrade|Version 2.3 Upgrade Guide]]
 +
 
 +
  NOTE: v2.3 of this application is compatible with '''ADF 2.x up to ADF 2.4.x'''.
 +
 
 +
* v2.2
 +
** [[PT_Comments_v2.2_Release_Notes|Version 2.2 Release Notes]]
 +
** [[PT_Comments_v2.2_Install|Version 2.2 Install Guide]]
 +
** [[PT_Comments_v2.2_Upgrade|Version 2.2 Upgrade Guide]]
 +
 
 +
NOTE: v2.2 of this application is compatible with both '''ADF 1.8.x''' and '''ADF 2.x up to ADF 2.4.x'''.
 +
 
 +
*v2.1:
 +
** [[PT_Comments_Install_v2.1|Install Guide]]
 +
** [[PT_Comments_Upgrade_v2.1|Upgrade Guide]]
 +
 
 +
*v1.0:
 +
** [[PT_Comments_Release_Notes_v1|Release Notes]]
 +
** [[PT_Comments_Install_v1|Install Guide]]
  
== Requirements ==
 
ADF Library components that are required for the Photo Gallery:
 
* CCAPI
 
* ceData_1_0
 
* scripts_1_0
 
  
ADF must be configured correctly for your site. [[Site Configuration (ADF.cfc)]] has instructions for configuration.
+
<!--
 +
'''Development Release Version:'''
 +
* v2.3
 +
** [[PT_Comments_v2.3_Release_Notes|Version 2.3 Release Notes]]
 +
** [[PT_Comments_v2.3_Install|Version 2.3 Install Guide]]
 +
** [[PT_Comments_v2.3_Upgrade|Version 2.3 Upgrade Guide]]
 +
-->
  
 
== Contents ==
 
== Contents ==
Line 20: Line 58:
 
Note: Elements may contain one or more: Render Handlers, Display Templates, or Custom Field Types
 
Note: Elements may contain one or more: Render Handlers, Display Templates, or Custom Field Types
  
== Pre-installation Considerations ==
+
== Going Further ==
[[Overview|Application Development Framework (ADF)]] must be setup and configured on the server for the site.  For detailed instructions, see the [[Overview|Application Development Framework (ADF)]] wiki page for Site Configurations.
+
* [[PT_Comments_Going_Further|Going Further]] - Guide to using comments for more than just a page.
 
 
This installation guide assumes that you have no Custom Elements/Metadata Forms with the names above.  Before the installation of CS Photo Gallery, remove any Custom Elements/Metadata Forms with the names contained in the "Contents" section above.  (If you do not remove existing elements with these names, you may have difficulties during the installation.)
 
 
 
The CCAPI must be configured for the site.  Follow the steps to set up the [[CCAPI Config|CCAPI Config]] file for the site.
 
 
 
== Installation/Setup ==
 
Each of the following steps should be completed fully and in the order presented:
 
 
 
# [[PT_Comments_Extract|Extract Comments Application]]
 
# [[PT_Comments_ADF_Configuration|ADF Configuration]]
 
# [[PT_Comments_Import|Import Element]]
 
# [[PT_Comments_Site_Configuration|Site Configuration]]
 
# [[PT_Comments_Build_Templates_Pages|Build Templates/Pages]]
 
 
 
== Getting Started ==
 
* [[PT_Photo_Gallery_Getting_Started|Getting Started]] - Guide to set up the photo sizes and categories.
 
  
 
[[Category:Project]]
 
[[Category:Project]]
 
[[Category:Comments]]
 
[[Category:Comments]]

Latest revision as of 21:40, 3 March 2020

Overview

The Comments application provides the flexibility to add comments to any custom element within the CommonSpot site. Functionality to dynamically add a comments block to news articles, publications, etc.

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

Pre-installation Considerations

Application Development Framework (ADF) must be setup and configured on the server for the site. For detailed instructions, see the Application Development Framework (ADF) wiki page for Site Configurations.

The CCAPI must be configured for the site. Follow the steps to set up the CCAPI Config file for the site.

Installation Guides

Current Release Version:

IMPORTANT: The above versions of this application require ADF 2.5 or greater and CommonSpot 10.5.2 or 10.6.1 or greater.

Previous Versions:

NOTE: v2.3 of this application is compatible with ADF 2.x up to ADF 2.4.x.
NOTE: v2.2 of this application is compatible with both ADF 1.8.x and ADF 2.x up to ADF 2.4.x.


Contents

The Comments Application contains the following:

  • Custom Elements:

Note: Elements may contain one or more: Render Handlers, Display Templates, or Custom Field Types

Going Further

  • Going Further - Guide to using comments for more than just a page.