Difference between revisions of "Keyboard macros"
From Catalyst
m |
|||
| Line 1: | Line 1: | ||
{{Review}} | {{Review}} | ||
== Summary == | == Summary == | ||
| − | Platinum allows you record a set of keystrokes that can be played back at a later time. | + | Platinum allows you to record a set of keystrokes that can be played back at a later time. You should make a note of the point from which the macro starts since the keystrokes may only do what you intend from that point ! |
| − | + | There are a number of ways in which you can use this feature. There are a couple of examples detailed in this article. | |
| + | |||
| + | * You can run a time-consuming series of procedures without you being in attendance. Macros can be executed on Platinum Start-up allowing you to run (possibly time scheduled) a copy of Platinum to produce a report. Once the report is complete, Platinum can exit automatically. | ||
| + | * You can simplify certain functions that users need on a day-to-day basis. | ||
| + | Examples of this might include job descriptions in the workshop or fields that need to be filled in when you are creating a stock item. The possibilities are endless ! | ||
== More Information == | == More Information == | ||
=== Recording === | === Recording === | ||
| − | To record a macro start the macro manager ({{KeyPress|A-M}} or select it from the "Macros" -> "Macro Manager"). | + | To record a macro, start the macro manager ({{KeyPress|A-M}} or select it from the "Macros" -> "Macro Manager"). |
| + | * Press {{KeyPress|F6}} to create a new macro. | ||
* Enter the {{DataPrompt|Macro Sort Code:}} - Macros will be sorted on menus and the selection list in alphabetical order based on this. | * Enter the {{DataPrompt|Macro Sort Code:}} - Macros will be sorted on menus and the selection list in alphabetical order based on this. | ||
* The {{DataPrompt|Name:}} will be displayed on the menus. | * The {{DataPrompt|Name:}} will be displayed on the menus. | ||
| − | * You can now enter a simple {{DataPrompt|Description:}}. | + | * You can now enter a simple {{DataPrompt|Description:}}. Try to give some idea of what the macro is intending to do here, and from where it starts. |
* Now press {{KeyPress|F2}} to start recording the macro. | * Now press {{KeyPress|F2}} to start recording the macro. | ||
| + | * Carry out the process for which you want to use this macro. In other words, press the keys that actually do this process ! | ||
* To end the recording process press {{KeyPress|A-M}}. | * To end the recording process press {{KeyPress|A-M}}. | ||
{{Tip|title=Shortcuts|text= | {{Tip|title=Shortcuts|text= | ||
| − | Use the {{DataPrompt|Hot key Number:}} if you want to link the macro a hot key from the range {{KeyPress|A-0}} to {{KeyPress|A-9}}. | + | Use the {{DataPrompt|Hot key Number:}} if you want to link the macro to a "hot" key from the range {{KeyPress|A-0}} to {{KeyPress|A-9}}. }} |
| − | }} | ||
{{Tip|title=Menu Word Search|text= | {{Tip|title=Menu Word Search|text= | ||
Use the 'Menu Word Search' when selecting menus inside a macro. This will allow you to add/remove items from your menu without 'breaking' a macro. | Use the 'Menu Word Search' when selecting menus inside a macro. This will allow you to add/remove items from your menu without 'breaking' a macro. | ||
| − | *If you selected | + | * If you selected Option {{DataValue|20}} on a menu and you then make changes to that menu that changes the order of your menu, your macro would then select the wrong option! If you selected Option {{DataValue|20}} by typing the description of that menu option, the macro would always find it even if it moved to a different option number. |
}} | }} | ||
=== Editing === | === Editing === | ||
| − | You can edit the keystrokes | + | You can edit (or add to) the keystrokes in a macro by pressing {{KeyPress|F5}}. This is very useful if your macro is misbehaving! |
=== Playback === | === Playback === | ||
| Line 30: | Line 35: | ||
{{Warning|title=Care|text= | {{Warning|title=Care|text= | ||
| − | Care should be used to | + | Care should be used to execute a macro only from where the keystrokes will be correctly interpreted. |
}} | }} | ||
| Line 40: | Line 45: | ||
==== Menu Selection ==== | ==== Menu Selection ==== | ||
| − | + | Macros remember the program from which they were recorded and when you are in that program, the macro will appear on the "Macros" menu. | |
==== Menu Execution ==== | ==== Menu Execution ==== | ||
| − | If a macro was executed from a menu (to run a particular set of reports), you can with the "Custom Menus" | + | If a macro was executed from a menu (to run a particular set of reports), you can, with the "Custom Menus" programme, assign a macro to a [[Adding items to Custom Menus#Macros|custom menu]]. |
* The {{DataPrompt|Name:}} of the macro will be used for the menu text. | * The {{DataPrompt|Name:}} of the macro will be used for the menu text. | ||
* You will always be certain of playing a macro from where it was recorded. | * You will always be certain of playing a macro from where it was recorded. | ||
| Line 49: | Line 54: | ||
==== Auto Execution ==== | ==== Auto Execution ==== | ||
On the macro creation screen you can assign a {{DataPrompt|Auto Execute Code:}} and a {{DataPrompt|Auto Execute Menu:}} to allow your macro to be started from outside of Platinum. | On the macro creation screen you can assign a {{DataPrompt|Auto Execute Code:}} and a {{DataPrompt|Auto Execute Menu:}} to allow your macro to be started from outside of Platinum. | ||
| − | * Once you have assigned a {{DataPrompt|Auto Execute Code:}} and recorded your macro you can now use that code on a Platinum Start-up short-cut. | + | * Once you have assigned a {{DataPrompt|Auto Execute Code:}} and recorded your macro, you can now use that code on a Platinum Start-up short-cut. |
* Giving a {{DataPrompt|Auto Execute Menu:}} will always start your macro from that menu. | * Giving a {{DataPrompt|Auto Execute Menu:}} will always start your macro from that menu. | ||
| − | * Make sure you record your macro from the menu you want to start it running from and afterwards you will need to record the keystrokes that exit Platinum from | + | * Make sure you record your macro from the menu you want to start it running from and afterwards you will need to record the keystrokes that exit Platinum from there so your macro will exit automatically. |
== See also == | == See also == | ||
Revision as of 09:06, 22 August 2008
 |
This article or section is under review. Be aware: Content may change as the document is reviewed. |
Contents
Summary
Platinum allows you to record a set of keystrokes that can be played back at a later time. You should make a note of the point from which the macro starts since the keystrokes may only do what you intend from that point !
There are a number of ways in which you can use this feature. There are a couple of examples detailed in this article.
- You can run a time-consuming series of procedures without you being in attendance. Macros can be executed on Platinum Start-up allowing you to run (possibly time scheduled) a copy of Platinum to produce a report. Once the report is complete, Platinum can exit automatically.
- You can simplify certain functions that users need on a day-to-day basis.
Examples of this might include job descriptions in the workshop or fields that need to be filled in when you are creating a stock item. The possibilities are endless !
More Information
Recording
To record a macro, start the macro manager (<Alt+M> or select it from the "Macros" -> "Macro Manager").
- Press <F6> to create a new macro.
- Enter the "Macro Sort Code:" - Macros will be sorted on menus and the selection list in alphabetical order based on this.
- The "Name:" will be displayed on the menus.
- You can now enter a simple "Description:". Try to give some idea of what the macro is intending to do here, and from where it starts.
- Now press <F2> to start recording the macro.
- Carry out the process for which you want to use this macro. In other words, press the keys that actually do this process !
- To end the recording process press <Alt+M>.
 | Shortcuts: Use the "Hot key Number:" if you want to link the macro to a "hot" key from the range <Alt+0> to <Alt+9>. |
| Menu Word Search: Use the 'Menu Word Search' when selecting menus inside a macro. This will allow you to add/remove items from your menu without 'breaking' a macro.
|
Editing
You can edit (or add to) the keystrokes in a macro by pressing <F5>. This is very useful if your macro is misbehaving!
Playback
There are various ways to playback a recorded macro depending on how you want to use your macro.
 | Care: Care should be used to execute a macro only from where the keystrokes will be correctly interpreted. |
Hot Keys
If you have attached a hot key to your macro (You are allowed a maximum on 10 hot-key macros) you can start that macro by pressing the hot key (<Alt+0> -> <Alt+9>).
 | Example: You could use this type of macro to auto insert commonly typed text. It is sometimes desirable to have 'templates' in the "General Notes". A macro can be used to insert the text of this template and then be used to position the text at the first entry in that template. |
Menu Selection
Macros remember the program from which they were recorded and when you are in that program, the macro will appear on the "Macros" menu.
Menu Execution
If a macro was executed from a menu (to run a particular set of reports), you can, with the "Custom Menus" programme, assign a macro to a custom menu.
- The "Name:" of the macro will be used for the menu text.
- You will always be certain of playing a macro from where it was recorded.
Auto Execution
On the macro creation screen you can assign a "Auto Execute Code:" and a "Auto Execute Menu:" to allow your macro to be started from outside of Platinum.
- Once you have assigned a "Auto Execute Code:" and recorded your macro, you can now use that code on a Platinum Start-up short-cut.
- Giving a "Auto Execute Menu:" will always start your macro from that menu.
- Make sure you record your macro from the menu you want to start it running from and afterwards you will need to record the keystrokes that exit Platinum from there so your macro will exit automatically.
See also
