23 May 2011
To follow this article, you should have a basic understanding of the following concepts:
*Some versions of P4V include the P4SCC plug-in. The Windows 32-bit installer does not.
**This article is not intended to provide instructions on the setup or maintenance of a Perforce source control system; it presumes that you have access to a Perforce depot to use for source control.
Perforce is a Perforce Software product providing source control, integration, and project tracking. RoboHelp 9 integrates seamlessly with Perforce depots via the Perforce Visual Client (P4V) and P4SCC plug-in to leverage the Microsoft Source Code Control Interface (MSCCI). I used the Perforce Visual Client/NTX86/2010.1/271261 version.
You must install the following components to use RoboHelp 9 with Perforce:
I also recommend that you contact your Perforce administrator to provide you with necessary information about your Perforce installation and depot.
Connecting to Perforce the first time
If this is your first experience with Perforce, you may need to create a connection. When you start the P4V client, Perforce may prompt you to create a connection by displaying the Connection Setup Wizard dialog box.
If you see this wizard, you should immediately contact your Perforce administrator to assist with the settings appropriate for your Perforce installation.
Creating a connection to a known depot
If you are already using Perforce, or have access to a Perforce depot, you should create a connection (if you don't already have one) before you create your workspace.
From the Connection menu, click Open Connection. The P4V client displays the Open Connection dialog box.
The default Server entry is "perforce:1666"; check with your Perforce administrator for information specific to your depot. Your user name should appear in the User box; type it in if the space is blank. Click New on the Workspace row to open the New Workspace dialog box and create a new workspace for your RoboHelp depot.
Creating a workspace
For example, if your workspace is called "robobuild", the Perforce depot is named "depot", and the location in the depot you are using is "help/builds", the depot side string is "//depot/help/builds/…" and the workspace side string is "//robobuild/…" .
Each writer needs to create a workspace to grant RoboHelp access to the Perforce depot. The following characteristics are worth noting:
Add a RoboHelp project to Perforce
Before you can use Perforce for source control, you must add your RoboHelp project to a Perforce depot. Once a project is in Perforce, writers can get the project files out, update to the latest revision, and submit changes in a controlled environment. To add a project to Perforce, complete the following steps:
This image of a Perforce changelist shows how Perforce recognizes that there are files waiting to be submitted. You need to check in these new files with RoboHelp to allow Perforce to submit them to the depot.
Get a RoboHelp project from Perforce the first time
Each writer must create a uniquely named workspace before they can work in a project. To get a project from Perforce the first time, make sure that you have the workspace name, folder details, and the appropriate access rights. Each writer needs to perform the following steps to acquire files from source control:
Working in RoboHelp with Perforce
Once you have gotten a project from Perforce, you can open it with the .xpj file or from the Starter menu. RoboHelp automatically updates all of the project files to the latest version from Perforce. When you need to modify a topic or project file, click the Check Out icon or use the Check Out menu option in the Project Manager. When your changes are complete, click the Check In icon or the Check In menu option to display the Submit Changelist dialog body to submit your changes to Perforce. Best practice indicates that using the Check In All option in RoboHelp is better than checking in individual files, because you need to submit only a single changelist. If your workspace specifies the "revertunchanged" Submit Option, only files with actual changes are updated.
What if you added the project to an incorrect location in Perforce?
Unless you have permission to permanently remove material from the depot, you will probably need to enlist the help of your Perforce administrator to correct this situation. Depending on your source control protocols, the administrator can determine whether you need to correctly add the files before or after the incorrect files are removed, or if another solution is available.