User Tools

Site Tools


manual:Editor_Window

Editor Window

To edit your macros, launch the Keyboard Maestro application. It will display one or more Editor Windows. If you close the last editor window, the Keyboard Maestro application will quit, but the Keyboard Maestro Engine will continue running to perform your macros. Normally you only launch the Keyboard Maestro editor application when you want to change your macros, and leave only the Keyboard Maestro Engine running normally.

You can create a new editor window by choosing the File ➤ New Editor Window menu.

 Editor Window

One the Group column (1) on the left, you have the a list of all your Smart Groups and Macro Groups. Smart Groups are saved searches of macros.

In the Macro column (2) in the middle are the Macros. Macros are the primary way you describe what you want Keyboard Maestro to do. This column will list all the macros matched by any selected Smart Groups, and all the macros contained by any selected Macro Groups. You can filter the list to find specific macros by using the Search Field (3).

In the right column (3) you have a description of the selected macro. When in Edit mode (which you can toggle with the Edit button (5)), this is where you will edit your Smart Group searches, your Macro Group configurations, and your Macros.

At the bottom of each column (4) it a set of buttons to create (+), delete (-) or enable/disable () their respective groups, macros or actions. There is an extra button at the far left to create a Smart Group.

Next to the Edit button (5) are buttons to set a timeout for a specific action, to try the selected actions, and the enter recording mode to add new actions by recording what you are doing (moving and clicking the mouse, selecting menus, moving and resizing windows, typing characters, etc).

Along the top of the window is the toolbar. From left to right the buttons let you:

  • Share your macros, including directly to the Keyboard Maestro Forum.
  • Select the most recently used (triggered) macros.
  • Select from the recently edited macro history.
  • Select the most recently edited macro.
  • Run the selected macro.
  • Search for macros. The Macros column (2) will be filtered to only matching macros, and any parts of the macro that match will be highlighted in striped blue in the detail column (3).

When you are in Edit Mode, and you select a Smart Group, you can edit its search settings.

 Smart Group Editor

You can adjust the name of the Smart Group (1), and adjust its Search Strings (2).

You can add another Search String by clicking the green + button.

When you are in Edit Mode, and you select a Macro Group, you can edit its configuration.

 Macro Group Editor

You can adjust the name of the Macro Group (1).

For a Macro to be available to trigger, it must be enabled and its parent Macro Group must be enabled, and active. The configurations for the Macro Group control when it will be active, and thus when the macros it contains will be active (available to be triggered and executed).

You can adjust whether the macro group is enabled (2), whether it is only active in some specific applications (3) (ie, when they are at the front, and their menu bar is showing), whether it is only active in specific windows (4), whether it is only active when you explicitly toggle it on or off, and whether and how it shows a palette containing its macros (5).

When you are in Edit Mode and you select a Macro, you can edit its behaviour.

 Macro Editor

You can adjust the name of the Macro (1), and whether it is enabled (2) (a macro must be enabled for it to be available to be triggered (executed) - its parent macro group must also be enabled and active).

A macro consists of a set of triggers (3). When it is active, if any of these triggers happen, then the macro executes the actions (5).

You can add a trigger by clicking and holding on the green + button (4) and selecting the kind of trigger you would like to use.
Some triggers, like the Status Menu trigger, do not have any additional configuration. Simply adding them to the macro will have macro triggered when the event happens (in this case, the macro will be listed in the Keyboard Maestro status menu, and will be triggered if you choose it from that menu).

Other triggers, like the Typed String trigger, require you to configure more details about when the trigger should happen, such as the specific string you have to type to trigger the macro. For the macro shown, the macro will be triggered when you type the string “=-=”.

When a macro is triggered, it will execute the actions you have specified (5).

You can add a new action by clicking the New Action button or the + button at the bottom of the macro detail view (6) to display the list of actions or by choosing the Edit ➤ Insert Action By Name menu or choosing from the Edit ➤ Insert Action menu.

In the displayed macro, the action uses the %SystemClipboard% token to read the system clipboard, and will then insert it by typing (rather than the normal pasting for the System Clipboard). This can be useful for cases where you are disallowed from pasting for some reason.

manual/Editor_Window.txt · Last modified: 2019/06/21 02:06 by peternlewis