ADF Docs - User contributions [en]

PT Comments Custom Element

2010-11-05T17:56:52Z

Mike: Created page with '== Overview == Comments Custom Element == Fields == Category:Comments'

== Overview ==
Comments Custom Element

== Fields ==

[[Category:Comments]]

PT Comments

2010-11-05T17:54:53Z

Mike: /* Contents */

== About Comments App ==
The Comments application is built in the [[Overview|Application Development Framework (ADF)]].

== Overview ==
The Comments application provides the flexibility to add comments to any custom element within the CommonSpot site. Functionality to dynamically add a comments block to news articles, publications, etc.

== Requirements ==
ADF Library components that are required for the Photo Gallery:
* CCAPI
* ceData_1_0
* scripts_1_0

ADF must be configured correctly for your site. [[Site Configuration (ADF.cfc)]] has instructions for configuration.

== Contents ==
The CS Photo Gallery contains the following:
* '''Custom Elements:'''
** [[PT_Comments_Custom_Element|Comment]] - Custom Element

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

== Pre-installation Considerations ==
[[Overview|Application Development Framework (ADF)]] must be setup and configured on the server for the site. 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.)

The CCAPI must be configured for the site. Follow the steps to set up the [[CCAPI Config|CCAPI Config]] file for the site.

== Installation/Setup ==
Each of the following steps should be completed fully and in the order presented:

# [[PT_Comments_Extract|Extract Comments Application]]
# [[PT_Comments_ADF_Configuration|ADF Configuration]]
# [[PT_Comments_Import|Import Elements]]
# [[PT_Comments_Site_Configuration|Site Configuration]]
# [[PT_Comments_Build_Templates_Pages|Build Templates/Pages]]

== Getting Started ==
* [[PT_Photo_Gallery_Getting_Started|Getting Started]] - Guide to set up the photo sizes and categories.

[[Category:Project]]
[[Category:Comments]]

PT Comments

2010-11-05T17:54:34Z

Mike: Created page with '== About Comments App == The Comments application is built in the Application Development Framework (ADF). == Overview == The Comments application provides the flex…'

== About Comments App ==
The Comments application is built in the [[Overview|Application Development Framework (ADF)]].

== Overview ==
The Comments application provides the flexibility to add comments to any custom element within the CommonSpot site. Functionality to dynamically add a comments block to news articles, publications, etc.

== Requirements ==
ADF Library components that are required for the Photo Gallery:
* CCAPI
* ceData_1_0
* scripts_1_0

ADF must be configured correctly for your site. [[Site Configuration (ADF.cfc)]] has instructions for configuration.

== Contents ==
The CS Photo Gallery contains the following:
* Custom Coding - various components and scripts.
* '''Custom Elements:'''
** [[PT_Comments_Custom_Element|Comment]] - Custom Element

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

== Pre-installation Considerations ==
[[Overview|Application Development Framework (ADF)]] must be setup and configured on the server for the site. 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.)

The CCAPI must be configured for the site. Follow the steps to set up the [[CCAPI Config|CCAPI Config]] file for the site.

== Installation/Setup ==
Each of the following steps should be completed fully and in the order presented:

# [[PT_Comments_Extract|Extract Comments Application]]
# [[PT_Comments_ADF_Configuration|ADF Configuration]]
# [[PT_Comments_Import|Import Elements]]
# [[PT_Comments_Site_Configuration|Site Configuration]]
# [[PT_Comments_Build_Templates_Pages|Build Templates/Pages]]

== Getting Started ==
* [[PT_Photo_Gallery_Getting_Started|Getting Started]] - Guide to set up the photo sizes and categories.

[[Category:Project]]
[[Category:Comments]]

View All

2010-11-05T17:41:25Z

Mike: /* All Projects */

PT Photo Gallery Configuration

2010-09-29T15:05:15Z

Mike: /* Steps */

== Overview ==
The Photo Gallery Configuration Pages will be used to manage the PTPhotoGallery Configuration custom element. Follow these steps to configure the datasheet and page for adding photos.

== Steps ==
# Create a new page called 'Configuration Manager' in the ''/webadmin/photogallery/'' subsite.
# In the main content of the page, add a Custom Script element.
# Enter the explicit module path for:
## ''/ADF/apps/pt_photo_gallery/customcf/photo_config_admin_ds.cfm''
# From the Datasheet element interface, click the "Datasheet" icon.
# From the "Datasheet Views" dialog, follow the "Click here to create a new datasheet view" link.
# Enter the following information and then click "Next":
## Name: All Photo Gallery Configurations
## Private: unchecked
## Default View: unchecked
## Description: View to manage all of the Photo Gallery Configurations
## Datasheet Source: Form Result/Custom Element Sheet
# From the Datasheet Source dialog choose the "PTPhotoGallery Configuration" custom element and click "Next".
# From the Datasheet Columns Dialog choose a few columns from the Available Columns list and move them to the Selected Columns list. (UPLOAD_URL, Date Added, Last Date Modified, etc...) and then click "Finish".
# You will be brought to the Datasheet View page; click "Close" to return to your page.
# You will see the datasheet element on this page now. Click the Datasheet element interface icon again and this time choose "Edit Columns".
# From the Datasheet View Column Properties dialog choose the link for "Add a new action column".
# Within the Action Column Properties dialog enter the following information and click "Finish":
## Header: Edit
## Hide Header: Checked
## Column Text: edit
## Window Target Name: <leave blank>
## Modules: edit-form-data.cfm
# From the Datasheet View Column Properties dialog, choose the link for "Add a new action column" again.
# Within the Action Column Properties dialog enter the following information and click "Finish":
## Header: Delete
## Hide Header: Checked
## Column Text: delete
## Window Target Name: <leave blank>
## Modules: delete-form-data.cfm
# Close the Edit Column window.
# Publish the page.

== Create Photo Gallery Configuration Record ==

'''Note''' that this step assumes that you have [[PT_Photo_Gallery_Build_Templates_Pages#Admin_Pages|previously created the admin pages]].

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

Go to the Add Configuration page and submit the form to create '''one record'''.

These fields will be completed as the pages are built.

See the [[PT_Photo_Gallery Site_Configuration|Site Configuration]] wiki page for more information on the fields and the correct values.

[[Reset ADF|Reset the ADF]] for the server and site.

[[Category:Photo Gallery]]

PT Photo Gallery Configuration

2010-09-29T14:56:24Z

Mike: /* Steps */

== Overview ==
The Photo Gallery Configuration Pages will be used to manage the PTPhotoGallery Configuration custom element. Follow these steps to configure the datasheet and page for adding photos.

== Steps ==
# Create a new page called 'Configuration Manager' in the ''/webadmin/photogallery/'' subsite.
# In the main content of the page, add a Custom Script element.
# Enter the explicit module path for:
## ''/ADF/apps/pt_photo_gallery/customcf/photo_config_admin_ds.cfm''
# From the Datasheet element interface, click the "Datasheet" icon.
# From the "Datasheet Views" dialog, follow the "Click here to create a new datasheet view" link.
# Enter the following information and then click "Next":
## Name: All Photo Gallery Configurations
## Private: unchecked
## Default View: unchecked
## Description: View to manage all of the Photo Gallery Configurations
## Datasheet Source: Form Result/Custom Element Sheet
# From the Datasheet Source dialog choose the "PTPhotoGallery Configuration" custom element and click "Next".
# From the Datasheet Columns Dialog choose a few columns from the Available Columns list and move them to the Selected Columns list. (UPLOAD_PATH, UPLOAD_URL, etc...) and then click "Finish".
# You will be brought to the Datasheet View page; click "Close" to return to your page.
# You will see the datasheet element on this page now. Click the Datasheet element interface icon again and this time choose "Edit Columns".
# From the Datasheet View Column Properties dialog choose the link for "Add a new action column".
# Within the Action Column Properties dialog enter the following information and click "Finish":
## Header: Edit
## Hide Header: Checked
## Column Text: edit
## Window Target Name: <leave blank>
## Modules: edit-form-data.cfm
# From the Datasheet View Column Properties dialog, choose the link for "Add a new action column" again.
# Within the Action Column Properties dialog enter the following information and click "Finish":
## Header: Delete
## Hide Header: Checked
## Column Text: delete
## Window Target Name: <leave blank>
## Modules: delete-form-data.cfm
# Close the Edit Column window.
# Publish the page.

== Create Photo Gallery Configuration Record ==

'''Note''' that this step assumes that you have [[PT_Photo_Gallery_Build_Templates_Pages#Admin_Pages|previously created the admin pages]].

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

Go to the Add Configuration page and submit the form to create '''one record'''.

These fields will be completed as the pages are built.

See the [[PT_Photo_Gallery Site_Configuration|Site Configuration]] wiki page for more information on the fields and the correct values.

[[Reset ADF|Reset the ADF]] for the server and site.

[[Category:Photo Gallery]]

Navigation CCAPI Setup

2010-09-08T19:13:12Z

Mike:

'''Important''': The Content Creation API (CCAPI) must be configured for your site. The [[CCAPI_Config|CCAPI Configuration]] wiki page has instructions for configuration.

== Create CCAPI page ==
* Create a new page called 'ccapi' (if it doesn't already exist).
* Add the 'Nav Element' custom element to the page.
* Select the 'Nav Element' element indicator and go to 'more...'. Select 'Name' from the menu.
* In the Element Name field, enter the text 'navElement'.
* Publish this page and put in read mode.

== Edit ccapi.xml ==
* Edit the 'ccapi.xml' file for the site and add the following xml block into the <elements> section:

<navigation>
<pageID>#####</pageID>
<subsiteID>##</subsiteID>
<elementType>custom</elementType>
<controlName>navElement</controlName>
</navigation>

* To populate the <pageID> and <subsiteID> tags, view the source code for the 'ccapi' page that was just created.
* Identify the following line in the cs page source:

var jsSubSiteID = ##;

and enter this numeric value into the <subsiteID> tag:

* Identify the following line in the cs page source:

var jsPageID = ####;

and enter this numeric value into the <pageID> tag:

== Reset ADF ==
* The ADF needs to be reset for the server and site for these CCAPI updates to take effect. Enter the following URL parameter string to any page call within the site:

?resetServerADF=1&resetSiteADF=1

Note: Resetting the ADF server might affect all sites implementing the ADF. If an error occurs, this could cause sites to go down. Needless to say, updates to the ADF Bean Configs and config files should be done in a controlled development environment (not on production servers!).

[[Category:OHSU Navigation]][[Category: Configuration]]

OHSU Navigation

2010-09-08T19:12:25Z

Mike: /* Requirements */

== About Navigation App ==
The Navigation application is built in the [[Overview|Application Development Framework (ADF)]].

== Requirements ==
CommonSpot Features:
* Simple Forms/Datasheets
* Custom Metadata
ADF Library components that are required for the Profile:
* CEData_1_0
* CSData_1_0
* Scripts_1_0
* Data_1_0
* CCAPI

The ADF must be configured correctly for your site. The [[Site Configuration (ADF.cfc)]] wiki page has instructions for configuration.

The Content Creation API (CCAPI) must be configured for your site. The [[CCAPI_Config|CCAPI Configuration]] wiki page has instructions for configuration.

== Contents ==
The Navigation application contains the following CommonSpot components in the /ohsu_nav/exported_objects/ directory:
* Custom Coding - various components and scripts.
* CommonSpot Components:
** Nav Element (Custom Element)
** Navigation Custom Field Type

'Note:' Elements may contain one or more: Render Handlers or Custom Field Types. They do NOT use Display Templates.

== Pre-installation Considerations ==
The [[Overview|ADF]] must be setup and configured on the server for the site that will be implementing the Navigation application. For detailed instructions follow the [[Overview|ADF Overview]] wiki page for Site Configurations.

This installation guide assumes that you have no Custom Elements/Metadata Forms with the names above. Before the install, remove any Custom Elements/Metadata Forms with the names listed 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 completed fully and in the order presented:
* Download the Navigation app (two choices)
** Latest Zip Archive (http://community.paperthin.com/projects/ohsu_navigation/)
** SVN (http://community.paperthin.com/svn/ohsu_nav/)
* Place the code for the navigation (/ohsu_nav/) into the /ADF/apps/ directory
* Open the 'ADF.cfc' file for your site (located in the /site_folder/_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("ohsuNav");

* Reset the ADF for the site by adding the following URL parameter to any page within the site. (If the site is completely new, you may have to create an index.cfm page first.)

?ResetSiteADF=1

Note: make sure that you are logged into CommonSpot before resetting the ADF
* Import the Nav Element
* Import the Navigation Custom Field type
* [[Navigation CCAPI Setup|CCAPI Setup]]
* Create the [[Navigation Management Page]]
* [[Navigation Element Configuration | Configure ]] the Navigation Element
* Add the [[Navigation Custom Field Type]] to a metadata form

== Guides ==
* [[Using the Navigation Application]]
* [[Customizing Navigation Rendering]]
* [[Navigation Element Best Practices]]

== Known Issues/Bugs ==
* Visit the Navigation project page in the Community site [http://community.paperthin.com/projects/ohsu_nav/]

[[Category:Project]][[Category:OHSU Navigation]]

OHSU Navigation

2010-09-08T19:11:57Z

Mike: /* Requirements */

== About Navigation App ==
The Navigation application is built in the [[Overview|Application Development Framework (ADF)]].

== Requirements ==
CommonSpot Features:
* Simple Forms/Datasheets
* Custom Metadata
ADF Library components that are required for the Profile:
* CEData_1_0
* CSData_1_0
* Scripts_1_0
* Data_1_0
* CCAPI

The ADF must be configured correctly for your site. The [[Site Configuration (ADF.cfc)]] wiki page has instructions for configuration.

The Content Creation API (CCAPI) must be configured for your site. The [[CCAPI Configuration|CCAPI_Config]] wiki page has instructions for configuration.

== Contents ==
The Navigation application contains the following CommonSpot components in the /ohsu_nav/exported_objects/ directory:
* Custom Coding - various components and scripts.
* CommonSpot Components:
** Nav Element (Custom Element)
** Navigation Custom Field Type

'Note:' Elements may contain one or more: Render Handlers or Custom Field Types. They do NOT use Display Templates.

== Pre-installation Considerations ==
The [[Overview|ADF]] must be setup and configured on the server for the site that will be implementing the Navigation application. For detailed instructions follow the [[Overview|ADF Overview]] wiki page for Site Configurations.

This installation guide assumes that you have no Custom Elements/Metadata Forms with the names above. Before the install, remove any Custom Elements/Metadata Forms with the names listed 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 completed fully and in the order presented:
* Download the Navigation app (two choices)
** Latest Zip Archive (http://community.paperthin.com/projects/ohsu_navigation/)
** SVN (http://community.paperthin.com/svn/ohsu_nav/)
* Place the code for the navigation (/ohsu_nav/) into the /ADF/apps/ directory
* Open the 'ADF.cfc' file for your site (located in the /site_folder/_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("ohsuNav");

* Reset the ADF for the site by adding the following URL parameter to any page within the site. (If the site is completely new, you may have to create an index.cfm page first.)

?ResetSiteADF=1

Note: make sure that you are logged into CommonSpot before resetting the ADF
* Import the Nav Element
* Import the Navigation Custom Field type
* [[Navigation CCAPI Setup|CCAPI Setup]]
* Create the [[Navigation Management Page]]
* [[Navigation Element Configuration | Configure ]] the Navigation Element
* Add the [[Navigation Custom Field Type]] to a metadata form

== Guides ==
* [[Using the Navigation Application]]
* [[Customizing Navigation Rendering]]
* [[Navigation Element Best Practices]]

== Known Issues/Bugs ==
* Visit the Navigation project page in the Community site [http://community.paperthin.com/projects/ohsu_nav/]

[[Category:Project]][[Category:OHSU Navigation]]

PT Blog Version 2.0 Install

2010-06-23T15:17:07Z

Mike: /* Blog Post Template */

== 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:
<source lang="java">
loadApp("ptBlog2");
</source>
* [[Reset ADF|Reset the ADF]] for the server and site.

== Import Custom Elements ==
Create a "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.

=== Lightbox ===
# Create a new subsite under the site root called ''lightbox''.
# Create a new subsite under ''lightbox'' called ''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 ==

=== Lightbox Template ===
The Lightbox template will be used to render pages within a lightbox. The Lightbox template may already exist on your site if you have installed another ADF application. Check your sites templates before following the steps below to create the template.

# Create a new page named ''Lightbox Template'' from the ''Blank Layout Template'' in the Lightbox subsite.
# Submit and activate the page.
# Save the page as a template.
# Submit the template for public use.

=== 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.
# 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''.

== CCAPI Configuration ==
The Blog Application uses the [[CCAPI|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|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.

# Create a new page called 'ccapiBlog'. Recommend creating this page in the ''/webadmin/blogs/'' subsite.
# Add the 'Posts2' element to the page.
# Select the 'Posts2' element indicator and go to 'more...'. Select 'Name' from the menu.
# 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.xml' file 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 Add Blog Post Page ==
This page will be used to create new Blog Posts in the Blog Administrator. Each Blog will share this Add page.
# Create a new page from the Lightbox template called "Add Blog" in the ''/lightbox/blogs/'' subsite.
# In the main content of the page, add a Custom Script element.
# Select the "/ADF/apps/pt_blog/customcf/handle_blog_post_create.cfm" script (Note: after page reloads a Simple Form Element will Appear)
# Choose "Select Form" from the Simple Form Element Interface
# Choose option 2 (Select Simple Form/Custom Element)
# Select the "Posts2" Custom Element
# For the Form Action: choose ''Display Textblock on Submission'' option and add 'Blog Post Successfully Created!' text in the RTE.
# Publish 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.
# Create page from the Base Plus One template called "Blog Dashboard" in the ''/webadmin/blogs/'' subsite.
# Place Custom Script on the page
# 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 ===
# Click the "Posts" tab

# 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
# Select the "Posts2" Custom Element and select the following columns: PostID, PostPageID, Title, Created By, and Date Posted.
# 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''
## Edit the PostPageID column, change the render handler to: ''/ADF/apps/pt_blog/datasheet-modules/post_page_url.cfm''
## Clear the header text for the 2 fields.
# Edit the datasheet layout
## 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, Created By, and Date Created.
# 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 CommentID column, change the render handler to: ''/ADF/apps/pt_blog/datasheet-modules/lightbox_edit_delete_comment.cfm''
# Edit the datasheet layout
## Uncheck "Allow JavaScript data sorting"
## Click "Save"
# Publish the Blog Dashboard 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''
## Edit the blogTemplate column, change the render handler to: ''/ADF/extensions/datasheet-modules/lightbox_edit_delete.cfm''
## Clear the header text for the 2 fields.
# 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".
# Publish Page

[[Category:Blogs]]

General Chooser Property Component

2010-06-21T13:10:44Z

Mike: /* Instructions */

== Overview ==
[[General_Chooser_Property_Component|General Chooser Property Component]] is a component to build the data set and customize rendering for the field.

The [[General_Chooser_Property_Component|General Chooser Property Component]] is extended to the ADF General Chooser component (/ADF/extensions/customfields/general_chooser/general_chooser.cfc) and contains the functions for the base rendering. By implementing this extension, we can defined a set of variables specific to the data set for the custom element to select.

Follow the instructions below to setup a simple Property Component.

== Instructions ==
# Copy the Sample_GC component from the ADF extensions general chooser directory (/ADF/extensions/customfields/general_chooser/general_chooser/sample_gc.cfc).
# Paste the sample into your local sites CS Apps components directory (/mysite/_cs_apps/components/). If the components directory does not exist, then create it.
# Rename the component file from "sample_GC.cfc" to the specific custom element that you are selecting. (For example, with the Profile application a property component is named "profileGC.cfc" to select Profile custom element records.) You will want to be able to recognize the custom element data for the property component by reading the name (don't make this harder on yourself than it needs to be here).
# Open the property component in an editor.
# In the first set of variables with the comment ''CUSTOM ELEMENT INFO'', define the following variables that are specific to your custom element:
## '''variables.CUSTOM_ELEMENT''' - The name of the custom element to select the records.
## '''variables.CE_FIELD''' - The field name in the custom element that is a unique value for each record. ('''Note''': Best practice is to use a UUID field in the custom field.)
## '''variables.SEARCH_FIELDS''' - A comma separated list of the field names in the custom element that will be searched to filter available selections.
## '''variables.ORDER_FIELD''' - The field name in the custom element to sort the available selections for rendering.
# Save the property component.
# [[Reset ADF|Reset the ADF]].

General Chooser Property Component

2010-06-21T13:09:15Z

Mike:

General Chooser Property Component

2010-06-21T12:57:20Z

Mike: Created page with '== Overview == General Chooser Property Component is a component to build the data set and customize rendering for the field. Follow the …'

== Overview ==
[[General_Chooser_Property_Component|General Chooser Property Component]] is a component to build the data set and customize rendering for the field.

Follow the instructions below to setup a simple Property Component.

== Instructions ==
# Copy the Sample_GC component from the ADF extensions general chooser directory (/ADF/extensions/customfields/general_chooser/general_chooser/sample_gc.cfc).
# Paste the sample into your local sites CS Apps components directory (/mysite/_cs_apps/components/). If the components directory does not exist, then create it.
#

General Chooser

2010-06-21T12:53:20Z

Mike:

== Overview ==
The General Chooser is a custom field type that allows the user to select multiple records from a defined data set. The data set is built through a [[General_Chooser_Property_Component|General Chooser Property Component]] that is defined specifically for each chooser.

The base data set is designed for selection custom element records. Although, the component will allow a developer to build any custom data set, from CommonSpot groups to data from a non-CommonSpot database.

The built in styles allow the General Chooser custom field type to be easier designed. The field is based around the JQuery UI themes and a specific theme can be defined per data set. Also, the height and width for the selection boxes and items can be styled differently per data set.

== Implementation ==
Import the General Chooser custom field type into your site from this ADF location:
* /ADF/extensions/customfields/general_chooser/

Follow these instructions to create a [[General_Chooser_Property_Component|General Chooser Property Component]].

Once the component is created and the ADF is reset, add the General Chooser field to your custom element. In the properties field, enter the name for the component that was created (do not include the '.cfc').

Create a new page and add a simple form on the page. In the simple form, select the custom element with the General Chooser field and publish this page.

On this new page, the General Chooser will render two selection boxes. The items on the left can be dragged to the right, and vice-versa.

== Documentation Needed ==
* How does each method work
* How to override each aspect of the UI

== Thoughts ==
* This doesn't feel like a traditional "Extend". There are methods that you must define in your CFC that are not defined in the CFC that you are extending.
* We need a "clear" option in the chooser that would clear a columns results

General Chooser

2010-06-21T12:52:53Z

Mike: /* Overview */

== Overview ==
The General Chooser is a custom field type that allows the user to select multiple records from a defined data set. The data set is built through a Property Component that is defined specifically for each chooser.

The base data set is designed for selection custom element records. Although, the component will allow a developer to build any custom data set, from CommonSpot groups to data from a non-CommonSpot database.

The built in styles allow the General Chooser custom field type to be easier designed. The field is based around the JQuery UI themes and a specific theme can be defined per data set. Also, the height and width for the selection boxes and items can be styled differently per data set.

== Implementation ==
Import the General Chooser custom field type into your site from this ADF location:
* /ADF/extensions/customfields/general_chooser/

Follow these instructions to create a [[General_Chooser_Property_Component|General Chooser Property Component]].

Once the component is created and the ADF is reset, add the General Chooser field to your custom element. In the properties field, enter the name for the component that was created (do not include the '.cfc').

Create a new page and add a simple form on the page. In the simple form, select the custom element with the General Chooser field and publish this page.

On this new page, the General Chooser will render two selection boxes. The items on the left can be dragged to the right, and vice-versa.

== Documentation Needed ==
* How does each method work
* How to override each aspect of the UI

== Thoughts ==
* This doesn't feel like a traditional "Extend". There are methods that you must define in your CFC that are not defined in the CFC that you are extending.
* We need a "clear" option in the chooser that would clear a columns results

General Chooser

2010-06-21T12:52:26Z

Mike: /* Implementation */

== Overview ==
The General Chooser is a custom field type that allows the user to select multiple records from a defined data set. The data set is built through a component that is defined specifically for each chooser.

The base data set is designed for selection custom element records. Although, the component will allow a developer to build any custom data set, from CommonSpot groups to data from a non-CommonSpot database.

The built in styles allow the General Chooser custom field type to be easier designed. The field is based around the JQuery UI themes and a specific theme can be defined per data set. Also, the height and width for the selection boxes and items can be styled differently per data set.

== Implementation ==
Import the General Chooser custom field type into your site from this ADF location:
* /ADF/extensions/customfields/general_chooser/

Follow these instructions to create a [[General_Chooser_Property_Component|General Chooser Property Component]].

Once the component is created and the ADF is reset, add the General Chooser field to your custom element. In the properties field, enter the name for the component that was created (do not include the '.cfc').

Create a new page and add a simple form on the page. In the simple form, select the custom element with the General Chooser field and publish this page.

On this new page, the General Chooser will render two selection boxes. The items on the left can be dragged to the right, and vice-versa.

== Documentation Needed ==
* How does each method work
* How to override each aspect of the UI

== Thoughts ==
* This doesn't feel like a traditional "Extend". There are methods that you must define in your CFC that are not defined in the CFC that you are extending.
* We need a "clear" option in the chooser that would clear a columns results

General Chooser

2010-06-21T12:52:09Z

Mike: /* Implementation */

== Overview ==
The General Chooser is a custom field type that allows the user to select multiple records from a defined data set. The data set is built through a component that is defined specifically for each chooser.

The base data set is designed for selection custom element records. Although, the component will allow a developer to build any custom data set, from CommonSpot groups to data from a non-CommonSpot database.

The built in styles allow the General Chooser custom field type to be easier designed. The field is based around the JQuery UI themes and a specific theme can be defined per data set. Also, the height and width for the selection boxes and items can be styled differently per data set.

== Implementation ==
Import the General Chooser custom field type into your site from this ADF location:
* /ADF/extensions/customfields/general_chooser/

Follow these instructions to create a [[General_Chooser__Property_Component|property component for your General Chooser]].

Once the component is created and the ADF is reset, add the General Chooser field to your custom element. In the properties field, enter the name for the component that was created (do not include the '.cfc').

Create a new page and add a simple form on the page. In the simple form, select the custom element with the General Chooser field and publish this page.

On this new page, the General Chooser will render two selection boxes. The items on the left can be dragged to the right, and vice-versa.

== Documentation Needed ==
* How does each method work
* How to override each aspect of the UI

== Thoughts ==
* This doesn't feel like a traditional "Extend". There are methods that you must define in your CFC that are not defined in the CFC that you are extending.
* We need a "clear" option in the chooser that would clear a columns results

General Chooser

2010-06-21T12:48:46Z

Mike: /* Implementation */

== Overview ==
The General Chooser is a custom field type that allows the user to select multiple records from a defined data set. The data set is built through a component that is defined specifically for each chooser.

The base data set is designed for selection custom element records. Although, the component will allow a developer to build any custom data set, from CommonSpot groups to data from a non-CommonSpot database.

The built in styles allow the General Chooser custom field type to be easier designed. The field is based around the JQuery UI themes and a specific theme can be defined per data set. Also, the height and width for the selection boxes and items can be styled differently per data set.

== Implementation ==
Import the General Chooser custom field type into your site from this ADF location:
* /ADF/extensions/customfields/general_chooser/

Follow these instructions to create a [[General_Chooser_Component|component for your General Chooser]].

Once the component is created and the ADF is reset, add the General Chooser field to your custom element. In the properties field, enter the name for the component that was created (do not include the '.cfc').

Create a new page and add a simple form on the page. In the simple form, select the custom element with the General Chooser field and publish this page.

On this new page, the General Chooser will render two selection boxes. The items on the left can be dragged to the right, and vice-versa.

== Documentation Needed ==
* How does each method work
* How to override each aspect of the UI

== Thoughts ==
* This doesn't feel like a traditional "Extend". There are methods that you must define in your CFC that are not defined in the CFC that you are extending.
* We need a "clear" option in the chooser that would clear a columns results

General Chooser

2010-06-21T12:47:54Z

Mike: /* Implementation */

== Overview ==
The General Chooser is a custom field type that allows the user to select multiple records from a defined data set. The data set is built through a component that is defined specifically for each chooser.

The base data set is designed for selection custom element records. Although, the component will allow a developer to build any custom data set, from CommonSpot groups to data from a non-CommonSpot database.

The built in styles allow the General Chooser custom field type to be easier designed. The field is based around the JQuery UI themes and a specific theme can be defined per data set. Also, the height and width for the selection boxes and items can be styled differently per data set.

== Implementation ==
Import the General Chooser custom field type into your site from this ADF location:
* /ADF/extensions/customfields/general_chooser/

Follow these instructions to create a component for your General Chooser.

Once the component is created and the ADF is reset, add the General Chooser field to your custom element. In the properties field, enter the name for the component that was created (do not include the '.cfc').

Create a new page and add a simple form on the page. In the simple form, select the custom element with the General Chooser field and publish this page.

On this new page, the General Chooser will render two selection boxes. The items on the left can be dragged to the right, and vice-versa.

== Documentation Needed ==
* How does each method work
* How to override each aspect of the UI

== Thoughts ==
* This doesn't feel like a traditional "Extend". There are methods that you must define in your CFC that are not defined in the CFC that you are extending.
* We need a "clear" option in the chooser that would clear a columns results

General Chooser

2010-06-21T12:44:54Z

Mike:

== Overview ==
The General Chooser is a custom field type that allows the user to select multiple records from a defined data set. The data set is built through a component that is defined specifically for each chooser.

The base data set is designed for selection custom element records. Although, the component will allow a developer to build any custom data set, from CommonSpot groups to data from a non-CommonSpot database.

The built in styles allow the General Chooser custom field type to be easier designed. The field is based around the JQuery UI themes and a specific theme can be defined per data set. Also, the height and width for the selection boxes and items can be styled differently per data set.

== Implementation ==
Import the General Chooser custom field type into your site from this ADF location:
* /ADF/extensions/customfields/general_chooser/

Follow these instructions to create a component for your General Chooser.

Once the component is created and the ADF is reset, add the General Chooser field to your custom element. In the properties field, enter the name for the component that was created (do not include the '.cfc').

== Documentation Needed ==
* How does each method work
* How to override each aspect of the UI

== Thoughts ==
* This doesn't feel like a traditional "Extend". There are methods that you must define in your CFC that are not defined in the CFC that you are extending.
* We need a "clear" option in the chooser that would clear a columns results