Contents of the VMC.DOC file
Instructions for VDE Macro Compiler
VMC 1.11 (8/07/90)
for use with Eric Meyer's VDE editor version 1.53 and above
VMC.DOC and VMC.COM
Copyright 1990,1991 Evan Slawson
All rights reserved
|||||| ABOUT VMC ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||:
VMC, the Macro Compiler for Eric Meyer's VDE editing program, converts
VDE keyboard and function-key macro definition files from their native
format to easy-to-edit text files or vice versa.
VMC.DOC covers use of VMC only. For complete information about VDE's macro
capabilities, please consult VDE documentation.
This version of the compiler works only with VDE versions that use the number
1.53 in their macro file headers. At this time, this includes VDE versions
1.53, 1.54, 1.55, 1.6 and 1.61.
|||||| WHAT'S NEW ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VMC v. 1.11 compensates for a rare error in VDE's macro processing in which
a VDE-produced .VD? file ends up with macro-type bytes which were out of
range to previous versions of VMC but were handled correctly by VDE.
Most users will never have encountered this error. Also, v. 1.11 now shows
the Version Number in the help screen.
VMC v. 1.10 has only one change from previous versions: It allows
the user to specify that a macro can be Non-repeat, Quiet or Both,
so it is compatible with Eric Meyer's VDE 1.61 release.
|||||| USAGE POLICY ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
The VMC utility and its documentation are copyright 1990, 1991 Evan Slawson, all
rights reserved. They may not be circulated in any incomplete or modified form,
nor sold for profit, without written permission of the author. VMC.COM and
VMC.DOC must be circulated together. There is no fee to individuals or
companies for use of VMC. Any software dealer or library may offer VMC for sale
as long as the price charged for the disk containing VMC does not exceed US
$5.00. Any other sale of VMC, either alone or together with other software or
hardware, requires a licensing agreement.
Address all correspondence to the author:
6320 Whitsett Ave. #4
North Hollywood, CA 91606
or E-mail at Glendale Litera BBS 818-956-6164
|||||| SOURCES ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||:
Please note that copies of VMC CANNOT be ordered directly from the author.
Glendale Littera QBBS - Glendale, CA (818)956-6164 is the primary distribution
point for VMC. If it becomes necessary to update VMC, new versions will be
|||||| DISCLAIMER ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
You undertake to use VMC at your own risk.
The author assumes no liability for damages of any kind
resulting from your use of VMC.
|||||| USING VMC ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||:
Place VMC.COM in either the current directory
or a directory that is included in your PATH setting.
To use VMC, simply type VMC
from the DOS command line.
Macro data files must have these identifiers:
.VDF for function key macros
.VDK for keyboard macros
(These identifiers are required by VDE as well.)
Macro text files must have these identifiers:
.VTF for function key macros
.VTK for keyboard macros
An easy way to remember these identifiers is to think of the D in
.VDF and .VDK as "Data" and the T in .VTF and .VTK as "Text".
VMC determines the kind of conversion based on the input filename.
The converted output file uses the name portion of the input file
and has the correct identifier for the type of file it is, i.e.:
Input Output Conversion
*.VDK -> *.VTK Keyboard macro data file converted to text file
*.VTK -> *.VDK Keyboard macro text file converted to data file
*.VDF -> *.VTF Function key data file converted to text file
*.VTF -> *.VDF Function key text file converted to data file
Entering VMC without a filename parameter will produce a single-screen
syntax summary for quick reference.
|||||| MACRO TEXTFILE FORMAT ||||||||||||||||||||||||||||||||||||||||||||||||:
Macro text files should be plain ASCII files, saved in /A or /N mode of VDE.
Macro text files use the same format for both .VTF and .VTK files.
Each macro must be typed on a single line. Each line may contain up to 256
text characters. VMC aborts if a line compiles to more than 128 characters in
the data file. This conforms with the VDE limit of 128 characters for any one
macro. Since control and alt keys may be represented in the text file as
two-character expressions, VMC allows text lines longer than 128 characters.
Each macro must begin with a label representing the key it is assigned to. The
label must be surrounded by . The label expression must begin in column 1.
For .VTF (function key) files the valid labels are ...
Remember that VDE assigns function keys like this:
[F1]...[F10] = F01...F10 in VDE notation
Shift-[F1]...[F10] = F11...F20
Ctrl-[F1]...[F10] = F21...F30
Alt-[F1]...[F10] = F31...F40
If you have an Enhanced (101-key) AT keyboard, also:
[F11],[F12] = F41,F42
Shift-[F11],[F12] = F43,F44
Ctrl-[F11],[F12] = F45,F46
Alt-[F11],[F12] = F47,F48
Function keys must be arranged in ascending numeric order in the .VTF file.
A .VTF file may have up to 48 lines.
Valid .VTK (keyboard macro) labels are in the ranges .. and [A]..[Z].
Label letters can be upper or lower case. Macros must be in the order 0..9,
A..Z in the .VTK file. .VTK files can have up to 36 lines.
|||||| SPECIAL CHARACTERS IN MACRO TEXT FILES ||||||||||||||||||||||||||||||||
There are several special characters in macro text files.
The @ symbol indicates the next key will be an Alt key. The
next key MUST be in the ranges A-Z or a-z.
The ^ symbol indicates the next key will be a Ctrl key. The next key
MUST be either ^, [, ], _ or \ or in the ranges A-Z or a-z. You can also
enter Ctrl keys directly in your text file, by pressing ^P followed by a
letter. VMC's output file will always convert to the ^ expession.
The Escape key can be entered as a control key (^[) or by pressing ^P then
the Escape key. Again, VMC will always convert to the ^ expression.
The ` (back apostrophe) symbol tells VMC to place the next character in
the data file without any conversion. This is useful if you need an actual
@ or ^ symbol in your macros. To enter an actual back apostrophe, you must
place two in a row.
|||||| NO REPEAT / QUIET MODES ||||||||||||||||||||||||||||||||||||||||||||||:
To make a macro run in No-repeat mode, Quiet mode or Both, put N, Q or B
as the first character after the label. (You can also use q or n.) If
you need a Q, q, N, n, B or B as the actual first letter of a macro, instead
of as a No-repeat, Quiet or Both mode designator, type a ` (back apostrophe)
|||||| ERROR MESSAGES ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VMC produces error messages for many conditions, including invalid filenames,
invalid macro order, bad macro labels, invalid character following ^ or @ and
some other conditions. If an error occured in macro processing VMC tells you:
Error occured after macro:
and then shows you a macro label. The label shown indicates the last correctly
processed macro. Whatever macro follows is where the error occured.
|||||| COMMENTING YOUR MACROS ||||||||||||||||||||||||||||||||||||||||||||||||
If you would like to comment your macros, keep the comments in a file named
with the name portion of your macro file and use an extension of .VCK or
.VCF. Think of the C representing Comments. Then use VDE and AltW to view
the .VT? and the .VC? files simultaneously.
|||||| ACKNOWLEDGEMENTS ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Thanks to Eric Meyer for VMC development suggestions and for VDE in the
first place, and to Fred Haines and Ben Cohen at Glendale Litera BBS for
coming up with the idea of writing a VDE macro compiler.