home *** CD-ROM | disk | FTP | other *** search
/ Oakland CPM Archive / oakcpm.iso / cpm / wstar / wskey.doc < prev    next >
Encoding:
Text File  |  1986-10-09  |  5.2 KB  |  121 lines
  1.  WSKEY: WordStar Function Key and Numeric Keypad Implementation
  2.  
  3.             Dr. William C. Parke
  4.              April, 1984
  5.  
  6. WSKEY  is a machine language module which can by attached to  the
  7. back of MicroPro's WordStar for CP/M-80.   When in place, it will
  8. translate  the    function  and  numeric keypad key  codes  on  the
  9. Heath/Zenith  H/Z-19,29,89,90,     and  100  series  terminals  and
  10. computers   into  user    defined  commands  and    strings   to   be
  11. interpreted by WordStar.
  12.  
  13. If  you  have the latest CP/M-80 WordStar  from  Zenith  (Version
  14. 3.3),  your  arrow  keys  already work,  and  the  function  keys
  15. generate  the  most often used    control  keys.     However,  simply
  16. having a single control code generated by a function key is not a
  17. great savings of keystrokes!  It would be far more useful to have
  18. specific  multistroke  WordStar functions generated by    a  single
  19. function key.    With WSKEY,  you can do that. Moreover, it is not
  20. an  internal  patch in WordStar,  so that it will not affect  any
  21. special  configurations or installations you  have  made.   WSKEY
  22. hides  on  the    backend of WordStar on disk.   When  WordStar  is
  23. loaded,  WSKEY    gets  control first,  relocates  a  function  and
  24. numeric  key  interceptor just under BDOS in  high  memory,  then
  25. transfers  control to WordStar.   At this point,  WordStar begins
  26. completely  ignorant  of  any  change  made.    However,  console
  27. character  requests made to BDOS are now check for  function  key
  28. action.    WSKEY   translates  these  requests    to  your   custom
  29. configuration for these functions.   On exit from WordStar,  BDOS
  30. is returned to its original form and the 25th line display of the
  31. key functions is turned off as part of the warm boot sequence.
  32.  
  33. The  choice for the numeric keypad functions are taken    from  the
  34. very  well-thought out conventions adopted by Pat Swayne (at  the
  35. National  HUG office) which he used in his program KEYMAP.   With
  36. KEYMAP,  you  can  configure  the  keys  interactively    from  the
  37. operating  system before entering any  particular  program.   Pat
  38. uses the HOME key as a function "shift" key,  so that each of the
  39. function  and numeric keypad keys can be given a double  purpose.
  40. The  keypad  itself  is reserved for screen  operations  (cursor,
  41. line, page moves and FIND operations corresponding to the ^Q menu
  42. options in WordStar).    If you will need interactive reprograming
  43. of the function keys, I strongly recommend Pat's KEYMAP.
  44.  
  45. The special advantage of WSKEY is its small size (only 512  bytes
  46. take  from WordStar's available space) and the fact that it loads
  47. and unloads automatically when WordStar is used.  It can be  used
  48. to configure the function and keypad keys on the H-19,    Z-29,  H-
  49. 89, and the Z-100 (under 8085 control) to generate any meaningful
  50. command string or often-used text line in WordStar.
  51.  
  52. You  may examine the function key and numeric keypad  definitions
  53. in the file WSKEY.DEF.     These definitions may be changed to your
  54. own commands using the patch table below.
  55.  
  56. Also, on this disk, there are a series of SUB and HEX files which
  57. are  ready to automatically patch your version of  WordStar.  The
  58. names  taken  for  these  files,  WSKExxyy.,  correspond  to  the
  59. WordStar version and the terminal or computer you wish to use  as
  60. the table below shows:
  61.  
  62.              WordStar Version
  63.              3.0          3.3
  64.  
  65.      H-19, H/Z-89,90     WSKE3019.    WSKE3319.
  66.      H/Z-29, Z-100s     WSKE3029.    WSKE3329.
  67.  
  68. Below  is  the    procedure  for adding  WSKEY  to  your    WordStar.
  69.  
  70.       1.   Pick  the appropriate version of WSKExxyy.SUB  for
  71.            your computer and WordStar version. Substitute the
  72.            value of xxyy in the steps below.
  73.  
  74.       2.   Copy to one disk the following files:
  75.     
  76.            WS.COM (Initialized, but without function keys)    
  77.            WSKExxyy.SUB
  78.            WSKExxyy.HEX
  79.         
  80.            DDT.COM (from Digital Research distribution disk)
  81.            EX.COM (an enhanced SUBMIT; contained herein)
  82.  
  83.       3.   From this disk, type: EX WSKExxyy.
  84.         
  85. Your new version of WordStar, WSK.COM should now be ready to use.
  86. The  twenty-fifth  line will define the double functions of  each
  87. function key.  The numeric keypad which principly controls cursor
  88. and page moves, is logically and functionally laid out.  However,
  89. you  may  wish    to  make a hard copy of  the  file  WSKEY.DEF  as
  90. reference.
  91.  
  92. If  you wish to redefine the command or ASCII string sent when    a
  93. function key is pressed while in WordStar,  patch WSK.COM at  the
  94. locations  given  below  with your own command string,    up  to    6
  95. characters for f1 to f7,  12 characters for f8.   The same number
  96. of characters can be used for the alternate functions.     End each
  97. string with the high-order bit (parity bit) set.
  98.  
  99. WordStar 3.0 Function Strings:
  100.  
  101. Functions      Addresses       Functions      Addresses
  102.  
  103. f1 ^f1           3FEC  403E    f5 ^f5          4004  4056
  104. f2 ^f2           3FF2  4044    f6 ^f6          400A  405C
  105. f3 ^f3           3FF8  404A    f7 ^f7          4010  4062
  106. f4 ^f4           3FFE  4050    f8 ^f8          4016  4068
  107.  
  108. The twenty-fifth line display string begins at 4195.
  109.  
  110.  
  111. WordStar 3.3 Function Strings:
  112.  
  113. Functions      Addresses       Functions      Addresses
  114.  
  115. f1 ^f1           46EC  473E    f5 ^f5          4704  4756
  116. f2 ^f2           46F2  4744    f6 ^f6          470A  475C
  117. f3 ^f3           46F8  474A    f7 ^f7          4710  4762
  118. f4 ^f4           46FE  4750    f8 ^f8          4716  4768
  119.  
  120. The twenty-fifth line display string begins at 4895.
  121.