Difference between revisions of "Portlet"
(→Requirements) |
|||
| (10 intermediate revisions by 4 users not shown) | |||
| Line 3: | Line 3: | ||
== Overview == | == Overview == | ||
| − | The Portlet application provides a drag and drop user interface utilizing content pods to allow users the ability to build their own personalized page. Pods can be configured with predefined content or user selected content. Via RSS, pods contain external content such as news and weather feeds or by using CommonSpot's out of the box RSS feed capability content from Global Custom elements can be displayed. Each pod has properties such has dragable, editable, deletable and collapsible. These properties | + | The Portlet application provides a drag and drop user interface utilizing content pods to allow users the ability to build their own personalized page. Pods can be configured with predefined content or user selected content. Via RSS, pods contain external content such as news and weather feeds or by using CommonSpot's out of the box RSS feed capability content from Global Custom elements can be displayed. Each pod has properties such has dragable, editable, deletable and collapsible. These properties can be locked so pre-defined pods are locked from user control. |
<!-- 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. | <!-- 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. | ||
| Line 23: | Line 23: | ||
* CCAPI | * CCAPI | ||
| − | The ADF must be configured correctly for your site. The [[Site | + | The ADF must be configured correctly for your site. The [[Site Configuration (ADF.cfc)]] wiki page has instructions for configuration. |
== Contents == | == Contents == | ||
| Line 29: | Line 29: | ||
* Custom Coding - various components and scripts. | * Custom Coding - various components and scripts. | ||
* CommonSpot Components: | * CommonSpot Components: | ||
| − | + | **Portlet App Elements | |
| − | ** | + | ***[[Portlet_Columns]] |
| − | ** | + | ***[[PortletPodInstances]] |
| − | ** | + | ***[[PortletPodUserData]] |
| − | ** | + | ***[[ptPortlet Configuration]] |
| − | ** | + | **Portlet Pod Types |
| − | ** | + | ***[[Links]] |
| + | ***[[RSS_Feeds]] | ||
| + | ***[[Simple_Content]] | ||
| + | ***[[Weather]] | ||
| + | ***[[Custom_File]] | ||
| + | **Portlet Pod Content | ||
| + | ***[[Link Items]] (optional) | ||
| + | ***[[RSS Formatted Content]] | ||
| − | + | Note: Elements may contain one or more: Render Handlers or Custom Field Types. They do NOT use Display Templates. | |
== Pre-installation Considerations == | == Pre-installation Considerations == | ||
| Line 47: | Line 54: | ||
Each of the following steps should be completed fully and in the order presented: | Each of the following steps should be completed fully and in the order presented: | ||
| + | # [[PT Portlet Extract Application|Download/Extract PT Portlet Application]] | ||
# [[PT Portlet ADF Configuration|PT Portlet ADF Configuration]] | # [[PT Portlet ADF Configuration|PT Portlet ADF Configuration]] | ||
| − | # [[PT Portlet | + | # [[PT Portlet Styles|Styles]] |
| − | |||
# [[PT Portlet Import Custom Elements|Import Custom Elements]] | # [[PT Portlet Import Custom Elements|Import Custom Elements]] | ||
# [[PT Portlet Site Configuration|Site Configuration]] | # [[PT Portlet Site Configuration|Site Configuration]] | ||
| Line 64: | Line 71: | ||
* Getting Started | * Getting Started | ||
| + | --> | ||
| + | |||
| + | <!-- | ||
| + | == Troubleshooting == | ||
--> | --> | ||
== Known Issues/Bugs == | == Known Issues/Bugs == | ||
| − | Found a bug | + | Found a bug? View the [http://community.paperthin.com/projects/pt_portlet/issue/ PT Portlet Issues] page. Your issue not on the list? Post it so the issue can be addressed. |
[[Category:Project]][[Category:Portlet]] | [[Category:Project]][[Category:Portlet]] | ||
Latest revision as of 21:20, 24 November 2010
Contents
About the Portlet App
The Portlet application is built in the Application Development Framework (ADF).
Overview
The Portlet application provides a drag and drop user interface utilizing content pods to allow users the ability to build their own personalized page. Pods can be configured with predefined content or user selected content. Via RSS, pods contain external content such as news and weather feeds or by using CommonSpot's out of the box RSS feed capability content from Global Custom elements can be displayed. Each pod has properties such has dragable, editable, deletable and collapsible. These properties can be locked so pre-defined pods are locked from user control.
Requirements
ADF Library components that are required for the Portlet 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 Portlet application contains the following:
- Custom Coding - various components and scripts.
- CommonSpot Components:
- Portlet App Elements
- Portlet Pod Types
- Portlet Pod Content
- Link Items (optional)
- RSS Formatted Content
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 Profile application. For detailed instructions follow the ADF Overview wiki page for Site Configurations.
This installation guide assumes that you have no Custom Elements and/or 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/Extract PT Portlet Application
- PT Portlet ADF Configuration
- Styles
- Import Custom Elements
- Site Configuration
- Build Subsites, Templates and Pages
Known Issues/Bugs
Found a bug? View the PT Portlet Issues page. Your issue not on the list? Post it so the issue can be addressed.
