home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 11 Util / 11-Util.zip / kbdplus.zip / Macros.hlp (.txt) < prev    next >
OS/2 Help File  |  1998-04-22  |  34KB  |  937 lines

  1.  
  2. ΓòÉΓòÉΓòÉ 1. Introduction ΓòÉΓòÉΓòÉ
  3.  
  4. Keyboard Plus provides extensive macro support for OS/2 Warp: 
  5.  
  6.      Insert pieces of text by typing a hotkey, including the current date or 
  7.       time, or the output from a program 
  8.  
  9.      Run programs or open objects by typing a hotkey 
  10.  
  11.      Make use of the Windows 95 keys on your keyboard 
  12.  
  13.      Define accelerator keys for applications which lack them 
  14.  
  15.      Set up application-specific macros using macrosets 
  16.  
  17.  The best way to get to grips with Keyboard Plus is to fiddle with the program, 
  18.  asking for help (press F1 or press a Help button) to find out more. There is a 
  19.  tutorial which will take you through the steps to creating a new macro which 
  20.  uses a custom function. 
  21.  
  22.  Choose one of the following topics for further information: 
  23.  
  24.      Limitations 
  25.      Frequently asked questions 
  26.      Support 
  27.  
  28.  You can get back to this page by choosing General Help from a help menu. 
  29.  
  30.  
  31. ΓòÉΓòÉΓòÉ 2. Frequently asked questions ΓòÉΓòÉΓòÉ
  32.  
  33.    1. How can I prune the log file? 
  34.       Delete the file "Macros.log" from the Keyboard Plus program directory. 
  35.  
  36.    2. When I press the Record button in the macro dialog, nothing happens. 
  37.       Delete the file "MacroRec.dat" from the Keyboard Plus program directory. 
  38.  
  39.    3. How can I change the colours? 
  40.       Use the OS/2 Scheme Palette, in the System Setup folder. When you shut 
  41.       down Keyboard Plus, the colours (and fonts too, while we're on the 
  42.       subject) will get saved. 
  43.  
  44.    4. I can't run more than one copy of the program at a time. 
  45.       Correct. That's a feature, that is. Why do you want to run more than one 
  46.       copy of the program at a time? 
  47.  
  48.    5. Why are there so many Keyboard Plus executables? 
  49.       That's just the way it came out... 
  50.  
  51.    6. How do I report a bug? 
  52.       See Support 
  53.  
  54.  
  55. ΓòÉΓòÉΓòÉ 3. Support ΓòÉΓòÉΓòÉ
  56.  
  57. This is free software, so I can make no guarantees! 
  58.  
  59. That said, if you find a bug, want to translate it to another language, or 
  60. (horror of horrors) like Keyboard Plus, please send me mail at 
  61. <john_fairhurst@iname.com> - in particular I'd be interested in uses people 
  62. have found for the program and extra features they might like to see. 
  63.  
  64. Application source code (C++, some C) is available on request. 
  65.  
  66.  
  67. ΓòÉΓòÉΓòÉ 4. Limitations ΓòÉΓòÉΓòÉ
  68.  
  69. Or, if you prefer, Bugs... 
  70.  
  71.      VIO (Eg. OS/2 windows) support is flakey - printable characters seem to 
  72.       work. 
  73.  
  74.      Keyboard Plus is not MBCS aware. 
  75.  
  76.      Recursive macro execution isn't allowed. 
  77.  
  78.      Exported things don't show up until you do a refresh. This appears to be 
  79.       a problem with my end of the source-rendering protocol (any hints 
  80.       gratefully received!) 
  81.  
  82.  
  83. ΓòÉΓòÉΓòÉ 5. Using Windows 95 keys ΓòÉΓòÉΓòÉ
  84.  
  85. You can use Keyboard Plus to make those three keys do things. Just define some 
  86. macros with the Windows 95 keys as the hotkey, and whatever you want as the 
  87. value - for example, to set the keys up to work as they do in Windows 95 (more 
  88. or less), set up the following in the global macroset: 
  89.  
  90.  
  91.       Hotkey         LH-Win95 
  92.       Value          Ctrl+Esc 
  93.  
  94.       Hotkey         RH-Win95 
  95.       Value          Ctrl+Esc 
  96.  
  97.       Hotkey         Win95-menu 
  98.       Value          Shift+F10 
  99.  
  100.  Now you can display the window list by pressing either key, or display any 
  101.  context menu for the currently selected thing by pressing the menu key. 
  102.  
  103.  
  104. ΓòÉΓòÉΓòÉ 6. Inserting the current date or time ΓòÉΓòÉΓòÉ
  105.  
  106. You can use Keyboard Plus to insert the time into a document using a built-in 
  107. function. Define a couple of macros in the global macroset: 
  108.  
  109.  
  110.       Hotkey         Ctrl+Shift+D 
  111.       Value          #DATE 
  112.  
  113.       Hotkey         Ctrl+Shift+T 
  114.       Value          #TIME 
  115.  
  116.  Now when you want to insert the date into your current document, just press 
  117.  Ctrl+Shift+D. When you want to insert the time, press Ctrl+Shift+T. 
  118.  
  119.  
  120. ΓòÉΓòÉΓòÉ 7. Defining new accelerators ΓòÉΓòÉΓòÉ
  121.  
  122. You can use Keyboard Plus to define accelerators - key presses that simulate 
  123. you going through an application's menu system and choosing a command. 
  124.  
  125. For example, in Netscape there's no accelerator to get the document source. The 
  126. command's there, on the View menu. To define Ctrl+S to get the document source, 
  127. you could define the macro: 
  128.  
  129.  Hotkey    Ctrl+S 
  130.  Value     Alt,V,S 
  131.  
  132.  The Alt keypress activates the menu, and the letters choose items from the 
  133.  current menu. 
  134.  
  135.  Now, because that command only makes sense if the current application in 
  136.  Netscape (in your editor, you might want Ctrl+S to do something else - you 
  137.  definitely don't want it issuing an Alt-V-S sequence!), you could define a new 
  138.  macroset specifically for Netscape to hold this macro, and any others you 
  139.  think up. 
  140.  
  141.  
  142. ΓòÉΓòÉΓòÉ 8. Entering text ΓòÉΓòÉΓòÉ
  143.  
  144. You can use Keyboard Plus to save on typing of repetitive phrases, for example 
  145. your name. You could define the following macro in the global macroset : 
  146.  
  147.  Hotkey    Ctrl+Shift+N 
  148.  Value     J,o,e,Space,S,m,i,t,h 
  149.  
  150.  Then, whenever you were filling in a form and need to type in your name, just 
  151.  press Ctrl+Shift+N, and in goes your name. (If you're called Joe Smith. But 
  152.  you get the idea.) 
  153.  
  154.  This is the most fundamental thing Keyboard Plus does. 
  155.  
  156.  
  157. ΓòÉΓòÉΓòÉ 9. Getting the output from a program ΓòÉΓòÉΓòÉ
  158.  
  159. You can use Keyboard Plus to run a program which prints some text and paste 
  160. that text into the activate window. 
  161.  
  162. You do this by definining a macro (probably in the global macroset) which uses 
  163. the built-in function READ, for example: 
  164.  
  165.  Hotkey    Alt+F8 
  166.  Value     #READ(C:\PROGS\QUOTE.CMD) 
  167.  
  168.  Here, QUOTE.CMD is a little REXX program which picks a random quote from a 
  169.  file. Whenever you press Alt+F8, the program runs and the random quote is 
  170.  pasted into the current window. 
  171.  
  172.  If you want to run the program with parameters, you'll need to define a custom 
  173.  function. 
  174.  
  175.  
  176. ΓòÉΓòÉΓòÉ 10. Running a program or opening an object ΓòÉΓòÉΓòÉ
  177.  
  178. You can use Keyboard Plus to launch programs using the built-in function OPEN. 
  179. For example, you could define a macro in the global macroset: 
  180.  
  181.  Hotkey    Ctrl+Shift+N 
  182.  Value     #OPEN(C:\NETSCAPE\NETSCAPE.EXE) 
  183.  
  184.  Now, whenever you press Ctrl+Shift+N, Netscape will start. 
  185.  
  186.  If you wanted to pass some parameters to the program, you'll need to define a 
  187.  custom function. 
  188.  
  189.  
  190. ΓòÉΓòÉΓòÉ 11. Defining application-specific macros ΓòÉΓòÉΓòÉ
  191.  
  192. You can set Keyboard Plus up so that (for example) Ctrl+F11 is defined to have 
  193. one value normally, but does something different in other applications. 
  194.  
  195. You might want to do this to make the hotkey have the same meaning in both 
  196. cases, even though the applications have different layouts. 
  197.  
  198. The steps to follow would be: 
  199.  
  200.    1. Define a macro in the global macroset with the normal value 
  201.    2. Create a macroset for the different application 
  202.    3. Copy the macro you created into the new macroset 
  203.    4. Edit the value in the new macroset 
  204.  
  205.  
  206. ΓòÉΓòÉΓòÉ 12. Macros ΓòÉΓòÉΓòÉ
  207.  
  208. Macros are the basic thing that Keyboard Plus is about. A macro has two parts: 
  209.  
  210.      A hotkey 
  211.      A value 
  212.  
  213.  When you type a hotkey that corresponds to a macro, the value of that macro is 
  214.  used to determine what happens next. This usually involves inserting text at 
  215.  the cursor, but may start programs or do some work to find out what that text 
  216.  should be. 
  217.  
  218.  Each macro is the member of a macroset, which determines in which applications 
  219.  the hotkey works. 
  220.  
  221.  Choose one of the following topics for further information: 
  222.  
  223.      Creating a new macro 
  224.      Editing a macro 
  225.      Copying a macro 
  226.      Importing and Exporting macros 
  227.  
  228.  
  229. ΓòÉΓòÉΓòÉ 13. Creating a new macro ΓòÉΓòÉΓòÉ
  230.  
  231. To create a new macro, first decide which macroset you want it to belong to. 
  232. Then open the macro container for this macroset. 
  233.  
  234. Any one of the following will create a new macro: 
  235.  
  236.      Open the background context menu and choose New Macro 
  237.  
  238.      Double-click the macro template object. 
  239.  
  240.      Drag a new macro from the macro template object 
  241.  
  242.      Choose Macros, Create new from the menu bar 
  243.  
  244.  Alternatively, you could copy another macro. 
  245.  
  246.  In any case, the Macro Properties dialog is opened. 
  247.  
  248.  
  249. ΓòÉΓòÉΓòÉ 14. Editing a macro ΓòÉΓòÉΓòÉ
  250.  
  251. To edit a macro, first open the macro container for the macroset to which it 
  252. belongs. Then do one of the following to open the Macro Properties dialog: 
  253.  
  254.      Double-click the macro object 
  255.  
  256.      Open the macro object's context menu and choose Open 
  257.  
  258.      Select the macro object and choose Selected, Open from the menu bar 
  259.  
  260.  
  261. ΓòÉΓòÉΓòÉ 15. Copying a macro ΓòÉΓòÉΓòÉ
  262.  
  263. There are two slightly different operations here: 
  264.  
  265.    1. Copying a macro in its macroset 
  266.  
  267.       Either: 
  268.  
  269.           Drag the macro you want to copy onto a blank area of the container 
  270.  
  271.           Open the macro object's context menu and choose Copy 
  272.  
  273.           Select the macro object and choose Selected, Copy from the menu bar 
  274.  
  275.       The Macro Properties dialog is opened, because the macro's hotkey 
  276.       clashes. 
  277.  
  278.    2. Copying a macro from its macroset to another. 
  279.  
  280.       Drag the macro into the macro container which belongs to the macroset you 
  281.       want to copy the macro to. The Macro Properties dialog might be opened if 
  282.       the hotkey clashes. 
  283.  
  284.  
  285. ΓòÉΓòÉΓòÉ 16. Importing and Exporting ΓòÉΓòÉΓòÉ
  286.  
  287. Active macros and macroset are stored within Keyboard Plus. However, it is 
  288. possible to copy or move objects into the filesystem, and then copy them back 
  289. again at a later stage. These processes are known as importing and exporting. 
  290.  
  291. The simplest way to do this is using drag and drop - just drag the object from 
  292. a Keyboard Plus window to a folder on the desktop to import, or drag a 
  293. previously exported object into a Keyboard Plus window. 
  294.  
  295. Alternatively, Import and Export options are available from the usual context 
  296. menus and the menu bar. 
  297.  
  298. Note that: 
  299.  
  300.    1. When you export a macroset, all macros in it are exported as well. 
  301.    2. When you export a macro, all mentioned functions are exported as well. 
  302.  
  303.  
  304. ΓòÉΓòÉΓòÉ 17. Macro Properties dialog ΓòÉΓòÉΓòÉ
  305.  
  306. This dialog allows you to edit a macro. There are two sections to the dialog 
  307. box: 
  308.  
  309.      Hotkey 
  310.  
  311.       Type the name of a valid hotkey into the entryfield, or press the Edit 
  312.       button to open the Hotkey editor. 
  313.  
  314.      Value 
  315.  
  316.       Either type a value description into the text area, or record a key 
  317.       sequence: 
  318.  
  319.         1. Press the Record button. The LED starts flashing. 
  320.         2. Type in the text you want the value to be (you won't see anything 
  321.            unless you click somewhere else in the desktop). 
  322.         3. Press the Stop button. The LED stops flashing and the value 
  323.            description is filled in. 
  324.         4. Edit the value description to correct any mistakes or import any 
  325.            functions you need. 
  326.  
  327.       You can drag a function from the Functions window into the text area to 
  328.       insert its name in the right format (though you may need to add 
  329.       arguments). 
  330.  
  331.  Press the OK button to confirm your changes, or Cancel to abort the operation. 
  332.  
  333.  
  334. ΓòÉΓòÉΓòÉ 18. Macro Window ΓòÉΓòÉΓòÉ
  335.  
  336. This container window displays the macros defined in a single macroset; the 
  337. name of that macroset is displayed in the window's titlebar. Display it by 
  338. opening a macroset object in the macroset container. 
  339.  
  340. There are two ways of interacting with Keyboard Plus' containers, via the menu 
  341. bar and via container and object context menus (or of course a combination of 
  342. the two). Besides help, the menus give you access to: 
  343.  
  344.      Control over the view 
  345.  
  346.       I like details view with mini-icons for macro containers, so I can see 
  347.       what the value associated with a macro is, as well as the hotkey. 
  348.  
  349.      Actions on macros 
  350.  
  351.         -  Create 
  352.         -  Open 
  353.         -  Copy 
  354.         -  Import & Export 
  355.         -  Delete 
  356.  
  357.      Actions on the macroset 
  358.  
  359.         -  Show properties 
  360.         -  Empty 
  361.         -  Export 
  362.  
  363.      Other windows 
  364.  
  365.         -  Macroset window 
  366.         -  Functions window 
  367.  
  368.  
  369. ΓòÉΓòÉΓòÉ 19. Hotkeys ΓòÉΓòÉΓòÉ
  370.  
  371. A hotkey is a trigger that identifies a macro, something like F3 or 
  372. Shift+Ctrl+R (which means: while holding down both the shift and ctrl keys, tap 
  373. the R key). 
  374.  
  375. The easiest way to enter a hotkey is to use the Hotkey editor. Alternatively, 
  376. you can type the name of the hotkey. This section describes what 
  377. key-combinations are valid Keyboard Plus hotkeys, and gives some notes on use: 
  378.  
  379.    1. Any function key plus some, all, or none of Shift, Alt or Ctrl. In this 
  380.       context, function key means either something like F1 or a Windows 95 key, 
  381.       eg: 
  382.  
  383.             F8
  384.             Ctrl+Shift+F3
  385.             Win95-menu
  386.             Alt+LH-Win95
  387.  
  388.    2. A letter of the alphabet, optionally plus shift, plus either or both of 
  389.       Ctrl or Alt, eg: 
  390.  
  391.             Ctrl+Shift+D
  392.             Ctrl+Q
  393.  
  394.    3. A graphical character plus either or both of Ctrl or Alt. In this 
  395.       context, graphical character means any printable character that's not a 
  396.       letter or space, eg: 
  397.  
  398.             Ctrl+!
  399.             Alt+?
  400.  
  401.  Some hotkeys don't work as anticipated, for example F10 - you'll find the menu 
  402.  of the active window gets selected instead of your macro getting run. Equally, 
  403.  if your hotkey corresponds to an accelerator the active window has defined, 
  404.  that'll get fired off instead of your macro. This is working as designed, to 
  405.  minimize applications doing odd things, and a reason why you should consider 
  406.  using multiple modifiers for non-function key hotkeys. 
  407.  
  408.  Pretty obviously, there can only be one macro with a given hotkey in a 
  409.  macroset. 
  410.  
  411.  
  412. ΓòÉΓòÉΓòÉ 20. Hotkey Editor ΓòÉΓòÉΓòÉ
  413.  
  414. Use this dialog to modify or enter a new hotkey. Display it by pressing the 
  415. Edit button in the Macro Properties dialog. 
  416.  
  417. The top half of the dialog determines the modifiers which apply to the hotkey. 
  418.  
  419. The entryfield is not a standard entryfield. To enter the none-modifier part of 
  420. the hotkey, click in the entryfield to make it active, and then press the key: 
  421. its name should be filled in. For example, to create the hotkey Ctrl+F8: 
  422.  
  423.    1. Check the Ctrl checkbox; uncheck the others. 
  424.    2. Click in the entryfield. 
  425.    3. Press the F8 key on your keyboard. 
  426.    4. The OK button should now be clickable, so press it. 
  427.  
  428.  Note that you can only press the OK button if the dialog contents describe a 
  429.  valid hotkey. 
  430.  
  431.  
  432. ΓòÉΓòÉΓòÉ 21. Values ΓòÉΓòÉΓòÉ
  433.  
  434. A value is a sequence of items that determines what happens when the hotkey of 
  435. a macro gets pressed. The easiest way to explain this is by example, so here's 
  436. a simple value: 
  437.  
  438. H,e,l,l,o,!
  439.  
  440. Now, when this value gets run, the text Hello! is inserted, as though you'd 
  441. pressed those keys yourself. Note that the commas are just punctuation, 
  442. separating one item from the next. 
  443.  
  444. You can enter a value in the Macro Properties dialog, where there are 
  445. facilities for recording your keystrokes to avoid having to type all those 
  446. commas and remember key names. 
  447.  
  448. If you want to enter a non-printable key in a value (for example Alt or Enter), 
  449. you do this by typing the name of the key, a list of which is here, eg: 
  450.  
  451. Alt,E,W
  452.  
  453. The third type of item is a function call. This is identified by the # symbol, 
  454. eg: 
  455.  
  456. #TIME
  457. T,o,d,a,y,Space,i,s,Space,#SDATE
  458. #OPEN(H:\NETSCAPE\NETSCAPE.EXE)
  459. #MYFUN
  460.  
  461. List of built-in functions. 
  462.  
  463.  
  464. ΓòÉΓòÉΓòÉ 22. Key names ΓòÉΓòÉΓòÉ
  465.  
  466. This table shows the name you should use to include non-printable characters in 
  467. a value. Most of them are pretty obvious, I hope. 
  468.  
  469.  Key               Name 
  470.  Break             Break 
  471.  Backspace         Backspace 
  472.  Tab               Tab 
  473.  Return            Return 
  474.  Shift             Shift 
  475.  Ctrl              Ctrl 
  476.  Alt               Alt 
  477.  Alt-Graphics      Alt-Gr 
  478.  Pause             Pause 
  479.  Caps Lock         CapsLock 
  480.  Escape            Esc 
  481.  Space bar         Space 
  482.  Page Up           Pg-Up 
  483.  Page Down         Pg-Down 
  484.  End               End 
  485.  Home              Home 
  486.  Left cursor       Left 
  487.  Up cursor         Up 
  488.  Right cursor      Right 
  489.  Down cursor       Down 
  490.  Print Screen      PrintScrn 
  491.  Insert            Insert 
  492.  Delete            Delete 
  493.  Scroll lock       Scroll-lock 
  494.  Numlock           Numlock 
  495.  Keypad Enter      Enter 
  496.  SysRq             SysRq 
  497.  Left-hand Windows 95 key LH-Win95 
  498.  Right-hand Windows 95 key RH-Win95 
  499.  The Windows 95 popup menu key Win95-menu 
  500.  F1 to F24         F1 to F24 
  501.  
  502.  
  503. ΓòÉΓòÉΓòÉ 23. Functions ΓòÉΓòÉΓòÉ
  504.  
  505. Keyboard Plus uses functions: 
  506.  
  507.    1. To allow a macro to produce a different string each time you use it, for 
  508.       example the current time 
  509.    2. To allow a macro to run other programs 
  510.  
  511.  Each function has a name, and some functions may take parameters. An example 
  512.  of calling a function in a value is: 
  513.  
  514.   #MYFUN(PARAMETERS)
  515.  
  516.  There is no limit to the number of functions present in a value. 
  517.  
  518.  Keyboard Plus supports several built-in functions, which do not appear in the 
  519.  Functions window. 
  520.  
  521.  Functions which you can define are known as custom functions. 
  522.  
  523.  
  524. ΓòÉΓòÉΓòÉ 24. Built-in functions ΓòÉΓòÉΓòÉ
  525.  
  526. This section lists the built-in functions, which do not appear in the Functions 
  527. window and are always available. 
  528.  
  529.  TIME 
  530.            Returns the current time, in the format defined in your system's 
  531.            Country settings. Eg: 
  532.  
  533.                       #TIME
  534.  
  535.  SDATE 
  536.            Returns the current date, in the format defined in your system's 
  537.            Country settngs. Eg : 
  538.  
  539.                       #SDATE
  540.  
  541.  DATE 
  542.            Returns the current date. This function may have an argument, which 
  543.            is interpreted as a format-specifier to the ANSI C function 
  544.            strftime. The default format-specifier is %A %d %B %Y, which is used 
  545.            if no argument is supplied. Eg: 
  546.  
  547.                       #DATE(%A)
  548.  
  549.  PAUSE 
  550.            This function must have an argument, which should be a number. 
  551.            Execution of the value pauses for a number of milliseconds equal to 
  552.            the argument. Eg: 
  553.  
  554.                       #PAUSE(100)
  555.  
  556.  JN 
  557.            This function generates a WM_JOURNALNOTIFY message on playback 
  558.            according to its argument. Don't worry about it; if you see one, 
  559.            don't delete it. 
  560.  
  561.                       #JN(0002-0054)
  562.  
  563.  OPEN 
  564.            This function must have an argument, which should either be an 
  565.            executable file (.EXE, .CMD) or the name of a WPS object (eg. 
  566.            <WP_DESKTOP>). The program or object is run (from the Keyboard Plus 
  567.            directory) or opened as appropriate. Eg: 
  568.  
  569.                       #OPEN(H:\NETSCAPE\NETSCAPE.EXE)
  570.                       #OPEN(<WP_LAUNCHPAD>)
  571.  
  572.  READ 
  573.            This function must have an argument, which should be an executable 
  574.            file. The program is run, and its output is inserted into the 
  575.            playback sequence. The program should not take too long to run! Eg: 
  576.  
  577.                       #READ(H:\PROGS\QUOTE.CMD)
  578.  
  579.  # 
  580.            This function returns the # character, which is otherwise 
  581.            non-representable in a value. Eg: 
  582.  
  583.                       ##
  584.  
  585.  , 
  586.            This function returns the , character, which is otherwise 
  587.            non-representable in a value. Eg: 
  588.  
  589.                       #,
  590.  
  591.  
  592. ΓòÉΓòÉΓòÉ 25. Custom functions ΓòÉΓòÉΓòÉ
  593.  
  594. You need to define a custom function if you wish to do a READ or OPEN (see 
  595. Built-in Functions) and either: 
  596.  
  597.      Supply parameters to the program 
  598.      Set the working directory of the program to something other than the 
  599.       Keyboard Plus directory. 
  600.  
  601.  Note that any parameters you give to a custom function are supplied as extra 
  602.  parameters to the program. 
  603.  
  604.  To define a new custom function, open the Functions window and press the New 
  605.  button to open a Function Properties dialog. 
  606.  
  607.  
  608. ΓòÉΓòÉΓòÉ 26. Functions Window ΓòÉΓòÉΓòÉ
  609.  
  610. This window displays the custom functions you have defined. Display the window 
  611. by choosing Functions from a container context menu or the Macroset Window menu 
  612. bar. 
  613.  
  614. You can perform the following actions related to functions from this window: 
  615.  
  616.      New 
  617.       The Function Properties dialog is displayed for the new function 
  618.      Edit 
  619.       The Function Properties dialog is displayed for the function in question 
  620.      Delete 
  621.       The function in question is deleted. You may still have macros which 
  622.       reference the function, in which case they will no longer work. 
  623.  
  624.  You can drag a function object to the value text area in the Macro Properties 
  625.  dialog to insert its name. 
  626.  
  627.  
  628. ΓòÉΓòÉΓòÉ 27. Function Properties dialog ΓòÉΓòÉΓòÉ
  629.  
  630. Use this dialog to alter or set up a custom function. 
  631.  
  632. The top half of the dialog lets you configure what program will be run by your 
  633. function, what directory it will start up in (you can leave this field blank), 
  634. and any parameters to supply to the program. 
  635.  
  636. Use the Action section to decide whether your function should behave as a READ 
  637. or OPEN function. 
  638.  
  639. Finally, you need to give a name for your function which can be used in a 
  640. value. 
  641.  
  642.  
  643. ΓòÉΓòÉΓòÉ 28. Macrosets ΓòÉΓòÉΓòÉ
  644.  
  645. A Macroset is a group of macros. Each macroset corresponds to a single program 
  646. (.EXE). There is one special macroset, the global macroset, in which you put 
  647. macros which you want to apply to all programs equally. 
  648.  
  649. When Keyboard Plus notices a potential hotkey being pressed, it first looks for 
  650. a macroset for the current program. If it finds one, it looks in there for a 
  651. macro with the hotkey. If either of these tests fail, Keyboard Plus examines 
  652. the global macroset for a macro with the hotkey. 
  653.  
  654. This means you can override general behaviour in specific applications. 
  655.  
  656. Choose one of the following topics for further information: 
  657.  
  658.      Creating a new macroset 
  659.      Editing a macroset 
  660.      Copying a macroset 
  661.      Emptying a macroset 
  662.      Importing & Exporting macrosets 
  663.  You can create new macrosets from the Macroset Window. 
  664.  
  665.  
  666. ΓòÉΓòÉΓòÉ 29. Creating a new macroset ΓòÉΓòÉΓòÉ
  667.  
  668. To create a new macroset, surface the macroset container and do one of the 
  669. following: 
  670.  
  671.      Open the background context menu and choose New Macroset 
  672.  
  673.      Double-click the macroset template object. 
  674.  
  675.      Drag a new macro from the macroset template object 
  676.  
  677.      Choose Macrosets, Create new from the menu bar 
  678.  
  679.  Alternatively, you could copy another macroset. 
  680.  
  681.  In any case, the Macroset Properties dialog is opened. 
  682.  
  683.  
  684. ΓòÉΓòÉΓòÉ 30. Editing a macroset ΓòÉΓòÉΓòÉ
  685.  
  686. To edit a macroset, either choose Properties from a menu, or hold down an Alt 
  687. key whilst double-clicking on its object in the macroset container. 
  688.  
  689. The Macroset Properties dialog is opened. 
  690.  
  691.  
  692. ΓòÉΓòÉΓòÉ 31. Copying a macroset ΓòÉΓòÉΓòÉ
  693.  
  694. To copy a macroset, either choose Copy from a menu, or drag it to an area of 
  695. empty space in the container. Which ever method you use, the macroset 
  696. application will clash, and so the Macroset Properties dialog is opened. 
  697.  
  698.  
  699. ΓòÉΓòÉΓòÉ 32. Emptying a macroset ΓòÉΓòÉΓòÉ
  700.  
  701. When you empty a macroset, all the macros in that macroset are deleted. You can 
  702. empty a macroset by choosing Empty from a menu. 
  703.  
  704.  
  705. ΓòÉΓòÉΓòÉ 33. Macroset Window ΓòÉΓòÉΓòÉ
  706.  
  707. This container window displays the macrosets Keyboard Plus knows about, 
  708. including the global macroset. 
  709.  
  710. There are two ways of interacting with Keyboard Plus' containers, via the menu 
  711. bar and via container and object context menus (or of course a combination of 
  712. the two). Besides help, the menus give you access to: 
  713.  
  714.      Control over the view 
  715.  
  716.       I like icon view with normal icons for this container. 
  717.  
  718.      Actions on macrosets 
  719.  
  720.         -  Create 
  721.         -  Alter properties 
  722.         -  Copy 
  723.         -  Empty 
  724.         -  Import & Export 
  725.         -  Delete 
  726.  
  727.      Other windows 
  728.  
  729.         -  Functions window 
  730.         -  Settings Window 
  731.         -  Log Window 
  732.  
  733.  
  734. ΓòÉΓòÉΓòÉ 34. Macroset Properties ΓòÉΓòÉΓòÉ
  735.  
  736. Use this dialog to configure a macroset. 
  737.  
  738. Use the Program entry field to enter the name of the application program (.EXE 
  739. file) which you wish the macroset to apply to. If this field is greyed out, 
  740. then you are looking at the global macroset, which doesn't apply to a single 
  741. program. 
  742.  
  743. You can enter a name for the macroset in the Title text area, which does not 
  744. affect the running of the program in any way. If this field is inactive then 
  745. this is the the global macroset, whose name is fixed. 
  746.  
  747.  
  748. ΓòÉΓòÉΓòÉ 35. Macroset Name Clash ΓòÉΓòÉΓòÉ
  749.  
  750. You have either: 
  751.  
  752.    1. Tried to import a macroset which applies to a program for which there is 
  753.       already a macroset. There can only be one macroset per program, and so 
  754.       something needs to change. 
  755.    2. Tried to import a global macroset. There can only be one global macroset, 
  756.       so something needs to change. 
  757.  
  758.  There are four options available at this stage: 
  759.  
  760.    1. Press Cancel. The import operation is aborted. 
  761.    2. Select the Replace radio button. The macroset which is being imported 
  762.       replaces the current one. 
  763.    3. Select the Merge radio button. The macros which belong to the macroset 
  764.       being imported are added to the current macroset. 
  765.    4. Select the Rename radio button, and type a new program name into the 
  766.       entryfield. The macroset is imported under a different name. 
  767.  
  768.  
  769. ΓòÉΓòÉΓòÉ 36. Function Name Clash ΓòÉΓòÉΓòÉ
  770.  
  771. You have tried to import a macro or a macroset containing a macro which defines 
  772. a custom function with the same name as an already existing function. 
  773.  
  774. There are three options available at this stage: 
  775.  
  776.    1. Press Cancel. The entire import operation is aborted. 
  777.    2. Select the Replace radio button. The new function replaces the old one. 
  778.    3. Select the Rename radio button. The function being imported is renamed, 
  779.       as are all references to it in the importing macros. 
  780.  
  781.  
  782. ΓòÉΓòÉΓòÉ 37. Log Window ΓòÉΓòÉΓòÉ
  783.  
  784. Sometimes messages are generated by Keyboard Plus at a time when it's not 
  785. appropriate to pop up a message box, for example when a program to be run as 
  786. part of a value cannot be found. 
  787.  
  788. These messages are collected here. 
  789.  
  790.  
  791. ΓòÉΓòÉΓòÉ 38. Settings Window ΓòÉΓòÉΓòÉ
  792.  
  793. Use this window to configure various behaviours of Keyboard Plus. Any changes 
  794. you make will take affect when you either press the `OK' button or close the 
  795. window, and be saved when you quit Keyboard Plus for future runs. 
  796.  
  797. Choose one of the following topics for further information: 
  798.  
  799.      User interface settings 
  800.      Confirmations settings 
  801.  
  802.  
  803. ΓòÉΓòÉΓòÉ 39. User interface settings ΓòÉΓòÉΓòÉ
  804.  
  805. General UI settings: 
  806.  
  807.      Show folder menubars 
  808.       When this is checked, Keyboard Plus displays menu bars in the container 
  809.       windows. 
  810.      Show template objects 
  811.       When this is checked, Keyboard Plus displays template objects in the 
  812.       containers. 
  813.      Startup minimized 
  814.       If checked, Keyboard Plus will start up minimized. Good if you have the 
  815.       program in your startup folder. 
  816.      Sound alarm on messages 
  817.       If checked, a warning will sound when a message is added to the Log 
  818.       Window. 
  819.  
  820.  
  821. ΓòÉΓòÉΓòÉ 40. Confirmations ΓòÉΓòÉΓòÉ
  822.  
  823. Confirmations on various actions: 
  824.  
  825.      Confirm on function delete 
  826.       If checked, Keyboard Plus will ask you before deleting a function. 
  827.      Confirm on macroset delete 
  828.       If checked, Keyboard Plus will ask you before deleting a macroset. 
  829.      Confirm on macro delete 
  830.       If checked, Keyboard Plus will ask you before deleting a macro. 
  831.      Confirm on macroset empty 
  832.       If checked, Keyboard Plus will ask you before emptying a macroset. 
  833.      Confirm on hotkey clash edit 
  834.       If checked, Keyboard Plus will ask you before displaying the Macro 
  835.       Properties dialog dialog when you import or copy a macro into a macroset 
  836.       and there's a clash of hotkey. 
  837.  
  838.  
  839. ΓòÉΓòÉΓòÉ 41. Folder menu bars ΓòÉΓòÉΓòÉ
  840.  
  841. By default, Keyboard Plus displays menu bars across the top of both its 
  842. container windows. You can alter this behaviour (there's nothing there you 
  843. can't access through context menus) from the User interface settings. 
  844.  
  845.  
  846. ΓòÉΓòÉΓòÉ 42. Template objects ΓòÉΓòÉΓòÉ
  847.  
  848. By default, Keyboard Plus displays template objects for creating new macros and 
  849. macrosets. You can alter this behaviour (you can create new objects from the 
  850. background context menu) from the User interface settings. 
  851.  
  852.  
  853. ΓòÉΓòÉΓòÉ 43. Tutorial ΓòÉΓòÉΓòÉ
  854.  
  855. This brief guide will take you through the process of creating a custom 
  856. function and a macro to use it. 
  857.  
  858. The example used is starting Netscape Navigator pointing at a URL. 
  859.  
  860. There needs to be a custom function so we can pass parameters to the program. 
  861.  
  862.    1. Creating the function 
  863.    2. Creating the macro 
  864.  
  865.  
  866. ΓòÉΓòÉΓòÉ 44. Creating the function ΓòÉΓòÉΓòÉ
  867.  
  868. This section describes how to create the custom function to start Netscape. 
  869.  
  870.    1. Open the Functions window by choosing Program, Functions from the main 
  871.       Keyboard Plus window. 
  872.  
  873.    2. Press the New button to open a Function Properties dialog. 
  874.  
  875.    3. Fill in the dialog: 
  876.  
  877.       Program        NETSCAPE.EXE 
  878.                      Use Find if you like 
  879.  
  880.       Parameters     -3 
  881.                      Always pass this parameter to Netscape 
  882.  
  883.       Action         Run program / open object 
  884.  
  885.       Name           NETSCAPE 
  886.  
  887.       Leave the Working directory field empty. 
  888.  
  889.    4. Press OK. The new function appears in the container. 
  890.  
  891.  Creating the macro 
  892.  
  893.  
  894. ΓòÉΓòÉΓòÉ 45. Creating the macro ΓòÉΓòÉΓòÉ
  895.  
  896. This section describes how to create the macro to call the NETSCAPE function 
  897. defined earlier. 
  898.  
  899.    1. Open the global macroset by double-clicking on the object marked Global 
  900.       Macros in the main Keyboard Plus window. 
  901.  
  902.    2. Double-click the New Macro template object to display a Macro Properties 
  903.       dialog 
  904.  
  905.    3. Fill in the dialog: 
  906.  
  907.       Hotkey         Ctrl+Shift+N 
  908.                      Use Edit if you like 
  909.  
  910.       Value          #NETSCAPE(http://www.unitedmedia.com/comics/dilbert/) 
  911.  
  912.    4. Press OK. The new macro appears in the container. 
  913.  
  914.  You can now press Ctrl+Shift+N to start up Netscape at today's Dilbert. 
  915.  
  916.  
  917. ΓòÉΓòÉΓòÉ 46. Keys Help ΓòÉΓòÉΓòÉ
  918.  
  919. Keyboard Plus supports the standard kind of keystrokes in its containers: 
  920.  
  921.      Return to open an object 
  922.      Alt+Return to show an object's properties 
  923.      Delete to delete an object 
  924.      Shift+F10 to open an object's context menu 
  925.  
  926.  If you think you're experiencing odd behaviour when you press keys, make sure 
  927.  you're not experiencing the effects of macros you've defined! 
  928.  
  929.  
  930. ΓòÉΓòÉΓòÉ <hidden>  ΓòÉΓòÉΓòÉ
  931.  
  932. An accelerator is an application-defined hotkey that performs an 
  933. application-specific function. 
  934.  
  935. A neat thing you can do with Keyboard Plus is to define your own accelerators, 
  936. by setting the value to something like Alt,E,W to spellcheck the current word 
  937. in EPM.