About the Documentation

The documentation is designed to provide support for the complete spectrum of participants. The print and online versions are organized to allow you to quickly locate the information that you need. The online documentation is provided in HTML and Adobe Acrobat formats.

You can also access release notes, product support information, and several developer resources from the Help menu.

The rest of this section describes the conventions used in the documentation and the contents of the ColdFusion Studio documentation set.

Documentation conventions

When reading the documentation, note the following formatting cues:

Code samples are set in a monospaced font.

Levels to access a dialog box or pane are separated by the greater than (>) sign, and the path to access the item is set in bold. Following are two examples:
- "Select File > New" means "Select New from the File menu."
- "Select Options > Settings > Editor > Auto Completion" means "Select Settings from the Options menu and then, in the Settings dialog box, expand the Editor node and select Auto Completion."

Book titles and emphasized text are set in italics.

New terms are set in boldface.

Printed and online documentation set

The ColdFusion documentation set consists of the following titles.

Book

Description

Using ColdFusion Studio
Describes how to use ColdFusion Studio to build, test, and deploy Web content, including using the built-in editor for a variety of scripting and markup languages

Installing and Configuring ColdFusion Server
Describes system installation and basic configuration for Windows NT, Windows 2000, Solaris, Linux, and HP-UX

Advanced ColdFusion Server Administration
Describes how to connect your data sources to the ColdFusion Server, configure security for your applications, and how to use ClusterCATS to manage scalability, clustering, and load-balancing for your site

Developing ColdFusion Applications
Describes how to develop your dynamic Web applications, including retrieving and updating your data, using structures, and forms

CFML Reference
Provides descriptions, syntax, usage, and code examples for all ColdFusion tags, functions, and variables

CFML Quick Reference
A brief guide that shows the syntax of ColdFusion tags, functions, and variables

Book	Description
Using ColdFusion Studio	Describes how to use ColdFusion Studio to build, test, and deploy Web content, including using the built-in editor for a variety of scripting and markup languages
Installing and Configuring ColdFusion Server	Describes system installation and basic configuration for Windows NT, Windows 2000, Solaris, Linux, and HP-UX
Advanced ColdFusion Server Administration	Describes how to connect your data sources to the ColdFusion Server, configure security for your applications, and how to use ClusterCATS to manage scalability, clustering, and load-balancing for your site
Developing ColdFusion Applications	Describes how to develop your dynamic Web applications, including retrieving and updating your data, using structures, and forms
CFML Reference	Provides descriptions, syntax, usage, and code examples for all ColdFusion tags, functions, and variables
CFML Quick Reference	A brief guide that shows the syntax of ColdFusion tags, functions, and variables

Viewing online documentation

You can view Help for a specific tag, Help topics in HTML format, or online documentation in Adobe Acrobat (PDF) format.

To view Help for a tag:

Position the cursor in a tag and press F1. Help for the selected tag appears, including syntax and usage information.

F1 Help is available for all supported languages. To view a list of the supported languages, open the Tag Chooser (Ctrl+E).

To view the online HTML help:

Select Help > Open Help References Window.
The Help tab of the Resources window appears, displaying a tree of online books that include several language references as well as the documentation.

Find the Help topic you need, using the tree, search engine, index, or bookmarks.
For details, see "Getting the Most from the Help System".
Double-click the topic you need to display it in the Document window.

To view the PDF documentation:

Open the PDF documentation from the product CD-ROM or download it from the Macromedia Web site, from www.allaire.com/developer/documentation/coldfusion.cfm.

Printing online documentation

You can print one Help topic at a time in the HTML Help, or print as many pages of the Help as you need from the Adobe Acrobat (PDF) format of the Help.

To print a single Help topic in the HTML Help:

Display the Help topic you need to print.
For instructions, see "Viewing online documentation".

Right-click the topic in the Document window and select your browser's command to print.

To print several pages from the PDF documentation:

Open the PDF documentation from the product CD-ROM or download it from the Macromedia Web site, from www.allaire.com/developer/documentation/coldfusion.cfm.

Print as many pages of the documentation as you need.

LiveDocs comments are not longer enabled for ColdFusion 5.0. Please use one of the following resources instead.

Version 5.0

Using ColdFusion Studio
About This Book