lid

SublimeText offline dynamic help for ColdFusion

Couple of years back, we were using ColdFusion Builder as our primary development IDE. We used only CFB 1 & 2, haven't tried CFB 3 so far. But CFB 1 & 2 were exceptionally slow and bloated.

An year back, We moved from ColdFusionBuilder to SublimeText, We knew it is not full fledged IDE, it is just an text code editor. After using it for a couple of weeks, we never turned back to CFB. It is freaking light weight. Please check CF Builder vs SublimeText 2 resources comparison by Chris Tierney

IDERAMDisk
CF Builder 2.0.1185,420 K525 MB
Sublime Text 2.0.147,232 K20 MB + 67.5MB App Data
Below are the top few reasons, why you should try SublimeText,
  • Package control
  • Goto Anything
  • Multiple cursor ( Ctrl/Cmd + d for select subsequent matches, Alt+f3 / Cmd+Ctrl+g selects all instances)
  • Column selection ( shift-right click and drag )

But we missed offline documentation in the ColdFusion builder in our new code editor. It is hard to remember all cftag attributes & function arguments list. Ctrl+F1 is a handy short cut to see the dynamic help in ColdFusion builder. We started using Dominic Watson's Cf Quick Docs Launcher plugin to achieve this. It is very simple sublimetext plugin which will select the word at the cursor & do search in CF Quick Docs. But CF Quick Docs is not offline & it is not actively updated.

We have 2 offline options for CFML documentation. First one, you can find it in, inside of your ColdFusion builder installation path plugins/com.adobe.coldfusion.help_2.0.1.282422 You can see toc.xml file & docs folder inside this. Create a folder called "Sublime_CF_help" in your ColdFusion wwwroot & place these toc.xml file & docs folder. We wrote small cfm script to parse & search the neccessary tag / function from toc.xml

Second option is cfdocs.org It is a great Initiative by Pete Freitag. Clone cfdocs repository from GitHub into "Sublime_CF_help" folder in your ColdFusion wwwroot

Finally modify the Cf Quick Docs Launcher plugin python code to use any one of these 2 options

@joseGaldamez mentioned about dash as an option for offline documentation for Mac. Using DashDoc sublimetext plugin, you could use dash in your Mac.

We have tried this & it is simply awesome. Dash supports offline access to 130+ API documentation sets. If you are in Mac, we suggest to use this.




lid