Difference between revisions of "PT Forum Overview"

From ADF Docs
Jump to: navigation, search
(→‎Pre-installation Considerations)
 
(54 intermediate revisions by 6 users not shown)
Line 1: Line 1:
−
==Overview==
+
== About Forums App ==
−
A forums application built using CommonSpot Custom Application Framework.  Similar in concept to [http://forums.adobe.com/ Adobe Forums].
+
The Forums application is built in the [[Overview|Application Development Framework (ADF)]].
  
−
==Requirements==
+
== Overview ==
−
* Administrators can build a forum
+
The [http://en.wikipedia.org/wiki/Forum_(internet) Forums] application provides the ability to create an online message board inside a CommonSpot site. Also, with the option to integrate with other ADF applications, like PT Profiles.
−
* All authenticated users can build discussions
 
−
* All authenticated users can add responses to any discussion
 
−
* Navigation through forums is consistent with traditional forums applications
 
−
* Discussion creator can mark a response as "The Answer"
 
−
* Forums application will be integrated with [[Profiles|Profile Application]]
 
  
−
==Definitions==
+
With this application users can post and manage multiple Forum Categories, Topics and Threads.
−
* Forum - an area where topics are discussed.  A few examples of this would be:
 
−
** CS Installation
 
−
** Custom Application Development
 
−
** Tips/Tricks
 
−
** General Questions
 
−
* Discussion - topics tied to a Forum
 
−
* Response - replies to a discussion
 
−
* Profile - application used to maintain a site users profile
 
  
−
==Element Architecture==
+
Inheritable group permissions can be assigned for read, post, edit rights.  
−
[[Image:Cs_forums_element_diagram.png]]
 
  
 +
<!-- Discussions are organized into categories, topics and then threads. Categories are the top level buckets and work as the forum landing pages. As an example each department in an organization can be assigned a category. Inside of each Category can be multiple topics. Within each topic, messages are added to threads. -->
  
−
[[Category:Application]]
+
== Requirements ==
−
[[Category:Forums]]
+
ADF Library components that are required for the Forums application:
 +
* CEData_1_0
 +
* CSData_1_0
 +
* Data_1_0
 +
* Date_1_0
 +
* Forms_1_0
 +
* Scripts_1_0
 +
* CCAPI
 +
 
 +
The ADF must be configured correctly for your site. The [[Site Configuration (ADF.cfc)]] wiki page has instructions for configuration.
 +
 
 +
== Contents ==
 +
The Forums application contains the following:
 +
* Custom Coding - various components and scripts.
 +
* CommonSpot Components:
 +
** [[Forum Categories]] - Custom Element
 +
** [[Forum Topics]] - Custom Element
 +
** [[Forum Threads]] - Custom Element
 +
** [[Forum Messages]] - Custom Element
 +
** [[Forum User Settings]] - Custom Element
 +
** [[Forum Subscriptions]] - Custom Element
 +
** [[PTForum Configuration]] - Custom Element
 +
 
 +
'''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 Forum 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:
 +
 
 +
# [[PT Forums Extract Application|Download/Extract PT Forum Application]]
 +
# [[PT Forums ADF Configuration|PT Forum ADF Configuration]]
 +
# [[PT Forums Styles|Styles]]
 +
# [[PT Forums Import Custom Elements|Import Custom Elements]]
 +
# [[PT Forums Site Configuration|Site Configuration]]
 +
# [[PT Forums Build Subsites Templates and Pages|Build Subsites, Templates and Pages]]
 +
<!-- # [[PT Forums After Login Configuration|After Login Configuration]] -->
 +
 
 +
<!--
 +
 
 +
== Features ==
 +
The Forums application provides the following features:
 +
 
 +
* [[PT_Forums_Lightbox|Lightbox]]
 +
 
 +
-->
 +
 
 +
== Getting Started ==
 +
The installation has been completed and you are ready to start posting to the forums.
 +
 
 +
* Navigate to the [[PT_Forums_Configuration|Configuration Manager]] page and edit the single record.  Update the ''Default Security'' for the forums.  Set the site administrators group to have ''admin'' rights.
 +
* Navigate to the [[PT_Forums_Categories_Page|Forum Home/Category Page]].  The ''New Category'' button will be rendered above the table.  Click the button and create a new category for the forum.
 +
* After you have a category created, then create a topic, a thread, and a message post.
 +
* Navigate to the Forum webadmin and review the datasheets to make sure the data matches what you have created. 
 +
 
 +
If everything works with no problems/errors, then you are ready to launch the Forums.
 +
 
 +
<!--
 +
== Troubleshooting ==
 +
-->
 +
 
 +
== Known Issues/Bugs ==
 +
Found a bug? View the [http://community.paperthin.com/projects/pt_forum/issue/ PT Forum Issues] page.  Your issue not on the list?  Post it so the issue can be addressed.
 +
 
 +
[[Category:Project]][[Category:Forums]]

Latest revision as of 15:49, 7 July 2011

About Forums App

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

Overview

The Forums application provides the ability to create an online message board inside a CommonSpot site. Also, with the option to integrate with other ADF applications, like PT Profiles.

With this application users can post and manage multiple Forum Categories, Topics and Threads.

Inheritable group permissions can be assigned for read, post, edit rights.


Requirements

ADF Library components that are required for the Forums application:

  • CEData_1_0
  • CSData_1_0
  • Data_1_0
  • Date_1_0
  • Forms_1_0
  • Scripts_1_0
  • CCAPI

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

Contents

The Forums application contains the following:

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

Pre-installation Considerations

The ADF must be setup and configured on the server for the site that will be implementing the Forum application. For detailed instructions follow the 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:

  1. Download/Extract PT Forum Application
  2. PT Forum ADF Configuration
  3. Styles
  4. Import Custom Elements
  5. Site Configuration
  6. Build Subsites, Templates and Pages


Getting Started

The installation has been completed and you are ready to start posting to the forums.

  • Navigate to the Configuration Manager page and edit the single record. Update the Default Security for the forums. Set the site administrators group to have admin rights.
  • Navigate to the Forum Home/Category Page. The New Category button will be rendered above the table. Click the button and create a new category for the forum.
  • After you have a category created, then create a topic, a thread, and a message post.
  • Navigate to the Forum webadmin and review the datasheets to make sure the data matches what you have created.

If everything works with no problems/errors, then you are ready to launch the Forums.


Known Issues/Bugs

Found a bug? View the PT Forum Issues page. Your issue not on the list? Post it so the issue can be addressed.

Retrieved from "http://community.paperthin.com/adf-docs/index.php?title=PT_Forum_Overview&oldid=4798"