Inside Out Outside In

CFC Component Doc Static Generator

 The componentDoc in the CFIDE/ComponentUtils is a nifty little utility for browsing your CFC's.  The standard 3 frame viewer generates the views on demand.  I've extended the componentDoc by building a static generator which takes selected packages and generates static html output for offline viewing and delivering documentation when a ColdFusion server isn't available.

Each run of the generator will store the output into a content folder within the componentUtils directory, using a UUID for the generation run, followed by the specified name to use for the package as well as a zip file containing the generated content.  Just place the generator files into the /CFIDE/ComponentUtils/ directory and call the generator.cfm file.

You can download it here.







Comments (Comment Moderation is enabled. Your comment will not appear until approved.)
Aaron Longnion's Gravatar Great tag! One thing: although it seems to have generated all the static files, I'm on CF 6.1 and get the following error:\n\n Attribute validation error for tag directory.\nThe tag does not have an attribute called recurse. The valid attribute(s) are action, directory, name, filter, sort, newdirectory, mode.\n \nThe error occurred in C:\\Program Files\\Apache Group\\Apache2\\htdocs\\CFIDE\\componentutils\\_zipPackage.cfm: line 7\n\n5 :     @version: 1.0\n6 : --->\n7 : <cfset packager = CreateObject( "component", "CFIDE.componentutils.zipper" )>\n8 : \n9 : <cfset packager.zipPackage(Request.contentPath)>\n\nPlease try the following:\n\n * Check the ColdFusion documentation to verify that you are using the correct syntax.\n * Search the Knowledge Base to find a solution to your problem.\n\nBrowser    Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.8.1.3) Gecko/20070309 Firefox/2.0.0.3\nRemote Address    127.0.0.1\nReferrer    http://localhost/cfide/ComponentUtils/generator.cf...\nDate/Time    28-Mar-07 04:59 PM\nStack Trace\nat cf_zipPackage2ecfm1309305615.runPage(C:\\Program Files\\Apache Group\\Apache2\\htdocs\\CFIDE\\componentutils\\_zipPackage.cfm:7) at cf_generate2ecfm238443199.runPage(C:\\Program Files\\Apache Group\\Apache2\\htdocs\\CFIDE\\componentutils\\_generate.cfm:279)\n\ncoldfusion.compiler.TagAttributeNotFoundException: Attribute validation error for tag directory.\n\n\nI think recurse is new to CF 7. (no big deal, though, as it worked great besides that. Very handy!)
# Posted By Aaron Longnion | 3/28/07 6:05 PM
Christopher Wigginton's Gravatar Yes, Recurse is a CFMX 7 CFDIRECTORY attribute. You could replace the tag with a custom tag. There are a few on the developer exchange for pre-7 installations that will recurse. look for CF_DirectoryList_Enhanced
# Posted By Christopher Wigginton | 3/28/07 8:13 PM