Versions Compared

Old Version 13

changes.mady.by.user Blair McKenzie

Saved on

compared with

New Version Current

changes.mady.by.user Blair McKenzie

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

Info
titleCFEclipse Dictionaries

CFEclipse IDE FarCry coding dictionaries:

Installing the dictionary:

  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.
Code Block
<version key="cf8" label="Coldfusion 8">
    <grammar location="cf8.xml" />
    <grammar location="user.xml" />
    <grammar location="farcry5.xml" />
</version>
Tip
titleCF Builder Beta Users

You can use the dictionary with CF Builder. Builder only accepts a single dictionary per version, so you will need to create a merged file of both CF? + FarCry xml files. Here is one I prepared earlier:

Documentation Guidelines

To ensure the documents are complete, the following guidelines should be followed when writing or updating code. By making sure all the relevant comments and metadata attributes are in place, we can automate the upkeep of various documentation sources.

...

Variable

Description

hint

A short description of what the tag does. Used in CFEclipse as a tooltip.

description

A longer explanation of the tag. Will be used in HTML documentation, and can contain HTML code.

examples

Examples of tag usage. Will be used in HTML documentation, and can contain HTML code.

single

A boolean value that indicates whether this is a single element tag (i.e. <abcd>) or not (i.e. <efgh>...</efgh>. Defaults to true.

xmlstyle

If this is a single tag, this boolean value indicates whether the tag needs to be used XML style, i.e. <abcd />

bDocument

Must be set to true for the tag to be included in documentation

bDeprecated

Set to true to indicate that use of this tag is discouraged. The description and examples should include further information about preferred usage.

Code Block


<!---
@@hint: This does does stuff!
@@single: false
--->

Attribute Information

Attribute information is extracted from CFParam'ed attribute variables. Comment variables should be included in a comment IMMEDIATELY after the CFParam tag (no spaces or line breaks). To include an attribute that can't be CFParam'ed (e.g. attributes that are used in isDefined checks) you can comment out the CFParam tag defining the attribute, and include another comment immediately after it for comment variables.

...

Attribute

Description

bDocument

A boolean value that indicates whether the component should be included in documentation. Defaults to false.

bDeprecated

A boolean value that indicates whether the component is considered deprecated in favor of other code. Defaults to false.

scopelocation

If the component is consistently available in one of the scopes, this attribute contains the path.

...

Variable

Description

description

A longer explanation of the tagfunction. Will be used in HTML documentation, and can contain HTML code.

examples

Examples of tag function usage. Will be used in HTML documentation, and can contain HTML code.

...

Components with a scopelocation defined, and their functions, are automatically added to the scope variables.

...