Difference between revisions of "Overview"

From ADF Docs
Jump to: navigation, search
(Folder Architecture)
Line 1: Line 1:
 
== Overview ==
 
== Overview ==
The Application Development Framework (ADF) provides a common library of building blocks for CommonSpot custom applications. The ADF is located at the server level and is accessible from all sites on the server.
+
The Application Development Framework (ADF) is an open source framework that essentially sits on top of (or next to) your CommonSpot installation. The ADF is a combination of Server and Site level Object factories built using the open source Lightwire Object Factory (visit the [[Glossary|Term Glossary]] for definitions of the terminology used with the lightwire object factory)
  
Visit the [[Glossary|Term Glossary]] for definitions of the terminology used with the lightwire object factory.
+
The framework consists of essentially these major components:
 +
* [[ADF Applications|Applications]] (Apps) - Custom built applications that can be a combination of components (cfc's), custom coding (custom field types, custom scripts, renderhandlers etc...) and common ADF library components
 +
* [[Lib|Library]] - Organized components designed to extend your CommonSpot development by giving you simple access to data within CommonSpot (like pages, subsites, documents, images and custom elements)
 +
* [[Extensions|Extensions]] - Global custom scripts, custom field types, datasheet modules, render handlers, etc... Extensions can be imported into you current CommonSpot sites to achieve enhanced functionality.
 +
* [[ThirdParty|ThirdParty]] - Third party software used to enhance the interface or interaction with CommonSpot data.  Examples include, jQuery plugins, jQuery UI, swfobject etc...
  
The ADF is a series of components and methodology to build apps within CommonSpot. ([[Licenses|Read the licensing details]])
 
 
== Folder Architecture ==
 
The ADF is built on the LightWire object factory framework.  The object factory is configured and saved in server scope. 
 
ADF directory structure:
 
* Apps ([[ADF Applications|Applications]]) - Location of the custom applications to be used throughout the server.
 
* [[Core|Core]] - Configuration components that build and control the ADF.
 
* [[Extensions|Extensions]] - Directory of custom scripts, custom field types, datasheet modules, render handlers, etc, used in development of custom applications.
 
* [[Lib|Lib]] - Library of components.
 
* [[ThirdParty|ThirdParty]] - Third party software used in the ADF.
 
 
== Security ==
 
[[Security|Read about ADF security]]
 
 
== ADF Library ==
 
[[Library|Library]] provided within the ADF.
 
 
== Installation Steps/Requirements ==
 
 
Minimum requirements for the ADF:
 
* ColdFusion 8
 
* Windows/Unix
 
* CommonSpot 5.0.3 (Hot Fix 11) or above
 
 
 
[[Installation|Step-by-step installation instructions]] for the ADF on your server.
 
 
[[Naming Conventions|ADF Naming Conventions]]
 
 
== Custom Applications ==
 
* [[Custom Application Configuration|Custom Application Configuration]]
 
* [[Custom Application ADF Library Overrides|Custom Application ADF Library Overrides]]
 
* [[Custom Application Site Level Configuration|Custom Application Site Level Configuration]]
 
* [[Custom Application Site Level Customization|Custom Application Site Level Customization]]
 
 
== Starter Application ==
 
A [[Starter Application|Starter Application]] can be used as a base to develop new applications.
 
 
== Auto CFC Documentation ==
 
Documentation for the ADF library components is automatically generated based on metadata from the component files.  This self-documenting process ensures documentation for the ADF library components remains in-sync with the code. 
 
 
To produce complete documentation, the component needs:
 
* Component hints
 
* Function hints
 
* Argument hints
 
* Properties
 
 
== Known Issues/Bugs ==
 
* [[Bug_Tracking|Bug Tracking]]
 
  
 
[[Category:Landing Page]]
 
[[Category:Landing Page]]

Revision as of 02:32, 5 April 2010

Overview

The Application Development Framework (ADF) is an open source framework that essentially sits on top of (or next to) your CommonSpot installation. The ADF is a combination of Server and Site level Object factories built using the open source Lightwire Object Factory (visit the Term Glossary for definitions of the terminology used with the lightwire object factory)

The framework consists of essentially these major components:

  • Applications (Apps) - Custom built applications that can be a combination of components (cfc's), custom coding (custom field types, custom scripts, renderhandlers etc...) and common ADF library components
  • Library - Organized components designed to extend your CommonSpot development by giving you simple access to data within CommonSpot (like pages, subsites, documents, images and custom elements)
  • Extensions - Global custom scripts, custom field types, datasheet modules, render handlers, etc... Extensions can be imported into you current CommonSpot sites to achieve enhanced functionality.
  • ThirdParty - Third party software used to enhance the interface or interaction with CommonSpot data. Examples include, jQuery plugins, jQuery UI, swfobject etc...