Dreamweaver 8 Integration

From Seapine Labs

Contents 1 Background 2 Associating sites with Surround SCM 3 Basic Surround SCM tasks 3.1 Putting files 3.2 Getting files 3.3 Checking out files 3.4 Undoing check out 3.5 Checking in files 3.6 Viewing file history 3.7 Viewing file properties 3.8 Diffing files 3.9 Renaming files 3.10 Refreshing file status 3.11 Removing files 4 Advanced Surround SCM tasks 4.1 Synchronizing 5 Troubleshooting Dreamweaver and Surround SCM integration

[edit] Background

This article was written using Surround SCM 5.0.4 and Dreamweaver 8.0. The same set of steps have also been successfully tested using Surround SCM 2008 and Dreamweaver CS3.

The site in Dreamweaver used in this article is one whose files have not been added to Surround SCM, there is not repository associated with Suround SCM, and the local root folder for the site is not a working directory in Surround SCM. This mirrors a user whose been using Dreamweaver already and has just installed the Surround SCM client for the first time.

[edit] Associating sites with Surround SCM

1. Start Dreamweaver.

2. "Choose Site" > "Manage Sites...".

The Manage Sites dialog box opens.

3. Select the site you want to associate with Surround SCM and click the "Edit" button.

The Site Definition dialog box opens.

4. Click the Advanced tab and select Remote Info.

5. Select Surround SCM from the Access list.

If Surround SCM is not displayed in the Access list the extension was not installed correctly. Refer to Troubleshooting Dreamweaver and Surround SCM integration for help.

6. Click Settings to select the site’s root folder. The Browse for Folder dialog box opens.

7. Browse for the site’s local root folder and click OK. You return to the Site Definition dialog box.

Make sure that you do not skip steps 6 and 7. If the root folder is incorrectly set, the integration will not work.

8. Select any options and click OK.

Next, we must set up an association between the site's root folder and a repositoy in Surround SCM. In the File Pane in Dreamweaver, click on the "remote to local host" button shown outlined in red in the image below.

This should pop up a message indicating that Surround SCM was unable to establish an association with the site's local root folder as shown in the image below.

Click on the "fix" button so the Surround SCM repository browser will open. In that window, you must either select an existing repository or create a new repository.

Unless you have a repository already associated with the local root folder, it is recommended that a new repository be created.

If you desire to select an existing repository, you should first right click on the desired repository and select "Set Working Directory..." and change the working directory for that repository to be the local root folder for the site.

Selecting an existing repository from the repository browser will not change the working directory to the local root folder automatically and if this is a directory other than the local root folder, the integration will not work properly.

Also, if you select an existing repository which already contains other files, Dreamweaver will add these files to the site and will now display in the Files Pane in Dreamweaver.

Figure below shows the Surround SCM repository browser with the button to create a repository oulined in red as well as the "Set Working Directory..." option from the context menu.

[edit] Basic Surround SCM tasks

Please refer to the Surround SCM User Guide for details on all of the options given for all of the Surround SCM tasks.

[edit] Putting files

Add or check in selected files to Surround SCM. Available when one or more files selected.

1. Select the files you want to add to source control.

2. Choose "Site" > "Put" or right-click the file and choose "Put".

The Add Files dialog box opens.

Please refer to the Surround SCM User Guide for details on all of the options given in the dialog box.

3. Click OK.

The files are added to Surround SCM.

[edit] Getting files

Get files when you want to view a file but do not need to make any changes.

1. Select the file(s) you want to get. 2. Choose "Site" > "Get" or right-click the files and choose Get.

The Get File(s) dialog box opens. Click Advanced to expand the dialog box.

Please refer to the Surround SCM User Guide for details on all of the options given in the dialog box.

3. Click OK to get the files.

[edit] Checking out files

Check out files when you need to modify the files.

1. Select the file you want to check out. 2. Choose Site > Check Out or right-click the file and choose Check Out.

The Check Out File(s) dialog box opens.

Please refer to the Surround SCM User Guide for details on all of the options given in the dialog box.

3. Click OK.

The file is checked out.

[edit] Undoing check out

If you check out and modify a file then decide you do not want to save the changes, you can undo the check out. This discards any changes made to the file and checks it back into the server.

1. Select the file.

2. Choose Site > Undo Check Out or right-click the file and choose Undo Check Out.

The Undo Check Out File(s) dialog box opens.

Please refer to the Surround SCM User Guide for details on all of the options given in the dialog box.

4. Click OK.

The file is no longer checked out.

[edit] Checking in files

Check in updates files with changes, removes the lock on the files, makes changes available to other users, and increments the version number by one.

1. Select the file you want to check in.

2. Choose Site > Check In or right-click the file and choose Check In.

The Check in File(s) dialog box opens.

Please refer to the Surround SCM User Guide for details on all of the options given in the dialog box.

3. Click OK.

The files are checked in.

[edit] Viewing file history

File history provides a way to view a source file’s history and work with a historical file version.

1. Select the file. 2. Right-click the file and select Source Control > History. The History dialog box opens. This dialog box includes a summary of historic version information.

Please refer to the Surround SCM User Guide for details on all of the options given in the dialog box.

3. Click Close to close the history.

[edit] Viewing file properties

File properties include general and check out information about the selected file.

1. Select the file.

2. Right-click the file and choose Source Control > Properties.

3. The Properties dialog box opens. The General tab includes read-only information about the file.

Depending on your security permissions you may also be able to Expand keywords or select a File type.

4. Click the Check Out tab. This tab includes read-only check out information about the file. 5. Click OK to close the Properties dialog box.

Note: A Shared tab is also available if the file is shared in Surround SCM.

[edit] Diffing files

You can diff files to compare, accept, or reject differences between two files.

1. Select the file. 2. Right-click the file and choose Source Control > Differences. The differences utility launches. For additional information about the utility refer to the application’s documentation.

[edit] Renaming files

1. Select the remote file you want to rename.

Note: Renaming a file in the local view does not rename it in Surround SCM. You must rename from the Remote view to rename the file in Surround SCM.

2. Right-click the file and choose Rename.

3. Enter the new file name.

The Rename File dialog box opens.

4. Enter any Comments.

5. Click OK.

The file is renamed in Surround SCM.

[edit] Refreshing file status

If you make changes to a file outside of Dreamweaver you can refresh the file to update its status. For example, if you check out a file from the Surround SCM client it will not be displayed as checked out in Dreamweaver unless you refresh the file status.

1. Choose View> Refresh or click the Refresh toolbar button. The file status is refreshed.

Note: You can also disconnect and reconnect to completely refresh the Surround SCM files.

Refreshing the Local view does not necessarily refresh the Remote view.

[edit] Removing files

You can remove files from Surround SCM control.

1. Select the remote file you want to remove.

2. Right-click the file and choose Delete.

The Remove Files and Repositories dialog box opens.

3. Enter any Comments.

Select Force recursive remove to remove the selected repository and all files and subrepositories.

4. Select Permanently destroy files and repositories to delete the files from Surround SCM.

5. Click OK.

The file is removed.

[edit] Advanced Surround SCM tasks

[edit] Synchronizing

You can synchronize files and folders with Surround SCM.

1. Select the file or folder.

2. Right-click and choose Synchronize.

The files are synchronized. Refer to Dreamweaver’s documentation for additional information.

[edit] Troubleshooting Dreamweaver and Surround SCM integration

This section can help you troubleshoot more common Dreamweaver/Surround SCM integration problems.

Surround SCM is not available from the Remote Info Access list:

Surround SCM is not listed when you select a project version control system. Please check the following for possible causes and resolutions.

􀂄 The Surround SCM extension is not installed. For more information see Installing the Dreamweaver extension.

􀂄 You are running an unsupported version of Dreamweaver.

The Surround SCM extension currently supports Dreamweaver 6.0 and 7.0. The integration does not work if you are running another version of Dreamweaver.

􀂄 The Surround SCM .dll file was not properly installed. Check to make sure the Surround SCM SCCI.dll file exists in the following directory: C:\Program Files\Common Files\Macromedia\2004\SourceControl. If it does not exist you can either reinstall the extension or copy the .dll file from the Surround SCM installation directory (C:\Program Files\Seapine\Surround SCM) to the Macromedia directory.

When Clicking on the "Connect to Remote Host" Button the "Edit Site" Window Opens Instead of the Prompt to Associate the Local Root Directory With a Repository

This can happen if the File Pane in Dreamweaver is set to "local view". Toggling betwen "local view" and "remote view" should resolve this issue.

Surround SCM files are not displayed in Dreamweaver.

You added files to Surround SCM but they are not displayed in the Dreamweaver Remote view. Please check the following for possible causes and resolutions.

􀂄 The Dreamweaver/Surround SCM integration is not configured correctly.

Make sure Surround SCM is configured to use the same folder as the site’s root. For more information see Associating sites with Surround SCM, page 2.

􀂄 Dreamweaver cannot connect to the Surround SCM server.

Make sure the Surround SCM server is running and that your username/password are valid.

􀂄 The local .MySCMServerInfo file is out of sync.

Dreamweaver uses the .MySCMServerInfo file to determine where to look for files in Surround SCM. Go to the site where the site exists and make sure the .MySCMServerInfo file data points to the correct branch/repository. If it is pointing to an incorrect branch/repository delete it then refresh the Dreamweaver site to regenerate the .MySCMServerInfo file.

Adding files fails from within Dreamweaver

You cannot add files to Surround SCM from within Dreamweaver. Please check the following for possible causes and resolutions.

􀂄 The Dreamweaver/Surround SCM integration is not configured correctly.

Make sure Surround SCM is configured to use the same folder as the site’s root. For more information see Associating sites with Surround SCM, page 2.

􀂄 The Put command does not fail but files are not added.

This can occur if you remove the file from Surround SCM then try to Put it into Dreamweaver. Dreamweaver relies on the contents of the .MySCMServerInfo file to determine if a Put command should be interpreted as an Add or Check In. To solve this problem manually edit the .MySCMServerInfo file and delete the data row that contains the name of the file(s) you cannot add.

􀂄 Dreamweaver points to the wrong branch/repository.

This can occur is you use the same working directory for multiple branches. Dreamweaver uses the .MySCMServerInfo file to determine where to add files. Surround SCM cannot determine where to add files if multiple .MySCMServerInfo files exist in one directory. To solve this problem you can perform a Get of the branch from Surround SCM or delete the .MySCMServerInfo files to be prompted to select a new branch/repository.

Getting or checking out files fails from within Dreamweaver

You cannot get or check out files from Surround SCM. Please check the following for possible causes and resolutions.

􀂄 The Dreamweaver/Surround SCM integration is not configured correctly.

Make sure Surround SCM is configured to use the same folder as the site’s root. For more information see Associating sites with Surround SCM, page 2.

􀂄 Dreamweaver points to the wrong branch/repository. This can occur is you use the same working directory for multiple branches. Dreamweaver uses the .MySCMServerInfo file to determine where to add files. Surround SCM cannot determine where to add files if multiple .MySCMServerInfo files exist in one directory. To solve this problem you can perform a Get of the branch from Surround SCM or delete the .MySCMServerInfo files to be prompted to select a new branch/repository.