Macromedia RoboHelp - 10.0 Scripting Guide

ADOBE® ROBOHELP® 10 Scripting Guide

Adobe, the Adobe logo, Adobe AIR, AIR, FlashHelp, FrameMaker, and RoboHelp are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. Windows is either a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries. All other trademarks are the property of their respective owners.

This work is licensed under the Creative Commons Attribution Non-Commercial 3.0 License. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc/3.0/us/

Adobe Systems Incorporated, 345 Park Avenue, San Jose, California 95110, USA.

Last updated 8/27/2012

Chapter 1: Scripting basics

Scripting support in RoboHelp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

RoboHelp object model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Chapter 2: Classes

RoboHelp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Token . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

TokenManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

TopicManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

MasterPageManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

SnippetManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

UDVManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

FileManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

TOCManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

IndexManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

GlossaryManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

ScreenProfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

ScreenProfileManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

SkinManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

CBT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

CBTManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

SSLManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

SSLContent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

FMFileManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

WordFileManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

ReportManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

ServerManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

MapIdManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Skin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

UDV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

ContentManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Snippet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

MasterPage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

TOC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

FMFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

iii

Last updated 8/27/2012

ROBOHELP 10 SCRIPTING GUIDE

Contents

WordFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

HTMLHelpWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

HTMLHelpWindowManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

Chapter 3: Constants

Syntax for using constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

AddMethod . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

SSLLayoutType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

ReportType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

DeleteOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

SkinType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

FrameFileFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

TokenType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

TagType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

PIType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

FileStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

SyncStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

ServerType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

WordFileFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

HTMLHelpWindowButtons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

HTMLHelpWindowAlign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

HTMLHelpWindowDefaultTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

HTMLHelpWindowProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

Last updated 8/27/2012

Chapter 1: Scripting basics

A script is a series of commands that instructs Adobe® RoboHelp® to perform a set of specified actions, such as counting the images used in a RoboHelp project or selecting multiple master pages and importing them. Scripts automate repetitive tasks and are often used as a creative tool to streamline tasks that are time-consuming.

Before you begin scripting, take a few moments to read an overview of the scripting support in RoboHelp and find out how to create and run scripts.

If you are familiar with scripting or programming languages, you can skip this chapter and refer to “Classes” on page 5 and “Constants” on page 101 for information about RoboHelp scripting classes and constants.

If you are new to scripting, you can acquaint yourself with the basic scripting concepts provided in the Introduction

to Scripting manual.

Scripting support in RoboHelp

RoboHelp supports ExtendScript, which is an extended version of JavaScript. As a beginner, the difference between these two languages does not affect you. However, name JavaScript scripts with a .jsx extension, instead of the usual .js extension. ExtendScript files are distinguished by the .jsx extension.

Creating scripts

Adobe provides ExtendScript Toolkit (ESTK) with its applications as a scripting utility. The ESTK has many features that make it easier to use than a text editor, including a built-in syntax checker that identifies where the problems are in your script and tries to explain how to fix them, and the ability to run your scripts right from the ESTK without saving the file. This second feature can save you a lot of time, especially in the beginning when you may have to test and edit a script several times to get it to work.

Debug scripts

❖ Select the Adobe RoboHelp 8 option as the target application from the drop-down list in the ESTK.

Edit scripts

❖ Double-click a script file in Script Explorer or Windows Explorer to edit it using the ESTK.

Managing scripts from within RoboHelp

The Script Explorer pod enables you to manage scripts and do any of the following:

Create a script folder Create a folder for storing specific scripts. For example, you can store scripts that record data in

one folder and scripts that display output in another folder.

Reorganize folders You can reorganize folders through simple drag-and-drop operations.

Import and export You can export and import script files and folders in different projects and locations. To import or

export a folder, it must contain at least one script file.

Last updated 8/27/2012

ROBOHELP 10 SCRIPTING GUIDE

Scripting basics

Running scripts

• From the command line, enter the following command:

Robohtml.exe -x [scriptfilenames]

You can specify multiple script filenames, separated by a space, to run one script after another. If the filename path contains a space, enclose the filename path in single or double quotation marks.

• In RoboHelp, choose Tools > Scripts to run sample scripts or create new scripts and run them.

• In Windows Explorer, double-click a script to open it in ExtendScript Toolkit and run it.

• In ExtendScript Toolkit, select Adobe RoboHelp 8 from the ExtendScrip Toolkit pop-up menu and click the Click

To Connect To Target Application

to run RoboHelp.

RoboHelp sample scripts

RoboHelp provides a set of sample scripts that you can use or customize. You can use these sample scripts to do the following:

EclipseHelp Use this script to convert WebHelp output to EclipseHelp output. See the script for more details.

Link Converter Use this script to convert an anchor link href target across all the files in a RoboHelp project. For

example, define a link to convert www.adobe.com to www.adobe.com/support/ across all the Help files in a project. See the script file for more information.

MultiMasterPageImport Use this script to select multiple master pages and import them.

SaveAsProjectTemplate Use this script to save a RoboHelp project as a template for creating similar RoboHelp

projects.

UDV Converter with UI Use this script to convert a keyword into a user-defined variable and change its value across all

files in a project. Enter a keyword, a user-defined variable name, and its value.

UDV Converter Use this script to convert a keyword into a user-defined variable and change its value across all the files

in a project. See the script for more details.

Word Count Use this script to get a word count for an open RoboHelp project. It provides a word count by topic and

by project. To run the Word Count script, right-click the script and select Run. The word count summary appears in the Output View pod.

RoboHelp object model

The RoboHelp object model is based on the principles of a document object model (DOM). A DOM is an application programming interface (API) that allows you to programmatically access various components of a document (as defined for that application) through a scripting language. The principle behind a DOM is the containment hierarchy. In other words, top-level objects in a DOM contain next-level objects, which contain the subsequent level of objects, and so on.

Each node in the Robohelp containment hierarchy is a class. The RoboHelp class sits at the top of the hierarchy and is a collection of classes and constants. To accomplish a task through scripting, you need to reference these objects following the parent-child relationship defined in the containment hierarchy.

Last updated 8/27/2012

ROBOHELP 10 SCRIPTING GUIDE

Scripting basics

For example, if you want to specify Adobe® AIR® Help as the single-source layout for a RoboHelp application, the object reference in your script needs to be:

RoboHelp.SSLLayoutType.AIRHELP

SSLLayoutType is a child class of the RoboHelp class, and AIRHELP is a property of the SSLLayoutType class.

Last updated 8/27/2012

ROBOHELP 10 SCRIPTING GUIDE

Scripting basics

RoboHelp

TokenManager

Token

RoboHelp containment hierarchy

Project

TopicManager

Topic

MasterPageManager

MasterPage

SnippetManager

Snippet

UDVManager

UDV

FileManager

File

TOCManager

TOC

IndexManager

Index

GlossaryManager

Glossary

SkinManager

Skin

CBTManager

CBT

SSLManager

SSL

ScreenManager

Screen

FMFileManager

FMFile

WordFileManager

WordFile

ServerManager

Server

HTMLHelpWindowManager

HTMLHelpWindow

ReportManager

MapIDManager

AddMethod

PIType

SSLLayoutType

Language

ReportType

DeleteOption

Status

SkinType

FrameFileFormat

TokenType

TagType

FileStatus

SynchStatus

ServerType

WordFileFormat

HTMLHelpWindowAlign

HTMLHelpWindowDefaultTab

HTMLHelpWindowButtons

HTMLHelpWindowProperties

ContentManager

SSLContent

For more information on classes, see “Classes” on page 5.

For more information on constants, see “Constants” on page 101.

Last updated 8/27/2012

Chapter 2: Classes

RoboHelp

Main class for interacting with a RoboHelp application.

RoboHelp properties

Property name Data type Description

version String Read-only

RoboHelp product version

name String Read-only

Product name

path String Read-only

Full path to the RoboHelp application executable

convertToHTMLOutput Boolean True if the Convert RoboHelp-edited Topics

typename String Class name of reference object

scriptingVersion String Scripting interface version

language Integer constant Read-only

project Project Project object

SSLLayoutType SSLLayoutType Read-only

Language Language Read-only

ReportType ReportType Read-only

AddMethod AddMethod AddMethod constant

DeleteOption DeleteOption Read-only

Status Status Read-only

To HTML Option is selected.

This option can be set using the scripting API.

RoboHelp language settings

SSLLayoutType constant

Language constant

ReportType constant

DeleteOption constant

Status constant

SkinType SkinType Read-only

SkinType constant

Last updated 8/27/2012

ROBOHELP 10 SCRIPTING GUIDE

Classes

Property name Data type Description

FrameFileFormat FrameFileFormat Read-only

FrameFileFormat constant

TokenType TokenType Read-only

TokenType constant

TagType TagType Read-only

TagType constant

FileStatus FileStatus Read-only

FileStatus constant

SyncStatus SyncStatus Read-only

SyncStatus constant

ServerType ServerType Read-only

ServerType constant

WordFileFormat WordFileFormat Read-only

WordFileFormat constant

commandLineArgCount Integer Number of command-line arguments passed

in the RoboHelp process

RoboHelp methods

getCommandLineArg

Description

Get the command line argument passed in RoboHelp process

Returns

String

Syntax

getCommandLineArg(argCount)

Parameters

Parameter name Data Type Optional Description

argCount int No Argument index in the command line

openProject

Description

Opens .mpj and .xpj projects in a RoboHelp application.

Last updated 8/27/2012

ROBOHELP 10 SCRIPTING GUIDE

Classes

Syntax

openProject (projectPath, upgradeIfRequired)

Parameters

Parameter name Data type Optional Description

projectPath String No Full path to the project file that you want to

upgradeIfRequired Boolean Yes Upgrade the project if created in older version

open

of RoboHelp. Default value is false.If upgrade not required for the project, this parameter is ignored.

getTokenManager

Description

Returns Token Manager for the specified file.

Returns

TokenManager

Syntax

getTokenManager (fullFilePath)

Parameters

Parameter name Data type Optional Description

fullFilePath String No Full path to the file that you want to open

readWholeFile

Description

Read the whole file and return the file content. This function will take care of encoding issues for XML and html files as well

Returns

String

Syntax

readWholeFile(fullFilePath)

Parameters

Parameter name Data Type Optional Description

fullFilePath String No Full path of file which user wants to read

Last updated 8/27/2012

ROBOHELP 10 SCRIPTING GUIDE

Classes

writeWholeFile

Description

Creates a new file if required and write the content to this file. This function will take care of encoding issues for XML and html files. If the file is HTML or XML then it will check for encoding type and encode the file accordingly, other wise it will write the content in UTF-8 and write BOM as well.

Returns

Boolean

Syntax

writeWholeFile(fullFilePath, stringBuffer)

Parameters

Parameter name Data Type Optional Description

fullFilePath String No Full path of file which user wants to read

stringBuffer String No String Content which needs to be

written to file

createZipFile

Description

Creates a zipped file. This function requires a input folder as well as output zip file path

Returns

Boolean

Syntax

createZipFile(inputFolderPath, outputZipFilePath, mimeType)

Parameters

Parameter name Data Type Optional Description

inputFolderPath String No Full path of folder which need to be

outputZipFilePath String No Full path of output zip file.

mimeType String Yes Mimetype for zip file. Empty Mimetype

zipped

will not create any mimetype file.

getCurrentProject

Description

Returns the active project object.

Returns

Project

Last updated 8/27/2012

ROBOHELP 10 SCRIPTING GUIDE

Classes

Syntax

getCurrentProject ()

closeProject

Description

Closes the active project.

Note: Unsaved topic files are not saved.

Returns

String

Syntax

closeProject ()

newProject

Description

Creates a project.

Returns

Project

Syntax

newProject (template, projectName, projectPath, title, firstTopic, language, saveSettings)

Parameters

Parameter name Data type Optional Description

template String No Name of the template or full path to the

projectName String No Name of the project

projectPath String No Full path to the location where the project will

title String Yes Title of the project

firstTopic String Yes Title of the first topic

language Integer constant Yes Lanuage for the project

saveSettings Boolean Yes Saves the specified language as the default

Template.hpr file. Specify an empty string to create a blank project.

be created

language for new projects

newProjectImport

Description

Creates a project from a DITA map.

Last updated 8/27/2012

ROBOHELP 10 SCRIPTING GUIDE

Classes

Returns

Project

Syntax

newProjectImport (projectName, outputFolder, DITAOTHomeDirectory, ditavalFile, topHeader,

bodyHeader, bodyFooter, xslFile, indexShow)

Parameters

Parameter name Data type Optional Description

projectName String No Full path to the DITA map file

outputFolder String No Full folder path where the project will be

DITAOTHomeDirectory String No Full path to the DITA Open Toolkit home

ditavalFile String Yes Full path to the Ditaval file for filtered

topHeader String Yes Full path to the file containing XHTML to place

bodyHeader String Yes Full path to the file containing XHTML to place

bodyFooter String Yes Full path to the file containing XHTML to place

xslFile String Yes Full path to the XSL file that is used instead of

indexShow Boolean Yes Use this option to show or hide index entries

created

bringToFront

Description

Makes the RoboHelp application the active window.

Syntax

bringToFront ()

quit

Description

Exits the RoboHelp application.

Syntax

quit ()

Last updated 8/27/2012

ROBOHELP 10 SCRIPTING GUIDE

Classes

executeScript

Description

Runs a script file.

Returns

String

Syntax

executeScript (scriptFilePath)

Parameters

Parameter name Data type Optional Description

scriptFilePath String No Full path to the script file to run

executeCommandline

Description

Execute any commandline and wait for that process to complete

Returns

Boolean

Syntax

executeCommandline(commandLine, currentDirectory, outputLogFilePath, waitForProcess)

Parameters

Parameter name Data Type Optional Description

commandLine String No CommandLine string to execute

currentDirectory String No Path to current directory where this

outputLogFilePath String No Log file path, which will contain all the

waitForProcess Boolean No Boolean to allow waiting for that

process will be executed

stdout and error logs

process to complete execution

closeAllWindows

Description

Closes all active document windows in the RoboHelp application.

Syntax

closeAllWindows ()

Last updated 8/27/2012

ROBOHELP 10 SCRIPTING GUIDE

Classes

registerEvent

Description

User can register any function in a script file along with an event. Function will be called each time the event is triggered in RoboHelp

Returns

Boolean

Syntax

registerEvent(eventName, scriptFilePath, functionName)

Parameters

Parameter name Data Type Optional Description

eventName String No Name of Event

scriptFilePath String No Full path to the script file to execute

functionName String No Name of function defined in the script

file

unregisterEvent

Description

User can unregister any function in a script file along with an event

Returns

Boolean

Syntax

unregisterEvent(eventName, scriptFilePath, functionName)

Parameters

Parameter name Data Type Optional Description

eventName String No Name of Event

scriptFilePath String No Full path to the script file to execute

functionName String No Name of function defined in the script

file

isEventRegistered

Description

Checks whether the given function in a script file along with an event is already registered

Returns

Boolean

Last updated 8/27/2012

ROBOHELP 10 SCRIPTING GUIDE

Classes

Syntax

isEventRegistered(eventName, scriptFilePath, functionName)

Parameters

Parameter name Data Type Optional Description

eventName String No Name of Event

scriptFilePath String No Full path to the script file to execute

functionName String No Name of function defined in the script

file

Project

Main class for handling project-related activities.

Project properties

Property name Data type Description

name String Read-only

Project name

title String Read-only

Project title

path String Read-only

Full path to the project main folder

typename String Read-only

Class name of the reference object

language Language Read-write

Project language settings

TopicManager TopicManager Read-only

TopicManager object

MasterPageManager MasterPageManager Read-only

MasterPageManager object

SnippetManager SnippetManager Read-only

SnippetManager object

UDVManager UDVManager Read-only

UDVManager object

FileManager FileManager Read-only

FileManager object

TOCManager TOCManager Read-only

TOCManager object

Last updated 8/27/2012

ROBOHELP 10 SCRIPTING GUIDE

Classes

Property name Data type Description

IndexManager IndexManager Read-only

IndexManager object

GlossaryManager GlossaryManager Read-only

GlossaryManager object

SkinManager SkinManager Read-only

SkinManager object

CBTManager CBTManager Read-only

CBTManager object

SSLManager SSLManager Read-only

SSLManager object

FMFileManager FMFileManager Read-only

FMFileManager object

WordFileManager WorldFileManager Read-only

WordFileManager object

ReportManager ReportManager Read-only

ReportManager object

ServerManager ServerManager Read-only

ServerManager object

MapIdManager MapIdManager Read-only

MapIdManager object

HTMLHelpWindowManager HTMLHelpWindowManager Read-only

HTMLHelpWindowManager object

Project methods

importSettings

Description

Imports the settings file (*.isf) into the current project.

Returns

Boolean

Syntax

importSettings (settingsFilePath)

Last updated 8/27/2012

ROBOHELP 10 SCRIPTING GUIDE

Classes

Parameters

Parameter name Data type Optional Description

settingsFilePath String No Full path to the .isf settings file

exportSettings

Description

Exports the settings file (*.isf) from the current project.

Returns

Boolean

Syntax

exportSettings (settingsFilePath, overwriteFile)

Parameters

Parameter name Data type Optional Description

settingsFilePath String No Full path to the .isf settings file

overwriteFile Boolean Yes Flag to overwrite the existing file

The default value is true.

outputMessage

Description

Displays the message on the Output View pod.

Returns

Boolean

Syntax

outputMessage (message)

Parameters

Parameter name Data type Optional Description

message String No String message to display

rename

Description

Renames the current project.

Returns

Boolean

Last updated 8/27/2012

ROBOHELP 10 SCRIPTING GUIDE

Classes

Syntax

rename (newName)

Parameters

Parameter name Data type Optional Description

newName String No New name for the project

updateAll

Description

Updates all linked documents (FrameMaker documents and Word documents) in the project.

Returns

Boolean

Syntax

updateAll (flagForceUpdate)

Parameters

Parameter name Data type Optional Description

flagForceUpdate Boolean No Flag to force the update of all linked

documents

importDITAMap

Description

Imports a DITA map file into the project.

Returns

Boolean

Syntax

importDITAMap (projectName, DITAOTHomeDirectory, ditavalFile, topHeader, bodyHeader,

bodyFooter, xslFile, indexShow)

Parameters

Parameter name Data type Optional Description

projectName String No Full path to the DITA map file

DITAOTHomeDirectory String No Full path to the DITA Open Toolkit home

autoCreateBrowseSequence

Description

Creates browse sequences based on a specified TOC.

Returns

Boolean

Syntax

autoCreateBrowseSequence (TOC object, level)

Parameters

Parameter name Data type Optional Description

TOC object TOC Yes A TOC object on which the browse sequences

level Integer Yes Creates a separate sequence for each book

will be based. If not specified, the default TOC of the project is used.

down to this level. If not specified, the last set value is used.

importHtmlFile

Description

Imports an HTML file into the current project.

Returns

Boolean

Syntax

importHtmlFile (filePath,folderName)

Last updated 8/27/2012

ROBOHELP 10 SCRIPTING GUIDE

Classes

Parameters

Parameter name Data type Optional Description

filePath String No Absolute path of the HTML file to import

folderName String No Relative path of the folder in the current

project in which the HTML file is to be imported

importWordDoc

Description

Imports a Word document into the current project.

Returns

Boolean

Syntax

importWordDoc (filePath, folderName, TOCName, addIndexToTopic, indexName, glossaryName)

Parameters

Parameter name Data type Optional Description

filePath String No Absolute path of the Word document to

folderName String No Relative path of the folder in the current

import

project in which the Word document is to be imported

TOCName String No Name of the existing or new TOC for the

addIndexToTopic Boolean No Whether the index from the Word document

indexName String No If addIndexToTopic is false, this is the name

glossaryName String No Name of the existing or new glossary for the

imported Word document

is added to the imported topics or not

of the existing or new index for the imported Word document.

imported Word document

saveOutputViewLog

Description

Save Output View Pod logs to the given file

Returns

Boolean

Syntax

saveOutputViewLog(logFilePath)

Last updated 8/27/2012

ROBOHELP 10 SCRIPTING GUIDE

Classes

Parameters

Parameter name Data Type Optional Description

logFilePath String No File path to save the logs

clearOutputViewLog

Description

Clear the Output View Pod logs

Returns

Boolean

Syntax

clearOutputViewLog()

compileCHMFile

Description

Compile and generate CHM file

Returns

Boolean

Syntax

compileCHMFile(HHPfilePath)

Parameters

Parameter name Data Type Optional Description

HHPfilePath String No Absolute path of the HHP File, THis file is

used for CHM file compilation

saveAll

Description

Save all the unsaved items in the project and return true on success

Returns

Boolean

Syntax

saveAll(forceSave)

Last updated 8/27/2012

ROBOHELP 10 SCRIPTING GUIDE

Classes

Parameters

Parameter name Data Type Optional Description

forceSave Boolean Yes Flag to force save project

importFrameMakerDoc

Description

Imports a FrameMaker document into the current project.

Returns

Boolean

Syntax

importFrameMakerDoc (filePath, folderName, frameMakerTOCFilePath, TOCName, addIndexToTopic,

indexName, glossaryName)

Parameters

Parameter name Data type Optional Description

filePath String No Absolute path of the FrameMaker document

folderName String No Relative path of the folder the in the current

frameMakerTOCFilePath String No Absolute path of the FrameMaker TOC file for

TOCName String No Name of the existing or new TOC for the

addIndexToTopic Boolean No Whether the index from the FrameMaker

indexName String No If addIndexToTopic is false, this is the name

glossaryName String No Name of the existing or new glossary for the

to import

project in which the FrameMaker document is to be imported

the FrameMaker document to import

imported FrameMaker document

document is added to the imported topics or not

of the existing or new index for the imported FrameMaker document.

imported FrameMaker document

Token

Handles a specific token.

Last updated 8/27/2012

ROBOHELP 10 SCRIPTING GUIDE

Classes

Token properties

Property name Data type Description

parent TokenManager Read-only

Parent TokenManager object

name String Read-only

Text from the token object

typename String Read-only

Class name of the reference object

previous Token Read-only

Returns the previous token object

next Token Read-only

Returns the next object

tokenType Integer constant Read-only

Type of token

tagType Integer constant Read-only

Returns the type of tag if tokenType is TOKENTAG

attributeCount int In case of TOKENTAG, returns the number of

attributes present in the token

Token methods

update

Description

Updates the text of the token if tokenType is TOKENTEXT.

Returns

Boolean

Syntax

update (newText)

Parameters

Parameter name Data type Optional Description

newText String No New text string to update for the token

isEndTagofType

Description

In case of TOKENTAG, it returns true if the token is and end tag

Last updated 8/27/2012

ROBOHELP 10 SCRIPTING GUIDE

Classes

Returns

Boolean

Syntax

isEndTagofType(startTagType)

Parameters

Parameter name Data Type Optional Description

startTagType TagType No

getAttribute

Description

Returns the specific attribute value.

Returns

String

Syntax

getAttribute (attributeName)

Parameters

Parameter name Data type Optional Description

attributeName String No Name of the attribute

getAttributeName

Description

Returns the attribute name specified by the index

Returns

String

Syntax

getAttributeName(index)

Parameters

Parameter name Data Type Optional Description

index int No Index for the attribute Name (starts with

Last updated 8/27/2012

ROBOHELP 10 SCRIPTING GUIDE

Classes

hasAttribute

Description

In case of TOKENTAG, Returns true if the specific attribute is present in the token, otherwise false

Returns

Boolean

Syntax

hasAttribute(attributeName)

Parameters

Parameter name Data Type Optional Description

attributeName String No Name of the attribute

setAttribute

Description

Sets the specific attribute value.

Returns

Boolean

Syntax

setAttribute (attributeName, attributeValue)

Parameters

Parameter name Data type Optional Description

attributeName String No Name of the attribute

attributeValue String No Value of the attribute

removeAttribute

Description

Removes the specific attribute value.

Returns

Boolean

Syntax

removeAttribute (attributeName)

Last updated 8/27/2012

ROBOHELP 10 SCRIPTING GUIDE

Classes

Parameters

Parameter name Data type Optional Description

attributeName String No Name of the attribute

insertText

Description

Inserts a new text token before or after the specified token.

Returns

Boolean

Syntax

insertText (newText, afterCurrentTag)

Parameters

Parameter name Data type Optional Description

newText String No New text to insert

afterCurrentTag Boolean Yes Inserts a new text token before a specified

token

By default, the new token is inserted after the current tag.

delete

Description

Removes the token.

Returns

Boolean

Syntax

delete ()

TokenManager

Handles tokens for a specific file.

Last updated 8/27/2012

ROBOHELP 10 SCRIPTING GUIDE

Classes

TokenManager properties

Property name Data type Description

parent RoboHelp Read-only

RoboHelp application object

typename String Read-only

Class name of the reference object

count Integer Read-only

Number of tokens in the file

valid Boolean Read-only

Checks if the token file is valid or not

TokenManager methods

item

Description

Returns the token specified by the index.

Returns

Token

Syntax

item (index)

Parameters

Parameter name Data type Optional Description

index Integer No Index for the token

save

Description

Saves the specified token file.

Returns

Boolean

Syntax

save ()

Last updated 8/27/2012

ROBOHELP 10 SCRIPTING GUIDE

Classes

close

Description

Closes the specified token file and frees all the resources consumed by it.

Returns

Syntax

close()

Topic

Handles specific topic functions in the project.

Topic properties

Property name Data type Description

parent TopicManager Read-only

Parent TopicManager object

name String Read-write

Title of the topic file

filename String Read-only

Topic file name

typename String Read-only

Class name of the reference object

previous Topic Read-only

Returns the previous topic object

next Topic Read-only

Returns the next topic object

language Language Read-only

Language of the specified topic

status Status Read-only

Returns the status of the topic file

CBT String Read-write

List of CBTs applied on the topic

fileStatus FileStatus Read-only

Status of the file

valid Boolean Read-only

Returns true if the file is present physically

Last updated 8/27/2012

+ 86 hidden pages