SideBar
User Login Dashboard
lmajano
on 10-Aug-2010
|
Welcome To The ColdBox Wiki
A next generation ColdFusion Framework and Development Platform
This websites holds all the online documentation for the ColdBox Platform. 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
- Configuration File Schema Documentation (3.0.0)
- Latest ColdBox Platform API Docs
Introduction & Theory
This documentation section touches on the theory of MVC, ColdBox application architecture, and an introductory overview to the ColdBox Platform.
- 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
This section gives you an introductory or getting started feel to ColdBox Development!
- My First ColdBox Application
- Application Directory Structure & Conventions
- ColdBox Internal Configuration Settings
- Major Classes - Reserved Words & Methods
- ColdBox URL Actions
- Application.cfc Bootstrapper
Main Components
We can now delve into more development and how to use the development platform.
- The ColdBox Configuration CFC
- The ColdBox Configuration XML File (We prefer the CFC aproach)
- Event Handlers
- The Request Context
- Layout Manager & Views
- URL Mapping & Rewriting
- The Flash RAM Object & Webflows
- Model Integration
- ColdBox Plugins
- ColdBox Interceptor
- ColdBox Modules
- ColdBox Unit Testing & Integration Testing
- ColdBox Proxy: Powering Flex/AIR/Remote Applications
- ColdBox-Ajax Integration
- Extending The Request Context
Internal Frameworks & Libraries
The ColdBox Platform is composed of several standalone internal frameworks and libraries that can be used on standalone applications as well as within ColdBox applications. Below are the documents for each standalone library or framework.
- MockBox: The ColdBox Mocking/Stubbing Framework
- CacheBox: The ColdBox Enterprise Caching Engine
- LogBox: The ColdFusion Enterprise Logging Library
- WireBox: ColdBox DI/AOP Engine
Core Extensions
In this section we have our core plugins, core interceptors and core extras documentation.
Core Plugins
Visit our Core Plugins Page Browser
- AntiSamy - Built in XSS cleanup tool
- Application Storage - Interface to the Application scope, the OO way
- BeanFactory - Our interface to WireBox
- CFCViewer - Love Documentation? Then use this plugin to document ANYTHING!
- Client Storage - Interface to the Client scope, the OO way
- Cluster Storage - Interface to the Cluster scope, the OO way
- Cookie Storage - Interface to the Cookie scope, the OO way
- Date Utility - Help you with funky dates
- Feed Reader Plugin - Read any feed
- Feed Generator Plugin - Generate any feed
- Feed Generator Elements
- File Utility - Cool file utility methods
- HTMLHelper - Get fancy with HTML
- IOC Plugin - Interface to Inversion of Control frameworks
- Internationalization Guide (i18n)
- JavaLoader - Get funky and interact with java the easy way
- JVMUtils - Talk to our favorite friend
- Logger Plugin - Interfacing with LogBox
- Mail Service - Sending mails with token replacements
- MessageBox - Cool little messages for your apps
- Method Injector - Elevate yourself to guru status
- Query Helper - Do some query magic with this plugin
- Session Storage - Interface to the Session scope, the OO way
- String Buffer - Need lots of string concatenations the fast way?
- Timer - Need to time/profile your code to the ColdBox Debugger?
- Validator - Validate ANYTHING!
- Webservices - Interact with your set webservices
- XML Converter - Convert anything to XML
- Zip - Zip Anything
Core Interceptors
Visit our Core Interceptors Page Browser
- 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
Visit our Core Extras Page Browser
Standalone Projects
The ColdBox standalone projects are a suite of projects, plugins, interceptors, modules, etc 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 entries.
- 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
- Creating a 404 template via onInvalidEvent
- Is there an easy, programmatic way to remove a specific element from the view cache
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
Comments (
