Keyboard Maestro Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Getting Help in Keyboard Maestro App ======

===== Purpose =====

Provide a guide to the various means of getting help directly from the Keyboard Maestro app.

===== Overview =====

There is a great deal of help available to you directly within the Keyboard Maestro app.\\
This includes:
  - Gear menu (options) on each Action
  - Help menu
  - Edit > Insert menu for:
    - Actions
    - Tokens
    - Functions

===== 1. Action Gear Menu =====

You can access the Wiki Article for the Action by clicking on the Gear (Options) Menu, then click on "Help":

{{:action-help-km-7.3.png?nolink|}}

===== 2. Help Menu =====

There is a great deal of help available from the Help menu. Some key areas are highlighted in this screenshot:

{{: help-menu-80.png?367;nolink|}}

Links from the Help Menu:
  * Search
  * [[User_Manual|User Manual (Documentation)]]
  * [[Quick_Start|Quick Start]]
  * [[Home_Page|Wiki]]
  * [[https://forum.keyboardmaestro.com/|Forum]]
  * Tutorial
  * [[#Assistance|Assistance]]
  * [ICU Date Format Reference](https://www.keyboardmaestro.com/action/linkthru?icudatetimereference)
  * [ICU Regular Expression Reference](https://www.keyboardmaestro.com/action/linkthru?regularexpressionreference)

If you search in the Help menu, it will display menu items that match, as well as links to the matching sections on the wiki.

The Tutorial will show you how to create a simple macro.

Assistance will help you if something is happening that you do not expect, Keyboard Maestro can show you what it is doing, or if a macro is not doing anything, Keyboard Maestro can help you to learn why.


===== 3. Edit > Insert Menu =====

To display the Wiki Help article for an Action, Token, or Function:
  - Goto the menu _**Edit > Insert Action**_ or _**Insert Token**_ or _**Insert Function**_
  - Mouse over a Category
  - Hold down the OPTION key
  - Click on the item of interest

For example, with Actions:

{{:edit-insert-action-help-km-7.3.png?nolink|}}


You can view the table of contents for each of these groups here:
  * [[Triggers|Triggers]]
  * [[Actions|Actions]]
  * [[Tokens|Tokens]]
  * [[Functions|Functions]]
  * [[Conditions|Conditions]]
  * [[Collections|Collections]]