Differences

This shows you the differences between two versions of the page.

--- Home_Page [2016/07/18 15:37]
JMichaelTX ADD shortcut key for search
+++ Home_Page [2023/09/05 00:20]
peternlewis [Using Search]
@@ Line 1: / Line 1: @@
-{{:wiki-icon.png?nolink |}}
+====== Official Keyboard Maestro Wiki ======
-====== Welcome to the Official Keyboard Maestro Wiki ======
-Welcome to the Keyboard Maestro Wiki, a community site for Keyboard Maestro users.  Keyboard Maestro is a powerful macro program for Mac OS X, and this wiki aims to encourage wider and deeper use of Keyboard Maestro by allowing users to expand on the documentation, share tips and macros, explain actions and their uses, ease the transition from other macro programs, and more.
+**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 [[manual:Quick_Start|Quick Start]].
-===== Topics Listed Here =====
-   * This is a list of some of the topics available on this wiki.
+**Key Terms**:
-   * We hope the topics below help you to get started, and to quickly find the most frequently used topics.
+  * "_**[[manual:Macros|Macro]]**_" -- Define an automation or workflow.
+  * "_**[[manual:Macro_Groups|Macro Groups]]**_" -- Contain Macros and control when they are available.
+  * "_**[[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.
+  * For a complete list, see [[manual:Glossary]]
-===== Using Search =====
+===== Purpose =====
-   * However, Search is a more powerful tool to find the topic/subject of interest
+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.  A search of this Wiki will include the [[User Manual]]. Also note that in the editor 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.
-   * **Please use the [[Search]] box the top right to find more detailed topics not listed below.**
-   * **Tip:**  Add an asterisk (*) to the end of a keyword to find both singular and plural forms of the word.
-   * Shortcut Key for Search Box:  <key>⌃</key><key>⌥</key><key>F</key>
+===== Scope =====
-The wiki reflects the most recent version of Keyboard Maestro, usually with notes to indicate when something applies only to recent versions.
+==== Keyboard Maestro App/Editor ====
-The official Keyboard Maestro [[User Manual]] for the current version is now on the wiki.
+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 =====
+The wiki reflects the most recent version of Keyboard Maestro, usually with notes to indicate when something applies only to recent versions.  The official Keyboard Maestro [[User Manual]] for the current version is also on the wiki.  If you do not immediately see the appropriate topic, try [[#Using_Search|searching the wiki]].
 ^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]] \\  • [[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]] \\  • [[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]] \\ • [[Tips]] \\ • [[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 =====
-You can also use the search field in the upper right corner.  When searching, note that the search differentiates between plurals (eg //operator// will not find //operators// and vice-versa), but you can use | for options (eg //operator|operators|operating//) or globbing (eg //operator*//).
+   * Search is a powerful tool to find the topic/subject of interest.
+   * **Please use the [[Search]] box at the top right of every page to find topics (and sub-topics) not listed here.**
+   * **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 more details, see [[Search|Searching the Wiki]].
-===== Becoming a Wiki Editor =====
+===== Wiki Editing =====
+==== How To Become an Editor ====
 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)!
+==== Markdown Syntax ====
+For details on how to format a wiki page and on keyboard shortcuts, see:\\
+[[wiki:syntax|Markdown Syntax for Wiki]]
+==== Style Guidelines ====
+In order to ensure consistent styling/formatting throughout the wiki, we have established these guidelines on styling, see:\\
+[[Style_Guide|]]

Keyboard Maestro Wiki

User Tools

Site Tools

Differences

Page Tools