home *** CD-ROM | disk | FTP | other *** search
/ Boldly Go Collection / version40.iso / TS / 25D / VDEMC.ZIP / VMC.DOC < prev   
Text File  |  1991-08-07  |  9KB  |  213 lines
  1.  
  2.  
  3.                                     VMC.DOC
  4.                                     -------
  5.                       Instructions for VDE Macro Compiler
  6.                               VMC 1.11 (8/07/90)
  7.           for use with Eric Meyer's VDE editor version 1.53 and above
  8.  
  9.                               VMC.DOC and VMC.COM
  10.                                    Written by
  11.                                   Evan Slawson
  12.  
  13.                         Copyright 1990,1991 Evan Slawson
  14.                               All rights reserved
  15.  
  16.  
  17. ||||||  ABOUT VMC  ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||:
  18.  
  19. VMC, the Macro Compiler for Eric Meyer's VDE editing program, converts
  20. VDE keyboard and function-key macro definition files from their native
  21. format to easy-to-edit text files or vice versa.
  22.  
  23. VMC.DOC covers use of VMC only.  For complete information about VDE's macro
  24. capabilities, please consult VDE documentation.
  25.  
  26. This version of the compiler works only with VDE versions that use the number
  27. 1.53 in their macro file headers.  At this time, this includes VDE versions
  28. 1.53, 1.54, 1.55, 1.6 and 1.61.
  29.  
  30.  
  31. ||||||  WHAT'S NEW  ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
  32.  
  33. VMC v. 1.11 compensates for a rare error in VDE's macro processing in which
  34. a VDE-produced .VD? file ends up with macro-type bytes which were out of
  35. range to previous versions of VMC but were handled correctly by VDE.
  36. Most users will never have encountered this error.  Also, v. 1.11 now shows
  37. the Version Number in the help screen.
  38.  
  39. VMC v. 1.10 has only one change from previous versions:  It allows
  40. the user to specify that a macro can be Non-repeat, Quiet or Both,
  41. so it is compatible with Eric Meyer's VDE 1.61 release.
  42.  
  43.  
  44. ||||||  USAGE POLICY  ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
  45.  
  46. The VMC utility and its documentation are copyright 1990, 1991 Evan Slawson, all
  47. rights reserved.  They may not be circulated in any incomplete or modified form,
  48. nor sold for profit, without written permission of the author.  VMC.COM and
  49. VMC.DOC must be circulated together.  There is no fee to individuals or
  50. companies for use of VMC.  Any software dealer or library may offer VMC for sale
  51. as long as the price charged for the disk containing VMC does not exceed US
  52. $5.00.  Any other sale of VMC, either alone or together with other software or
  53. hardware, requires a licensing agreement.
  54.  
  55. Address all correspondence to the author:
  56.  
  57. Evan Slawson
  58. 6320 Whitsett Ave. #4
  59. North Hollywood, CA 91606
  60.  
  61. or E-mail at Glendale Litera BBS  818-956-6164
  62.  
  63.  
  64. ||||||  SOURCES  ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||:
  65.  
  66. Please note that copies of VMC   CANNOT   be ordered directly from the author.
  67.  
  68. Glendale Littera QBBS - Glendale, CA  (818)956-6164 is the primary distribution
  69. point for VMC.  If it becomes necessary to update VMC, new versions will be
  70. posted here.
  71.  
  72.  
  73. ||||||  DISCLAIMER  ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
  74.  
  75.                    You undertake to use VMC at your own risk.
  76.             The author assumes no liability for damages of any kind
  77.                         resulting from your use of VMC.
  78.  
  79.  
  80. ||||||  USING VMC  ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||:
  81.  
  82. Place VMC.COM in either the current directory
  83. or a directory that is included in your PATH setting.
  84.  
  85. To use VMC, simply type   VMC <macrodatafilename>
  86.                    or     VMC <macrotextfilename>
  87. from the DOS command line.
  88.  
  89. Macro data files must have these identifiers:
  90.  
  91.    .VDF  for function key macros
  92.    .VDK  for keyboard macros
  93.    (These identifiers are required by VDE as well.)
  94.  
  95. Macro text files must have these identifiers:
  96.  
  97.    .VTF  for function key macros
  98.    .VTK  for keyboard macros
  99.  
  100. An easy way to remember these identifiers is to think of the D in
  101. .VDF and .VDK as "Data" and the T in .VTF and .VTK as "Text".
  102.  
  103. VMC determines the kind of conversion based on the input filename.
  104. The converted output file uses the name portion of the input file
  105. and has the correct identifier for the type of file it is, i.e.:
  106.  
  107.      Input       Output    Conversion
  108.      *.VDK   ->  *.VTK     Keyboard macro data file converted to text file
  109.      *.VTK   ->  *.VDK     Keyboard macro text file converted to data file
  110.      *.VDF   ->  *.VTF     Function key   data file converted to text file
  111.      *.VTF   ->  *.VDF     Function key   text file converted to data file
  112.  
  113. Entering   VMC   without a filename parameter will produce a single-screen
  114. syntax summary for quick reference.
  115.  
  116.  
  117. ||||||  MACRO TEXTFILE FORMAT  ||||||||||||||||||||||||||||||||||||||||||||||||:
  118.  
  119. Macro text files should be plain ASCII files, saved in /A or /N mode of VDE.
  120.  
  121. Macro text files use the same format for both .VTF and .VTK files.
  122.  
  123. Each macro must be typed on a single line.  Each line may contain up to 256
  124. text characters.  VMC aborts if a line compiles to more than 128 characters in
  125. the data file.  This conforms with the VDE limit of 128 characters for any one
  126. macro.  Since control and alt keys may be represented in the text file as
  127. two-character expressions, VMC allows text lines longer than 128 characters.
  128.  
  129. Each macro must begin with a label representing the key it is assigned to.  The
  130. label must be surrounded by [].  The label expression must begin in column 1.
  131.  
  132. For .VTF (function key) files the valid labels are [01]..[48].
  133.  
  134. Remember that VDE assigns function keys like this:
  135.  
  136.          [F1]...[F10]  =  F01...F10 in VDE notation
  137.    Shift-[F1]...[F10]  =  F11...F20
  138.     Ctrl-[F1]...[F10]  =  F21...F30
  139.      Alt-[F1]...[F10]  =  F31...F40
  140.  
  141. If you have an Enhanced (101-key) AT keyboard, also:
  142.           [F11],[F12]  =  F41,F42
  143.     Shift-[F11],[F12]  =  F43,F44
  144.      Ctrl-[F11],[F12]  =  F45,F46
  145.       Alt-[F11],[F12]  =  F47,F48
  146.  
  147. Function keys must be arranged in ascending numeric order in the .VTF file.
  148.  
  149. A .VTF file may have up to 48 lines.
  150.  
  151. Valid .VTK (keyboard macro) labels are in the ranges [0]..[9] and [A]..[Z].
  152. Label letters can be upper or lower case.  Macros must be in the order 0..9,
  153. A..Z in the .VTK file.  .VTK files can have up to 36 lines.
  154.  
  155.  
  156. ||||||  SPECIAL CHARACTERS IN MACRO TEXT FILES  ||||||||||||||||||||||||||||||||
  157.  
  158. There are several special characters in macro text files.
  159.  
  160. The  @  symbol indicates the next key will be an Alt key.  The
  161. next key MUST be in the ranges A-Z or a-z.
  162.  
  163. The  ^  symbol indicates the next key will be a Ctrl key.  The next key
  164. MUST be either ^, [, ], _ or \ or in the ranges A-Z or a-z.  You can also
  165. enter Ctrl keys directly in your text file, by pressing ^P followed by a
  166. letter.  VMC's output file will always convert to the ^ expession.
  167.  
  168. The Escape key can be entered as a control key (^[) or by pressing ^P then
  169. the Escape key.  Again, VMC will always convert to the ^ expression.
  170.  
  171. The  `  (back apostrophe) symbol tells VMC to place the next character in
  172. the data file without any conversion.  This is useful if you need an actual
  173. @ or ^ symbol in your macros.  To enter an actual back apostrophe, you must
  174. place two in a row.
  175.  
  176.  
  177. ||||||  NO REPEAT / QUIET MODES  ||||||||||||||||||||||||||||||||||||||||||||||:
  178.  
  179. To make a macro run in No-repeat mode, Quiet mode or Both, put N, Q or B
  180. as the first character after the label.  (You can also use q or n.)  If
  181. you need a Q, q, N, n, B or B as the actual first letter of a macro, instead
  182. of as a No-repeat, Quiet or Both mode designator, type a ` (back apostrophe)
  183. before it.
  184.  
  185.  
  186. ||||||  ERROR MESSAGES  ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
  187.  
  188. VMC produces error messages for many conditions, including invalid filenames,
  189. invalid macro order, bad macro labels, invalid character following ^ or @ and
  190. some other conditions.  If an error occured in macro processing VMC tells you:
  191.  
  192.   Error occured after macro:
  193.  
  194. and then shows you a macro label.  The label shown indicates the last correctly
  195. processed macro.  Whatever macro follows is where the error occured.
  196.  
  197.  
  198. ||||||  COMMENTING YOUR MACROS  ||||||||||||||||||||||||||||||||||||||||||||||||
  199.  
  200. If you would like to comment your macros, keep the comments in a file named
  201. with the name portion of your macro file and use an extension of .VCK or
  202. .VCF.  Think of the C representing Comments.  Then use VDE and AltW to view
  203. the .VT? and the .VC? files simultaneously.
  204.  
  205.  
  206. ||||||  ACKNOWLEDGEMENTS  ||||||||||||||||||||||||||||||||||||||||||||||||||||||
  207.  
  208. Thanks to Eric Meyer for VMC development suggestions and for VDE in the
  209. first place, and to Fred Haines and Ben Cohen at Glendale Litera BBS for
  210. coming up with the idea of writing a VDE macro compiler.
  211.  
  212.  
  213.