How to Use the Compare Macro

First, identify two Help projects: one help project serves as the base project (we'll call it "Original.HPJ"); the other help project serves as the translated help project (we'll call it "Translate.HPJ"). In the following exercise, you open the Translate project and turn on ActiveEdit and Help Author Mode.

Try this

  1. Open the Help project you wish to compare or translate (this project is usually the newer of two help projects).  You can open the project in any version of RoboHELP for WinHelp.

  2. Turn on Active Edit (Project Settings: Compile Tab).

  3. Click OK.

  4. On the RoboHELP Explorer choose View: Help Author Mode.

  5. Compile, but do not run the Help file. Leave RoboHelp open, but minimize it on the screen.

  6. Open Windows Explorer and locate and double click "Original.HLP", not Original.HPJ. This is the help file you want to compare. You must display a Help topic window, not the Help Topics dialog box.

  7. Press CNTL + SHIFT + J to open the Jump dialog box.

  8. Type in the macro and the path to the Help file.  In the example below the two projects (Original & Translate) are positioned laterally as in the following:


    The macro is written as follows (note the exclamation point and forward slashes): !compare(`../translate/translate.hlp') into the Enter topic identifier text box field (below).  I have used a relative path to the file using ../ (this takes you up one level), then translate/ (takes you down a level). You could also use an absolute path such as d:/compare/translate/translate.hlp.  For more information on the use of path statements see the September 2000 tip at: Understanding Paths in WinHelp.  

  9. What follows are two help files tiled side by side. Note that the ActiveEdit button is on the Translate project.

  10. Use Help Author Mode commands to navigate from topic to topic.

  11. When you find a topic to want to edit, click the ActiveEdit button. You are taken to the source Microsoft Word document file in the translated document.

  12. After making your comparison, switch back to the tiled Help files and repeat the process.

Now if I can figure out a way to do this in HTML... I'm working on it!!

That's it for this month.  See you all next month!!

rob@magrino.com