Difference between revisions of "PT Photo Gallery v2 Install"

Revision as of 19:55, 22 October 2011

Extract Photo Gallery Application

Download the Photo Gallery Application from the Community Site or from the SVN Repository.

Extract the zip files into the following directory: /ADF/apps/pt_photo_gallery/

ADF Configuration

The Photo Gallery Application is built within the ADF. The ADF must be installed in the site to run the Photo Gallery, follow the ADF Installation instructions.

• Make sure the ADF is setup and running on the site. If the ADF is not setup, then follow the instructions for ADF Installation.
• Open the sites 'ADF.cfc' (See Site Configuration (ADF.cfc) for more info) file (located in your site's /_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("ptPhotoGallery");

• Reset the ADF for the server and site.

Styles

There are several out of the box style options for the Photo Gallery application. The styles are defined in the following style sheets located in the /pt_photo_gallery/style/ directory within the ADF Photo GalleryApp directory:

• ptPhotoGallery.css (/ADF/apps/pt_photo_gallery/style/ptPhotoGallery.css)

The recommended approach is to load this style sheet into your Base Plus One Template.

'Note:' the classes and styles defined for the Photo Gallery are targeted tightly for the layout generated by the Photo Gallery application and should not interfere with your site styles. However, it is a good idea to give these styles sheets higher precedence in your style definitions.

Import Elements

The Photo Gallery Application has several Custom Components defined within CommonSpot. The components have been exported and are available in the Photo Gallery's "exported-objects" folder located at the root of the Photo Gallery application directory (e.g. /ADF/apps/pt_photo_gallery/exported-objects/)

Optional: You may want to create a new category within the CommonSpot Element Gallery for 'Photo Gallery Elements'.

To import these objects, you will need to be an administrator for your site. If you are not a site administrator, consult your Server administrator for more information.

Import

Import Custom Elements in this order:

1. Photo (Photo-Custom-Element.zip)
2. Photo Category (Photo-Category-Custom-Element.zip)
3. Photo Size (Photo-Size-Custom-Element.zip)
4. Photo Gallery (Photo-Gallery-Custom-Element.zip)
5. PTPhotoGallery Configuration (PTPhotoGallery-Configuration-Custom-Element.zip)

Import Metadata form:

1. PhotoSizeRender (PhotoSizeRender-Metadata-Form.zip)
   1. Bind this form to the following Photo Gallery Render Handler
      1. Cycle
      2. Cycle Thumb Nav
      3. Grid

Verify Imports

The imported components' render handlers and custom field types must be verified. During the import process, the render handler and custom field types paths may have been changed to reflect the current site's path.

Review and update these paths to reference the ADF path. In most cases, this will just require to be unlocked and a change in the path from the site name to 'ADF'. Check the paths for the custom field types that were imported with the custom elements by unlocking them and fixing the explicit paths to point to "/ADF/extensions/".

If the custom elements that are imported contain custom field types that are already in the site, the naming convention for the custom field type will be unique. To resolve this, unlock the field types and elements, and reassign the element field type to the pre-existing field type.

Example: The Photo Category custom element contains two uses of the General Chooser field type, if the General Chooser field type is already installed on the site then the import process will attempt to import another General Chooser but with a new name such as "General Chooser_import_1250003208472." To resolve this issue, open the custom element and assign the field type (General Chooser_import_1250003208472) to the field type with the simple name General Chooser. Note that when you assign the existing general chooser you will need to click on the "properties" tab and enter "photoSizeGC" as the bean name. After reassigning the field type, delete the new imported field from the list of custom field types.

Site Configuration

The Photo Gallery App uses a custom element to store site specific configurations. The Photo Gallery App needs to know the profile element name, unique field, roles, subsite ids, and template ids for the site.

If you are installing the PT Photo Gallery application, there is no need to do anything with this element at this time. This element will be configured in a later step.

The fields for the Photo Gallery Configuration custom element are defined below.

Configuration Fields

There are six major components to the configuration:

1. CE_FORM_ID - Photo custom element form ID within the site.
2. ADD_URL - Site relative URL for the Photo Add page. (Example: /webadmin/photogalleryadmin/lightbox/Photo-Add.cfm)
3. UPLOAD_FORM_URL - Site relative URL for the Photo Upload page. (Example: /webadmin/photogalleryadmin/lightbox/Photo-Upload.cfm)
4. DISPLAY_URL - Site relative URL for rendering a photo to the user.
5. UPLOAD_URL - URL Path on the server to store the uploaded photos. (Example: /_cs_apps/pt_photo_gallery/uploads/)
6. UPLOAD_PATH - Server Path on the server to store the uploaded photos. (Example: D:/full/path/to/this/dir/_cs_apps/pt_photo_gallery/uploads/)
7. UPLOAD_DOC_TYPES - Photo file types that are allowed to be uploaded. (Example: jpg,gif,bmp,png)

Build Templates/Pages