home *** CD-ROM | disk | FTP | other *** search
/ ProfitPress Mega CDROM2 …eeware (MSDOS)(1992)(Eng) / ProfitPress-MegaCDROM2.B6I / APPS / WORDPERF / WPMPRT11.ZIP / WPMPRT.DOC < prev    next >
Encoding:
Text File  |  1991-11-24  |  16.1 KB  |  416 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.                              WPMPRT
  13.              WordPerfect 5.1 Macro Printing Utility
  14.                        User Documentation
  15.                            version 1.1
  16.  
  17.                   (c) Copyright 1991, Les Dunn
  18.                     Micro Management Systems
  19.                        All Rights Reserved
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.                            CONTENTS
  30.  
  31.  
  32. CONTENTS . . . . . . . . . . . . . . . . . . . . . . . . . . .  i
  33.  
  34. INTRODUCTION . . . . . . . . . . . . . . . . . . . . . . . . .  1
  35.  
  36. TRADEMARKS . . . . . . . . . . . . . . . . . . . . . . . . . .  1
  37.  
  38. FILES INCLUDED IN THE 'WPMPRT11.ZIP' PACKAGE . . . . . . . . .  1
  39.  
  40. ENHANCEMENTS/BUG REPORTS . . . . . . . . . . . . . . . . . . .  2
  41.  
  42. THE WPMPRT.EXE COMMAND LINE. . . . . . . . . . . . . . . . . .  2
  43.  
  44. ARGUMENTS. . . . . . . . . . . . . . . . . . . . . . . . . . .  2
  45.  
  46. OUTPUT FILE SPECIFICATION. . . . . . . . . . . . . . . . . . .  2
  47.  
  48. INPUT FILE SPECIFICATION . . . . . . . . . . . . . . . . . . .  3
  49.  
  50. SYNTAX EXAMPLES. . . . . . . . . . . . . . . . . . . . . . . .  3
  51.  
  52. STATUS MESSAGES. . . . . . . . . . . . . . . . . . . . . . . .  4
  53.  
  54. ERROR/WARNING MESSAGES . . . . . . . . . . . . . . . . . . . .  4
  55.  
  56. CONTENTS OF OUTPUT FILES . . . . . . . . . . . . . . . . . . .  5
  57.  
  58. WORDPERFECT COMPOSED CHARACTERS IN MACROS. . . . . . . . . . .  5
  59.  
  60. RETRIEVING THE OUTPUT FILE INTO WORDPERFECT. . . . . . . . . .  6
  61.  
  62. CONTACTING THE AUTHOR. . . . . . . . . . . . . . . . . . . . .  8
  63.                           WPMPRT.EXE
  64.              WordPerfect 5.1 Macro Printing program
  65.                   (c) Copyright 1991, Les Dunn
  66.                     Micro Management Systems
  67.                        All Rights Reserved
  68.  
  69. INTRODUCTION
  70.  
  71. WPMPRT is a utility program written to translate the contents of
  72. WordPerfect 5.1 macro files (*.wpm) to their ASCII representations
  73. so that they may be printed, displayed on the screen, incorporated
  74. into word processing files or treated in a manner that any ASCII
  75. text file may be used.
  76.  
  77. This program was written as shareware, and as such, registration is
  78. required in order to ensure that you receive support, information
  79. pertaining to future updates and (heaven forbid!) bug reports and
  80. corrections. The enclosed README.DOC file contains information
  81. regarding copyrights and registration information. PLEASE READ THIS
  82. "README.DOC" FILE FIRST.
  83.  
  84.  
  85. TRADEMARKS
  86.  
  87. "WordPerfect" is a registered trademark of WordPerfect Corporation,
  88. 1555 N. Technology Way, Orem, Utah 84057 U.S.A. The author of the
  89. WPMPRT utility program has no affiliation with the WordPerfect
  90. Corporation.
  91.  
  92.  
  93. FILES INCLUDED IN THE 'WPMPRT11.ZIP' PACKAGE
  94.  
  95.      The following files are included in the WPMPRT11.ZIP package:
  96.  
  97.      HISTORY.DOC - version history
  98.      README.DOC  - copyright and registration information
  99.      README.WP   - the WordPerfect version of README.DOC
  100.      WPMPRT.EXE  - the WPMPRT program
  101.      WPMPRT.DOC  - documentation for the WPMPRT program
  102.      WPMPRT.WP   - the WordPerfect version of WPMPRT.DOC
  103.      WPMPRT.WPM  - WordPerfect macro to re-compose characters
  104.      WPMPRT.TXT  - sample text file produced from WPMPRT-ing the
  105.                    WPMPRT.WPM WordPerfect macro file.
  106.      T1.WPM      - sample WordPerfect macro to create an ASCII
  107.                    character table
  108.      T1.TXT      - sample text file produced from WPMPRT-ing the
  109.                    T1.WPM WordPerfect macro file
  110.  
  111.     
  112. ENHANCEMENTS/BUG REPORTS
  113.  
  114. If you encounter problems or errors, or have any suggestions for
  115. enhancements, please forward pertinent details to the author. Every
  116. attempt will be made to rectify and/or implement all of these
  117. submissions in a timely manner.
  118.  
  119.  
  120. THE WPMPRT.EXE COMMAND LINE
  121.  
  122.      C:>       WPMPRT [-q] [-sNN] [-mNN] [-o filename] filelist
  123.  
  124. ARGUMENTS
  125.  
  126.      The following options may be entered in either upper or lower
  127. case letters.
  128.  
  129.      -q             Quiet mode. Suppresses printing of the
  130.                     activity report on the screen.
  131.  
  132.      -sNN           Inter-listing spacing. Omit for page breaks.
  133.                     NN>0 to suppress page breaks and leave NN
  134.                     spaces between listings in a single output
  135.                     file.
  136.  
  137.      -mNN           Left Margin spacing. NN is the number of
  138.                     spaces that are desired for a left margin. The
  139.                     default is 8.
  140.  
  141.      -o filename    directs listings of all input files to the
  142.                     single specified output file.
  143.  
  144.      filelist       a single input file name or list of input file
  145.                     names.
  146.  
  147.  
  148.  
  149. OUTPUT FILE SPECIFICATION
  150.  
  151. If an output file is not specified with the -o option, a separate
  152. output file will be created for each input file specified in the
  153. filelist. Each created output file will have a file extension of
  154. .TXT. 
  155.  
  156. If an output filename is provided, ALL input file listings will be
  157. printed to this one output file. By default, listings in this file
  158. are separated from each other by page breaks. You may suppress
  159. these page breaks by setting the -s option where NN will be the
  160. number of blank lines that will be left between listings within the
  161. output file. 
  162. A fully qualified output file name may be provided if the output
  163. file is to be written to a directory other than the current default
  164. directory. 
  165.  
  166.      If the output file is to be printed and stored in a binder,
  167. you may specify a margin setting. This margin setting is an integer
  168. number stating the number of spaces that are to be entered at the
  169. beginning of each output line as a margin. The default is 8 spaces.
  170.  
  171. INPUT FILE SPECIFICATION
  172.  
  173. You may specify a single input file name or a list of file names as
  174. the filelist argument. Each input file will be processed
  175. sequentially. You may use wildcard names to specify the list of
  176. input files. A fully qualified file name should be specified if the
  177. input file resides in a directory other than the current directory.
  178. You need not specify an extension on the input file name since the
  179. WPMPRT program will assume that all input files have an extension
  180. of .WPM. File extensions will be ignored for input files. 
  181.  
  182.  
  183. SYNTAX EXAMPLES
  184.  
  185.      WPMPRT c:\wp51\altx.wpm       
  186.           will create an output ASCII text file named
  187.           'C:\WP51\ALTX.TXT' (default output file name) from the
  188.           specified input file name 'C:\WP51\ALTX.WPM'.
  189.  
  190.      WPMPRT -ob:macro.asc c:\wp51\altr.wpm
  191.           will create the specified output ASCII text file named
  192.           'MACRO.ASC' on the B: drive. The specified input file
  193.           'c:\WP51\ALTR.WPM' will be processed.
  194.  
  195.      WPMPRT -o c:\mac_asc\example.xxx c:\wp51\proof1
  196.           will create an output ASCII text file named 'EXAMPLE.XXX'
  197.           in the pre-created 'MAC_ASC' directory on the C: drive.
  198.           The input file is the C:\WP51\PROOF1.WPM file.
  199.  
  200.      WPMPRT -omacros.txt c:\macros\*.wpm
  201.           will create a single output ASCII text file named
  202.           'MACROS.TXT' in the current directory. All .WPM macros
  203.           files in the 'C:\MACROS\' directory will be printed in
  204.           this output file.
  205.  
  206.      WPMPRT c:\macros\*.*
  207.           will print ALL WordPerfect macro files in the 'C:\MACROS'
  208.           directory. Non-macro files will not be printed. Each file
  209.           will be printed to a separate, corresponding output file.
  210.           Each output file will default to the same file name as
  211.           the input file with the extension of .TXT.
  212.  
  213.      WPMPRT -q -o a:\wp51\macros\output.asc *.wpm
  214.           will print ALL WordPerfect macro files in the current
  215.           directory to the specified output file on drive A:. All
  216.           status messages will be suppressed.
  217.  
  218.      WPMPRT -s3 c:\macros\*.
  219.           will print ALL WordPerfect macro files in the 'C:\MACROS'
  220.           directory to multiple output files. Page breaks between
  221.           listings will be replaced by 3 blank lines.
  222.  
  223.      WPMPRT -m 5
  224.           will print ALL WordPerfect macro files in the current
  225.           default directory to a multiple output file. The left
  226.           margin will be set to 3 spaces (instead of the default of
  227.           8).
  228. STATUS MESSAGES
  229.  
  230. As each WordPerfect macro file is translated and printed, a status
  231. message is printed on stdout (usually the screen) indicating the
  232. name of the input file and the name of the output file to which the
  233. translated output is written. The printing of these status messages
  234. may be suppressed by specifying the -q option (Quiet mode) on the
  235. command line. 
  236.  
  237.  
  238. ERROR/WARNING MESSAGES
  239.  
  240. The following error or warning messages may appear during the
  241. execution of the WPMPRT program. Distinct return codes are set for
  242. each error. Errors will terminate the execution of the WPMPRT
  243. program immediately. Warnings will allow the program to continue
  244. but the warning message will print along with Status Messages on
  245. the standard output device.
  246.  
  247. Return Code    Message
  248.  
  249.      201       [Usage:] ...
  250.                     no arguments are provided in the call to the
  251.                     WPMPRT program. You must provide at least the
  252.                     input file name.
  253.  
  254.      202       ERROR: Output file name not specified.
  255.                     the -o option was specified but no file name
  256.                     was provided.
  257.  
  258.      203       ERROR: Can't open output file <filename.ext>.
  259.                     the program tried to open the output file.
  260.                     Check for sufficient disk space or a non-
  261.                     existent/invalid path name.
  262.  
  263.      204       ERROR: Can't find or open input file <filename.ext>.
  264.                     the specified input file does not exist.
  265.  
  266.      205       ERROR: Input file not specified.
  267.                     at least one input file name has not been
  268.                     provided as an argument to the program.
  269.  
  270.      206       ERROR: Unknown code in macro file.
  271.                     the WPMPRT program detected an unknown code in
  272.                     the specified macro file. Ensure that the
  273.                     macro file is a valid WordPerfect macro file.
  274.  
  275.      100       WARNING: Invalid option <-*>. Option ignored.
  276.                     an option other than o, s or q has been
  277.                     entered as an argument for the WPMPRT program.
  278.  
  279.      100       WARNING: Invalid line spacing number specified.
  280.                         Using page breaks.
  281.                     the number entered for the -s option as an
  282.                     argument was invalid.
  283.  
  284.      100       WARNING: No files found for <filename.ext>.
  285.                     usually seen if the file name specified uses
  286.                     the wildcard feature and no files were found
  287.                     when the wildcard was expanded.
  288.  
  289.      100       WARNING: Unknown KEY MACRO code. Noted as {*KEY*}.
  290.                     during macro translation, a KEY macro command
  291.                     was detected but the exact command was not
  292.                     known.
  293.  
  294.      100       WARNING: Unknown ALT MACRO code. Noted as {*ALT*}.
  295.                     during macro translation, an ALT macro command
  296.                     was detected but the exact command was not
  297.                     known.
  298.  
  299.      100       WARNING: Unknown VAR MACRO code. Noted as {*VAR*}.
  300.                     during macro translation, a VAR macro command
  301.                     was detected but the exact command was not
  302.                     known.
  303.  
  304.  
  305. CONTENTS OF OUTPUT FILES
  306.  
  307. Each output file contains the following information:
  308.  
  309.      FILE   :  path/filename.extension of the input file as it
  310.                appears in the argument list.
  311.  
  312.      HEADING:  the WordPerfect macro heading.
  313.      
  314.      a single blank line spacer
  315.  
  316.      the translated macro codes formatted with the same format as
  317.           displayed in the macro editor.
  318.  
  319.      inter-listing blank lines (specified with the -s option) or a
  320.           form-feed character (if no -s option specified). Inter-
  321.           listing spacing is ignored if individual output files are
  322.           created for each input file (ie. no -o option specified).
  323.  
  324.  
  325. WORDPERFECT COMPOSED CHARACTERS IN MACROS
  326.  
  327. WordPerfect provides the ability to create a user-defined character
  328. set in which you assign the characters with the Printer Definition
  329. Program (see the Appendix - Printer Program in the WordPerfect
  330. documentation). Other character sets are also available (13 in
  331. total) from which you may select specific characters (see the
  332. Appendix - WordPerfect Characters in the WordPerfect
  333. documentation). These characters are selected using the 'Compose'
  334. command of WordPerfect (see the Compose command in the WordPerfect
  335. documentation). 
  336.  
  337. The Compose command specifies the character set number (0 to 12)
  338. and a character number from within that character set. WordPerfect
  339. indicates the composed character within a macro using the following
  340. representation:
  341.  
  342.      [char:charset,charnum]
  343.  
  344. where:
  345.      char      - is a representation of the character selected.
  346.      charset   - is the character set number from which the
  347.                character has been selected.
  348.      charnum   - is the character number of the character in the
  349.                character set.
  350.  
  351. In order to correctly document these composed characters, WPMPRT
  352. represents any composed character using this notation in the output
  353. file. The character represented is displayed as a blank in the
  354. output file. This is done since the video character set used by DOS
  355. may display differently than the one being used in WordPerfect
  356. which may be different than the one used by your printer. Using
  357. this convention, WPMPRT will produce an output file which displays
  358. the WordPerfect composition of special characters rather that the
  359. character itself. Another consideration is the use of characters
  360. which are displayable on the video screen but which may mean
  361. something totally different if found within a disk file. For
  362. example, ASCII character 26 (composed character [:6,21]) displays
  363. as a right-pointing arrow when the macro is edited within the
  364. WordPerfect macro editor. When stored in a file, however, ASCII
  365. character 26 represents the ctrl-Z character which is an EOF
  366. character in DOS. It is evident that this character should not be
  367. stored in the output file.
  368.  
  369.  
  370. RETRIEVING THE OUTPUT FILE INTO WORDPERFECT
  371.  
  372. The created ASCII output files can be retrieved into WordPerfect in
  373. order to include the macro listing as part of a WordPerfect
  374. document. As a result, you will be able to use the printer
  375. definitions within WordPerfect to allow you to print the macro
  376. listing on your attached printer. This is especially valuable for
  377. output to either a postscript printer or to a printer which
  378. supports the character set(s) required to display any 'composed'
  379. characters which you may have used within you macro.
  380.  
  381. For example, your macro may prompt the user with:  
  382.  
  383.                Enter your name 
  384.  
  385. where 'name' is followed by the composed character [:6,21] which
  386. is displayed on your monitor in WordPerfect as the right-pointing
  387. arrow. When WPMPRT produces the output file, this character is
  388. represented as '{[ :6,21]}' (with a blank in place of the actual
  389. character). If your copy of WordPerfect has been set up to use an
  390. attached printer which will display this character, you may start
  391. WordPerfect and retrieve the output file into the current document.
  392. At this point, the character is still represented by '{[ :6,21]}'.
  393. In order to convert the character back and display it as a right-
  394. pointing arrow you should run the WPMPRT.WPM macro. This macro will
  395. convert all composed characters represented in this form back to
  396. the proper composed character. This macro allows you to employ and
  397. display user-defined characters (character set 12) that are used
  398. within your WordPerfect macro. Assuming that your printer will
  399. print such composed characters, you may then print the document
  400. (macro listing) on your printer and the correct characters will be
  401. displayed. CONTACTING THE AUTHOR
  402.  
  403.      The author may be contacted at the following address:
  404.  
  405.                Les Dunn
  406.                Micro Management Systems
  407.                348 Scottsdale Drive
  408.                Guelph, Ontario.   N1G 2Z8
  409.                CANADA
  410.  
  411.      phone:    (519) 836-6605
  412.  
  413.      BITNET address: SOSDUNN@vm.uoguelph.ca
  414.                      (until April 30, 1991.)
  415.  
  416.