Gcronkright: /* Site Configuration */

2016-05-09T17:42:41Z

‎Site Configuration

Mcarroll: moved PT Page Rating Version 2.0 Install to PT Page Rating Install v2

2013-02-12T19:38:47Z

moved PT Page Rating Version 2.0 Install to PT Page Rating Install v2

Mcarroll: Created page with '== Site Configuration == * 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 'A…'

2012-09-13T13:50:43Z

Created page with '== Site Configuration == * 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 'A…'

New page

== Site Configuration ==
* 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' ([[Site Configuration (ADF.cfc) | See Site Configuration (ADF.cfc) for more info]]) file in a text editor. Locate the ''Load the ADF Application into application space'' comment in the file. Add the following command under the comment section:
<source lang="java">
loadApp("ptPageRating");
</source>
* [[Reset ADF|Reset the ADF]] for the server and site.

== Element Import ==
* Import the following elements from the /ADF/apps/pt_page_rating/exported-objects/ folder:
** PT-Page-Rating-Custom-Element.zip

== CCAPI Configuration ==
ccapi.cfm configuration
# Navigate to your ccapi.cfm page (or create one)
# Add the PT Page Rating Element to the page
# Click on the More under the PT Page Rating Element and select name
# enter the name: ptPageRating
# Submit the page

XML Configuration
# Open the _cs_apps/config/ccapi.xml (or cfm) document
# add the following:
<pre>
<ptPageRating>
<pageID>[ccapi.cfm page ID]</pageID>
<subsiteID>[subsite ID ccapi.cfm lies in]</subsiteID>
<elementType>custom</elementType>
<controlName>ptPageRating</controlName>
</ptPageRating>
</pre>

== Subsites ==
It is '''highly recommended''' to create a Page Rating subsite for administrators. This allows security to be setup for the subsite to allow only administrators access for the webadmin.

Your site may already have a ''webadmin'' subsite. The steps below will add a ''pagerating'' subsite into the ''webadmin'' subsite.

=== Web Admin ===
# Create a new subsite under the site root called ''webadmin''.
# Create a new subsite under ''webadmin'' called ''pagerating''.
# Configure the ''/webadmin/pagerating/'' subsite Content Security to give 'No Rights' to 'Anonymous Users' and 'Authenticated Users'.
# Configure the ''/webadmin/pagerating/'' subsite Content Security to give permissions to the group of administrators who will manage the Comments.

== Page Rating Manager ==
This page will be used to manage the Comments custom element data records for the site.

# Create page with the name "index" and title is "Page Rating Manager" in the ''/webadmin/pagerating/'' subsite.
# Add a Datasheet element into the page.
## Define a View for the Datasheet Element called "All Page Ratings"
## Leave the View Source as the Default: Form Result/Custom Element Sheet
## Select the "PT Page Rating" Custom Element and select the following columns:
### ID, UserID, RatingPageID, Rating, and Date Added
## Edit the column for the "ID" field and make the following changes:
### Header: Edit/Delete
### Render Handler: /ADF/extensions/datasheet-modules/1.0/edit-delete.cfm
## Edit the column for the "UserID" field and make the following changes:
### Header: User
### Render Handler: /ADF/extensions/datasheet-modules/1.0/userID-to-name.cfm
## Edit the column for the "RatingPageID" field and make the following changes:
### Header: Rating Page
### Render Handler: /ADF/extensions/datasheet-modules/1.0/pageID-to-link.cfm
### Prevent Text from Wrapping: Unchecked
## Edit the Layout properties for the datasheet:
### Default Sorting: Date Added DESCENDING
### Results Per Page: 50
### Allow JavaScript data sorting: Uncheck
# Publish the page.

== Adding rating to Your Pages ==
There are 3 options for adding the ratings to your pages:
# Base Plus One Template controlled through custom metadata - This will allow the all the site pages to have a metadata option to show or hide the page rating element .
# Template - Add the page rating custom script into a template and then all the pages derived from this template will have page rating.
# Page - On a page by page basis a custom script can be added directly into the page to display the page rating module.

The following steps will outline the 3 install options.

=== Base Template ===
# Create a new custom metadata form, or add to an existing custom metadata form (preferably if you have a custom metadata form for layout options this would be a good place).
# Add a new "checkbox" field with the following values:
## Field Name: displayPageRating
## Type: Checkbox
## Label: Display Page Rating
## Description: Check this field to display the Page Rating module into the page for all users.
## Properties: You have the option here to default this value to checked by default.
# On the Base Plus One Template
## Add a custom script module into the container or area of the page for the page rating.
## Define the explicit path for the following:
### /ADF/apps/pt_page_rating/customcf/pageRatingMetadataValidate.cfm
### Important Note: Based on your custom metadata form this custom script MAY need to be customized for your implementation.

=== Template/Page ===
# Navigate to your template or page.
# Add a custom script to the page (under Miscellaneous)
# Specify the location of the custom script to be:
## /ADF/apps/pt_page_rating/customcf/pageRating.cfm
# Submit the page.

[[Category:Page Rating]]

@@ Line 2: / Line 2: @@
 * 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' ([[Site Configuration (ADF.cfc) | See Site Configuration (ADF.cfc) for more info]]) file in a text editor. Locate the ''Load the ADF Application into application space'' comment in the file. Add the following command under the comment section:
-<source lang="java">
-loadApp("ptPageRating");
+ loadApp("ptPageRating");
-</source>
 * [[Reset ADF|Reset the ADF]] for the server and site.

← Older revision	Revision as of 19:38, 12 February 2013
(No difference)

PT Page Rating Install v2 - Revision history

Gcronkright: /* Site Configuration */

Mcarroll: moved PT Page Rating Version 2.0 Install to PT Page Rating Install v2

Mcarroll: Created page with '== Site Configuration == * 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 'A…'