When you open the working copy of a team project, Doc-To-Help will include an additional ribbon and window, both named "Team Authoring."
Three different file types make up a team authoring project:
-
Documents These are the source documents included in your Doc-To-Help project. By default, they will be located in the Documents folder. Any rich content variable documents will be included in these folders also.
-
Auxiliary Files These are any files that are not documents. Examples include image and CSS files. By default, these will be located in the Media and CSSFiles folders.
-
Project File (.d2h Extension) This is the project itself, which contains all project information such as keywords, attributes, windows, and project properties.
You can check out and work with all three file types. In projects stored in a File or Web Repository, when a document or auxiliary file is checked out by an author, no one else can edit that file until those files are checked back in. When an entire project is checked out, no one else can edit the project or the files within it until the project is checked back in. Projects stored in Team Foundation Server (TFS) repositories have additional check out options.
You can manage components of your Doc-To-Help project in the following ways if you intend to bind it with a shared repository:
Once your Team Authoring project is open, you can access the Team Authoring panel for more functions to help manage this project. See Team Authoring Window Panel (Doc-To-Help).
Team Authoring ribbon
After you have opened your project, you can do the following with the Team Authoring ribbon:
-
Filter View Choose the file types that will be displayed in the Team Authoring window: Documents, Auxiliary Files, Only Pending Changes.
- Refresh View Refresh the entire display to update the file status.
-
Get Latest Version Get the latest version of the selected document from the repository. (TFS projects include a drop-down that allow you to choose a specific version of a document.)
-
Check Out Check the selected document out of the repository.
-
Undo Pending Changes Undo all changes made to a document that has been checked out.
-
Check In Check the selected document into the repository.
-
Go Offline Break the connection with the server. You will be prompted to choose the project editing mode: Restricted or Unrestricted. If you choose Restricted, an Unrestricted Project Editing button will appear in the ribbon, allowing you to switch modes if you wish. This button will toggle to Go Online while you are offline.
-
Compare (TFS projects only) Compare the selected document with the version on the server.
-
History (TFS projects only) View a history of the selected document's changes.
-
Open Open the file selected in the Team Authoring window for editing.