PT Photo Gallery Overview

About Photo Gallery App

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

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.

Requirements

ADF components that are required for the Photo Gallery:

• CEData_1_0
• CSData_1_0
• Scripts_1_0
• CCAPI

ADF Extensions custom field types required for the Photo Gallery:

• Hidden Field With Name

ADF must be configured correctly for your site. Site Configuration has instructions for configuration.

Elements

This image represents the element relationships used in the Photo Gallery application.

Contents

The CS Photo Gallery contains the following:

• Custom Coding - various components and scripts.
• CommonSpot Components:
  • Photo - Custom Element
  • Photo Category - Custom Element
  • Photo Size - Custom Element

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

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.

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

Installation/Setup

Each of the following steps should be completedly fully and in the order presented:

1. ADF Configuration for the Photo Gallery
2. Extract Photo Gallery Application
3. Import CommonSpot Components
4. Site Configuration
5. CCAPI Configuration
6. Build CommonSpot Templates/Pages

Getting Started

• Getting Started - Guide to set up the photo sizes and categories.

Features

The photo gallery application provides the following features:

• Photo Gallery Element
• Photo Upload Link Custom Field Type
• Hook into CS Image Gallery
• Change Photo Manager Styles
• Photo Size Types

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.