Difference between revisions of "Overview"

From ADF Docs
Jump to: navigation, search
(Auto CFC Documentation)
(What can I do with the ADF?)
 
(14 intermediate revisions by 5 users not shown)
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 in 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]] to understand 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]])
 
  
== Architecture ==
+
[[Image:CommonSpot_Stack_2010.png|thumb|200px|none|alt=CommonSpot 6.0 Stack w/ the ADF.|CommonSpot 6.0 Stack w/ the ADF]]
The ADF is built on the LightWire object factory framework.  The object factory is configured and saved in server scope. 
 
The directory structure is as follows:
 
* [[Apps|Apps]] - 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 ==
+
== What can I do with the ADF? ==
[[Security|Read about ADF security]]
+
At the simplest level you can use the ADF to access content within your CommonSpot installation programattically.  For instance if you had a custom element named "News" and you wanted to get all of the content/records for that custom element you could use the ADF and write code like this:
  
== ADF Library ==
+
<!-- <source lang="cfm"> -->
[[Library|Library]] provided within the ADF.
+
  <cfset myData = application.ADF.ceData.getCEdata("News")>
 +
<!-- </source> -->
  
== Install Steps/Requirements ==
+
What you choose to do with that data is completely up to you.  Prior to the ADF, the only way you could access the data like this would be to write your own code against the CommonSpot database.
  
Minimum requirements for the ADF:
+
The above example is only the beginning.  The ADF is so much more.  With the ADF you can also do some of the following:
* ColdFusion 8
+
* Access Standard and Custom Metadata for any page and/or document in CommonSpot:
* Windows/Unix
 
* CommonSpot 5.0.3 (Hot Fix 11) or above
 
  
 +
  <cfset metadata = application.ADF.csData.getStandardMetadata(pageID)>
 +
  <cfset customdata = application.ADF.csData.getCustomMetadata(pageID)>
  
[[Installation|Step-by-step installation instructions]] for the ADF on your server.
+
* Access common tools typically found on the cflib.org site:
  
[[Naming Conventions|ADF Naming Conventions]]
+
  <cfset myArray = application.ADF.data.queryToArrayOfStructures(myQuery)>
  
== Custom Applications ==
+
* Connect two CommonSpot elements together using the new [[General Chooser]] and [[Custom Element Select]] custom field types
* [[Custom Application Configuration|Custom Application Configuration]]
+
* Download applications built using the ADF and add features to your site like [[Profiles]], [[Forums]], [[Blogs]]
* [[Custom Application ADF Library Overrides|Custom Application ADF Library Overrides]]
+
* Build [[ADF Applications| Applications]] using the ADF to distribute amongst your CommonSpot sites or share with the Community
* [[Custom Application Site Level Configuration|Custom Application Site Level Configuration]]
+
* Add [[ADF lightbox| lightbox]] interfaces to any of your applications/custom field types using code like:
* [[Custom Application Site Level Customization|Custom Application Site Level Customization]]
 
  
== Starter Application ==
+
  <cfset application.ADF.scripts.loadADFLightbox()>
A [[Starter Application|Starter Application]] can be used as a base to develop a new application.
+
  &lt;div rel="myCustomScript.cfm" class="ADFLightbox"&gt;Open in lightbox&lt;/div&gt;
  
== Auto CFC Documentation ==
+
  Body of the myCustomScript.cfm file being opened in the lightbox
The documentation for the ADF library components is automatically generated to display the metadata from the component files. This self-documenting process ensures documentation for the ADF library components remains in-sync with the code.
+
  <cfset application.ADF.scripts.loadADFLightbox()>
 +
  <cfset application.ADF.ui.lightboxHeader(lbTitle="myCustomScript")>
 +
  <cfoutput>{Lightbox Page Content}</cfoutput>
 +
  <cfset application.ADF.ui.lightboxFooter()>
  
To produce complete information, the component needs to be documented with the following:
+
== Getting Started ==
* Component hints
+
The best way to get started using the ADF is to [[ADF Installation|Install]] it.
* Function hints
+
Once you have the ADF installed you can:  
* Argument hints
 
* Properties
 
  
== Known Issues/Bugs ==
+
* Browse the [http://community.paperthin.com/projects/browse.cfm applications] available on the Community Site
* [[Bug_Tracking|Bug Tracking]]
 
  
 
[[Category:Landing Page]]
 
[[Category:Landing Page]]

Latest revision as of 19:48, 1 May 2014

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...


CommonSpot 6.0 Stack w/ the ADF.
CommonSpot 6.0 Stack w/ the ADF

What can I do with the ADF?

At the simplest level you can use the ADF to access content within your CommonSpot installation programattically. For instance if you had a custom element named "News" and you wanted to get all of the content/records for that custom element you could use the ADF and write code like this:

 <cfset myData = application.ADF.ceData.getCEdata("News")>

What you choose to do with that data is completely up to you. Prior to the ADF, the only way you could access the data like this would be to write your own code against the CommonSpot database.

The above example is only the beginning. The ADF is so much more. With the ADF you can also do some of the following:

  • Access Standard and Custom Metadata for any page and/or document in CommonSpot:
 <cfset metadata = application.ADF.csData.getStandardMetadata(pageID)>
 <cfset customdata = application.ADF.csData.getCustomMetadata(pageID)>
  • Access common tools typically found on the cflib.org site:
 <cfset myArray = application.ADF.data.queryToArrayOfStructures(myQuery)>
  • Connect two CommonSpot elements together using the new General Chooser and Custom Element Select custom field types
  • Download applications built using the ADF and add features to your site like Profiles, Forums, Blogs
  • Build Applications using the ADF to distribute amongst your CommonSpot sites or share with the Community
  • Add lightbox interfaces to any of your applications/custom field types using code like:
 <cfset application.ADF.scripts.loadADFLightbox()>
 <div rel="myCustomScript.cfm" class="ADFLightbox">Open in lightbox</div>
 Body of the myCustomScript.cfm file being opened in the lightbox
 <cfset application.ADF.scripts.loadADFLightbox()>
 <cfset application.ADF.ui.lightboxHeader(lbTitle="myCustomScript")>
 <cfoutput>{Lightbox Page Content}</cfoutput>
 <cfset application.ADF.ui.lightboxFooter()>

Getting Started

The best way to get started using the ADF is to Install it. Once you have the ADF installed you can: