Differences

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

--- manual:Editor_Window [2019/12/31 14:46]
JMichaelTX CHG numeric symbol locators
+++ manual:Editor_Window [2023/09/27 03:15]
peternlewis
@@ Line 5: / Line 5: @@
 You can create a new editor window by choosing the [[Menus#New_Editor_Window|File ➤ New Editor Window menu]].
-{{ editor-window-marked.png?nolink&937x553 | Editor Window }}
+===== Window Elements =====
-One the Group column 1️⃣ on the left, you have the a list of all your [[Smart_Groups|Smart Groups]] and [[Macro_Groups|Macro Groups]].  Smart Groups are saved searches of macros.
+{{ editor-window-marked.png?nolink&937x589 | Editor Window }}
-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️⃣.
+==== Main Elements ====
+  - **//Groups Column//** 1️⃣ (on the left)
+    * List of all of the [[Macro_Groups|Macro Groups]] and [[Smart_Groups|Smart Groups]] (shown at top) in your account.
+    * Smart Groups are saved searches of macros.
+  - **//Macros Column//** 2️⃣ (in the middle)
+    * List All of the [[Macros]] in the Selected [[Macro_Groups|Macro Group]].
+    * Macros are the primary way you describe what you want Keyboard Maestro to do.
+    * You can filter the list to find specific macros by using the Search Field (upper right corner).
+  - **_Details Column_** 3️⃣ (on the right)
+    - 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.
+      * Layout changes depending on which type is selected.
+    - **If a _Macro_ is selected**, shows the following elements:
+      - _Macro Name_
+      - _Enabled Checkbox_ ✅ (shown just before the text "Triggered by any of the following").
+        * Must be checked to enable your Macro to be triggered.
+      - _[[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.
+    - **If a _Macro Group_ is selected**, shows the following elements:
+      - _Macro Group Name_.
+      - _Enabled Checkbox_ ✅ (shown just before the text "Enable Macro Group").
+        * Must be checked to enable your Macro Group.
+        * 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.
-In the right column 3️⃣ you have a description of the selected macro.  When in Edit mode (which you can toggle with the BUTTON{{{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 (BUTTON{{{+}}}), delete (BUTTON{{{-}}}) or enable/disable (BUTTON{{{✓}}}) their respective groups, macros or actions.  There is an extra BUTTON{{{⊕}}} button at the far left to create a Smart Group.
+==== Toolbars ====
+  - **Toolbar at Bottom**
-Next to the BUTTON{{{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).
+    * Below each of the above columns are tools (buttons) to be used only for that column.
+    * See below for details
+  - **Toolbar at Top**
+    * At the top of the window are tools generally apply to all Macros.
+    * See below for details.
+===== Toolbar at Top =====
+{{:manual:km-editor-top-toolbar-km9.png?|}}\\
 Along the top of the window is the toolbar.  From left to right the buttons let you:
+  - **//Share//** 1️⃣ Share your Macros or Actions, including directly to the [[https://forum.keyboardmaestro.com/|Keyboard Maestro Forum]].
+  - **//Used//** 2️⃣ Select the most recently used (triggered) macros.
+  - **//History//** 3️⃣ Select from the recently edited macro history.
+  - **//Modified//** 4️⃣ Select the most recently edited macro.
+  - **//Run//** 5️⃣ Run the selected macro.
+  - **//Search//** 6️⃣ Search for Macros and Actions.
+    * 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.
+    * 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]].
+    * Tap a modifiers key to enter the corresponding modifier symbol.
+    * 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_.
+    * If any macros are filtered out, an entry will show at the bottom of the macro column list representing all the hidden macros.
-* Share your macros, including directly to the [[https://forum.keyboardmaestro.com/|Keyboard Maestro Forum]].
+===== Toolbar at Bottom =====
-* Select the most recently used (triggered) macros.
+{{:manual:km-editor-bottom-toolbar-km9.png|}}\\
-* Select from the recently edited macro history.
+Buttons:
-* Select the most recently edited macro.
+  - **Common Buttons** 2️⃣ at the bottom of each column \\ (Applies to Item in that column)
-* Run the selected macro.
+    - Create (BUTTON{{{+}}})
-* 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️⃣.
+    - Delete (BUTTON{{{-}}})
+    - Enable/disable (BUTTON{{{✓}}})
+  - **Groups Column Buttons**
+    - Create Smart Group BUTTON{{{⊕}}} 1️⃣
+  - **Details Column Buttons**
+    - Set Timeout for selected Action 3️⃣
+    - Toggle Edit Mode BUTTON{{{Edit}}} 4️⃣
+    - Try the selected actions BUTTON{{{Try}}} 5️⃣
+      - This is for testing _Actions_, NOT the entire Macro.
+      - To test the entire Macro, click the Run Button ▶️ in the Top Toolbar
+    - Start Macro Recording BUTTON{{{Record}}} 6️⃣
-When you are in Edit Mode, and you select a Smart Group, you can edit its search settings.
+===== Editing =====
+Edit mode may be toggled on/off by clicking the BUTTON{{{Edit}}} button on the Bottom Toolbar, or by selecting the menu  _View > Stop/Start Editing Macros_. Note that macros are saved immediately after every change (there is a small “dirty” marker in the bottom right corner of the editor window that shows when the save occurs). There is no need to ever turn off Edit mode, or do anything else to have your macro changes be recognised by the Keyboard Maestro Engine.
-{{ smart-group-marked.png?nolink&937x465 | Smart Group Editor }}
+==== Actions ====
-You can adjust the name of the Smart Group 1️⃣, and adjust its [[Search_Strings|Search Strings]] 2️⃣.
+**You can add a new action by any of the following:**
+  - Click the BUTTON{{{New Action}}} button.
+  - 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]].
+  - Press <kbd>⌘⌃A</kbd> to show a Insert Action By Name Popup.
+  - Choose from the [[Menus#Insert_Action|Edit ➤ Insert Action menu]].
-You can add another Search String by clicking the green BUTTON{{{+}}} button.
+==== Macros ====
-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, you can edit its behaviour.
-{{ macro-group-marked.png?nolink&937x584 | Macro Group 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.
+  - **//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.
-You can adjust the name of the Macro Group (1).
+==== Triggers ====
-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).
+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 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 add a trigger by clicking and holding on the green BUTTON{{{+}}} button and selecting the kind of trigger you would like to use.
-When you are in Edit Mode and you select a Macro, you can edit its behaviour.
+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).
-{{ macro-editor-marked.png?nolink&937x694 | Macro Editor }}
+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 “=-=”.
-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).
+When a macro is triggered, it will execute the actions 5️⃣.
-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]].
+==== Macro Groups ====
-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.
+When you are in Edit Mode, and you select a Macro Group, you can edit its configuration.
-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).
+{{ macro-group-marked.png?nolink&937 | Macro Group Editor }}
-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 “=-=”.
+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.
-When a macro is triggered, it will execute the actions you have entered in the Macro Detail Panel 3️⃣.
+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 add a new action by any of the following:**
+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️⃣.
-  - Click the BUTTON{{{New Action}}} button
-  - Click the BUTTON{{{+}}} button at the bottom of the Macro Detail Panel 3️⃣ to display the list of actions
+==== Smart Groups ====
-  - 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
+When you are in Edit Mode, and you select a Smart Group, you can edit its search settings.
-  - Choose from the [[Menus#Insert_Action|Edit ➤ Insert Action menu]]
+{{ 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 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.
-In the displayed macro, the action uses the [[token:SystemClipboard|%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.

Keyboard Maestro Wiki

User Tools

Site Tools

Differences

Page Tools