User Tools
Home_Page
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
Home_Page [2017/08/31 03:35] peternlewis [Topics] |
Home_Page [2023/10/10 03:14] (current) peternlewis [Topics] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== Official Keyboard Maestro Wiki ====== | ====== Official Keyboard Maestro Wiki ====== | ||
| - | **Welcome to the Keyboard Maestro Wiki**, a [[https://www.dokuwiki.org/dokuwiki# | wiki]] designed just for Keyboard Maestro users of all levels of expertise and experience. Keyboard Maestro is a powerful [[https://computers.tutsplus.com/tutorials/how-to-choose-the-right-tools-to-automate-the-mac--cms-25531 | automation tool for macOS]] which uses [[manual:Macros|Macros]] to automate your [[https://en.wikipedia.org/wiki/Workflow | workflows]]. **If you are relatively new to Keyboard Maestro, and need help**, then you may want to just jump to [[manual:Quick_Start]]. | + | **Welcome to the Keyboard Maestro Wiki**, a wiki designed for Keyboard Maestro users of all levels of expertise and experience. Keyboard Maestro is a powerful automation tool for macOS which uses [[manual:Macros|Macros]] to automate your workflow. **If you are relatively new to Keyboard Maestro, and need help**, then you may want to just jump to the [[manual:Quick_Start|Quick Start]] or you may want to read the [[/User_Manual|User Manual]]. |
| **Key Terms**: | **Key Terms**: | ||
| - | * "_**[[manual:Macros|Macro]]**_" -- [[https://en.wikipedia.org/wiki/Workflow | Workflow]], Procedure, or Process | + | * “_**[[manual:Macros|Macro]]**_” -- Define an automation or workflow. |
| - | * "_**[[Actions|Action]]**_" -- Steps in the Workflow (etc) | + | * “_**[[manual:Macro_Groups|Macro Groups]]**_” -- Contain Macros and control when they are available. |
| - | * "_**[[Triggers|Trigger]]**_" -- The (user) event that causes a macro to be executed (eg, a hot key) | + | * “_**[[manual:Macro_Triggers|Triggers]]**_” -- Describe the event that causes a macro to be executed (eg, a hot key). |
| + | * “_**[[manual:Macro_Actions|Actions]]**_” -- Describe what the macro does at each step. | ||
| + | * “Keyboard Maestro Engine” -- the engine that runs all the time and executes your macros. | ||
| + | * “Keyboard Maestro” -- the application as a whole, and the editor for your Macros. | ||
| + | * For a complete list, see [[manual:Glossary]] | ||
| ===== Purpose ===== | ===== Purpose ===== | ||
| - | This wiki aims to help new users get started, and then provide wider and deeper understanding of Keyboard Maestro by explaining how to create and use //Macros// and //Actions// in detail, usually with examples and references. We want to help you get started quickly, and then learn how to take full advantage of Keyboard Maestro. Note that now the [[User Manual]] is actually part of this Wiki. A search of this Wiki will include the [[User Manual]]. | + | This wiki aims to help new users get started, and then provide wider and deeper understanding of Keyboard Maestro by explaining how to create and use //Macros// and //Actions// in detail, with references and examples. We want to help you get started quickly, and then learn how to take full advantage of Keyboard Maestro. Note that the [[User Manual]] is actually part of this Wiki so a search of this Wiki will include the [[User Manual]]. Also note that in the editor you can search in the Help menu and it will include references to this wiki, and you can select Help from the gear ⚙ menu in each action and it will take you directly to the wiki reference for that action. When adding Triggers (or Tokens or other things), holding the option key down while selecting the item will similarly take you directly to the help on that thing. |
| - | ===== Scope ===== | + | This Wiki mostly provides information about using the **Keyboard Maestro** editor. This is the application that you use to create and manage your Keyboard Maestro [[manual:Macros|Macros]], and [[Macro_Groups|Macro Groups]]. Separate from the Keyboard Maestro app, is the **Keyboard Maestro Engine**, which is normally always running in the background. The Engine detects and processes your Macro triggers, whether or not the Keyboard Maestro editor itself is running. |
| - | ==== Keyboard Maestro App/Editor ==== | ||
| - | |||
| - | This Wiki mostly provides information about using the **Keyboard Maestro.app**, or as it is sometimes called, the "**Keyboard Maestro Editor**". This is the application that you use to create and manage your Keyboard Maestro [[manual:Macros|Macros]], and [[Macro_Groups|Macro Groups]]. Separate from the Keyboard Maestro app, is the **Keyboard Maestro Engine**, which is normally always running in the background. It is the software that detects and processes your Macro triggers, whether or not the Keyboard Maestro.app is running. | ||
| - | ==== Accessing Macros and Variables from Other Tools ==== | ||
| - | |||
| - | The Wiki also includes how to access your Macros and Keyboard Maestro Variables from other tools, like [[Scripting|scripts]], [[trigger:URL|custom URL scheme]], and the [[trigger:Web_Server|Keyboard Maestro Web Server]]. | ||
| - | |||
| - | ==== Responds to Help Requests from the Keyboard Maestro App ==== | ||
| - | |||
| - | This Wiki will respond to a "help" request make from an Action in the Keyboard Maestro.app. For details see [[Getting Help in the Keyboard Maestro app]]. | ||
| - | | ||
| ===== Topics ===== | ===== Topics ===== | ||
| Line 29: | Line 23: | ||
| ^Special Topics^Standard Topics^ | ^Special Topics^Standard Topics^ | ||
| - | | • [[About Keyboard Maestro]] \\ • [[Applications]] \\ • [[External Links]] \\ • [[Forum]] \\ • [[Frequently Asked Questions|Frequently Asked Questions (FAQ)]] \\ • [[Getting Started]] \\ • [[manual:Glossary]] \\ • [[Ideas]] \\ • [[manual:Quick Start]] \\ • [[Searching For Answers]] \\ • [[Scripting the Keyboard Maestro editor]] \\ • [[Search|Searching the Wiki]] \\ • [[Syncing Macros Between Macs]] \\ • [[Tips]] \\ • [[Transition]] from other programs or versions \\ • [[Transition From QuicKeys]] \\ • [[Troubleshooting]] \\ • [[User Manual]] \\ • [[Videos]] \\ • [[Wishlist]] \\ • [[WhatsNew]]| • [[Actions]] \\ • [[manual:Calculations]] \\ • [[Clipboards]] \\ • [[Collections]] \\ • [[Conditions]] \\ • [[Dates and Times]] \\ • [[Functions]] \\ • [[manual:Macros]] \\ • [[Macro Groups]] \\ • [[Macro Library]] (example macros) \\ • [[Regular Expressions]] \\ • [[Scripting]] \\ • [[Status Menu]] \\ • [[Text Fields]] \\ • [[Tokens]] \\ • [[Triggers]] \\ • [[Variables]]| | + | | • [[About Keyboard Maestro]] \\ • [[Applications]] \\ • [[External Links]] \\ • [[Forum]] \\ • [[Frequently Asked Questions|Frequently Asked Questions (FAQ)]] \\ • [[Getting Started]] \\ • [[manual:Glossary]] \\ • [[Ideas]] \\ • [[manual:Quick Start]] \\ • [[Scripting the Keyboard Maestro editor]] \\ • [[Search|Searching the Wiki]] \\ • [[Syncing Macros Between Macs]] \\ • [[Transition]] from other programs or versions \\ • [[Transition From QuicKeys]] \\ • [[Troubleshooting]] \\ • [[User Manual]] \\ • [[Videos]] \\ • [[Wishlist]] \\ • [[WhatsNew]]| • [[Actions]] \\ • [[manual:Calculations|Calculations & Operators]] \\ • [[Clipboards]] \\ • [[Collections]] \\ • [[Conditions]] \\ • [[Dates and Times]] \\ • [[manual:Dictionaries]] \\ • [[Functions]] \\ • [[manual:Macros]] \\ • [[Macro Groups]] \\ • [[Macro Library]] (example macros) \\ • [[Regular Expressions]] \\ • [[Scripting]] \\ • [[Shortcut Actions]] \\ • [[Status Menu]]\\ • [[Subroutines]] \\ • [[Text Fields]] \\ • [[Tokens]] \\ • [[Triggers]] \\ • [[manual:Variables]]| |
| ===== Using Search ===== | ===== Using Search ===== | ||
| Line 36: | Line 30: | ||
| * **Tip:** Add an asterisk (\*) to the end of a keyword to find both singular and plural forms of the word. | * **Tip:** Add an asterisk (\*) to the end of a keyword to find both singular and plural forms of the word. | ||
| * For example, `operator*` will find both `operator` and `operators` (without this, the wiki search will not find both unless you search for either `operator*` or `operator|operators`). | * For example, `operator*` will find both `operator` and `operators` (without this, the wiki search will not find both unless you search for either `operator*` or `operator|operators`). | ||
| - | * Shortcut Key for Search Box: <key>⌃</key><key>⌥</key><key>F</key> | + | * For more details, see [[Search|Searching the Wiki]]. |
| - | * For more details, see [[Search|Searching the Wiki]] | + | |
| + | |||
| + | ===== Wiki Editing ===== | ||
| + | |||
| + | You do not need any account to view this wiki. However to edit it, you do need an account, which are manually created as needed. If you spot a typo, just [[mailto:support@stairways.com|email us]] with the details and we will get it fixed. | ||
| + | |||
| + | If you are interested in doing more on the wiki, we would love to have real users editing these wiki pages, so if you would like an account to help add to the documentation about Keyboard Maestro, please [email us](mailto:support@stairways.com)! | ||
| + | For details on how to format a wiki page and on keyboard shortcuts, see [[wiki:syntax|Markdown Syntax for Wiki]]. | ||
| - | ===== Becoming a Wiki Editor ===== | + | In order to ensure consistent styling/formatting throughout the wiki, we have established these guidelines on styling, see: [[Style_Guide|Style Guide]]. |
| - | We would love to have real users editing these wiki pages, so if you would like an account to help add to the documentation about Keyboard Maestro, please [email us](mailto:support@stairways.com)! | ||
Home_Page.1504164910.txt.gz · Last modified: 2017/08/31 03:35 by peternlewis
Page Tools
