Difference between revisions of "PT Photo Gallery Overview"

From ADF Docs
Jump to: navigation, search
(Contents)
(Installation Guides)
 
(23 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
 +
 
== About Photo Gallery App ==
 
== About Photo Gallery App ==
 
The Photo Gallery application is built in the [[Overview|Application Development Framework (ADF)]].
 
The Photo Gallery 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 Image Galleries.''
  
 
== Overview ==
 
== Overview ==
Line 11: Line 16:
 
The Photo element stores the information for the uploaded photo.  This element stores the path to the original photo and the category for the photo.  Combining these fields, we are able to return the size breakdowns for the photo category.
 
The Photo element stores the information for the uploaded photo.  This element stores the path to the original photo and the category for the photo.  Combining these fields, we are able to return the size breakdowns for the photo category.
  
== Requirements ==
+
== Pre-installation Considerations ==
ADF Library components that are required for the Photo Gallery:
+
[[Overview|Application Development Framework (ADF)]] must be setup and configured on the server for the site that will be implementing the Photo Gallery application. For detailed instructions, see the [[Overview|Application Development Framework (ADF)]] wiki page for Site Configurations.
* ceData_1_0
 
* csData_1_0
 
* scripts_1_0
 
* CCAPI
 
* utils_1_0
 
* forms_1_0
 
 
 
ADF must be configured correctly for your site.  [[Site Configuration|Site Configuration]] has instructions for configuration.
 
 
 
== Elements ==
 
This image represents the element relationships used in the Photo Gallery application.
 
 
 
 
 
[[Image:adf_photogallery_elements.gif]]
 
 
 
== Contents ==
 
The CS Photo Gallery contains the following:
 
* Custom Coding - various components and scripts.
 
* '''Custom Elements:'''
 
** [[PT_Photo_Gallery_Photo_Custom_Element|Photo]] - Custom Element
 
** [[PT_Photo_Gallery_Photo_Category_Custom_Element|Photo Category]] - Custom Element
 
** [[PT_Photo_Gallery_Photo_Size_Custom_Element|Photo Size]] - Custom Element
 
 
 
* '''Custom Fields:'''
 
** Photo Image Gallery Checkbox Field
 
** Photo Upload
 
** Photo Size Select Metadata Form Field
 
** Photo Chooser
 
** Photo Image
 
** General Chooser
 
  
Note: Elements may contain one or more: Render Handlers, Display Templates, or Custom Field Types
+
== Installation Guides ==
 +
'''Last ADF 2.0 Release Version:'''
 +
* v4.0
 +
** [[PT_Photo_Gallery_4.0_Release_Notes|Version 4.0 Release Notes]]
 +
** [[PT_Photo_Gallery_4.0_Install|Version 4.0 Install Guide]]
 +
** [[PT_Photo_Gallery_4.0_Upgrade|Version 4.0 Upgrade Guide]]
 +
IMPORTANT: v4.0 of this application requires '''ADF 2.0''' or greater (and '''CommonSpot 10''' or greater)
  
== Pre-installation Considerations ==
 
[[Overview|Application Development Framework (ADF)]] must be setup and configured on the server for the site that will be implementing the Photo Gallery application.  For detailed instructions, see the [[Overview|Application Development Framework (ADF)]] wiki page for Site Configurations.
 
  
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.)
+
'''Last ADF 1.8 Release Version:'''
 +
* v3.1:
 +
** [[PT_Photo_Gallery_Release_Notes_v3.1|Version 3.1 Release Notes]]
 +
** [[PT_Photo_Gallery_Install_v3.1|Version 3.1 Install Guide]]
 +
** [[PT_Photo_Gallery_Upgrade_v3.1|Version 3.1 Upgrade Guide]]
 +
  IMPORTANT: v3.1 of this application requires the '''ADF 1.6''' up to '''ADF 1.8.x'''
  
== Installation/Setup ==
 
Each of the following steps should be completedly fully and in the order presented:
 
  
# [[PT_Photo_Gallery_Extract|Extract Photo Gallery Application]]
+
Previous Versions:
# [[PT_Photo_Gallery_ADF Configuration|ADF Configuration for the Photo Gallery]]
+
*v3.0:
# [[PT_Photo_Gallery_Styles|Styles]]
+
** [[PT_Photo_Gallery_Release_Notes_v3.0|Release Notes]]
# [[PT_Photo_Gallery_Import|Import Elements]]
+
** [[PT_Photo_Gallery_Install_v3.0|Install Guide]]
# [[PT_Photo_Gallery_Site_Configuration|Site Configuration]]
+
** [[PT_Photo_Gallery_Upgrade_v3.0|Upgrade Guide]]
# [[PT_Photo_Gallery_Build_Templates_Pages|Build Templates/Pages]]
+
* v2.3:
 +
** [[PT_Photo_Gallery_Version_2.3_Release_Notes|Release Notes]]
 +
** [[PT_Photo_Gallery_Version_2.3_Install|Install Guide]]
 +
** [[PT_Photo_Gallery_Version_2.3_Upgrade|Upgrade Guide]]
 +
* v2.2
 +
** [[PT_Photo_Gallery_Version_2.2_Release_Notes|Version 2.2 Release Notes]]
 +
** [[PT_Photo_Gallery_Version_2.2_Install|Version 2.2 Install Guide]]
 +
** [[PT_Photo_Gallery_Version_2.2_Upgrade|Version 2.2 Upgrade Guide]]
 +
* v2.1
 +
** [[PT_Photo_Gallery_Version_2.1_Release_Notes|Version 2.1 Release Notes]]
 +
** [[PT_Photo_Gallery_Version_2.1_Install|Version 2.1 Install Guide]]
 +
** [[PT_Photo_Gallery_Version_2.1_Upgrade|Version 2.1 Upgrade Guide]]
 +
* v2.0
 +
** [[PT_Photo_Gallery_Version_2.0_Install|Version 2.0 Install Guide]]
 +
** [[PT_Photo_Gallery_Version_2.0_Upgrade|Version 2.0 Upgrade Guide]]
 +
* v1.2
 +
** [[PT_Photo_Gallery_Version_1.2_Install | Install v1.2 ]]
  
 
== Getting Started==
 
== Getting Started==
Line 71: Line 69:
 
* [[PT_Photo_Gallery_Photo_Manager_Styles|Customize Photo Manager Styles]]
 
* [[PT_Photo_Gallery_Photo_Manager_Styles|Customize Photo Manager Styles]]
 
* [[PT_Photo_Gallery_Photo_Size_Types|Photo Size Types]]
 
* [[PT_Photo_Gallery_Photo_Size_Types|Photo Size Types]]
 +
* [[PT_Photo_Gallery_Cropper_Field|Photo Cropper Custom Field]]
  
 
== Troubleshooting ==
 
== Troubleshooting ==

Latest revision as of 14:19, 18 May 2016


About Photo Gallery App

The Photo Gallery 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 Image Galleries.

Overview

The Photo Gallery provides the ability to set dimension requirements for the uploaded image and to resize according to the sizes selected for the category.

A Photo Category is associated with Photo Size elements. The selections are the dimensions required for the initial upload and the resize processing dimensions. The fields in the element define the category title and the directory to store the category's upload images.

The Photo Size element provides a collection of predefined dimensions and directory names. Elements are selected and associated with the Photo Category.

The Photo element stores the information for the uploaded photo. This element stores the path to the original photo and the category for the photo. Combining these fields, we are able to return the size breakdowns for the photo category.

Pre-installation Considerations

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

Installation Guides

Last ADF 2.0 Release Version:

IMPORTANT: v4.0 of this application requires ADF 2.0 or greater (and CommonSpot 10 or greater)


Last ADF 1.8 Release Version:

 IMPORTANT: v3.1 of this application requires the ADF 1.6 up to ADF 1.8.x


Previous Versions:

Getting Started

Features

The photo gallery application provides the following features:

Troubleshooting

Known Issues/Bugs

Found a bug? View the Known Issues/Bugs wiki page. Your issue not on the list? Post it so the issue can be addressed.