Dashboard
|
Welcome To The ColdBox Wiki
A next generation ColdFusion Framework and Development Platform
This websites holds all the online documentation for the ColdBox Platform. If you would like to report a bug for ColdBox, please do so by posting it on the Online Forums or email it to bugs@coldbox.org. This project survives thanks to your donations. So please Donate to ColdBox or you can visit My Amazon Wishlist
Important: This site is the new repository of the ColdBox Documentation starting from version 3.0.0 and above. If you are looking for the documentation for ColdBox 2.6.4 and below then visit our old wiki repository: http://ortus.svnrepository.com/coldbox/trac.cgi
General Platform Information
- Release Notes : Where all our release notes go
- License Agreement : Our official software license
- Credits : A thank you to the team and collaborators
- Site Usage : Checkout some of the companies, websites and applications that run ColdBox
- ColdBox Case Studies : Our collection of Company Case Studies using the ColdBox Platform
- ColdBox 2.6.4 < Documentation
What's New ?
A collection of all the what's new documents for each ColdBox Release.- What's New with 3.0.0
- What's New with 2.6.3
- What's New with 2.6.2
- What's New with 2.6.1
- What's New with 2.6.0
- What's New with 2.5.2
- What's New with 2.5.0
Compatibility Guides
These guides are to help developers migrate to new versions of the framework.- Upgrading to ColdBox 3.0.0 (2.X.X - 2.6.3)
- Compatibility Guide from pre 2.6.0 applications (2.5.0 - 2.5.2)
- Compatibility Guide from pre 2.5.0 applications (2.0.0 - 2.0.3)
- Compatibility Guide from pre 2.0.0 applications to 2.X.X
Installing & Getting Ready For Development
This section contains the necessary information to install, upgrade, maintain and get ready to start developing in ColdBox.- System Requirements
- Installing ColdBox
- Upgrading ColdBox
- Refactoring ColdBox for Custom Installations
- Eclipse Integration Plugins
- Installing IDE Syntax Dictionaries
- Adobe CF Builder Extension : ColdBox Platform Utilities
Generated Documentation
- Configuration File Schema Documentation (3.0.0)
- Configuration File Schema Documentation (2.6.X)
- Latest ColdBox API Docs
API Documents
Version Download 3.0.0 M4 ColdBoxDocs-3.0.0.M4.zip 2.6.4 ColdBoxDocs-2.6.4.zip 2.6.3 ColdBoxDocs-2.6.3.zip Introduction & Theory
- ColdBox Overview
- ColdBox MVC & Remote Application Life Cycles
- Model-View-Controller Demystified
- ColdFusion Development Best Practices
- ColdFusion SQL Injection Protection Best Practices
- Database Naming Conventions
The Basics
- My First ColdBox Application
- Application Directory Structure & Conventions
- ColdBox Internal Configuration Settings
- Reserved Words & Methods
- ColdBox URL Actions
Main Components
- The ColdBox Configuration CFC
- Event Handlers
- The ColdBox Request Context
- Layouts & Views
- URL Mapping & Rewriting
- The ColdBox Flash RAM Object
- Model Integration
- ColdBox Plugins
- ColdBox Interceptor
- Extending The Request Context
- ColdBox Unit Testing & Integration Testing
- ColdBox Proxy: Powering Flex/AIR/Remote Applications
- ColdBox-Ajax Integration
- ColdBox Modules
- The ColdBox Configuration File (We prefer the CFC aproach)
Internal Frameworks & Libraries
Here is the documentation for all the internal frameworks and libraries that the ColdBox Platform offers. All of these frameworks and libraries can be used on standalone applications as well as within ColdBox applications.- MockBox: The ColdBox Mocking/Stubbing Framework
- ColdBox Cache: The ColdBox Enterprise Caching Engine
- LogBox: The ColdFusion Enterprise Logging Library
- BlenderBox: ColdBox DI/AOP Engine
Core Extensions
In this section we have our core plugins, core interceptors and core extras documentation.Core Plugins
- ColdBox-ColdSpring Integration Guide
- ColdBox-LightWire Integration Guide
- Internationalization Guide (i18n)
- Feed Reader Plugin
- Feed Generator Plugin
- Feed Generator Elements
- JavaLoader
Core Interceptors
- Pretty URL's via SES Interceptor
- Environment Control Interceptor : Per-Environment Settings
- Autowire Interceptor
- Security Interceptor: Securing your applications
- ColdBox SideBar
- Deployment Interceptor
Core Extras
Standalone Projects-Plugins-Interceptors
The ColdBox standalone projects are a suite of projects, plugins, interceptors that are not part of the core platform but are available as separate downloads from ForgeBox. You can find these and tons of other projects at ForgeBox, our community repository. We are trying to document all official released plugins, projects and interceptors.
- The Groovy Loader Project
- The Lookup Manager Project
- JSMin Compressor for ColdBox Applications
- SASS Implementation in ColdBox
ForgeBox REST API Documentation
ForgeBox is an online repository of anything ColdBox or CodexWiki. Below is the documentation for its RESTful API.
ColdBox Recipes
A collection of useful recipes, you can also check out our Recipes Viewer
- Using Helper UDF's and CFC's
- My First Event Handler
- My First Custom Exception Handler
- My First Custom Plugin
- My First Interceptor
- My First Context Decorator
- How to time your code
- Object factory custom plugin
- Loading a custom ColdBox configuration file
- Tracing messages to the debug panel
- Creating a messagebox css
- Creating a Custom exception template
- Caching objects
- Autowiring using the ColdBox cache
- Persisting values using the ColdBox Flash Ram
Other Resources
- Community Articles & Tutorials : A collection of community articles and tutorials
- Media & Presentations : A collection of ColdBox media and presentations
- User Group Presentations : A collection of ColdBox user group presentations
SideBar
User Login
Comments (