CFEclipse Dictionaries for FarCry Developers

written by Geoff Bowers on Saturday, 23 February, 2008 @ 04:28 PM

One of the cool little unsung features of CFEclipse are dictionaries. Dictionaries are those little files that provide all the code hinting and insight for your CF tags, functions and scopes as you type. Daemonite Blair has been investigating clever ways to build dictionaries for FarCry Core and keep them automatically up to date.

CFEclipse FarCry Dictionary

The good news is we already have a couple of dictionaries freely available for FarCry developers:

And they're dead easy to install:

  1. This XML file should be saved in your CFEclipse application in the /plugins/org.cfeclipse.cfml_1.3.1.6/dictionary directory (or the equivilant for your version) as farcry.xml (or whatever you like).
  2. Edit the dictionaryconfig.xml file in the same directory. Add your new dictionary the same way as the user.xml to the cf701 and cf8 coldfusion versions.
<version key="cf8" label="Coldfusion 8">
    <grammar location="cf8.xml" />
    <grammar location="user.xml" />
    <grammar location="farcry5.xml" />

Note to Pulse users; you will find your CFEclipse plugin somewhere like this: .pulse/cache/plugins

The even better news is we have a parser that trawls through the code base looking for specifically marked up and commented code, and then automatically generating the dictionary file. It means we can update the code base inline when we add a new attribute or argument and be confident that the change will magically make its way into the dictionary file in the next build. There's the added bonus of encouraging good inline commenting :)

Note to FarCry regulars; we haven't quite mastered the complexity of formtool metadata insight for cfproperty, but we're working on it. For now you'll need to refer to the online formtool documentation library.

* Another FarCry Breakfast production.