Displaying Help

The displayHelp() function, which is part of several extension APIs, causes Adobe Dreamweaver to do the following two things when you include it in your extension:

• Add a Help button to the interface.
• Call displayHelp() when the user clicks the Help button.

You must write the body of the displayHelp() function to display Help. How you code the displayHelp() function determines how your extension displays Help. You can call the dreamweaver.browseDocument() function to open a file in a browser or devise a custom way to display Help such as displaying messages in another layer in alert boxes.

The following example uses the displayHelp() function to display Help by calling dreamweaver.browseDocument():

// The following instance of displayHelp() opens a browser to display a file// that explains how to use the extension.function displayHelp() { var myHelpFile = dw.getConfigurationPath() + "ExtensionsHelp/myExtHelp.htm"; dw.browseDocument(myHelpFile);}