beautypg.com

Dreamweaver.openhelpurl() – Adobe Dreamweaver API Reference CS5 User Manual

Page 115

background image

110

DREAMWEAVER API REFERENCE

Application

Last updated 8/27/2013

Returns
A string that contains the path on the computer of the user to the secondary browser, which is expressed as a file://
URL. If no secondary browser is defined, it returns nothing.

dreamweaver.openHelpURL()

Availability
Dreamweaver MX.

Description
Opens the specified Help file in the operating system Help viewer.

Dreamweaver displays help content in the standard operating system help viewer instead of a browser. Help content
is in HTML, but it is packaged for Windows HTML Helpor Help Viewer for Mac OS X.

The following four types of files comprise the full help content. For more information on Help files, see your operating
system documentation.

Help book

The Help book consists of the HTML Help files, images, and indexes. In Windows, the Help book is a file that has
a name with a .chm extension. On the Macintosh, the Help book is a folder.

The Help book files reside in the Dreamweaver Help folder.

The help.xml file

The help.xml file maps book IDs to help book names. For example, the following XML code maps the book ID for
Dreamweaver Help to the filenames that contains help on both the Windows and Macintosh operating systems:

"

1.0

"

?>

"

DW_Using

"

win-

mapping=

"

UsingDreamweaver.chm

"

mac-mapping=

"

Dreamweaver Help

"

/>

Each

book-id

entry has the following attributes:

The

id

attribute is the book ID that is used in the help.map and HelpDoc.js files.

The

win-mapping

attribute is the Windows book name, which is

"UsingDreamweaver.chm"

in this example.

The

mac-mapping

attribute is the Macintosh book name, which is

"Dreamweaver Help"

in this example.

The help.map file

The help.map file maps a help content ID to a specific help book. Dreamweaver uses the help.map file to locate
specific help content when it calls help internally.

The helpDoc.js file

The helpDoc.js file lets you map variable names that you can use in place of the actual book ID and page string. The
helpDoc.js file maps a help content ID to an HTML page in a specific help book. Dreamweaver uses the helpDoc.js
file when it calls help from JavaScript.