Reference Topic

HotDocs Author SVN Connector

The HotDocs Author SVN Connector is a version control plugin that enables multiple template authors to work on the same workspace at the same time.

You can link a workspace to a Subversion (SVN) repository and then use the workspace interface to update, check in and check out template files.

Common Tasks

• Linking a Workspace to a Version Control System
• Getting the Latest Version of a Workspace from Version Control
• Editing a Version Controlled Template
• Committing a Change to Version Control
• Undoing a Local Change

About HotDocs Author SVN Connector

To connect HotDocs to an SVN repository, you need to install the SVN Connector plugin files. The plugin adds new options to Workspace Explorer that enable you to add workspaces to version control and check in and out templates without leaving the HotDocs Author environment. Once you link a workspace to the version control repository, any edits you make to a template are added to a local copy of the master template files stored in the version control repository.

Source Control Options in Workspace Explorer

Once you install the plugin, the following new items appear in the Workspace Explorer menu under Subversion (or the name of the version control you are using):

Option name	Description
Get Latest	Gets any updates to the template files from the version control repository.
Undo Checkout	Reverts any checked out template files to the state the file was in before you checked it out.
Resolve Conflicts	Resolves any discrepancies between your local template files and the template files in version control repository.
Check In	Applies any changes you made to the templates files in the Workspace to the version control repository.

Once you link a workspace to an SVN repository, the following options appear on the template details pane:

Option name	Description
Get Latest	Gets any updates to the selected template files from the version control repository.
Check Out	Makes the selected template files editable and locks them so no one else can edit them.
Undo Checkout	Reverts the selected template file to the state the file was in before you checked it out.
Check In	Uploads the changes you made to the selected template files to the version control repository where Subversion saves them as new revisions of the files.

Source Control File Status in Workspace Explorer

Once you link a workspace to an SVN repository, your file status appears as one of the following:

Status	Description
Unmodified	Indicates you have not checked out or modified your local copy since your last "Get Latest".
Checked out	Indicates you checked out the file for editing, but you have yet to edit your local copy.
Modified	Indicates you edited your local copy, and made some changes, but still need to check your changes into the file repository.
Pending Add	Indicates you created a new template in your version-controlled Workspace, and still need to add it to the file repository.
Not Added	Indicates you copied a template from a non-version-controlled Workspace to a version-controlled Workspace, but still need to add that template to the repository.

Additional Workspace Options

When you perform the following actions in a version-controlled workspace, the next time you check in these files, the plugin applies the changes to the version control repository:

Action	Description
Rename a Template	When you rename a template and then check in that file, the plugin renames the template in the version control repository.
Delete a Template	When you delete a template and then check in the workspace, the plugin deletes the template from the version control repository.