Table of Contents

  1. Welcome to the Fusebox Project Wiki
    1. Bug Tracker
    2. History
    3. Team Fusebox and TeraTech
  2. Documentation Overview
    1. Frequently Asked Questions
  3. Understanding the XML Files
    1. What are the Fusebox XML files?
    1. The fusebox.xml File
    1. The circuit.xml file
      1. circuit
      2. fuseaction
      3. prefuseaction, postfuseaction
    2. The circuit.dtd file
  6. Circuit XML Grammar
    1. Overview
    2. The Builtin Verbs
    3. Gotchas
    4. Summary
  7. Extending the FB5 framework with Custom Lexicons
    1. What’s happening here?
    2. Built-in Verbs
    3. Writing Custom Verbs
    4. Example verbs
      1. <cf:abort>
      2. <cf:dump>
  8. Extending The FB5 Framework With Plugins
  9. FLiP Methodology Overview
  10. Fusebox 5.1 Release Notes
    1. Bugs fixed in Fusebox 5.1
    2. Enhancements added in Fusebox 5.1
    3. Other miscellaneous tickets closed in Fusebox 5.1
  11. Fusebox 5.1 Enhancements
    1. Globally Shared Files
      1. Globally Shared Circuits
      2. Globally Shared Plugins
      3. Globally Shared Error Templates
      4. Globally Shared Lexicons
    2. Search Engine Safe URLs
    3. Using event as an alternative to attributes

Documentation Overview

This is the start of the next generation documentation:

Feel free to edit / add suggestions etc.

Many thanks to Kevin Roche for the first cut of the above documentation, as an update from what was on the previous Fusebox website.

Frequently Asked Questions

  1. I make changes to my fusebox.xml file, but nothing is happening.
    1. Changes made to the fusebox.xml file may not be picked up when you refresh your page. This is because only the 'development-full-load' mode will re-parse the xml files on every request. (see The fusebox.xml file). This saves time when using the other modes, but to pick up any changes you have made in your fusebox.xml file (including changing the mode to 'development-full-load'!), you need to over-ride this. Simply append the following fusebox URLs to your request: 
       index.cfm?fusebox.password=PASSWORD&fusebox.load=true
  2. I am getting 'Could not get exclusive lock to fusebox xml file'. What does this mean?
    1. Make sure the parsed/ directory is writable by your web server. This directory will be found in your application root. By default this will be where your fusebox.xml file is stored. See also ParsePath.
  3. I am getting an error that says
     "This is the template "errortemplates/fusebox.errorWritingParsedFile.cfm"
 An Error of type "fusebox.errorWritingParsedFile" has occurred
 An Error during write of Parsed File or Parsing Directory not found.
    What does this mean?
    1. ColdFusion will need permission to create and write certain folders and files. This error is most commonly encountered with a new application when it tries to write files to the YourApplicationRoot?/parsed/ directory. This folder needs to be writable by ColdFusion and should also match the 'ParsePath' value defined in the fusebox.xml.
      If you are running on Linux, you might also check to see if there are any case-sensitivity issues with regard to file and directory names you defined there. Note that by default the values for ParsePath, as well as PluginsPath?, errorTemplatesPath, and LexiconsPath? are relative from the application root (where the fusebox.xml file lives).
  4. Can Fusebox do SES (Search Engine Safe) URLs?
    1. Yes, Fusebox 5.5 will handle SES URLs 'out-of-the-box', and solutions are freely available for older versions, including PHP. Here is one for ColdFusion and Another for PHP.
  5. When I run my application, all I get is a white screen.
    1. This is most commonly caused by improper syntax in the XML files (fusebox.xml or circuit.xml). Make sure all tags are properly closed and only XML-valid symbols are used. See CircuitXmlGrammarPage.