Credit for this one goes to Rick Stone, a.k.a. RoboWizard. I was having this problem and didn’t know what was causing it, and someone was smart enough (you’ll notice it wasn’t me) to put in a post about this in the RoboHelp forums.
Here’s the situation: The help author checks his WebHelp or FlashHelp output files in to a Subversion repository where the developers check in their code. This way, when the code is all rolled up for application builds, the help goes along for the ride. The help author has his output location set to a directory that is under Subversion control. However, every time he generates his output and tries to check it in, Subversion gives him an error. The help author rants and raves against Subversion, RoboHelp, and everything under the sun (you’ll notice that this also isn’t me).
Each directory that is under Subversion control has a folder called “.svn.” My guess is that because RoboHelp deletes output files before generating the new ones, something in that .svn folder was getting hosed. My workaround was to publish to a different folder and then copy the entire set of files inside into my Subversion help folder.
I was on the right track, but Rick suggested something better: using the Publish step.
Here’s how to set it up:
- Create a directory next to the one with the output files you check in to Subversion. For example, if your output folder is “apphelp,” the second folder could be “apphelp output.” DO NOT check this second directory in to Subversion.
- In the single source layout generation dialog, set that new folder as the output folder.
- On the last page of the dialog, click the New button next to the list of servers (this will be empty if you don’t otherwise use the Publish feature).
- In the New Destination dialog, enter a name, and click the File System radio button.
- Click the folder button, and browse for the directory that is under Subversion control.
- Click OK.
- Click the checkbox for the new destination in the list of servers.
- Click the Finish button to generate your output.
- When the output generation is finished, click the Publish button. The files that have changed will be moved into the Subversion folder, and the .svn folder will be untouched. Both RoboHelp and Subversion are happy.
Repeat step 9 whenever you generate your output, and only the changed files get moved into the Subversion folder.
One of the great things about this Publish approach is that it also works well for files that you have manually tweaked and don’t want overwritten every time you generate your output (see the previous FlashHelp tip). You put the tweaked file in the Subversion folder and check it in. If it never changes in RoboHelp, the output generation process never knows that you’ve tweaked the file, so it thinks it hasn’t changed. Therefore, when you publish the changed files to the Subversion folder, your tweaked file is never overwritten.
Related entries (auto-generated):
Changing a Topic File Name in RoboHelp and Subversion
Deleting a Topic from RoboHelp and Subversion
FlashHelp Tech Tip: Fixing the “Flash Player has stopped a potentially unsafe operation” Problem
FlashHelp Tech Tip: Removing IE’s “Click to activate and use this control” Message
The Case of the Missing Help Topics; or, Version Control Comes Through
Journals by Email











2 Comments to 'Tech Tip: Checking WebHelp/FlashHelp Output Files in to Subversion'
January 19, 2010
A great tip Ben (or it that Rick?). we are looking into migrating to SVN from VSS and the info here is very useful. Keep it up.
[Reply]
Trackbacks
Set Me Straight. Leave a Comment.