Difference between revisions of "PT Blog Version 2.0 Install"

From ADF Docs
Jump to: navigation, search
(→‎Site Configuration)
 
(74 intermediate revisions by 7 users not shown)
Line 1: Line 1:
−
== Overview ==
+
== Download ==
 +
Download the Blog Application from the [http://community.paperthin.com/projects/pt_blog/index.cfm Community Site Project] or from the SVN Repository. 
 +
 
 +
Extract the zip files into the following directory:
 +
'''/ADF/apps/pt_blog/'''
 +
 
 +
== 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:
 +
 
 +
loadApp("ptBlog2");
 +
 
 +
* [[Reset ADF|Reset the ADF]] for the server and site.
  
 
== Import Custom Elements ==
 
== Import Custom Elements ==
 +
Create a "PT Blog Elements" category and import all portions of each component in the order listed.
 +
 +
'''Import Custom Element:'''
 +
 +
# Blog2 (Blog2-Custom-Element.zip)
 +
# Posts2 (Posts2-Custom-Element.zip)
 +
# Comments2 (Comments2-Custom-Element.zip)
 +
# PTBlog2 Configuration (PTBlog2-Configuration-Custom-Element.zip)
 +
 +
'''Import Metadata:'''
 +
 +
# Blogs (Blogs-Metadata-Form.zip)
 +
 +
=== 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.
 +
 +
== Subsites ==
 +
It is '''highly recommended''' this Blog Web Admin subsite for administrators and a Blog Lightbox subsite for the lightbox pages.  This allows security to be setup for the subsite to allow only administrators access for the webadmin and the CS toolbar turned off for the lightbox pages.
 +
 +
Your site may already have a ''webadmin'' and/or ''lightbox'' subsite.  The steps below will add a ''blogs'' subsite into the ''webadmin'' and ''lightbox'' subsites.
 +
 +
=== Web Admin ===
 +
# Create a new subsite under the site root called ''webadmin''.
 +
# Create a new subsite under ''webadmin'' called ''blogs''.
 +
# Configure the ''/webadmin/blogs/'' subsite Content Security to give 'No Rights' to 'Anonymous Users' and 'Authenticated Users'. 
 +
# Configure the ''/webadmin/blogs/'' subsite Content Security to give permissions to the group of administrators who will manage the Blogs.
 +
 +
=== Blogs ===
 +
The subsite for the blog pages must be created manually. This subsite is custom to your implementation and can be any subsite within the site.
 +
If you don't have a specific subsite then create a ''Blogs'' subsite under the site root.
 +
 +
== Templates ==
 +
 +
=== Blog Post Template ===
 +
The Blog Post Template is the template that all the blog post pages are created from.
 +
To construct your Blog Post Template complete the following steps.
 +
 +
# Create a CommonSpot page called 'Blog Post' from the Base Plus One template. (The subsite for this is not critical but it is a good idea to create this page in a subsite that has been created for the Blogs.)
 +
# Place the ''Posts2'' Custom Element on this page.
 +
# Click ''Render Mode'' in the element interface.
 +
# Select ''Display existing element data (content reuse)'' on the ''Rendering Mode'' tab.
 +
# Select the ''Filter'' tab.
 +
# Select Filter Type to ''Show subset of records''.
 +
# Select the field drop-down as the ''PostID'' field.
 +
# Select the operator as ''Equals''.
 +
# Click the '...' button to open the ColdFusion expression window.
 +
# Enter the text ''request.page.metadata.blogs.postID'' as the expression and check the ''force cache'' checkbox.  Click ''OK'' and then check the box to ''Ignore ColdFusion error'', then click ''OK''.
 +
# Click ''OK'' on the render mode window.
 +
## Ignore the error message for 'Error: Error evaluating a user-defined expresssion'.
 +
# Click ''More'' in the element interface.  Then the ''Custom Render Handlers'' menu option, and choose the ''Main Display'' Render Handler. (You may see an error on this page with the Render Handler.  That is OK at this point.)
 +
# Submit Page and then Save as Template.
 +
# Remember to submit the template for public use.
 +
# Go to the CommonSpot Site Administration and bind the ''Blogs'' metadata form to this new ''Blog Post Template''.
  
−
== Create Add Blog Page ==
+
== CCAPI Configuration ==
−
This page will be used to create new Blog Posts in the Blog Administrator.  Each Blog will share this Add page.
+
The Blog Application uses the [[CCAPI|ADF CCAPI]] to populate blog post records.  This needs to be configured for the site and blog app.
−
# Create page called "Add Blog"
+
 
−
# Place Custom Script on the page
+
Follow the steps to setup the [[CCAPI Config|CCAPI Config]] file for the site if this is not done.  Once this is completed, follow the steps below to setup the CCAPI config for the Blog App.  Make sure to update the ''wsVars'' section with the correct URL's and username/password.
−
# Select the "/ADF/apps/pt_blog/customcf/handle_blog_create.cfm" script (Note: after page reloads a Simple Form Element will Appear
+
 
−
# Choose "Select Form" from the Simple Form Element Interface
+
# Create a new page called 'ccapi' under the root subsite and from the base plus one template.  When creating the page, disable the standard metadata 'Include In' fields for 'Page Indexes' and 'Full Text and Search Element Results'. This page may already exist within your site, if it does, then continue to the next steps.
−
# Choose option 2 (Select Simple Form/Custom Element)
+
# Add the 'Posts2' element to the page.
−
# Locate the "Blog Posts" Custom Element and add data for the Action (using the "Specify Results Text" method)
+
# Select the 'Posts2' element indicator and go to 'more...'.  Select 'Name' from the menu.
−
# Publish Page
+
# In the Element Name field, enter the text 'ccapiPosts2Element'.
 +
# Add the 'Comments2' element to the page.
 +
# Select the 'Comments2' element indicator and go to 'more...'.  Select 'Name' from the menu.
 +
# In the Element Name field, enter the text 'ccapiComments2Element'.
 +
# Publish this page and put in read mode.
 +
# Edit the 'ccapi.cfm' file (it may be ccapi.xml) for the site and add the following xml block into the <elements> section:
 +
<source lang="xml">
 +
<BlogPost>
 +
  <pageID>#####</pageID>
 +
  <subsiteID>##</subsiteID>
 +
  <elementType>custom</elementType>
 +
  <controlName>ccapiPosts2Element</controlName>
 +
</BlogPost>
 +
<Comments>
 +
  <pageID>#####</pageID>
 +
  <subsiteID>##</subsiteID>
 +
  <elementType>custom</elementType>
 +
  <controlName>ccapiComments2Element</controlName>
 +
</Comments>
 +
</source>
 +
 
 +
# To populate the <pageID> and <subsiteID> tags, view the source code for the 'ccapiBlog' page that was just created.
 +
# Identify the following line in the source code and enter this numeric value into the <subsiteID> tag:
 +
<source lang="java">
 +
var jsSubSiteID = ##;
 +
</source>
 +
# Identify the following line in the source code and enter this numeric value into the <pageID> tag:
 +
<source lang="java">
 +
var jsPageID = ####;
 +
</source>
 +
 
 +
[[Reset ADF|Reset the ADF]] for the server and site.
  
 
== Create Blog Dashboard Page==
 
== Create Blog Dashboard Page==
 
This page will be used to manage the blog post and comments for each blog.  Each Blog will share this Dashboard Page.
 
This page will be used to manage the blog post and comments for each blog.  Each Blog will share this Dashboard Page.
−
# Create page called "Blog Dashboard"
+
# Create page from the Base Plus One template called "Blog Dashboard" in the ''/webadmin/blogs/'' subsite.
 
# Place Custom Script on the page
 
# Place Custom Script on the page
−
# Select the "/ADF/apps/pt_blog/customcf/blog_dashboard.cfm" script (after page reloads 3 tabs and links to datasheets will appear)
+
# Select the "/ADF/apps/pt_blog/customcf/blog_dashboard.cfm" script (after page reloads 2 tabs and links to datasheets will appear)
  
 
=== Configure Posts Tab ===
 
=== Configure Posts Tab ===
 
# Click the "Posts" tab
 
# Click the "Posts" tab
−
 
−
# Locate the "Blog" Custom Element and click on the "Render Mode" option in the Element Interface
 
−
# Choose "Content Reuse" and leave the filter option on "Render results dynamically based on a filter, or display all records."
 
−
# Click on the "Filter" tab and apply the following filter: Field = BlogID; Operator = "equals"; Value = "request.params.blogID" (note: use the UDE button)
 
  
 
# Define a View for the Datasheet Element in this Tab - call it "All Blog Posts"
 
# Define a View for the Datasheet Element in this Tab - call it "All Blog Posts"
 
# Leave the View Source as the Default: Form Result/Custom Element Sheet
 
# Leave the View Source as the Default: Form Result/Custom Element Sheet
−
# Select the "Blog Posts" Custom Element and select the following columns: Title, Date Posted, Created By and PageURL (Note: The only required column is "PageURL")
+
# Select the "Posts2" Custom Element and select the following columns: PostID, PostPageID, Title, Created By, and Date Posted.
−
# Move the "PageURL" field to the end of the list of columns
+
# On the Datasheet, click on the "Filter" and apply the following filter: Field = BlogID; Operator = "equals"; Value = "request.params.blogID" (note: use the UDE button)
 +
# Edit the datasheet columns.
 +
## Edit the PostID column, change the render handler to: ''/ADF/apps/pt_blog/datasheet-modules/lightbox_edit_delete_post.cfm''
 +
### Clear the header text.
 +
## Edit the PostPageID column, change the render handler to: ''/ADF/apps/pt_blog/datasheet-modules/post_page_url.cfm''
 +
### Clear the header text.
 +
## Edit the CreatedBy column, change the render handler to: ''/ADF/extensions/datasheet-modules/1.0/userID-to-name.cfm''
 +
# Edit the datasheet layout
 +
## Set default sorting to "Title" field.
 +
## Set Results Per Page to "50".
 +
## Uncheck "Show Alphabet Characters for Filtering"
 +
## Uncheck "Allow JavaScript data sorting"
 +
## Click "Save"
 +
 
 +
=== Configure Comments Tab ===
 +
# Click the "Comments" tab
  
 +
# Define a View for the Datasheet Element in this Tab - call it "All Blog Comments"
 +
# Leave the View Source as the Default: Form Result/Custom Element Sheet
 +
# Select the "Comments2" Custom Element and select the following columns: CommentID, Name, and Date Created.
 +
# On the Datasheet, click on the "Filter" and apply the following filter: Field = Comments2.blogID; Operator = "equals"; Value = "request.params.blogID" (note: use the UDE button)
 +
# Edit the datasheet columns.
 +
## Edit the CommentID column, change the render handler to: ''/ADF/extensions/datasheet-modules/1.0/edit-delete.cfm''
 +
## Clear the header text for the field.
 +
# Edit the datasheet layout
 +
## Set default sorting to "DateCreated" field and "Descending".
 +
## Set Results Per Page to "50".
 +
## Uncheck "Show Alphabet Characters for Filtering"
 +
## Uncheck "Allow JavaScript data sorting"
 +
## Click "Save"
 +
# Publish the Blog Dashboard page.
  
 
== Create Blogs Management Page ==
 
== Create Blogs Management Page ==
 +
This page will be used to manage the blogs for the site. 
 +
 +
# Create page from the Base Plus One template called "Blogs Manager" in the ''/webadmin/blogs/'' subsite.
 +
# Place Custom Script on the page
 +
# Select the "/ADF/apps/pt_blog/customcf/all_blogs_manager.cfm" script.
 +
# Define a View for the Datasheet Element for this page - call it "All Blogs"
 +
# Leave the View Source as the Default: Form Result/Custom Element Sheet
 +
# Select the "Blog2" Custom Element and select the following columns: blogID, blogTemplate, Name, Subsite, DateCreated, and Active.
 +
# Edit the datasheet columns.
 +
## Edit the blogID column, change the render handler to: ''/ADF/apps/pt_blog/datasheet-modules/blog_dashboard_link.cfm''
 +
### Clear the header text.
 +
## Edit the blogTemplate column, change the render handler to: ''/ADF/extensions/datasheet-modules/lightbox_edit_delete.cfm''
 +
### Clear the header text.
 +
## Edit the Subsite column, change the render handler to: ''/ADF/extensions/datasheet-modules/1.0/subsiteID-to-link.cfm''
 +
# Edit the datasheet layout
 +
## Uncheck "Allow JavaScript data sorting"
 +
## Click "Save"
 +
# Publish the Blogs Management page.
 +
 +
== Create Blog Configuration Record ==
 +
We are creating a single Blog Configuration element record to be used within the application.
 +
 +
Go to the Blogs Management Page and select the ''Edit App Configuration'' link.  In the form, select the CommonSpot pages that were created in the previous steps. 
 +
 +
[[Reset ADF|Reset the ADF]] for the server and site.
 +
 +
== Blog Listing Page ==
 +
This page will be used to list the Blog Posts.
 +
# Create a new page from the Base Plus One template with page name "index" and title "Blogs" in the ''/blogs/'' subsite. 
 +
# In the main content of the page, add "Posts2" element.
 +
# Select the "Home Page Display" render handler.
 +
# Open the elements "Render Mode" and select "Display existing element data (content reuse)" and "Render results dynamically based on a filter, or display all records.". 
 +
# Select the "Show all records" option and set the sort order to "Date Posted" is "Descending".
 +
# Change the custom render handler to "Home Page Display".
 +
# Publish Page
 +
 +
[[Category:Blogs]]

Latest revision as of 15:28, 5 May 2016

Download

Download the Blog Application from the Community Site Project or from the SVN Repository.

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

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' ( 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:
loadApp("ptBlog2");

Import Custom Elements

Create a "PT Blog Elements" category and import all portions of each component in the order listed.

Import Custom Element:

  1. Blog2 (Blog2-Custom-Element.zip)
  2. Posts2 (Posts2-Custom-Element.zip)
  3. Comments2 (Comments2-Custom-Element.zip)
  4. PTBlog2 Configuration (PTBlog2-Configuration-Custom-Element.zip)

Import Metadata:

  1. Blogs (Blogs-Metadata-Form.zip)

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.

Subsites

It is highly recommended this Blog Web Admin subsite for administrators and a Blog Lightbox subsite for the lightbox pages. This allows security to be setup for the subsite to allow only administrators access for the webadmin and the CS toolbar turned off for the lightbox pages.

Your site may already have a webadmin and/or lightbox subsite. The steps below will add a blogs subsite into the webadmin and lightbox subsites.

Web Admin

  1. Create a new subsite under the site root called webadmin.
  2. Create a new subsite under webadmin called blogs.
  3. Configure the /webadmin/blogs/ subsite Content Security to give 'No Rights' to 'Anonymous Users' and 'Authenticated Users'.
  4. Configure the /webadmin/blogs/ subsite Content Security to give permissions to the group of administrators who will manage the Blogs.

Blogs

The subsite for the blog pages must be created manually. This subsite is custom to your implementation and can be any subsite within the site. If you don't have a specific subsite then create a Blogs subsite under the site root.

Templates

Blog Post Template

The Blog Post Template is the template that all the blog post pages are created from. To construct your Blog Post Template complete the following steps.

  1. Create a CommonSpot page called 'Blog Post' from the Base Plus One template. (The subsite for this is not critical but it is a good idea to create this page in a subsite that has been created for the Blogs.)
  2. Place the Posts2 Custom Element on this page.
  3. Click Render Mode in the element interface.
  4. Select Display existing element data (content reuse) on the Rendering Mode tab.
  5. Select the Filter tab.
  6. Select Filter Type to Show subset of records.
  7. Select the field drop-down as the PostID field.
  8. Select the operator as Equals.
  9. Click the '...' button to open the ColdFusion expression window.
  10. Enter the text request.page.metadata.blogs.postID as the expression and check the force cache checkbox. Click OK and then check the box to Ignore ColdFusion error, then click OK.
  11. Click OK on the render mode window.
    1. Ignore the error message for 'Error: Error evaluating a user-defined expresssion'.
  12. Click More in the element interface. Then the Custom Render Handlers menu option, and choose the Main Display Render Handler. (You may see an error on this page with the Render Handler. That is OK at this point.)
  13. Submit Page and then Save as Template.
  14. Remember to submit the template for public use.
  15. Go to the CommonSpot Site Administration and bind the Blogs metadata form to this new Blog Post Template.

CCAPI Configuration

The Blog Application uses the ADF CCAPI to populate blog post records. This needs to be configured for the site and blog app.

Follow the steps to setup the CCAPI Config file for the site if this is not done. Once this is completed, follow the steps below to setup the CCAPI config for the Blog App. Make sure to update the wsVars section with the correct URL's and username/password.

  1. Create a new page called 'ccapi' under the root subsite and from the base plus one template. When creating the page, disable the standard metadata 'Include In' fields for 'Page Indexes' and 'Full Text and Search Element Results'. This page may already exist within your site, if it does, then continue to the next steps.
  2. Add the 'Posts2' element to the page.
  3. Select the 'Posts2' element indicator and go to 'more...'. Select 'Name' from the menu.
  4. In the Element Name field, enter the text 'ccapiPosts2Element'.
  5. Add the 'Comments2' element to the page.
  6. Select the 'Comments2' element indicator and go to 'more...'. Select 'Name' from the menu.
  7. In the Element Name field, enter the text 'ccapiComments2Element'.
  8. Publish this page and put in read mode.
  9. Edit the 'ccapi.cfm' file (it may be ccapi.xml) for the site and add the following xml block into the <elements> section:
<BlogPost>
  <pageID>#####</pageID>
  <subsiteID>##</subsiteID>
  <elementType>custom</elementType>
  <controlName>ccapiPosts2Element</controlName>
</BlogPost>
<Comments>
  <pageID>#####</pageID>
  <subsiteID>##</subsiteID>
  <elementType>custom</elementType>
  <controlName>ccapiComments2Element</controlName>
</Comments>
  1. To populate the <pageID> and <subsiteID> tags, view the source code for the 'ccapiBlog' page that was just created.
  2. Identify the following line in the source code and enter this numeric value into the <subsiteID> tag:
var jsSubSiteID = ##;
  1. Identify the following line in the source code and enter this numeric value into the <pageID> tag:
var jsPageID = ####;

Reset the ADF for the server and site.

Create Blog Dashboard Page

This page will be used to manage the blog post and comments for each blog. Each Blog will share this Dashboard Page.

  1. Create page from the Base Plus One template called "Blog Dashboard" in the /webadmin/blogs/ subsite.
  2. Place Custom Script on the page
  3. Select the "/ADF/apps/pt_blog/customcf/blog_dashboard.cfm" script (after page reloads 2 tabs and links to datasheets will appear)

Configure Posts Tab

  1. Click the "Posts" tab
  1. Define a View for the Datasheet Element in this Tab - call it "All Blog Posts"
  2. Leave the View Source as the Default: Form Result/Custom Element Sheet
  3. Select the "Posts2" Custom Element and select the following columns: PostID, PostPageID, Title, Created By, and Date Posted.
  4. On the Datasheet, click on the "Filter" and apply the following filter: Field = BlogID; Operator = "equals"; Value = "request.params.blogID" (note: use the UDE button)
  5. Edit the datasheet columns.
    1. Edit the PostID column, change the render handler to: /ADF/apps/pt_blog/datasheet-modules/lightbox_edit_delete_post.cfm
      1. Clear the header text.
    2. Edit the PostPageID column, change the render handler to: /ADF/apps/pt_blog/datasheet-modules/post_page_url.cfm
      1. Clear the header text.
    3. Edit the CreatedBy column, change the render handler to: /ADF/extensions/datasheet-modules/1.0/userID-to-name.cfm
  6. Edit the datasheet layout
    1. Set default sorting to "Title" field.
    2. Set Results Per Page to "50".
    3. Uncheck "Show Alphabet Characters for Filtering"
    4. Uncheck "Allow JavaScript data sorting"
    5. Click "Save"

Configure Comments Tab

  1. Click the "Comments" tab
  1. Define a View for the Datasheet Element in this Tab - call it "All Blog Comments"
  2. Leave the View Source as the Default: Form Result/Custom Element Sheet
  3. Select the "Comments2" Custom Element and select the following columns: CommentID, Name, and Date Created.
  4. On the Datasheet, click on the "Filter" and apply the following filter: Field = Comments2.blogID; Operator = "equals"; Value = "request.params.blogID" (note: use the UDE button)
  5. Edit the datasheet columns.
    1. Edit the CommentID column, change the render handler to: /ADF/extensions/datasheet-modules/1.0/edit-delete.cfm
    2. Clear the header text for the field.
  6. Edit the datasheet layout
    1. Set default sorting to "DateCreated" field and "Descending".
    2. Set Results Per Page to "50".
    3. Uncheck "Show Alphabet Characters for Filtering"
    4. Uncheck "Allow JavaScript data sorting"
    5. Click "Save"
  7. Publish the Blog Dashboard page.

Create Blogs Management Page

This page will be used to manage the blogs for the site.

  1. Create page from the Base Plus One template called "Blogs Manager" in the /webadmin/blogs/ subsite.
  2. Place Custom Script on the page
  3. Select the "/ADF/apps/pt_blog/customcf/all_blogs_manager.cfm" script.
  4. Define a View for the Datasheet Element for this page - call it "All Blogs"
  5. Leave the View Source as the Default: Form Result/Custom Element Sheet
  6. Select the "Blog2" Custom Element and select the following columns: blogID, blogTemplate, Name, Subsite, DateCreated, and Active.
  7. Edit the datasheet columns.
    1. Edit the blogID column, change the render handler to: /ADF/apps/pt_blog/datasheet-modules/blog_dashboard_link.cfm
      1. Clear the header text.
    2. Edit the blogTemplate column, change the render handler to: /ADF/extensions/datasheet-modules/lightbox_edit_delete.cfm
      1. Clear the header text.
    3. Edit the Subsite column, change the render handler to: /ADF/extensions/datasheet-modules/1.0/subsiteID-to-link.cfm
  8. Edit the datasheet layout
    1. Uncheck "Allow JavaScript data sorting"
    2. Click "Save"
  9. Publish the Blogs Management page.

Create Blog Configuration Record

We are creating a single Blog Configuration element record to be used within the application.

Go to the Blogs Management Page and select the Edit App Configuration link. In the form, select the CommonSpot pages that were created in the previous steps.

Reset the ADF for the server and site.

Blog Listing Page

This page will be used to list the Blog Posts.

  1. Create a new page from the Base Plus One template with page name "index" and title "Blogs" in the /blogs/ subsite.
  2. In the main content of the page, add "Posts2" element.
  3. Select the "Home Page Display" render handler.
  4. Open the elements "Render Mode" and select "Display existing element data (content reuse)" and "Render results dynamically based on a filter, or display all records.".
  5. Select the "Show all records" option and set the sort order to "Date Posted" is "Descending".
  6. Change the custom render handler to "Home Page Display".
  7. Publish Page
Retrieved from "http://community.paperthin.com/adf-docs/index.php?title=PT_Blog_Version_2.0_Install&oldid=7088"