Scripts

Adobe RoboHelp supports scripting but in a different format from the Classic version. They were written in ExtendScript while in Adobe RoboHelp they are written in JavaScript, which is an open standard.

Supplied Scripts

The scripts included in Adobe RoboHelp are:-

Cross Ref Converter

Converts existing hyperlinks to cross references. Run the script and a list of all hyperlinks found will display. You can then select all or specific links to convert.

Glossary Term Converter

Converts text to a glossary hotspot. On running the script, a dialog is presented and you choose which glossary file and term is to be applied. That term is then searched for in the project and each instance is converted to a glossary hotspot. How that term displays in topics is defined in the presets.

The script as supplied applies a hotspot to all glossary terms. The Glossary topic describes how to apply hotspots with more control over how they are applied.

Open File

This script opens RoboHelp's File Open dialog so that the end user can pick a file to open. This script is supplied to let you see how scripts can be used when added as described below in Using the Scripts.

Variable Converter

On running the script a dialog is displayed allowing you to select one of your variables. You then enter some text. When you click Apply, the script will search for the text and convert it to the variable.

Word Count

On running the script a dialog is displayed showing  the number of words in each topic. The details can then be saved as a CSV file if required.

Using the Scripts

You can run the scripts from the Project Toolbar on the left or select a script in

  • The Post Generation field in the General settings of the Output Presets.
  • The Advanced settings when importing a Word or FrameMaker document.

To add your own scripts, click Scripts in the Project Toolbar and either import your script or click the + icon. That will open a text editor where you can write or paste in your own script.

Scripting API

Detailed information about scripting can be found in the API Guide.