Writing Macros for the Editor

You may want to write an editor macro to customize aspects of the Editor window, and to automate lengthy or frequently used sequences of commands.

Macros are written using a combination of REXX commands and Editor commands and parameters. Macros used by the Editor, along with other example macros, can be found in the macros directory. You can use these system macros as a guide when creating your own macros, as follows:

1. Decide on a name for the macro, according to its purpose:
   • If the macro will be run when a specific event occurs, such as when the Editor window is started, or when a file is saved or loaded, use the naming conventions described in Macros and Profiles, and Using Profiles to Modify Editor Behavior.

     Note: A profile is a special type of macro.

   • If you are creating an ordinary macro that will be run using the Editor macro command, name the macro filename.lx, where filename can be any name except profile.
2. Create a new text file.
3. Place the commands you want to issue in the text file. The first line of the macro must start with a comment. Comments begin with /* and end with the */ symbols. Editor commands within the macro must be enclosed in single or double quotation marks. If you need to extract information from the Editor, use the extract command.
4. Save the file.
5. Ensure that the file is in a directory that is on your LPATH.

Note: Unless you issue a sshow command, the Editor does not refresh information displayed in the Editor window until after a macro finishes running.

See the repeats sample macro for a detailed example of how to create a macro.

Macros and Profiles Using Profiles to Modify Editor Behavior repeats sample macro