User Tools

Site Tools


manual:Macros

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
manual:Macros [2017/09/03 22:58]
peternlewis [How to Import Macros]
manual:Macros [2019/07/27 05:14] (current)
peternlewis [Import Macros Safely]
Line 1: Line 1:
 ====== Macros ====== ====== Macros ======
  
-_**Macros**_ are used to automate your [[https://​en.wikipedia.org/​wiki/​Workflow | workflow]], procedure, or process on your Mac. Macros, also known as Shortcuts, are a way of improving your productivity by allowing you to perform repetitive or frequently required actions more quickly and accurately, tailoring your Mac to your usage patterns.+_**Macros**_ are used to automate your workflow, procedure, or process on your Mac. Macros, also known as Shortcuts, are a way of improving your productivity by allowing you to perform repetitive or frequently required actions more quickly and accurately, tailoring your Mac to your usage patterns.
  
 A _**Macro**_ consists of: A _**Macro**_ consists of:
Line 27: Line 27:
 You can create a new trigger by clicking on the green BUTTON{{{⊕}}} button. ​ There are several [[Macro Triggers]] to choose from, the most common being the [[trigger:​Hot_Key|Hot Key trigger]] which allows you to execute the Macro at the press of a key.  You can define several different triggers, and any of the triggers will execute the Macro~~Actions. ​ You can delete a trigger by clicking the red BUTTON{{{⊖}}} button. You can create a new trigger by clicking on the green BUTTON{{{⊕}}} button. ​ There are several [[Macro Triggers]] to choose from, the most common being the [[trigger:​Hot_Key|Hot Key trigger]] which allows you to execute the Macro at the press of a key.  You can define several different triggers, and any of the triggers will execute the Macro~~Actions. ​ You can delete a trigger by clicking the red BUTTON{{{⊖}}} button.
  
-You can add a new action by clicking the BUTTON{{{New Action}}} button or the BUTTON{{{+}}} button at the bottom of the macro detail view to display the list of actions or by choosing [[Menus#Edit_Insert_Action_by_Name|Insert Action By Name]] from the [[Menus#​Edit|Edit ​menu]] or choosing ​[[Menus#​Edit_Insert_Action|Insert Action]] ​from the [[Menus#Edit|Edit menu]]. ​ There are many [[Macro Actions]] to choose from.  The actions you include will be executed in order. ​ You can reorder the actions by dragging them around. ​ You can copy actions by Option-Dragging or by using Copy and Paste. ​ You can delete an action by selecting it and  pressing the Delete key.  You can enable or disable actions by selecting them and clicking the BUTTON{{{✓}}} button at the bottom of the macro detail view.+You can add a new action by clicking the BUTTON{{{New Action}}} button or the BUTTON{{{+}}} button at the bottom of the macro detail view to display the list of actions or by choosing ​the [[Menus#Insert_Action_by_Name|Edit ➤ Insert Action By Name menu]] or choosing from the [[Menus#Insert_Action|Edit ➤ Insert Action ​menu]]. ​ There are many [[Macro Actions]] to choose from.  The actions you include will be executed in order. ​ You can reorder the actions by dragging them around. ​ You can copy actions by Option-Dragging or by using Copy and Paste. ​ You can delete an action by selecting it and  pressing the Delete key.  You can enable or disable actions by selecting them and clicking the BUTTON{{{✓}}} button at the bottom of the macro detail view
 + 
 +You can control or right click on a macro group to Disable, Enable, Rename, Duplicate, or Export it.
  
 An easy way to generate macro actions is to turn on recording by clicking the BUTTON{{{Record}}} button at the bottom of the macro detail view and proceeding to show Keyboard~~Maestro what you want to do.  Then turn recording back off and look through the actions. ​ Chances are you will need to delete or adjust some of the recorded actions to make a robust macro, but this will be quicker than creating each action manually. An easy way to generate macro actions is to turn on recording by clicking the BUTTON{{{Record}}} button at the bottom of the macro detail view and proceeding to show Keyboard~~Maestro what you want to do.  Then turn recording back off and look through the actions. ​ Chances are you will need to delete or adjust some of the recorded actions to make a robust macro, but this will be quicker than creating each action manually.
Line 37: Line 39:
 You can share a macro to the Keyboard Maestro Forum, or to a friend via Mail or Messages using the sharing button at the top of the [[Windows#​Macros_Window|Macros window]]. You can share a macro to the Keyboard Maestro Forum, or to a friend via Mail or Messages using the sharing button at the top of the [[Windows#​Macros_Window|Macros window]].
  
-You can disable or enable a macro by selecting it and clicking the BUTTON{{{✓}}} button at the bottom of the Macros list.  You can also disable or enable a Macro using the Set Macro Enable action, or from AppleScript with:+You can disable or enable a macro by selecting it and clicking the BUTTON{{{✓}}} button at the bottom of the Macros list.  You can also disable or enable a Macro using the [[action:​Set_Macro_or_Group_Enable|Set Macro Enable]] action, or from AppleScript with:
  
 <code applescript>​ <code applescript>​
Line 54: Line 56:
  
 The Keyboard Maestro editor has full AppleScript support so you can manipulate macros in many ways via AppleScript. The Keyboard Maestro editor has full AppleScript support so you can manipulate macros in many ways via AppleScript.
- 
 ===== How to Edit a Macro ===== ===== How to Edit a Macro =====
  
 You edit a macro by selecting it and ensure you are in Edit mode.  Double clicking on the macro will turn on Edit mode. You edit a macro by selecting it and ensure you are in Edit mode.  Double clicking on the macro will turn on Edit mode.
  
-You can select a macro by name by choosing [[Menus#​Select_Macro_by_Name|Select Macro By Name]] from the [[Menus#​View|View ​menu]] ​+You can select a macro by name by choosing ​the [[Menus#​Select_Macro_by_Name|View ➤ Select Macro By Name menu]]
  
 ===== How to Run a Macro ===== ===== How to Run a Macro =====
  
-In order to run (execute or trigger) a macro must be active:+In order to run (execute or trigger) a macro it must be active, that is:
   * It is enabled   * It is enabled
   * It’s containing Macro Group is enabled   * It’s containing Macro Group is enabled
Line 72: Line 73:
 You can try out a macro from the Keyboard Maestro by clicking the BUTTON{{{▶︎}}} Run button at the top of the editor window. ​ Of course, macros are often sensitive to the context, so it may not be appropriate to run them directly from the editor. You can try out a macro from the Keyboard Maestro by clicking the BUTTON{{{▶︎}}} Run button at the top of the editor window. ​ Of course, macros are often sensitive to the context, so it may not be appropriate to run them directly from the editor.
  
-Generally, you run a macro by invoking one of its triggers.+Generally, you run a macro by invoking ​any one of its triggers.
  
-You execute a macro’s action sequence by invoking one of its Macro~~Triggers that you have defined (such as pressing a hot key if you have configured a hot key trigger). ​ For some triggers, no action is required on your part.  For example, the macro could be triggered at a specific time, or what a specific USB device is attached.+You execute a macro’s action sequence by invoking one of its Macro~~Triggers that you have defined (such as pressing a hot key if you have configured a hot key trigger). ​ For some triggers, no action is required on your part.  For example, the macro could be triggered at a specific time, or when a specific USB device is attached.
  
-You can also trigger macros by name using the [[/​action/​Trigger_Macro_by_Name|Trigger Macro by Name action]], which in turn can be in a macro and triggered any way you desire.+You can also trigger macros by name using the [[/​action/​Trigger_Macro_by_Name|Trigger Macro by Name]] ​action, which in turn can be in a macro and triggered any way you desire.
  
 You can trigger a macro using the kmtrigger: scheme with a URL like `kmtrigger://​macro=MacroName&​value=Value` (the value is accessible via the CODE{{{%TriggerValue%}}} Text~~Token). You can trigger a macro using the kmtrigger: scheme with a URL like `kmtrigger://​macro=MacroName&​value=Value` (the value is accessible via the CODE{{{%TriggerValue%}}} Text~~Token).
  
-If the web server is enabled for remote access, you can trigger a macro remotely after logging in using a web browser or the Keyboard Maestro Control iPhone application.+If the web server is enabled for remote access, you can trigger a macro remotely after logging in using a web browser or the Keyboard Maestro Control iPhone application.  Alternatively,​ you can use the [[trigger:​Remote|Remote]] trigger and trigger your macro using a URL from remotely via our trigger server.
  
 You can also trigger a macro using AppleScript or another scripting language (select the “Or by script” entry to display script code in various languages such as AppleScript or Perl). You can also trigger a macro using AppleScript or another scripting language (select the “Or by script” entry to display script code in various languages such as AppleScript or Perl).
Line 92: Line 93:
 You may use any of the following to import the macro file (`.kmmacros`):​ You may use any of the following to import the macro file (`.kmmacros`):​
   * Double-click on the macro file in the Mac Finder.   * Double-click on the macro file in the Mac Finder.
-  * In the Keyboard Maestro app, goto _File > Import Macros..._ and select the macro file.+  * In the Keyboard Maestro app, goto _File > Import Macros ​Safely..._ and select the macro file.
   * In some browsers, click on the downloaded file icon at the bottom of the browser window.   * In some browsers, click on the downloaded file icon at the bottom of the browser window.
  
 :!: Note that the macro file (`.kmmacros`) may contain one or more macros, and will also create the Macro Group if it does _not_ exist in your configuration. ​ Otherwise, it will put the Macro in your existing Macro Group. :!: Note that the macro file (`.kmmacros`) may contain one or more macros, and will also create the Macro Group if it does _not_ exist in your configuration. ​ Otherwise, it will put the Macro in your existing Macro Group.
- 
 ==== Import Macros Safely ==== ==== Import Macros Safely ====
  
-(!) You should be aware that the macros will be imported in the same state, triggers, and macro group that they were saved in.  By default, macros are imported disabled unless you hold the Option key down.  **This could result in the imported Macro being triggered (executed) as soon as it is imported.** ​ If you are at all uncertain about the source of the macros, ensure you import the macros disabled or hold choose ​choose [[Menus#File_Import_Macros_Disabled|Import Macros ​Disabled]] from the [[Menus#​File|File ​menu]].+(!) You should be aware that the macros will be imported in the same state, triggers, and macro group that they were saved in.  By default, macros are imported disabled unless you hold the Option key down.  ​Importing them disabled is important, because otherwise ​**this could result in the imported Macro being triggered (executed) as soon as it is imported.** ​ If you are at all uncertain about the source of the macros, ensure you import the macros disabled or choose ​the [[Menus#Import_Macros_Safely|File ➤ Import Macros ​Safely ​menu]].
  
 See also the [[Macro Groups]], [[Macro Actions]], [[Macro Triggers]], [[:​Macro_Activation]],​ [[Macro Examples]], [[Macro Library]] and [[Recording]] sections. See also the [[Macro Groups]], [[Macro Actions]], [[Macro Triggers]], [[:​Macro_Activation]],​ [[Macro Examples]], [[Macro Library]] and [[Recording]] sections.
manual/Macros.1504493931.txt.gz · Last modified: 2017/09/03 22:58 by peternlewis