This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
manual:Editor_Window [2021/10/03 22:11] peternlewis [Editing] |
manual:Editor_Window [2023/09/27 03:15] peternlewis |
||
---|---|---|---|
Line 7: | Line 7: | ||
===== Window Elements ===== | ===== Window Elements ===== | ||
- | {{ editor-window-marked.png?nolink&937x553 | Editor Window }} | + | {{ editor-window-marked.png?nolink&937x589 | Editor Window }} |
==== Main Elements ==== | ==== Main Elements ==== | ||
Line 19: | Line 19: | ||
- **_Details Column_** 3️⃣ (on the right) | - **_Details Column_** 3️⃣ (on the right) | ||
- Display or Edit the details of the selected Macro, Macro Group, or Smart Group. | - Display or Edit the details of the selected Macro, Macro Group, or Smart Group. | ||
- | * This is where you enter the actual details of the selected Macro | + | * This is where you enter the actual details of the selected Macro. |
* Layout changes depending on which type is selected. | * Layout changes depending on which type is selected. | ||
- **If a _Macro_ is selected**, shows the following elements: | - **If a _Macro_ is selected**, shows the following elements: | ||
Line 25: | Line 25: | ||
- _Enabled Checkbox_ ✅ (shown just before the text "Triggered by any of the following"). | - _Enabled Checkbox_ ✅ (shown just before the text "Triggered by any of the following"). | ||
* Must be checked to enable your Macro to be triggered. | * Must be checked to enable your Macro to be triggered. | ||
- | - _[[Macro_Triggers|Trigger]] List_ (if any) that have been assigned to your Macro | + | - _[[Macro_Triggers|Trigger]] List_ (if any) that have been assigned to your Macro. |
- _[[:Actions|Action]] List_ -- the meat of your Macro that provides the processing steps to be performed. | - _[[:Actions|Action]] List_ -- the meat of your Macro that provides the processing steps to be performed. | ||
- **If a _Macro Group_ is selected**, shows the following elements: | - **If a _Macro Group_ is selected**, shows the following elements: | ||
- | - _Macro Group Name_ | + | - _Macro Group Name_. |
- _Enabled Checkbox_ ✅ (shown just before the text "Enable Macro Group"). | - _Enabled Checkbox_ ✅ (shown just before the text "Enable Macro Group"). | ||
* Must be checked to enable your Macro Group. | * Must be checked to enable your Macro Group. | ||
* If unchecked, none of the Macros in that Macro Group can be triggered. | * If unchecked, none of the Macros in that Macro Group can be triggered. | ||
+ | - You can resize the columns with the dividers 4️⃣, and double click on them to auto-resize the columns. | ||
+ | |||
==== Toolbars ==== | ==== Toolbars ==== | ||
Line 44: | Line 46: | ||
{{:manual:km-editor-top-toolbar-km9.png?|}}\\ | {{:manual:km-editor-top-toolbar-km9.png?|}}\\ | ||
Along the top of the window is the toolbar. From left to right the buttons let you: | Along the top of the window is the toolbar. From left to right the buttons let you: | ||
- | - BUTTON{{{Share}}} ⇪ -- Share your Macros or Actions, including directly to the [[https://forum.keyboardmaestro.com/|Keyboard Maestro Forum]]. | + | - **//Share//** 1️⃣ Share your Macros or Actions, including directly to the [[https://forum.keyboardmaestro.com/|Keyboard Maestro Forum]]. |
- | - BUTTON{{{Used}}} ⌘ Select the most recently used (triggered) macros. | + | - **//Used//** 2️⃣ Select the most recently used (triggered) macros. |
- | - BUTTON{{{History}}} ⬅️➡️ Select from the recently edited macro history. | + | - **//History//** 3️⃣ Select from the recently edited macro history. |
- | - BUTTON{{{Modified}}} ⏲️ Select the most recently edited macro. | + | - **//Modified//** 4️⃣ Select the most recently edited macro. |
- | - BUTTON{{{Run}}} ▶️ Run the selected macro. | + | - **//Run//** 5️⃣ Run the selected macro. |
- | - BUTTON{{{Search}}} 🔍 Search for Macros and Actions. | + | - **//Search//** 6️⃣ Search for Macros and Actions. |
* Press <kbd>⌘F</kbd> to search Macros only in the selected Macro Group. | * Press <kbd>⌘F</kbd> to search Macros only in the selected Macro Group. | ||
* Press <kbd>⌘⌥F</kbd> (or <kbd>⌘F</kbd> a second time) to search all Macros. | * Press <kbd>⌘⌥F</kbd> (or <kbd>⌘F</kbd> a second time) to search all Macros. | ||
* If you enter simple text, it will search for any text in any Action, or Macro Name, that contains that text. | * If you enter simple text, it will search for any text in any Action, or Macro Name, that contains that text. | ||
* To better restrict the Search, use [[:manual/Search_Strings|Search Qualifiers]]. | * To better restrict the Search, use [[:manual/Search_Strings|Search Qualifiers]]. | ||
+ | * Tap a modifiers key to enter the corresponding modifier symbol. | ||
* The _Macros Column_ will be filtered to only matching macros. | * The _Macros Column_ will be filtered to only matching macros. | ||
* Any parts of the macro that match will be highlighted in striped blue in the _Details Column_. | * Any parts of the macro that match will be highlighted in striped blue in the _Details Column_. | ||
+ | * If any macros are filtered out, an entry will show at the bottom of the macro column list representing all the hidden macros. | ||
===== Toolbar at Bottom ===== | ===== Toolbar at Bottom ===== | ||
Line 80: | Line 84: | ||
**You can add a new action by any of the following:** | **You can add a new action by any of the following:** | ||
- | - Click the BUTTON{{{New Action}}} button | + | - Click the BUTTON{{{New Action}}} button. |
- | - Click the BUTTON{{{+}}} button at the bottom of the _Details Column_ 3️⃣ to display the list of actions | + | - Click the BUTTON{{{+}}} button at the bottom of the _Details Column_ to display the list of actions. |
- | - Choose the [[Menus#Insert_Action_by_Name|Edit ➤ Insert Action By Name menu]] | + | - Choose the [[Menus#Insert_Action_by_Name|Edit ➤ Insert Action By Name menu]]. |
- | - Press <kbd>⌘⌃A</kbd> to show a Insert Action By Name Popup | + | - Press <kbd>⌘⌃A</kbd> to show a Insert Action By Name Popup. |
- | - Choose from the [[Menus#Insert_Action|Edit ➤ Insert Action menu]] | + | - Choose from the [[Menus#Insert_Action|Edit ➤ Insert Action menu]]. |
==== Macros ==== | ==== Macros ==== | ||
Line 91: | Line 95: | ||
{{ macro-editor-marked.png?nolink&937x694 | Macro Editor }} | {{ macro-editor-marked.png?nolink&937x694 | Macro Editor }} | ||
- | + | - **//Icon and Name//** 1️⃣ You can adjust the icon by double clicking the icon and selecting an image in the [[Icon Chooser]] and you can change the name of the Macro. | |
- | You can adjust the name of the Macro 3️⃣, and whether it is enabled 3️⃣ (a macro must be enabled for it to be available to be triggered (executed) - its parent macro group must also be enabled and active). | + | - **//Enabled//** 2️⃣ You can enable or disable the macro with this checkbox (a macro must be enabled for it to be available to be triggered (executed) - its parent macro group must also be enabled and active). |
+ | - **//Triggers//** 3️⃣ You can add [[Macro Triggers]] to the macro which control when the macro will run. | ||
+ | - **//Triggers//** 4️⃣ You can add more than one trigger to define different ways that you can start the macro. | ||
+ | - **//Actions//** 5️⃣ You then add one more [[Macro Actions]] which definite when the macro does when it runs. | ||
+ | - **//New Action//** 6️⃣ Click the New Action button to add additional actions. | ||
==== Triggers ==== | ==== Triggers ==== | ||
- | A macro consists of a set of triggers 3️⃣. When it is active, if any of these [[Macro_Triggers|triggers]] happen, then the macro executes the [[Macro_Actions|actions]]. | + | A macro consists of a set of triggers 3️⃣. When it is active (ie, when it is enabled, and its parent Macro Group is enabled and active), if any of these [[Macro_Triggers|triggers]] happen, then the macro executes the [[Macro_Actions|actions]]. |
- | You can add a trigger by clicking and holding on the green BUTTON{{{+}}} button and selecting the kind of trigger you would like to use. | + | You can add a trigger by clicking and holding on the green BUTTON{{{+}}} button and selecting the kind of trigger you would like to use. |
- | Some triggers, like the [[trigger:Status_Menu|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). | + | Some triggers, like the [[trigger:Status_Menu|Status Menu]] trigger 3️⃣, 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 [[trigger:Typed_String|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 “=-=”. | + | Other triggers, like the [[trigger:Typed_String|Typed String]] trigger 4️⃣, 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 entered in the Details Column 3️⃣. | + | When a macro is triggered, it will execute the actions 5️⃣. |
==== Macro Groups ==== | ==== Macro Groups ==== | ||
Line 110: | Line 118: | ||
When you are in Edit Mode, and you select a Macro Group, you can edit its configuration. | When you are in Edit Mode, and you select a Macro Group, you can edit its configuration. | ||
- | {{ macro-group-marked.png?nolink&937x584 | Macro Group Editor }} | + | {{ macro-group-marked.png?nolink&937 | Macro Group Editor }} |
- | You can adjust the name of the Macro Group (1). | + | You can adjust the icon by double clicking the icon 1️⃣ and selecting an image in the Icon Chooser and you can change the name of the Macro. |
- | 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). | + | For a Macro to be available to trigger, it must be enabled and its parent Macro Group must be enabled 2️⃣, 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). | + | 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️⃣ and whether and how the macro group displays in the menu bar 6️⃣. |
==== Smart Groups ==== | ==== Smart Groups ==== | ||
Line 122: | Line 130: | ||
When you are in Edit Mode, and you select a Smart Group, you can edit its search settings. | When you are in Edit Mode, and you select a Smart Group, you can edit its search settings. | ||
- | {{ smart-group-marked.png?nolink&937x465 | Smart Group Editor }} | + | {{ smart-group-marked.png?nolink&937x396 | Smart Group Editor }} |
You can adjust the name of the Smart Group 1️⃣, and adjust its [[Search_Strings|Search Strings]] 2️⃣. | You can adjust the name of the Smart Group 1️⃣, and adjust its [[Search_Strings|Search Strings]] 2️⃣. | ||
- | You can add another Search String by clicking the green BUTTON{{{+}}} button. | + | You can add another Search String by clicking the green BUTTON{{{+}}} button. Any macro that matches any of the search strings will be listed in the Macros column. |