Skip to main content
Skip table of contents

(v13) Conventions used in this manual

This page applies to Harlequin v13.1r0 and later; and to Harlequin MultiRIP but not Harlequin Core

All conventions are explained as they are first used. Here are some widely‚Äźused conventions.

Selectors

(v13) How the RIP communicates with a plugin explains how the RIP calls plugins with an argument called a selector , always starting with the form D_... It is simpler, however, to describe a call to the plugin with a particular selector among the arguments as calling that selector. Rather than saying:

The RIP calls the plugin with the selector D_INITIALISE ... It is easier to say this:

The RIP calls D_INITIALISE ...

Structure fields

In descriptions of structures used by plugins, each field is classified using the following letters, according to the type of access which can be made by the plugin and the RIP. These letters are shown on the right of the page, next to the name of the field.

R

The RIP reads from this field.

W

The RIP writes to this field.

r

The plugin reads from this field.

w

The plugin writes to this field.

N

The field is used by the RIP for internal purposes. The plugin can ignore it.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.