Macromedia dreamweaver 8-extending dreamweaver User Manuals

Table of Contents

• Contents

  3
  • Introduction

    9
    • Background

      9
    • Installing an extension

      10
    • Creating an extension

      10
    • Additional resources for extension writers

      11
    • What’s new in Dreamweaver

      11
      • Documentation changes

        12
      • Macromedia Press

        12
      • Deprecated functions

        12
      • Errata

        13
    • Conventions used in this guide

      13
• Customizing Dreamweaver

  15
  • Customizing Dreamweaver

    17
    • Ways to customize Dreamweaver

      17
      • Customizing default documents

        18
      • Customizing page designs

        18
      • Customizing the appearance of dialog boxes

        19
      • Changing the default file type

        20
      • Customizing the interpretation of third-party tags

        21
        • <tagspec>

          22
        • How custom tags appear in the Design view

          25
        • Avoiding rewriting third-party tags

          26
    • Customizing Dreamweaver in a multiuser environment

      27
      • Deleting configuration files in a multiuser environment

        28
        • About mm_deleted_files.xml tag syntax

          29
        • <deleteditems>

          29
        • <item>

          29
      • Reinstalling and uninstalling Dreamweaver in a multiuser environment

        30
    • Working with browser profiles

      30
      • About browser-profile formatting

        30
      • Creating and editing a browser profile

        32
    • Changing FTP mappings

      34
    • Extensible document types in Dreamweaver

      35
      • Document type definition file

        35
        • Structure of document type definition files

          37
      • Dynamic templates

        41
      • Document extensions and file types

        43
      • Localized strings

        44
      • Rules for document type definition files

        45
      • Opening a document in Dreamweaver

        46
      • Customizing workspace layouts

        46
        • <panelset>

          47
        • <application>

          47
        • <document>

          48
        • <panelframe>

          48
        • <panelcontainer>

          49
        • <panel>

          50
      • Customizing the Code view toolbar

        52
  • Customizing Code View

    55
    • Code hints

      55
      • The CodeHints.xml file

        56
      • Code Hints tags

        57
        • <codehints>

          57
        • <menugroup>

          58
        • <description>

          58
        • <menu>

          59
        • <menuitem>

          60
        • <function>

          61
    • Code coloring

      63
      • Code coloring files

        63
        • <scheme>

          65
        • <blockEnd>

          66
        • <blockStart>

          66
        • <brackets>

          67
        • <charStart>

          68
        • <charEnd>

          68
        • <charEsc>

          68
        • <commentStart>

          68
        • <commentEnd>

          69
        • <cssImport/>

          69
        • <cssMedia/>

          69
        • <cssProperty/>

          70
        • <cssSelector/>

          70
        • <cssValue/>

          71
        • <defaultAttribute>

          71
        • <defaultTag>

          71
        • <defaultText/>

          72
        • <endOfLineComment>

          72
        • <entity/>

          72
        • <functionKeyword>

          73
        • <idChar1>

          73
        • <idCharRest>

          74
        • <ignoreCase>

          74
        • <ignoreMMTParams>

          74
        • <ignoreTags>

          75
        • <isLocked>

          75
        • <keyword>

          75
        • <keywords>

          76
        • <numbers/>

          76
        • <operators>

          76
        • <regexp>

          77
        • <sampleText>

          77
        • <searchPattern>

          78
        • <stringStart>

          78
        • <stringEnd>

          79
        • <stringEsc>

          79
        • <tagGroup>

          80
      • Scheme block delimiter coloring

        80
        • innerText

          80
        • customText

          81
        • outerTag

          81
        • innerTag

          82
        • nameTag

          82
        • nameTagScript

          82
      • Scheme processing

        83
        • Wildcard characters

          84
        • Escape characters

          85
        • Maximum string length

          85
        • Scheme precedence

          86
      • Editing schemes

        87
      • Code coloring examples

        89
    • Code validation

      92
      • <css-support>

        92
      • <property>

        93
      • <value>

        94
    • Changing default HTML formatting

      95
• Overview of Extending Dreamweaver

  97
  • Extending Dreamweaver

    99
    • Types of Dreamweaver extensions

      100
      • Other ways to extend Dreamweaver

        101
    • Configuration folders and extensions

      102
      • Multiuser Configuration folders

        104
      • Running scripts at startup or shutdown

        104
      • Reloading extensions

        104
    • Extension APIs

      105
      • How Dreamweaver processes JavaScript in extensions

        106
      • Displaying Help

        107
    • Localizing an extension

      107
      • XML String files

        108
      • Localizable Strings with Embedded Values

        109
    • Working with the Extension Manager

      109
  • User Interfaces for Extensions

    111
    • Designing an extension user interface

      111
    • Dreamweaver HTML rendering control

      112
    • Using custom UI controls in extensions

      113
      • Editable select lists

        114
      • Database controls

        116
        • Adding a database tree control

          117
      • Adding a variable grid control

        118
      • Adding tree controls

        120
      • Creating a tree control

        120
      • Manipulating content within a tree control

        122
      • A color button control for extensions

        123
    • Adding Flash content to Dreamweaver

      124
      • A simple Flash dialog box example

        124
  • The Dreamweaver Document Object Model

    127
    • Which document DOM?

      128
    • The Dreamweaver DOM

      128
      • Objects, properties, and methods of the Dreamweaver DOM

        129
      • Properties and methods of the document object

        131
      • Properties and methods of HTML tag objects

        132
      • Properties and methods of text objects

        134
      • Properties and methods of comment objects

        135
      • The dreamweaver and site objects

        135
        • Properties of the dreamweaver object

          135
        • The site object

          136
• Extension APIs

  137
  • Insert Bar Objects

    139
    • How object files work

      140
    • The Insert bar definition file

      141
      • Insertbar.xml tag hierarchy

        141
      • Insert bar definition tags

        142
        • <insertbar>

          142
        • <category>

          142
        • <menubutton>

          143
        • <button />

          143
        • <checkbutton />

          144
        • <separator />

          144
      • Insert bar definition tag attributes

        144
        • id="unique id"

          144
        • image="image_path”

          145
        • canDrag="Boolean”

          145
        • showIf="enabler"

          145
        • enabled="enabler"

          146
        • checked="enabler"

          146
        • command="API_function"

          146
        • file="file_path"

          147
        • tag="editor"

          147
        • name="tooltip_text"

          147
    • Modifying the Insert bar

      148
      • Adding objects to the Insert bar

        149
      • Adding objects to the Insert menu

        150
    • A simple insert object example

      150
      • Creating the HTML file

        151
      • Adding the JavaScript functions

        151
      • Creating the image

        153
      • Editing the insertbar.xml file

        153
      • Adding a dialog box

        154
      • Building an Insert bar pop-up menu

        157
    • The Objects API

      161
      • canInsertObject()

        161
      • displayHelp()

        161
      • isDomRequired()

        162
      • insertObject()

        162
      • objectTag()

        164
      • windowDimensions()

        165
  • Commands

    167
    • How commands work

      167
    • Adding commands to the Commands menu

      168
    • A simple command example

      168
      • Creating the UI

        169
      • Writing the JavaScript code

        170
        • Determining whether the command should be enabled or dimmed

          170
        • Linking functions to the OK and Cancel buttons

          173
        • Letting the user specify uppercase or lowercase

          173
      • Testing the extension

        176
    • The Commands API

      176
      • canAcceptCommand()

        176
      • commandButtons()

        177
      • isDomRequired()

        178
      • receiveArguments()

        178
      • windowDimensions()

        178
  • Menus and Menu Commands

    181
    • About the menus.xml file

      182
      • <menubar>

        182
      • <menu>

        183
      • <menuitem>

        184
      • <separator>

        186
      • <shortcutlist>

        187
      • <shortcut>

        188
      • <tool>

        189
      • <action>

        189
      • <activate>

        190
      • <override>

        190
    • Changing menus and menu commands

      191
      • Changing the name of a menu command or menu

        192
      • Changing keyboard shortcuts

        192
    • Menu commands

      194
      • Modifying the Commands menu

        195
      • How menu commands work

        196
    • A simple menu command example

      197
      • Creating the menu commands

        198
      • Writing the JavaScript code

        198
        • canAcceptCommand()

          198
        • receiveArguments()

          199
        • setMenuText()

          200
      • Placing the command file in the Menu folder

        201
    • A dynamic menu example

      201
      • Creating the dynamic menu items

        202
      • Writing the JavaScript code

        202
        • canAcceptCommand()

          203
        • havePreviewTarget()

          204
        • receiveArguments()

          206
    • The Menu Commands API

      209
      • canAcceptCommand()

        209
      • commandButtons()

        209
      • getDynamicContent()

        210
      • isCommandChecked()

        211
      • receiveArguments()

        212
      • setMenuText()

        212
      • windowDimensions()

        213
  • Toolbars

    215
    • How toolbars work

      215
      • How toolbars behave

        216
      • How toolbar commands work

        217
    • A simple toolbar command file

      218
      • Creating the text box

        218
      • Writing the JavaScript code

        218
        • canAcceptCommand(): enable the toolbar item

          219
        • receiveArguments(): set the title

          219
        • getCurrentValue(): get the title

          219
    • The toolbar definition file

      220
      • <toolbar>

        221
      • <include/>

        223
      • <itemtype/>

        224
      • <itemref/>

        224
      • <separator/>

        225
    • Toolbar item tags

      226
      • <button>

        226
      • <checkbutton>

        227
      • <radiobutton>

        227
      • <menubutton>

        228
      • <dropdown>

        229
      • <combobox>

        230
      • <editcontrol>

        230
      • <colorpicker>

        231
    • Item tag attributes

      232
      • id="unique_id"

        232
      • showIf="script"

        232
      • image="image_path"

        232
      • disabledImage="image_path"

        233
      • overImage="image_path"

        233
      • tooltip="tooltip string"

        233
      • label="label string"

        234
      • width="number"

        234
      • menuID="menu_id"

        234
      • colorRect="left top right bottom"

        234
      • file="command_file_path"

        235
      • domRequired="true" or "false"

        235
      • enabled="script"

        235
      • checked="script"

        235
      • value="script"

        236
      • update="update_frequency_list"

        236
      • command="script"

        237
      • arguments="argument_list"

        238
    • The toolbar command API

      238
      • canAcceptCommand()

        239
      • getCurrentValue()

        240
      • getDynamicContent()

        240
      • getMenuID()

        242
      • getUpdateFrequency()

        243
      • isCommandChecked()

        243
      • isDOMRequired()

        245
      • receiveArguments()

        245
      • showIf()

        246
  • Reports

    249
    • Site reports

      249
      • How site reports work

        250
      • A simple site report example

        250
        • Creating the report definition

          251
        • Writing the JavaScript code

          252
    • Stand-alone reports

      253
      • How stand-alone reports work

        253
      • A simple stand-alone report example

        254
        • Creating the dialog box UI

          254
        • Writing the JavaScript code

          255
    • The Reports API

      256
      • processFile()

        256
      • beginReporting()

        256
      • endReporting()

        257
      • commandButtons()

        257
      • configureSettings()

        258
      • windowDimensions()

        258
  • Tag Libraries and Editors

    261
    • Tag library file format

      262
    • The Tag Chooser

      268
      • TagChooser.xml files

        268
    • A simple example of creating a new tag editor

      270
      • Registering the tag in the tag library

        271
      • Creating a tag definition (VTML) file

        272
      • Creating a tag editor UI

        272
      • Adding a tag to Tag Chooser

        274
    • Tag editor APIs

      275
      • inspectTag()

        275
      • validateTag()

        276
      • applyTag()

        276
  • Property Inspectors

    279
    • Property inspector files

      279
    • How Property inspector files work

      281
    • A simple Property inspector example

      282
      • Creating the user interface

        282
      • Writing the JavaScript code

        283
      • Creating the image

        285
      • Testing the Property inspector

        285
    • The Property inspector API

      285
      • canInspectSelection()

        285
      • displayHelp()

        286
      • inspectSelection()

        287
  • Floating Panels

    289
    • How floating panel files work

      290
    • A simple floating panel example

      291
      • Creating the floating panels

        291
      • Writing the JavaScript code

        293
        • selectionChanged(): is a script marker selected?

          293
        • updateScript(): write back changes

          296
      • Creating a menu item

        296
    • The Floating panel API

      297
      • displayHelp()

        297
      • documentEdited()

        298
      • getDockingSide()

        299
      • initialPosition()

        299
      • initialTabs()

        300
      • isATarget()

        301
      • isAvailableInCodeView()

        301
      • isResizable()

        302
      • selectionChanged()

        302
      • About performance

        303
  • Behaviors

    305
    • How Behaviors work

      306
      • Inserting multiple functions in the user’s file

        307
      • What to do when an action requires a return value

        307
    • A simple behavior example

      307
      • Creating the behavior extension

        308
      • Creating the HTML files to browse

        310
      • Testing the behavior

        312
    • The Behaviors API

      312
      • applyBehavior()

        312
      • behaviorFunction()

        314
      • canAcceptBehavior()

        315
      • displayHelp()

        316
      • deleteBehavior()

        316
      • identifyBehaviorArguments()

        317
      • inspectBehavior()

        319
      • windowDimensions()

        320
  • Server Behaviors

    321
    • Dreamweaver architecture

      322
      • Server behavior folders and files

        322
      • Extension Data Markup Language

        322
        • Group files

          323
        • Participant files

          323
        • The script file

          324
    • A simple server behavior example

      324
      • Creating the dynamic page document

        325
      • Defining the new server behavior

        325
      • Defining the code to insert

        325
    • How the Server Behavior API functions are called

      326
    • The Server Behavior API

      329
      • analyzeServerBehavior()

        329
      • applyServerBehavior()

        330
      • canApplyServerBehavior()

        331
      • copyServerBehavior()

        331
      • deleteServerBehavior()

        332
      • displayHelp()

        332
      • findServerBehaviors()

        333
      • inspectServerBehavior()

        333
      • pasteServerBehavior()

        334
    • Server behavior implementation functions

      335
      • dwscripts.findSBs()

        335
      • dwscripts.applySB()

        336
      • dwscripts.deleteSB()

        337
    • Editing EDML files

      337
      • Regular expressions

        338
      • Notes about EDML structure

        339
    • Group EDML file tags

      340
      • <group>

        340
      • <group> attributes

        340
        • version

          340
        • serverBehavior

          341
        • dataSource

          341
        • subType

          342
      • <title>

        343
      • <groupParticipants>

        344
      • <groupParticipants> attributes

        344
        • selectParticipant

          344
      • <groupParticipant>

        345
      • <groupParticipant> attributes

        345
        • name

          345
        • partType

          346
    • Participant EDML files

      347
      • <participant>

        347
      • <participant> attributes

        347
        • version

          347
      • <quickSearch>

        348
      • <insertText>

        349
      • <insertText> attributes

        349
        • location

          349
        • nodeParamName

          351
      • <searchPatterns>

        352
      • <searchPatterns> attributes

        353
        • whereToSearch

          353
      • <searchPattern>

        354
      • <searchPattern> attributes

        355
        • paramNames

          355
        • limitSearch

          356
        • isOptional

          357
      • <updatePatterns>

        358
      • <updatePattern>

        359
      • <updatePattern> attributes

        360
        • paramName

          360
      • <delete>

        361
      • <delete> attributes

        361
        • deleteType

          361
      • <translator>

        362
      • <searchPatterns>

        363
      • <translations>

        363
      • <translation>

        364
      • <translation> attributes

        364
        • whereToSearch

          364
        • limitSearch

          364
        • translationType

          365
      • <openTag>

        366
      • <attributes>

        367
      • <attribute>

        367
      • <display>

        368
      • <closeTag>

        368
    • Server behavior techniques

      369
      • Finding server behaviors

        369
      • Search pattern resolution

        373
      • Updating server behaviors

        374
      • Deleting server behaviors

        376
      • Avoiding conflicts with share-in-memory JavaScript files

        376
  • Data Sources

    379
    • How data sources work

      380
    • A simple data source example

      382
      • Creating the data source definition file

        382
      • Creating the EDML file

        383
      • Creating the JavaScript file that implements the Data Sources API functions

        384
      • Creating the supporting command files for user input

        387
      • Testing the new data source

        389
    • The Data Sources API

      391
      • addDynamicSource()

        391
      • deleteDynamicSource()

        391
      • displayHelp()

        392
      • editDynamicSource()

        393
      • findDynamicSources()

        393
      • generateDynamicDataRef()

        394
      • generateDynamicSourceBindings()

        395
      • inspectDynamicDataRef()

        396
  • Server Formats

    399
    • How data formatting works

      400
      • The Formats.xml file

        400
      • The Edit Format List Plus (+) menu

        401
    • When the data formatting functions are called

      402
    • The Server Formats API

      403
      • applyFormat()

        403
      • applyFormatDefinition()

        403
      • deleteFormat()

        404
      • formatDynamicDataRef()

        405
      • inspectFormatDefinition()

        406
  • Components

    407
    • Component basics

      407
    • Extending the Components panel

      408
    • How to customize the Components panel

      408
    • Components panel files

      409
      • Adding a service component

        410
      • Populating the tree control

        411
    • Components panel API functions

      412
      • getComponentChildren()

        412
      • getContextMenuId()

        413
      • getCodeViewDropCode()

        414
      • getSetupSteps()

        415
      • setupStepsCompleted()

        416
      • handleDesignViewDrop()

        417
      • handleDoubleClick()

        418
      • toolbarControls()

        420
  • Server Models

    423
    • How customizing server models works

      423
    • The Server Model API functions

      424
      • canRecognizeDocument()

        424
      • getFileExtensions()

        425
      • getLanguageSignatures()

        425
      • getServerExtension()

        426
      • getServerInfo()

        426
      • getServerLanguages()

        427
      • getServerModelExtDataNameUD4()

        428
      • getServerModelDelimiters()

        428
      • getServerModelDisplayName()

        429
      • getServerModelFolderName()

        429
      • getServerSupportsCharset()

        430
      • getVersionArray()

        430
  • Data Translators

    433
    • How data translators work

      434
    • Determining what kind of translator to use

      435
    • Adding a translated attribute to a tag

      435
      • Translating more than one attribute at a time

        436
    • Inspecting translated attributes

      437
    • Locking translated tags or blocks of code

      437
    • Creating Property inspectors for locked content

      439
    • Finding bugs in your translator

      442
    • A simple attribute translator example

      443
      • Creating the tagspec tag

        443
      • Creating the icon

        444
      • Creating the attribute translator

        444
    • A simple block/tag translator example

      447
    • The Data Translator API

      452
      • getTranslatorInfo()

        452
      • translateMarkup()

        454
      • liveDataTranslateMarkup()

        455
  • C-Level Extensibility

    457
    • How integrating C functions works

      457
    • C-level extensibility and the JavaScript interpreter

      459
    • Data types

      460
      • typedef struct JSContext JSContext

        460
      • typedef struct JSObject JSObject

        460
      • typedef struct jsval jsval

        460
      • typedef enum { JS_FALSE = 0, JS_TRUE = 1 } JSBool

        460
    • The C-level API

      461
      • typedef JSBool (*JSNative)(JSContext *cx, JSObject *obj, unsigned int argc, jsval *argv, jsval *rval)

        461
      • JSBool JS_DefineFunction()

        461
      • char *JS_ValueToString()

        462
      • JSBool JS_ValueToInteger()

        462
      • JSBool JS_ValueToDouble()

        463
      • JSBool JS_ValueToBoolean()

        463
      • JSBool JS_ValueToObject()

        464
      • JSBool JS_StringToValue()

        464
      • JSBool JS_DoubleToValue()

        465
      • JSVal JS_BooleanToValue()

        465
      • JSVal JS_IntegerToValue()

        466
      • JSVal JS_ObjectToValue()

        466
      • char *JS_ObjectType()

        466
      • JSObject *JS_NewArrayObject()

        467
      • long JS_GetArrayLength()

        467
      • JSBool JS_GetElement()

        468
      • JSBool JS_SetElement()

        468
      • JSBool JS_ExecuteScript()

        469
      • JSBool JS_ReportError()

        469
    • File Access and Multiuser Configuration API

      470
      • JS_Object MM_GetConfigFolderList()

        472
      • JSBool MM_ConfigFileExists()

        473
      • int MM_OpenConfigFile()

        474
      • JSBool MM_GetConfigFileAttributes()

        475
      • JSBool MM_SetConfigFileAttributes()

        476
      • JSBool MM_CreateConfigFolder()

        477
      • JSBool MM_RemoveConfigFolder()

        478
      • JSBool MM_DeleteConfigFile()

        478
    • Calling a C function from JavaScript

      479
• Appendix

  481
  • The Shared Folder

    483
    • The Shared folder contents

      483
      • The Common folder

        484
      • The MM folder

        486
        • The Scripts folder

          486
      • Other folders

        490
    • Using the Shared folder

      491
• Index

  493