Checking Out the Project File

In most cases, you do not need to check out the Doc-To-Help project (D2H) file. However, there are some cases when this is necessary. If you need to make the following changes, check the project out, make the changes, and check it back in.

  • Delete existing documents
  • Change existing document properties
  • Change project properties
  • Change target properties
  • Change style properties
  • Change topic properties
  • Edit the table of contents
  1. In the Team Authoring window, select the project (D2H) file.
  2. Click the Check Out button. The Check Out dialog opens.
    • For File and Web Repositories After the file is checked out, click the Close button.
    • For TFS Repositories You need to confirm the lock type before you check out the file. Choose from the following:
      • Unchanged Will keep the existing lock.
      • Check Out Will prevent other users from checking the file in or out.
      • Check in Will allow other users to check out the file but they will not be permitted to check it back in.

      To set the default lock type, use the Doc-To-Help Options dialog (File > Tools > Options > Team).

  3. After edits are made to the project, in the Team Authoring window select the project (D2H) file.
  4. Click the Check In button. The Check In dialog opens.
  5. Confirm the check in and click the Check In or OK button.

Note You do not need to check out the project file in order to build your project. When you click the Build button, Doc-To-Help will give you the option to temporarily suspend team authoring to perform the build. Click OK to accept this option. In that scenario, any changes made to the project file will be temporary. If you would like them to be permanent, check out the project file before building the project.

Note For other tasks, see Working in a Team Project.