Chapter 1: Overview
A script is a series of commands that instructs Adobe® FrameMaker® to perform a set of specified actions. Scripts
automate repetitive tasks, such as counting the images in a book or adding an indent to all the para tags in a file. Use
scripts as a creative tool to streamline time-consuming tasks.
If you are new to scripting, you can acquaint yourself with the basic scripting concepts provided in the
to Scripting
manual.
About this document
Naming conventions
To help you identify the structures, constants, and functions defined by the ESTK, this document adheres to the
following naming conventions:
Type
API error codes
API functions
API scriptable function property
names
Flags used by API functions
Initialization constants
Notification constants
Object types
Property value constants
Typographic conventions
Notice the use of different fonts to represent different types of information:
• What you type is shown in text like this.
• Function names, property names, structure names, returned values, constants, filter names, program names, paths,
and filenames are also shown in
Naming Convention
Prefix:
Constants.FE
Suffix: Error number in parentheses
Suffix: ()
Prefix:
Constants.FS_
Suffix: Enumerated value in parentheses
Prefix:
Constants.FF_
Suffix: Enumerated value in parentheses
Prefix:
Constants.FA_Init
Suffix: Enumerated value in parentheses
Prefix:
Constants.FA_Note
Prefix:
Constants.FO_
Suffix: Enumerated value in parentheses
Prefix:
Constants.FV_
Suffix: Enumerated value in parentheses
.
text like this
Last updated 9/26/2011
Example
Constants.FE_BadName(-33)
UpdateTextInset()
Constants.FS_ForceImportAsText (17)
Constants.FF_UFF_VAR()
Constants.FA_Init_First (1)
Constants.FA_Note_PreFileType (9)
Constants.FO_Doc (4)
Constants.FV_Doc_Type_MIF (0x03)
1
Introduction