Difference between revisions of "Overview"
(→Starter Application) |
(→Auto CFC Documentation) |
||
| Line 43: | Line 43: | ||
== Auto CFC Documentation == | == Auto CFC Documentation == | ||
| − | The documentation for the ADF library components is automatically generated to display the metadata | + | 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. |
To produce complete information, the component needs to be documented with the following: | To produce complete information, the component needs to be documented with the following: | ||
Revision as of 23:41, 19 December 2009
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 in all sites on the server.
Visit the Term Glossary to understand 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. The directory structure is as follows:
- 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.
Install 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 a new application.
Auto CFC Documentation
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.
To produce complete information, the component needs to be documented with the following:
- Component hints
- Function hints
- Argument hints
- Properties
