Difference between revisions of "Overview"
(→Auto CFC Documentation) |
|||
| 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 | + | 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. |
| − | Visit the [[Glossary|Term Glossary]] | + | Visit the [[Glossary|Term Glossary]] for definitions of the terminology used with the lightwire object factory. |
The ADF is a series of components and methodology to build apps within CommonSpot. ([[Licenses|Read the licensing details]]) | The ADF is a series of components and methodology to build apps within CommonSpot. ([[Licenses|Read the licensing details]]) | ||
| Line 8: | Line 8: | ||
== Architecture == | == Architecture == | ||
The ADF is built on the LightWire object factory framework. The object factory is configured and saved in server scope. | The ADF is built on the LightWire object factory framework. The object factory is configured and saved in server scope. | ||
| − | + | ADF directory structure: | |
* [[Apps|Apps]] - Location of the custom applications to be used throughout the server. | * [[Apps|Apps]] - Location of the custom applications to be used throughout the server. | ||
* [[Core|Core]] - Configuration components that build and control the ADF. | * [[Core|Core]] - Configuration components that build and control the ADF. | ||
| Line 21: | Line 21: | ||
[[Library|Library]] provided within the ADF. | [[Library|Library]] provided within the ADF. | ||
| − | == | + | == Installation Steps/Requirements == |
Minimum requirements for the ADF: | Minimum requirements for the ADF: | ||
| Line 40: | Line 40: | ||
== Starter Application == | == Starter Application == | ||
| − | A [[Starter Application|Starter Application]] can be used as a base to develop | + | A [[Starter Application|Starter Application]] can be used as a base to develop new applications. |
== Auto CFC Documentation == | == 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 | + | To produce complete documentation, the component needs: |
* Component hints | * Component hints | ||
* Function hints | * Function hints | ||
Revision as of 17:06, 24 January 2010
Contents
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.
Visit the Term Glossary for definitions of the terminology used with the lightwire object factory.
The ADF is a series of components and methodology to build apps within CommonSpot. (Read the licensing details)
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 - Location of the custom applications to be used throughout the server.
- Core - Configuration components that build and control the ADF.
- Extensions - Directory of custom scripts, custom field types, datasheet modules, render handlers, etc, used in development of custom applications.
- Lib - Library of components.
- ThirdParty - Third party software used in the ADF.
Security
ADF 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
Step-by-step installation instructions for the ADF on your server.
Custom Applications
- Custom Application Configuration
- Custom Application ADF Library Overrides
- Custom Application Site Level Configuration
- Custom Application Site Level Customization
Starter Application
A 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
