User Guide

118 The Source Control Integration API
How source control integration with
Dreamweaver works
When a Dreamweaver user selects server connection, file transfer, or Design Notes features,
Dreamweaver calls the DLL’s version of the corresponding API function (
Connect(),
Disconnect(), Get(), Put(), Checkin(), Checkout(), Undocheckout(), and
Synchronize()). The DLL handles the request, including displaying dialog boxes that gather
information or letting the user interact with the DLL. The DLL also displays information or
error messages.
The source control system can optionally support Design Notes and Check In/Check Out.
The Dreamweaver user enables Design Notes in source control systems by selecting the
Design Notes tab in the Edit Sites dialog box and checking the box that enables the feature;
this process is same to enable Design Notes with FTP and LAN. If the source control system
does not support Design Notes and the user wants to use this feature, Dreamweaver
transports Design Note (MNO) files to maintain the Design Notes (as it does with FTP and
LAN).
Check In/Check Out is treated differently than the Design Notes feature; if the source control
system supports it, the user cannot override its use from the Design Notes dialog box. If the
user tries to override the source control system, an error message appears.
Adding source control system
functionality
You can add source control system functionality to Dreamweaver by writing a
GetNewFeatures handler that returns a set of menu items and corresponding C functions.
For example, if you write a Sourcesafe library and want to let Dreamweaver users see the
history of a file, you can write a
GetNewFeatures handler that returns the History menu item
and the C function name of
history. Then, in Windows, when the user right-clicks a file, the
History menu item is one of the items on the menu. If a user selects the History menu item,
Dreamweaver calls the corresponding function, passing the selected file(s) to the DLL. The
DLL displays the History dialog box so the user can interact with it in the same way as
Sourcesafe.
000_DW_API_Print.book Page 118 Wednesday, July 20, 2005 11:58 AM