CF8 Syntax Dictionaries for CFEclipse

Posted At : June 7, 2007 3:23 PM | Posted By : Mark Drew
Related Categories: coldfusion, cfeclipse

I have seen a lot of posts on various lists about this, and rather than making everyone hold out for the next release of CFEclipse (I am a bit behind due to having a flu since I got back from Scotch on the Rocks) I thought I would post up the dictionary file for ColdFusion 8 beta so you can install it yourselves.

Now, pay attention, I am going to detail the process here and wont be providing support for INSTALLING it. If you notice if any tags are wrong, send me the tag node from the XML and let me know the change and I can keep the master copy updated.

Here goes:

  1. Download and unzip the following file: cf8dictionary.zip, you should have a file called cf8.xml
  2. Browse to < eclipse install path >/plugins/org.cfeclipse.cfml_<version number>/dictionary/ and move cf8.xml into that directory
  3. open up the dictionaryconfig.xml file that is in that directory and add the following XML above the cfmx701 entry
    <version key="cf8" label="Coldfusion 8">
                      <grammar location="cf8.xml" />
                      <grammar location="user.xml" />
                   </version>
  4. Restart (or start) Eclipse.

You should now, if you look under CFEclipse in a projects preferences, have ColdFusion 8 added as a language.

Enjoy!

Comments (Comment Moderation is enabled. Your comment will not appear until approved.)
todd sharp's Gravatar You rock Mark. Thanks.
# Posted By todd sharp | 6/7/07 3:44 PM
Mark Drew's Gravatar Actually, after the last week of having a cold/flu, I shivver gently rather than rock.
# Posted By Mark Drew | 6/7/07 3:52 PM
Daniel's Gravatar thumps Up ! Having flu and doing work for the community... Hope you get better soon
# Posted By Daniel | 6/7/07 4:42 PM
Dan's Gravatar Great job, thanks Mark!
# Posted By Dan | 6/7/07 4:44 PM
Charlie Arehart's Gravatar Hey Mark, I thought the CF8 Eclipse Extensions (from Adobe) included CF8 tag support. Does it not? Or is yours doing something different?
# Posted By Charlie Arehart | 6/7/07 4:49 PM
Mark Drew's Gravatar I dont see how, they have documentation but not the syntax dictionary at all.
# Posted By Mark Drew | 6/7/07 4:56 PM
Brian Kotek's Gravatar Thanks Mark! One question, are these incomplete? For example, the cfdiv tag has some of the correct attributes but is missing "bind". I'm sure this is in flux as the API for CF8 isn't complete yet but I just wanted to ask/point it out.
# Posted By Brian Kotek | 6/7/07 5:19 PM
Damon Cooper's Gravatar Hey Mark, thanks!

@Charlie: We have Eclipse plugins with CF8, but not the CFEclipse tag editor updates for CF8.

Damon
# Posted By Damon Cooper | 6/7/07 5:34 PM
Brian Rinaldi's Gravatar Hey Mark, thanks for this and hope you feel better. Just an FYI, the cfdbinfo tag appears to be missing.
# Posted By Brian Rinaldi | 6/7/07 5:46 PM
Charlie Arehart's Gravatar Wow, my bad. Sorry for the misinformation (which I spread in a "Hidden Gems in CF8" talk that I did last night.)

And all the more thanks to Mark for his efforts on this, and all of CFEclipse.
# Posted By Charlie Arehart | 6/7/07 5:49 PM
Bill's Gravatar Thanks a million Mark. I'm just getting over the Flu as well. It's been two weeks of hell. Like you, I worked through it all. Nothing worse then trying to focus and unable too.

Get well soon
# Posted By Bill | 6/7/07 6:22 PM
Dan Vega's Gravatar Mark,
Is there somewhere we can collectively file missing attributes or tags? I would just hate for 10 people to keep emailing you about the same thing. FYI - I found that the attributeCollection attribute is missing from the tags. This in turn is causing errors for tags such as cfmail & cfmenu.
# Posted By Dan Vega | 6/7/07 6:48 PM
todd sharp's Gravatar "If you notice if any tags are wrong, send me the tag node from the XML and let me know the change and I can keep the master copy updated."

I think Mark was hoping we'd all just fix the xml file and send him the fix. I think that's only fair of us to do as we find them....ya know?
# Posted By todd sharp | 6/7/07 6:54 PM
todd sharp's Gravatar Not it..........
# Posted By todd sharp | 6/7/07 6:54 PM
Scott Krebs's Gravatar The new attribute statusCode is missing from cflocation. Sending my XML to Mark now...
# Posted By Scott Krebs | 6/7/07 7:19 PM
Dan Vega's Gravatar I was never good at reading directions, sorry! You know those tests where the first line would be sign your name and your done, I would always finish the whole test.
:)
# Posted By Dan Vega | 6/7/07 7:48 PM
Stephen Moretti's Gravatar To stop multiple emails you could always use cfeclipe's trac? http://trac.cfeclipse.org/ Search for your fix before you post. ;)
# Posted By Stephen Moretti | 6/7/07 7:53 PM
Sean Corfield's Gravatar Thanx for making this available Mark!

Like Brian, I noticed that cfdiv still has source instead of bind. Also, cfgrid doesn't appear to have onchange. I'll post others here as I find them.
# Posted By Sean Corfield | 6/7/07 8:07 PM
Sean Corfield's Gravatar Heh, just read the other comments... I too missed the note about sending Mark the fixes :)
# Posted By Sean Corfield | 6/7/07 11:38 PM
Mark Drew's Gravatar @Brian: well spotted, this is a change from the beta -> RC. I should have changed it as I had spotted this myself too.

And it would be easier if people send me the changes. I am sure there might be changes after the final, would like to do things incrementally.... also check for the functions, there are so many new ones!!!
# Posted By Mark Drew | 6/8/07 6:42 AM
Luis's Gravatar The new ARRAY attribute was missing from CFLOOP. I've added it to the CFLOOP node. I didn't know where to send the changes, so I posted them below.

      <tag xmlns="http://www.cfeclipse.org/version1/dictionary"; name="cfloop" single="false" xmlstyle="false">
         <help><![CDATA[
      Different items are required based on loop type. Items listed
      as required may not be depending on your loop type.
      Loop forms:
      [query] [condition] [index + from + to ] [index + list]
      [collection + item ]
   ]]></help>
         <parameter name="index" type="String" required="false">
            <help><![CDATA[
         Index value. CFML sets it to from value and
         increments or decrements by step value, until it equals to
         value.
      ]]></help>
            <values/>
         </parameter>
         <parameter name="to" type="Numeric" required="false">
            <help><![CDATA[
         Beginning value of index.
      ]]></help>
            <values/>
         </parameter>
         <parameter name="from" type="Numeric" required="false">
            <help><![CDATA[
         Ending value of index.
      ]]></help>
            <values/>
         </parameter>
         <parameter name="step" type="Numeric" required="false">
            <help><![CDATA[
         Ending value of index.
      ]]></help>
            <values/>
         </parameter>
         <parameter name="condition" type="boolean" required="false">
            <help><![CDATA[
         Condition that controls the loop.
      ]]></help>
            <values/>
         </parameter>
         <parameter name="query" type="String" required="false">
            <help><![CDATA[
         Query that controls the loop.
      ]]></help>
            <values/>
         </parameter>
         <parameter name="startrow" type="Numeric" required="false">
            <help><![CDATA[
         First row of query that is included in the loop.
      ]]></help>
            <values/>
         </parameter>
         <parameter name="endrow" type="Numeric" required="false">
            <help><![CDATA[
         Last row of query that is included in the loop.
      ]]></help>
            <values/>
         </parameter>
         <parameter name="list" type="String" required="false">
            <help><![CDATA[
         A list, variable, or filename; contains a list
      ]]></help>
            <values/>
         </parameter>
         <parameter name="delimiters" type="String" required="false">
            <help><![CDATA[
         Character(s) that separates items in list
      ]]></help>
            <values default=",">
               <value option=","/>
               <value option=";"/>
               <value option="|"/>
               <value option=":"/>
            </values>
         </parameter>
         <parameter name="collection" type="Object" required="false">
            <help><![CDATA[
         The collection attribute is used with the item attribute.
         often to loop over a structure
      ]]></help>
            <values/>
         </parameter>
         <parameter name="item" type="String" required="false">
            <help><![CDATA[
         The item attribute is used with the collection attribute.
         often to loop over a structure
      ]]></help>
            <values/>
         </parameter>
         <parameter name="array" type="String" required="false">
            <help><![CDATA[
         An array, or variable; contains an array
      ]]></help>
            <values/>
         </parameter>
      </tag>
# Posted By Luis | 6/8/07 5:29 PM
barry.b's Gravatar Hey Mark, I don't get it.

Why do you - a CF community person working hard to give everyone CFEclipse - have to come up with the CF8 dictionary for the tags?

sure, others in the community can help but I wonder....

... since Adobe has the info on tap when they're preparing the documentation, AND they've got the taginsight add-on for Homesite+....
... it's the *community* that _has_ to come up with the dictionary XML for CFEclipse?

just a thought. Thanx again for your hard work, Mark.
# Posted By barry.b | 6/11/07 6:19 AM
Mark Drew's Gravatar @Barry: I got the definitions from Adobe... so it was just up to me to convert them.

MD
# Posted By Mark Drew | 6/11/07 6:44 AM
barry.b's Gravatar phew! that's a relief. And thanx to Adobe for coming to the party to give back to the community.

and here I was thinking (worried) you were left to do everything.
# Posted By barry.b | 6/11/07 7:13 AM
Kai Tischler's Gravatar I use this thread to pose a question that has not been answered in the CFEclipse forum.

First of all: Very kind that You provide this CF 8 info - which I digest for another
editor, too - so early. How can one be informed about updates to the file "cf8.xml" ?

I want to enrich the info provided by the dictionary view with info
about my own CF libs; I have inserted the XML info into the file "user.xml".
How does the file "user.xml" work in conjunction with the dictionary view ? It is
not used alongside cf8.xml though I have declared it properly in "dictionaryconfig.xml" as described by You above.

Are there possibilities to feed CFC info into the dictionary view, too ?
# Posted By Kai Tischler | 6/11/07 8:40 PM
Maximilian Nyman's Gravatar Hey Mark,

Thanks for the CF8 support - Awesome!

But FYI (and anyone reading this)... there is a little bug in the cf8.xml for the cfinterface tag.
Currently it says <code>single="true"</code> but it should be <code>single="false"</code>. It's really no biggie but I thought I let you know.

Cheers,
Max
# Posted By Maximilian Nyman | 6/19/07 6:32 AM
Russell Youngblood's Gravatar Works like a champ .... thanks so much for the info!
# Posted By Russell Youngblood | 6/20/07 1:22 AM
Lu's Gravatar Thanks so much Mark, you are awesome.
# Posted By Lu | 6/29/07 7:16 AM
Charlie Arehart's Gravatar Hey Mark (or others), can you help out a relative newcomer? How does one see the alternative dictionary options after following the steps above (yes, including restarting the workbench)?

You say, "if you look under CFEclipse in a projects preferences, have ColdFusion 8 added as a language", but I've looked through each of the options under windows>preferences>cfeclipse and none refer to "language". I also used the "type filter text" feature, but find nothing referring to "language" (or "dictionary").

What am I missing? :-)
# Posted By Charlie Arehart | 7/13/07 5:40 AM
Mark Drew's Gravatar Hey Charlie,
Its actually the properties of a Project. So you have to right click on a project and you will see under the CFEclipse tab, the dictionaries you can choose.

Regards

Mark Drew
# Posted By Mark Drew | 7/13/07 5:47 AM
Will Bale's Gravatar Thanks, Mark.

Now I can do some of my own playing around and exploration...

You Rock!
# Posted By Will Bale | 7/17/07 3:39 PM
Charlie Arehart's Gravatar Hey Mark, is the update above (from 6/26) still the latest and greatest CF8 dictionary for CFEclipse? I know that Adobe has since come out with their Eclipse plugins (and help files for Eclipse), at http://www.adobe.com/support/coldfusion/downloads...., but those don't have anything to do with the CFE tag insight features, right?

If you do have an update, you may want to make a change to the content above, since a lot of searches and blog entries may bring people here for many months to come. :-)
# Posted By Charlie Arehart | 8/15/07 3:36 PM