Document Outline

• Contents
• Chapter 1: Introduction
  • About extensions
  • Install an extension
  • Creating an extension
  • Additional resources for extension writers
  • New features in Dreamweaver CS4
  • Conventions used in this guide
• Chapter 2: Customizing Dreamweaver
  • Ways to customize Dreamweaver
    • Customizing default documents
    • Customizing page designs
    • Customizing the appearance of dialog boxes
    • Changing the default file type
    • Customizing the interpretation of third-party tags
      • <tagspec>
      • How custom tags appear in the Design view
      • Avoiding third-party tag overwrites
  • Customizing Dreamweaver in a multiuser environment
    • Deleting configuration files in a multiuser environment
      • The mm_deleted_files.xml tag syntax
      • <deleteditems>
      • <item>
    • Reinstalling and uninstalling Dreamweaver in a multiuser environment
  • Changing FTP mappings
  • Extensible document types in Dreamweaver
    • Document type definition files
      • Structure of document type definition files
    • Defining dynamic templates
    • Adding and modifying document extensions and file types
    • Providing localized strings
    • Rules for document type definition files
    • Opening a document in Dreamweaver
    • Customizing workspace layouts
      • <panelset>
      • <application>
      • <document>
      • <panelframe>
      • <panelcontainer>
      • <panel>
    • Customizing the Coding toolbar
  • Changing keyboard shortcut mappings
    • The keyboard layout mapping XML files
• Chapter 3: Customizing Code view
  • About code hints
    • The CodeHints.xml file
    • JavaScript code hinting
    • Crosstag attributes code hinting
      • Spry attribute grouping format
    • Code hints tags
      • <codehints>
      • <menugroup>
      • <description>
      • <menu>
      • <menuitem>
      • <function>
      • <method>
      • <parammenu>
      • <parammenuitem>
      • <optionparammenu>
      • <optionparammenuitem>
      • <property>
      • <event>
  • About code coloring
    • Code coloring files
      • <scheme>
      • <blockEnd>
      • <blockStart>
      • <brackets>
      • <charStart>
      • <charEnd>
      • <charEsc>
      • <commentStart>
      • <commentEnd>
      • <cssImport/>
      • <cssMedia/>
      • <cssProperty/>
      • <cssSelector/>
      • <cssValue/>
      • <defaultAttribute>
      • <defaultTag>
      • <defaultText/>
      • <endOfLineComment>
      • <entity/>
      • <functionKeyword>
      • <idChar1>
      • <idCharRest>
      • <ignoreCase>
      • <ignoreMMTParams>
      • <ignoreTags>
      • <isLocked>
      • <keyword>
      • <keywords>
      • <numbers/>
      • <operators>
      • <regexp>
      • <sampleText>
      • <searchPattern>
      • <stringStart>
      • <stringEnd>
      • <stringEsc>
      • <tagGroup>
    • Scheme block delimiter coloring
      • innerText
      • customText
      • outerTag
      • innerTag
      • nameTag
      • nameTagScript
    • Scheme processing
      • Wildcard characters
      • Escape characters
      • Maximum string length
      • Scheme precedence
    • Editing schemes
    • Code coloring examples
  • About Code validation
    • <css-support>
    • <property>
    • <value>
  • Changing default HTML formatting
  • About Vertical Split view
  • About related files
    • How related files work
    • Related files terminology
  • About Live view
    • A simple Live view example
• Chapter 4: Extending Dreamweaver
  • Types of Dreamweaver extensions
    • Other ways to extend Dreamweaver
  • Configuration folders and extensions
    • Multiuser Configuration folders
    • Running scripts at startup or shutdown
    • Reloading extensions
  • Extension APIs
    • How Dreamweaver processes JavaScript in extensions
    • Displaying Help
  • Localizing an extension
    • XML string files
    • Localizable strings with embedded values
  • Working with the Extension Manager
• Chapter 5: User interfaces for extensions
  • Extension user interface designing guidelines
  • Dreamweaver HTML rendering control
  • Custom UI controls in extensions
    • Editable select lists
    • Database controls
    • Adding a database tree control
    • Adding a variable grid control
    • Tree controls
    • Creating a tree control
    • Manipulating content within a tree control
    • Adding a color button control
  • Adding Flash content to Dreamweaver
    • A simple Flash dialog box example
  • Photoshop integration and Smart Objects
    • A Smart Object example
• Chapter 6: The Dreamweaver Document Object Model
  • About Dreamweaver DOM
  • Distinguishing between the user document and extension DOMs
  • The Dreamweaver DOM
    • Objects, properties, and methods of the Dreamweaver DOM
    • Properties and methods of the document object
    • Properties and methods of HTML
    • Properties and methods of text objects
    • Properties and methods of comment objects
    • The dreamweaver and site objects
      • Properties of the dreamweaver object
      • The site object
• Chapter 7: Insert bar objects
  • How object files work
  • The Insert bar definition file
    • The Insertbar.xml tag hierarchy
    • Insert bar definition tags
      • <insertbar>
      • <category>
      • <menubutton>
      • <button />
      • <checkbutton />
      • <separator />
    • Insert bar definition tag attributes
      • id="unique id"
      • image="image_path”
      • canDrag="Boolean”
      • showIf="enabler"
      • enabled="enabler"
      • checked="enabler"
      • command="API_function"
      • file="file_path"
      • tag="editor"
      • name="tooltip_text"
  • Modifying the Insert bar
    • Add a new object to the Insert bar
    • Adding objects to the Insert menu
  • A simple insert object example
    • Create the HTML file
    • Adding the JavaScript functions
    • Create the image for the Insert bar
    • Editing the insertbar.xml file
    • Adding a dialog box
    • Building an Insert bar pop-up menu
  • The objects API functions
    • canInsertObject()
    • displayHelp()
    • isDOMRequired()
    • insertObject()
    • objectTag()
    • windowDimensions()
• Chapter 8: Browser compatibility check issues API
  • How detection works
  • An Issues example
  • The issues API functions
    • findIssue()
    • getAffectedBrowserProfiles()
    • getAffectedBrowserDisplayNames()
    • getIssueID()
    • getIssueName()
    • getIssueDescription()
• Chapter 9: Commands
  • How commands work
  • Adding commands to the Commands menu
  • A simple command example
    • Create the user interface
    • Writing the JavaScript code
    • Test the extension
  • The commands API functions
    • canAcceptCommand()
    • commandButtons()
    • isDOMRequired()
    • receiveArguments()
    • windowDimensions()
• Chapter 10: Menus and menu commands
  • The menus.xml file
    • <menubar>
    • <menu>
    • <menuitem>
    • <separator>
    • <shortcutlist>
    • <shortcut>
    • <tool>
    • <action>
    • <activate>
    • <override>
  • Changing menus and menu commands
    • Change the name of a menu command or menu
    • Change keyboard shortcuts
    • Pop-up menus and context menus
  • Menu commands
    • Modifying the Commands menu
    • How menu commands work
  • A simple menu command example
    • Create a menu command
    • JavaScript code for the menu
    • Placing the command file in the Menu folder
  • A dynamic menu example
    • Create dynamic menu items
    • JavaScript code for the dynamic menu item
  • The menu commands API functions
    • canAcceptCommand()
    • commandButtons()
    • getDynamicContent()
    • isCommandChecked()
    • receiveArguments()
    • setMenuText()
    • windowDimensions()
• Chapter 11: Toolbars
  • How toolbars work
    • How toolbars behave
    • How toolbar commands work
  • A simple toolbar command file
    • Create the text box
    • JavaScript code for the text box
      • canAcceptCommand(): enable the toolbar item
      • receiveArguments(): set the title
      • getCurrentValue(): get the title
  • The toolbar definition file
    • <toolbar>
    • <include/>
    • <itemtype/>
    • <itemref/>
    • <separator/>
  • Toolbar item tags
    • <button>
    • <checkbutton>
    • <radiobutton>
    • <menubutton>
    • <dropdown>
    • <combobox>
    • <editcontrol>
    • <colorpicker>
  • Item tag attributes
    • id="unique_id"
    • showIf="script"
    • image="image_path"
    • disabledImage="image_path"
    • overImage="image_path"
    • tooltip="tooltip string"
    • label="label string"
    • width="number"
    • menuID="menu_id"
    • colorRect="left top right bottom"
    • file="command_file_path"
    • domRequired="true" or "false"
    • enabled="script"
    • checked="script"
    • value="script"
    • update="update_frequency_list"
    • command="script"
    • arguments="argument_list"
  • The toolbar command API functions
    • canAcceptCommand()
    • getCurrentValue()
    • getDynamicContent()
    • getMenuID()
    • getUpdateFrequency()
    • isCommandChecked()
    • isDOMRequired()
    • receiveArguments()
    • showIf()
• Chapter 12: Reports
  • Site reports
    • How site reports work
    • A simple site report example
      • Create the report definition
      • Write the JavaScript code
  • Stand-alone reports
    • How stand-alone reports work
    • A simple stand-alone report example
      • Create the dialog box UI
      • Write the JavaScript code
  • The reports API functions
    • processFile()
    • beginReporting()
    • endReporting()
    • commandButtons()
    • configureSettings()
    • windowDimensions()
• Chapter 13: Tag libraries and editors
  • Tag library file format
  • The Tag Chooser
    • TagChooser.xml files
  • A simple example of creating a new tag editor
    • Registering the tag in the tag library
    • Create a tag definition (VTML) file
    • Create a tag editor UI
    • Add a tag to Tag Chooser
  • The tag editor API functions
    • inspectTag()
    • validateTag()
    • applyTag()
• Chapter 14: Property inspectors
  • Property inspector files
  • How Property inspector files work
  • A simple Property inspector example
    • Create the user interface
    • Write the JavaScript code
    • Create the image
    • Test the Property inspector
  • The Property inspector API functions
    • canInspectSelection()
    • displayHelp()
    • inspectSelection()
• Chapter 15: Floating panels
  • How floating panel files work
  • A simple floating panel example
    • Creating the floating panels
    • Writing the JavaScript code
    • Creating a menu item
  • The floating panel API functions
    • displayHelp()
    • documentEdited()
    • getDockingSide()
    • initialPosition()
    • initialTabs()
    • isATarget()
    • isAvailableInCodeView()
    • isResizable()
    • selectionChanged()
    • About performance
• Chapter 16: Behaviors
  • How Behaviors work
    • Inserting multiple functions in the user’s file
    • Handling actions that require return value
  • A simple behavior example
    • Create the behavior extension
    • Create the HTML files to browse (deprecated)
    • Test the behavior
  • The behaviors API functions
    • applyBehavior()
    • behaviorFunction()
    • canAcceptBehavior()
    • displayHelp()
    • deleteBehavior()
    • identifyBehaviorArguments()
    • inspectBehavior()
    • windowDimensions()
• Chapter 17: Server behaviors
  • Server behavior terminology
  • Dreamweaver architecture
    • Server behavior folders and files
    • Extension Data Markup Language
      • Group files
      • Participant files
      • The script file
  • A simple server behavior example
    • Creating the dynamic page document
    • Defining the new server behavior
    • Defining the code to insert
  • Scenarios in which the server behavior API functions are called
  • The server behavior API
    • analyzeServerBehavior()
    • applyServerBehavior()
    • canApplyServerBehavior()
    • copyServerBehavior()
    • deleteServerBehavior()
    • displayHelp()
    • findServerBehaviors()
    • inspectServerBehavior()
    • pasteServerBehavior()
  • Server behavior implementation functions
    • dwscripts.findSBs()
    • dwscripts.applySB()
    • dwscripts.deleteSB()
  • EDML files
    • Regular expressions
    • EDML structure
  • Group EDML file tags
    • <group>
    • <group> attributes
      • version
      • serverBehavior
      • dataSource
      • subType
    • <title>
    • <groupParticipants>
    • <groupParticipants> attributes
      • selectParticipant
    • <groupParticipant>
    • <groupParticipant> attributes
      • name
      • partType
  • Participant EDML files
    • <participant>
    • <participant> attributes
      • version
    • <quickSearch>
    • <insertText>
    • <insertText> attributes
      • location
      • nodeParamName
    • <searchPatterns>
    • <searchPatterns> attributes
      • whereToSearch
    • <searchPattern>
    • <searchPattern> attributes
      • paramNames
      • limitSearch
      • isOptional
    • <updatePatterns>
    • <updatePattern>
    • <updatePattern> attributes
      • paramName
    • <delete>
    • <delete> attributes
      • deleteType
    • <translator>
    • <searchPatterns>
    • <translations>
    • <translation>
    • <translation> attributes
      • whereToSearch
      • limitSearch
      • translationType
    • <openTag>
    • <attributes>
    • <attribute>
    • <display>
    • <closeTag>
  • Server behavior techniques
    • Finding server behaviors
    • Search pattern resolution
    • Updating server behaviors
    • Deleting server behaviors
    • Share-in-memory JavaScript files
• Chapter 18: Data sources
  • How data sources work
  • A simple data source example
    • Creating the data source definition file
    • Creating the EDML file
    • Creating the JavaScript file that implements the data sources API functions
    • Creating the supporting command files for user input
    • Test the new data source
  • The data sources API functions
    • addDynamicSource()
    • deleteDynamicSource()
    • displayHelp()
    • editDynamicSource()
    • findDynamicSources()
    • generateDynamicDataRef()
    • generateDynamicSourceBindings()
    • inspectDynamicDataRef()
• Chapter 19: Server formats
  • How data formatting works
    • The Formats.xml file
    • The Edit Format List Plus (+) menu
  • Scenarios in which the data formatting functions are called
  • The server formats API functions
    • applyFormat()
    • applyFormatDefinition()
    • deleteFormat()
    • formatDynamicDataRef()
    • inspectFormatDefinition()
• Chapter 20: Components
  • About component basics
  • Extending the Components panel
  • Customizing the Components panel
  • Customizing Components panel files
    • Add a new lightweight directory access protocol (LDAP) service component
    • Properties of tree control
  • Components panel API functions
    • getComponentChildren()
    • getContextMenuId()
    • getCodeViewDropCode()
    • getSetupSteps()
    • setupStepsCompleted()
    • handleDesignViewDrop()
    • handleDoubleClick()
    • toolbarControls()
• Chapter 21: Server models
  • Customizing server models
  • The server model API functions
    • canRecognizeDocument()
    • getFileExtensions()
    • getLanguageSignatures()
    • getServerExtension()
    • getServerInfo()
    • getServerLanguages()
    • getServerModelExtDataNameUD4()
    • getServerModelDelimiters()
    • getServerModelDisplayName()
    • getServerModelFolderName()
    • getServerSupportsCharset()
    • getVersionArray()
• Chapter 22: Data translators
  • How data translators work
  • Determining what kind of translator to use
  • Adding a translated attribute to a tag
  • Inspecting translated attributes
  • Locking translated tags or blocks of code
  • Creating Property inspectors for locked content
  • Finding bugs in your translator
  • A simple attribute translator example
    • Create the tagspec tag
    • Create the icon
    • Create the attribute translator
  • A simple block/tag translator example
  • The data translator API functions
    • getTranslatorInfo()
    • translateDOM()
    • translateMarkup()
    • liveDataTranslateMarkup()
• Chapter 23: C-level extensibility
  • How integrating C functions works
  • C-level extensibility and the JavaScript interpreter
  • Data types
  • The C-level API
    • typedef JSBool (*JSNative)(JSContext *cx, JSObject *obj, unsigned int argc, jsval *argv, jsval *rval)
    • JSBool JS_DefineFunction()
    • char *JS_ValueToString()
    • JSBool JS_ValueToInteger()
    • JSBool JS_ValueToDouble()
    • JSBool JS_ValueToBoolean()
    • JSBool JS_ValueToObject()
    • JS_ValueToUCString()
    • JSBool JS_StringToValue()
    • JSBool JS_UCStringToValue()
    • JSBool JS_DoubleToValue()
    • JSVal JS_BooleanToValue()
    • JSVal JS_IntegerToValue()
    • JSVal JS_ObjectToValue()
    • char *JS_ObjectType()
    • JSObject *JS_NewArrayObject()
    • long JS_GetArrayLength()
    • JSBool JS_GetElement()
    • JSBool JS_SetElement()
    • JSBool JS_ExecuteScript()
    • JSBool JS_ReportError()
  • File access and multiuser configuration API
    • JS_Object MM_GetConfigFolderList()
    • JSBool MM_ConfigFileExists()
    • int MM_OpenConfigFile()
    • JSBool MM_GetConfigFileAttributes()
    • JSBool MM_SetConfigFileAttributes()
    • JSBool MM_CreateConfigFolder()
    • JSBool MM_RemoveConfigFolder()
    • JSBool MM_DeleteConfigFile()
  • Calling a C function from JavaScript
• Chapter 24: The Shared folder
  • The Shared folder contents
    • The Common folder
    • The MM folder
      • The Scripts subfolder
      • The Class folder
      • The CMN folder
    • Other folders
  • Using the Shared folder
• Index
  • A
  • B
  • C
  • D
  • E
  • F
  • G
  • H
  • I
  • J
  • K
  • L
  • M
  • N
  • O
  • P
  • Q
  • R
  • S
  • T
  • U
  • V
  • W
  • X