This manual, as well as the software described in it, is furnished under license and may
be used or copied only in accordance with the terms of such license. The content of
this manual is furnished for informational use only, is subject to change without
notice, and should not be construed as a commitment by Allaire Corporation. Allaire
Corporation assumes no responsibility or liability for any errors or inaccuracies that
may appear in this book.
Except as permitted by such license, no part of this publication may be reproduced,
stored in a retrieval system, or transmitted in any form or by any means, electronic,
mechanical, recording, or otherwise, without the prior written permission of Allaire
Corporation.
ColdFusion and HomeSite are federally registered trademarks of Allaire Corporation.
HomeSite, the ColdFusion logo and the Allaire logo are trademarks of Allaire
Corporation in the USA and other countries. All other products or name brands are
the trademarks of their respective holders.
ColdFusion Studio is a powerful and flexible tool for building, testing, and deploying
dynamic Web applications.
It is also an easy to use tool to create and edit Web content, with support for a variety
of scripting languages.
Contents
• Intended Audience...................................................................................................... x
• Introduction to the ColdFusion 4.5 Web Application Server................................... x
• Development Features in ColdFusion Studio 4.5 .................................................... xi
• About ColdFusion Documentation ......................................................................... xii
• Developer Resources................................................................................................ xiv
• Contacting Allaire...................................................................................................... xv
xIntended Audience
Intended Audience
The principal audience for this user guide is professional Web developers who have a
working knowledge of HTML and Web server environments. The focus is on
introducing you to Studio’s interface and development tools.
Introduction to the ColdFusion 4.5 Web Application Server
The ColdFusion 4.5 release focuses on fundamentals — the fundamentals of delivering
your e-business: faster development, better reliability, enhanced scalability, expanded
integration, and stronger security.
At the center of the ColdFusion 4.5 release is an application server platform that's been
highly optimized with new functionality and native support for UNIX. As a result, your
e-business systems will run better and do more. With this release we're launching a
new edition of ColdFusion Server for Linux so you can take advantage of the reliability
and performance of the hottest new Internet server operating system.
While optimizing the core server, we also enhanced fundamental features including
email integration, server-side FTP and HTTP, advanced security, scheduling, and
database connectivity — again giving you more reliability and new functionality.
The focus on fundamentals extends to new features. As part of a broad new
commitment to Java, ColdFusion 4.5 has a range of new Java integration options from
Java CFXs to Java Servlet support to Java object and EJB connectivity. In ColdFusion
Studio 4.5, we added new tools to make you more productive including a flexible new
project architecture that makes managing and deploying complex Web applications a
snap. On the server, we focused on reliability, performance and security with features
such as service-level fail-over, Cisco Local Director integration, and OS security
integration.
Whether you're revolutionizing your company's HR operations, building the next
generation of your firm's global intranet, or launching the next killer .COM company,
you'll find the speed, scalability, connectivity, and security you need in ColdFusion 4.5.
Welcome to ColdFusion Studioxi
Development Features in ColdFusion Studio 4.5
A wide range of features are available in ColdFusion 4.5 for application development
and for creating Web content.
Allaire FTP & RDS — Manage all your files from a single interface that integrates access
to the Windows file system, ColdFusion server via Remote Development Servers (RDS),
and FTP servers.
Advanced Project Management — Manage complex Web application development
projects using physical, virtual, and auto-inclusive folders, resource browsing, and
direct access to version source control applications.
Scriptable Project Deployment — Write in VBScript or JScript to script application
deployment, with granular control over file uploads, to multiple server configurations
with FTP or RDS.
Editing — Easy tag selection, customizable language color coding, collaspe code
blocks, edit code in the Tag Inspector property sheet interface, navigate code hierarchy
in Tag Tree.
Function Insight — Insert function syntax as you type.
Code validation — Configurable for multiple versions of HTML, CFML, SMIL, and
browser-specific tags.
Image Map Editor — Create image maps right in ColdFusion Studio with a new
easy-to-use visual tool.
TopStyle Lite CSS Editor — Create and edit standards-compliant cascading style sheets
to easily control the look and feel of your web applications.
Wireless Support — Build wireless Web applications quickly and easily with the
complete set of Wireless Markup Language (WML) and Handhelp Markup Language
(HDML) visual tools.
CodeSweeper — Enforce code formatting with customizable rules.
Browsers — Preview pages in multiple browsers, with automatic detection of installed
browsers.
Proofing and Testing tools — Maintain site content with search and replace, spell
checking, code validation, and link verification.
Code templates — Quickly insert common text blocks and expand abbreviations.
Snippets — Save code blocks and content for reuse.
Templates and Wizards — Quickly create basic pages, tables, frames, JavaScript and
DHTML elements, and synchronized RealAudio content.
Image preview — View Web images and their properties.
User macros — Automate tasks by scripting the Visual Tools Object Model (VTOM).
xiiAbout ColdFusion Documentation
About ColdFusion Documentation
ColdFusion documentation is designed to provide support for all components of the
ColdFusion development system. Both the print and online versions are organized to
allow you to quickly locate the information you need.
In addition to the book set, the documentation is provided in two other formats:
• HTML — Browser-based Help references.
• Adobe Acrobat (PDF) — Available from the root level on the product CD-ROM
and from the Developer area of Allaire’s Web site at http://www.allaire.com/
developer
Documentation updates
Late additions and corrections to ColdFusion printed documentation are listed in the
Documentation Updates page. To reach this page, open the Welcome to ColdFusion
page installed with ColdFusion, where you’ll find links to the update page as well as
links to other pages containing useful information about ColdFusion, Allaire support
options, and Allaire products and services.
For ColdFusion Studio users, you can access the Documentation Update page in the
Allaire Support folder in Help References.
.
ColdFusion manuals
The core ColdFusion documentation set consists of the following titles.
Administering ColdFusion Server
Includes instructions for installing ColdFusion Server. Describes configuration options
for maximizing performance, managing data sources, setting security levels, and a
range of development and site management tasks. If you are administering a
ColdFusion site, you’ll need this book to help plan and implement ColdFusion
security, load balancing, and for details about tuning the ColdFusion application
server.
Developing Web Applications with ColdFusion
Presents the fundamentals of ColdFusion application development and deployment.
Also includes detailed information about ColdFusion data sources, user interfaces,
and Web technologies.
CFML Language Reference
Provides the complete syntax, with example code, of all CFML tags and functions.
Welcome to ColdFusion Studioxiii
Using ColdFusion Studio
Documents everything you need to know about using ColdFusion Studio, including
features like projects, source control integration, as well as the Studio workspace and
interface.
Quick Reference to CFML
A valuable quick reference to CFML tags, functions, and variables.
ColdFusion Server online documentation
To view the HTML documentation, open the following URL: http://127.0.0.1/
cfdocs/dochome.htm
Note that because the Verity search libraries are not available on Linux for this release,
the online documentation search facility is not functional on Linux. If you try to open
the search page, a message box opens to explain why the facility is not available.
Acrobat versions of all ColdFusion documentation are available from the root level on
the product CD. If you don’t have a product CD, you can download ColdFusion
documentation from the Allaire web site by visiting
developer
and clicking the Documentation link.
.
http://www.allaire.com/
ColdFusion Studio online documentation
Click the Help resource tab in ColdFusion Studio to view online Help pages. The help
tree contains ColdFusion documentation and a number of additional developer
resources. Studio online documentation is searchable and individual pages can be
bookmarked.
As you code your work, you can use the online HTML Reference to check syntax and
usage. You can open it from the Help References or press place the cursor in an HTML
and press F1. F1 help is available for all the supported languages. Open the Tag
Chooser (Ctrl+E) to view the list.
To learn about creating and modifying editor dialogs for tags, see Customizing the
Development Environment.
Power users and application developers can take advantage of the Visual Tools Object
Model to automate tasks and to call HomeSite functionality from other programs.
xivDeveloper Resources
Developer Resources
This section is a brief listing of CFML resources.
Allaire ColdFusion Developer Center
The Developer Center at http://www.allaire.com/developer/referenceDesk/index.cfm
contains all the latest information on ColdFusion and offers tutorials, technical
articles, and links to other resources.
ColdFusion Web Resources
Following are just a few of many site dedicated to CFML development.
• CF Advisor Online at http://www.cfadvisor.com/api-shl/engine.cfm.
• Haznet’s Fallout shelter, a CF portal, at http://www.hudziak.com/haznet/
cfml.html.
• ColdFusion Developer’s Journal, online version of the popular print journal, at
http://www.sys-con.com/coldfusion/index2.cfm.
Making Web sites accessible to visually impaired visitors
The W3C Web Accessibility Initiative at http://www.w3.org/WAI/ provides a great deal
of practical information about designing applications and interfaces for the broadest
range of users. Allaire supports user accessibility in its product interfaces and is
striving to fully implement the WAI recommendations.
Simple steps, such as providing a text alternative for images, graphics, and animations,
and using clear descriptive text for page elements and navigation, can make a world of
difference to a visually impaired user’s experience of your site. Validation tools are
available on the site to check compliance with established standards.
Welcome to ColdFusion Studioxv
Contacting Allaire
Please contact Allaire for sales and support information.
Corporate headquarters
Allaire Corporation
275 Grove Street
Newton, MA 02446
Telephone: 617.219.2000
Fax: 617.219.2001
http://www.allaire.com
Customer Service
Contact Allaire customer service to inquire about product orders and to obtain
corporate and product information and an Allaire username and password.
Hours: 8:00 AM to 8:00 PM Eastern time.
Toll Free US & Canada: 888.939.2545
Local & International: 617.219.2100
Email: info@allaire.com
Sales
Toll Free: 888.939.2545
Telephone: 617.219.2100
Fax: 617.219.2101
Email: sales@allaire.com
http://www.allaire.com/store
Technical support
Allaire offers a range of telephone and Web-based support options. See the Allaire
Support folder in the online Help References or go to http://www.allaire.com/support/
for a complete description of technical support services.
xviContacting Allaire
C HAPTER 1
Exploring the Workspace
This chapter acquaints you with the main areas of the interface. It will also give you
some pointers on customizing the workspace to make all your development work as
productive as possible.
Contents
• The Workspace Areas................................................................................................ 18
• Working in the Resource Windows .......................................................................... 19
• Creating and Browsing Files in the Document Window........................................ 20
• Tracking Your Work in the Results Window ............................................................ 21
• Getting the Most from the Help System.................................................................. 21
18
The Workspace Areas
The term Workspace describes the user interface that you see when you first load the
program. The workspace has four principal areas:
• Command area— At the top of the workspace is the title bar, which displays
the file path of the current document. Below that is the menu bar, which
contains standard Windows commands plus development menus. Below the
menus are toolbars that provide one-click access to commands and application
tools. To the right is the QuickBar, a tabbed toolbar for inserting JSP, HTML, and
other language elements.
• Resources window— Tabs for file management, data sources, Projects, code
snippets, online Help, and the Tag Inspector.
• Document window— Tabs for writing and browsing pages.
• Results window— Tabs to track search and replace operations, code validation,
link verification, images, project deployment, and compilation. The Console
tab gives you built-in access to the command prompt.
The following illustration shows the main workspace areas.
Exploring the Workspace19
Setting workspace options
Selecting Options > Settings (F8) opens the control center for user preferences. By
navigating the feature tree in the left pane, you can view and change options for file
management, coding, and testing applications and Web content.
Working in the Resource Windows
The Resource window is a multipanel interface that lets you switch easily among
development resources as you build site content. Several of the panels contain their
own toolbars.
Resource tabs
Following is a summary of each of the Resource tabs:
• The Files tab lets you manage files on local and network drives and on remote
servers. The drop-down list at the top allows you to pick a drive or server, the
bottom two panes display directories and files for the selected drive or server.
• The Database tab is the access point for working with ColdFusion data sources.
• The Projects tab helps you manage site content by organizing pages and
supporting files. You have the option of adding projects to your version source
control system. The drop-down list at the top displays recent projects. The
bottom two panes display the folders and files for the selected project.
• The Site View tab gives you a visual rendering of the links in the current
document. Right-click in the pane to select a view type and display options.
Right-click on a link to expand the view.
• The Snippets tab gives you a convenient place to store code blocks and content
for reuse. Snippets can also be shared with other users.
• The Help tab contains product documentation and other online resources.
• The Tag Inspector tab lets you edit in an interactive property sheet interface.
The top pane is the Tag Tree, a customizable view of the document hierarchy.
The bottom pane is the Tag Inspector, where you can edit code without having
to work in the Document window directly.
20
Creating and Browsing Files in the Document Window
The Document window is where code and other content are entered and edited.
Edit tab
The Editor has many productivity features for creating and editing code, content, and
navigation structures. You can easily insert tags, generate code, and add content from
text files, Microsoft Office applications, or directly from the Web. You can easily create
templates to insert common content.
The Editor toolbar extends vertically to the left and below the Edit tab in the Document
window.
Browse tab
Click the Browse tab or press F12 to process the current document in the internal
browser.
The Browse toolbar displays at the top of the Document window when you select the
Browse tab. You can use it to browse open documents, refresh the display, and access
browser tools. The document URL displays based on the current server mapping. See
“Adding Server Mappings” on page 45 for details.
Press F11 to view the document in the external browser. See “Configuring External
Browsers” on page 38 for details.
Design tab
This mode allows WYSIWYG creation and editing of HTML page elements. You can set
display and CodeSweeper formatting options in the Options > Settings > Design pane.
Exploring the Workspace21
Tracking Your Work in the Results Window
The Results window presents the results of document operations in individual panels.
It opens automatically when you run Search, Code Validation, Link Verification, Image
Thumbnails, or Project Deployment. You can also open it from the View menu.
Right-click in any of the panels to open a context menu.
Getting the Most from the Help System
The online Help system encompasses a variety of features:
• Pop-up Help for basic tag syntax (F2)
• Comprehensive context-sensitive tag Help (F1)
• Embedded Help in dialog boxes and tag editors
• An extensive collection of searchable references in the Help tab
Opening dialog box Help
Help text in tag editors and in the Tag Chooser provides context-sensitive syntax and
usage information.
To view Help text in a tag editor or in Tag Chooser:
1. Click the Toggle Embedded Help button (Alt+H) to see Help text in a pane at the
bottom of the dialog box.
2. Click the Show help in separate window button (Alt+M) to view the Help text in a
floatable browser window.
Creating Help files for custom tag editors
Using the Allaire Visual Tools Markup Language (VTML), you can edit Help text in
dialog boxes or add your own. See Customizing the Development Environment for
details.
Accessing Help References
The Help system is an extensible resource for learning about product features,
technology extensions, and other development topics. The online Help References
contain the printed product documentation in HTML format and additional online
references.
Click the Help tab at the bottom of the Resources window to view the Help References
tree. The Help toolbar is located at the top of the Help References window.
22
Printing Help topics
If you are using Internet Explorer as the internal browser, you can print a Help topic by
right-clicking the document in Browse mode and selecting Print. The default internal
browser does not support printing.
Bookmarking Help topics
You can get quick access to Help documents by bookmarking them. Bookmarks can be
assigned to documents in the Help tree and to HTML documents in the file system or
on the Internet.
To bookmark a document in the Help Tree, right-click the document title and select the
Add bookmark command. If the Help document is open, it displays automatically in
the Bookmarks list. If the document is not open, you need to right-click again and
select the Refresh command.
To open a bookmarked Help document, click the down arrow next to the Bookmarks
icon on the Help tab toolbar and select from the list.
You can maintain bookmarks by selecting Organize Bookmarks from the Help
Bookmarks drop-down list.
To bookmark an external document:
1. Click the Bookmark button in the Help toolbar to open the Help Bookmarks dialog
box.
2. Click the Add button to open the Add Bookmark dialog box.
3. Enter a name for the bookmark.
4. Enter a URL or a filepath for an HTML document.
5. Click OK to add the bookmark to the Help Bookmarks list.
Searching Help References
You can do everything from a simple title search to advanced searches using complex
criteria.
To run a search:
1. Click the Search button on the Help toolbar to open the Search Help References
dialog box.
The first time you open the search dialog box, you will be prompted to index the
Help References. Allaire recommends doing this, as it greatly improves search
engine performance. After the initial indexing, it checks the Help References tree
for changes each time you open the Help panel and automatically indexes the
documents again if needed.
Exploring the Workspace23
2. Enter a word or phrase in the Enter the word(s) to find box.
For information on using search operators, click the Search Tips button.
3. To limit the references searched, select the Search only in selected references
option and select the check box next to one or more references.
4. Click the Search button.
The Help References pane shows the search results.
5. Double-click a document in the results list to open it.
The results list is saved until a new search is run, so you can return to the document list
by clicking the Search results button on the Help toolbar.
TipTo redo a recent search, click the down arrow next to the Enter the
word(s) to find box and select search keywords from the drop-down list.
Using advanced search operators
You can use a variety of advanced search operators to make your searching more
precise. For information on using advanced search operators, click the Search Tips
button in the Search Help References dialog box.
A printable copy of the Search Tips, titled search_tips.pdf, is installed in the Help/
Allaire Support folder of your installation directory. If you have Adobe Acrobat Reader
on your system, you can open this file by double-clicking it in Windows Explorer.
Extending the Help system
One of the Help system’s most useful features is its extensibility. You can add
documents to the Help system by dragging and dropping them into the Help folder,
either from the Files tab or Windows Explorer.
Help document files are generally in HTML, but you can include text files. The Help
browser will use the file name as the title. You can also create hyperlinks from within
an HTML file to files with txt, dtd, and pdf extensions if you use Internet Explorer as the
internal browser. Web graphics files (GIF, JPG, PNG) are viewable in Help files.
This extensibility gives you a number of opportunities:
• You can write and install your own custom Help files.
• You can download documents from the Web and add them to the Help system.
• You can edit existing Help topics.
• You can distribute Help files; this can be particularly helpful for team
development.
NoteDocuments do not display at the Help References root level, so you must
either place them in an existing folder or create a new folder.
24
To create a new folder in the Help tree:
1. Open the Files panel in the Resources window.
2. Navigate to the Help folder of your installation.
3. Right-click in the files pane and select the Create Folder menu item to open a new
folder box in the directory pane.
4. Type a folder name in the box and press Enter to save the new folder.
You might need to press F5 to refresh the Help display.
You have several options for adding documents to the Help system:
To add documents to the Help tree do one of the following:
• Write an HTML Help file and save it to a folder in the Help directory.
• Use standard Windows commands to paste a file into a Help folder.
• Select File > Open from the Web to open an HTML document, then save it to a
folder in the Help tree.
Exploring the Workspace25
Adding Help References to the booktree structure
If you add a folder to the Help directory, the folder appears at the bottom of the Help
References list. For most users, this is all you need.
If, however, you want to control the display order of the Help References, you can edit
the booktree.xml file in the Help root directory. The booktree structure uses a simple
tag set to configure the Help display on the book, chapter, and page level. A quick study
of the file will get you started.
The parser reads the booktree tags from top to bottom, so you can just insert folder
and file tags where you want the references to appear in the Help list. This applies to
rearranging existing Help content and to adding new files. Alternately, you can use the
path attribute in the book and chapter tags to specify the folder location.
To add a folder to the Help structure:
1. Copy the new folder into the Help root directory.
2. Open the Help directory from the Files tab.
3. Make a backup copy of the booktree.xml file.
4. Open the booktree.xml file in the Editor.
5. Enter a book tag for the new folder.
Example: <help_book path="folder name">Custom Help Files.
The new folder now appears in the order you set up, but the files in the folder will be
displayed in alphabetical order. If you want to control the display at the chapter and
page level, you can tag these entries in the booktree file.
Displaying text files in the Help structure
Text files can be added to the Help tree. The Help browser default file type is HTML, so
it looks for a
filename in the Help tree display. You can use the
add title text, if you wish.
TITLE tag in each file. If it doesn’t find one or the tag is empty, it uses the
<help_page title=""> attribute to
26
Adding media content
You have considerable flexibility in adding supporting files (such as graphics,
animations, video, and sound) to Help documents. One approach is to create a file
structure in the Help tree that conforms to the media file references in your
documents. Alternately, you can supply a URL or accessible file location for remote
files.
Be aware that if you are using the default internal browser or an older external browser,
proper playback of media files is limited.
C HAPTER 2
Managing Files
This chapter shows you how to work with folders and files.
Contents
• About the Files Tab.................................................................................................... 28
• Working with Files..................................................................................................... 29
• Changing the File List Display.................................................................................. 31
• Dragging Files from Windows Explorer................................................................... 31
• Building a Favorite Folders List................................................................................ 32
• Working with Files on Remote Servers....................................................................33
• Downloading Web Pages ..........................................................................................34
28
About the Files Tab
Creating a project is the best way to organize files when developing a Web site or Web
applications (see “Using Projects for Site Management” on page 91), but for general file
management chores, you work in the Files tab on the Resources window. The Files tab
gives you access to servers, drives, directories, and files without having to go to
Windows Explorer.
Managing Files29
Working with Files
You can use the following procedures to work with files, regardless of their location
(local drive, network drive, or remote server).
Setting startup options
Open Options > Settings > Startup to select which files and folders open when load the
program.
Setting the startup file option
You can select one of the these options:
• Open all the documents that were open when you closed the program.
• Open the project that was open.
• Open a blank document.
Setting the startup folder option
• Open the folder that was active in the Files tab.
• Open the folder that was last selected in the File > Open dialog box.
• Select a default folder to open.
Opening files
Use the procedures below to open a file in the file list.
To open a file:
1. On the Files tab, use the Drive List and the Directory List to navigate to the
directory that contains the file you want to open.
2. Double-click the file in the file list or right-click the file and choose Edit from the
menu.
Note Read-only files are marked with a red dot in the file list. You can right-click a file
and choose Properties from the menu to set read and write access. This is not
recommended, however, if you are using a source control application to
manage read and write privileges.
Opening recently used files
You can re-open any of the last 10 closed files from the File > Recent Files list. If you use
this feature regularly, you can maintain the list by clearing it or removing obsolete files
when needed.
30
Adding a link to an open file
To create a link to a file:
1. Open the page you want to place the link in the Editor window.
2. Drag the file you want to create a link to from the file list to the page in the Editor
window. Release the mouse button when the cursor is in the location where you
want the link to be added.
NoteAlternatively, you can right-click a file and choose Insert As Link
from the shortcut menu. The link is inserted in the current page at
the cursor location.
You can also right-click a file in the file list and use the File options in the shortcut
menu to delete, move, copy, or rename the file.
Saving files
Unsaved changes in a document are indicated by an "X" next to the file name in the
Document tab at the bottom of the Editor window.
Use the Save commands from the File menu or the Standard toolbar icons to save and
close files. Open the Settings dialog box (F8) and use the File Settings pane to specify a
format for saved files. The default is PC, but UNIX and Macintosh formats are
available. You can set a default file extension on this tab, as well.
When you add links or images to a new file, you are prompted to save the file. This
ensures that relative paths to these page elements are resolved correctly.
Loading...
+ 206 hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.