home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 22 gnu / 22-gnu.zip / texprt14.zip / TeXPERT.DOC < prev    next >
Text File  |  1994-03-01  |  11KB  |  253 lines
  1. Small documentation for TeXPERT:
  2. ---------------------------------
  3.  
  4.  
  5. 0.Files in this package:
  6. ------------------------
  7. - ReadMe.OS2    - small overview over TeXPERT (OS/2 Version only)
  8. - ReadMe.DOS    - dito                        (DOS  Version only)
  9. - TeXPERT.DOC   - this documentation
  10. - TeXPERTd.EXE  - German version of TeXPERT  \ put one of these in a
  11. - TeXPERTe.EXE  - English version of TeXPERT / directory in your path
  12. - TeXENV.DAT    - default TeX-Environment file for TeXPERT
  13. - emx.dll       - emx-0.8h dll, put in a directory in your LIBPATH
  14.                   for example x:\os2\dll or x:\emtex\dll (OS/2 only)
  15.  
  16.  
  17. 1.Patterns:
  18. -----------
  19. Patterns are normal ASCII-Files that quickly can be loaded via the pattern
  20. menu. You can define up to 20 patterns and give them a name of your choice.
  21. If you select a pattern from the menu it will replace the text in the current
  22. buffer while the name of the buffer is not changed or will optionally be
  23. loaded into a new (unnamed) buffer.
  24. You can use them for example to load a pattern of a letter...
  25.  
  26.  
  27. 2.Archives:
  28. -----------
  29. You can invoke "grep" (or another scanner of your choice) from TeXPERT to
  30. scan your texts for a string. Select "Archives - Search for key word".
  31. The names of the files found are stored in a file called "TeXPERT.FND".
  32. You can select a file from this list by calling "Archives - Select text".
  33.  
  34. To replace grep by another scanner select "Archives options" from the
  35. "Options" menu. In the "Parameter of scan program" %1 represents the search
  36. string, %2 represents the files to scan, and %3 represents the output file
  37. ("TeXPERT.FND" on default). The output has to have exactly the same format
  38. as grep.
  39. Note: "grep" is contained in the gnu text utils, available from ftp.cdrom.com
  40.       and other sites.
  41.  
  42.  
  43. 3.TeX:
  44. ------
  45. You can call several TeX programs from TeXPERT. You can adjust the programs
  46. to start and their parameters by selecting "TeX options" in the "Options"
  47. menu. You will be asked for:
  48. - Name of menu entry   : Text to appear as menu choice in the TeX-Menu.
  49. - Name of program      : Filename of the program to be called.
  50.                          If this is left blank, CMD.EXE (OS/2) resp.
  51.                          COMMAND.COM (DOS) will be called.
  52. - Options for program  : Parameters that will be passed to the program.
  53.                          (see 3.2.)
  54. - HotKey for invokation: Scancode of the hotkey to call the program.
  55.                          You may press Ctrl-A and then the hotkey to let
  56.                          TeXPERT find the correct scancode.
  57.  
  58. You will also be asked for the type of the dialog to be called before
  59. the start of the program:
  60. - Separator     : This program entry will not be executed. Its line
  61.                   in the TeX-Menu will be marked to be non-selectable.
  62.                   This is useful to include separator lines in the TeX-Menu.
  63. - No Dialog     : The program will be executed without opening a dialog box.
  64. - Preview Dialog: A preview dialog will be opened before starting the program.
  65. - Print Dialog  : A print dialog will be opened before starting the program.
  66. - MFJob Dialog  : A mfjob dialog will be opened before starting the program.
  67.  
  68. You may specify some further options:
  69. - autosave file before start: Save current editor file before starting
  70.                               the program.
  71. - don't use TeX-Environment : see 3.1.
  72. - close window on exit      : close window of the program to be executed
  73.                               when program has ended (OS/2 only)
  74. - session type for program  : PM, fullscreen or standard (OS/2 only)
  75.  
  76. The default settings are adjusted to the normal emTeX package (for TeX
  77. programs) respectively the beta DVI-driver package (for DVI-drivers) of
  78. November 1992.
  79.  
  80. 3.1.TeX-Environment:
  81. --------------------
  82. The programs are passed an environment, that can be entered in a small editor
  83. window by selecting "Options - TeX environment". Note that you HAVE to include
  84. a PATH and a DPATH (OS/2 only) environment entry pointing to "X:\EMTEX" (where
  85. X: is the drive where emTeX is installed) and a COMSPEC entry pointing to
  86. C:\OS2\CMD.EXE (OS/2) or C:\DOS\COMMAND.COM (DOS) respectively. You may also
  87. want to include an EMXOPT environment entry if you use TeX386 or MF386. The
  88. environment is saved in an ASCII file as "TEXENV.DAT" (or what you enter in
  89. "Options - Editor options". If you begin a line in the environment file with
  90. a "+", it is appended to the previous line.
  91.  
  92. The easiest way to create the environment file is to read your "set-tex.cmd"
  93. via ^KR into the environment editor and to delete all "SET "'s by pressing
  94. ^KZ4 (i.e. move block 4 columns right). Then include the PATH, DPATH and
  95. COMSPEC environment strings.
  96.  
  97. If you want a program to use the standard environment (which is specified
  98. in CONFIG.SYS (OS/2) or AUTOEXEC.BAT (DOS)), check the "Don't use
  99. TeX-Environment" button in its options dialog.
  100.  
  101. 3.2.Parameters of programs to be executed:
  102. ------------------------------------------
  103. Within the options string (see above) for each program you may use some
  104. special expressions. They all look like this:
  105.     %<name>
  106. or  %<name>[<default>]
  107. These expressions will be replaced by the content of the internal TeXPERT
  108. variable <name>. If the content of <name> is empty and [<default>] is used,
  109. the expression will be replaced by <default>.
  110.  
  111. The following variables are available:
  112. (*)  %fullname : full name of the editor/main file  (e.g. X:\MYTEX\TEST.TEX)
  113. (*)  %name&ext : name and ext of editor/main file   (e.g. TEST.TEX)
  114. (*)  %path&name: path and name of editor/main file  (e.g. X:\MYTEX\TEST)
  115. (*)  %name     : body of name of editor/main file   (e.g. TEST)
  116. (*)  %path     : path of editor/main file           (e.g. X:\MYTEX)
  117. (*)  %ext      : extension of editor/main file      (e.g. TEX)
  118.      %begin    : first page number  (after preview/print dialog only)
  119.      %end      : last page number   (after preview/print dialog only)
  120. (*)  %trans    : transformation     (after preview/print dialog only)
  121.      %copies   : number of copies requested (after print dialog only)
  122.      %fonts    : font names                 (after mfjob dialog only)
  123.      %steps    : font sizes                 (after mfjob dialog only)
  124.      %model    : printer model              (after mfjob dialog only)
  125.  
  126. Variables marked by (*) are never empty; therefore "%fullname[xyz.tex]" is
  127. equivalent to "%fullname".
  128.  
  129. Three special variables exist: %format, %special1 and %special2
  130. If one of these variables is specified in the parameter string, TeXPERT will
  131. open the editor/main file and scan the first 10 lines of the file for the
  132. string "%format=", "%special1=" resp. "%special2=". The string has to start
  133. in the first column of the file. If TeXPERT finds the required string, it
  134. will replace it in the parameter string by the string that starts after the
  135. =-character up to the next whitespace or linefeed.  Otherwise it will use
  136. the default string.
  137. Note that TeXPERT will open the disk file, even if the file is loaded in
  138. the editor. So you have to save your editor file before calling the program
  139. (or specify "autosave" in the options (see above)).
  140.  
  141. Example:
  142. --------
  143. Editor file:                     TEST1.TEX               TEST2.TEX
  144. Contents:                        \documentstyle...       \documentstyle...
  145.                                  %format=myfmt           %special1=1
  146.                                  ...                     ...
  147.                 expands to:
  148. %format[lplain]                  myfmt                   lplain
  149. /tr%special1[%trans]             value specified in      1
  150.                                  preview/print dialog
  151.  
  152.  
  153. 4.Word wrap:
  154. ------------
  155. Can be activated by entering a non zero value for "Auto word wrap at column"
  156. in "Options - Editor options".
  157.  
  158.  
  159. 5.Macros:
  160. ---------
  161. Macros can be recorded by pressing ALT-F1. A menu will pop up listing
  162. all recorded macros (if any). You can now choose "Record" to record
  163. a new macro. If you do so, you'll be asked for the name of the macro
  164. and the one ore two hot keys, which will invoke the macro. After
  165. selecting "Ok" all keystrokes you do will be recorded until you press
  166. ALT-F1 a second time. Different macros must differ in their name!
  167.  
  168. From within the macro menu you are also able to invoke and delete macros.
  169.  
  170.  
  171. 6.Warranties:
  172. -------------
  173. Exactly none
  174.  
  175.  
  176. 7.Bugs:
  177. -------
  178. I'm sure there are some, please report them and any suggestions to
  179.    jmartin@goofy.zdv.uni-mainz.de
  180.  
  181.  
  182. 8.Changes:
  183. ----------
  184. Version 1.4 (03/02/1994):
  185.   - support of wildcards and response files in command line
  186.   - TeX options have been changed significantly. Although TeXPERT will
  187.     read old configuration files you have to change the TeX-Options!!
  188.     (see section 3)
  189.   - colors can now be changed
  190. Version 1.3b (09/22/1993):
  191.   - TeXPERT looks for its configuration file now in
  192.     1. current directory
  193.     2. directory where TeXPERT.EXE is (new, OS/2 only)
  194.     3. DPATH (OS/2) or PATH (DOS)
  195.   - "Main file" now possible
  196. Version 1.3a (09/12/1993):
  197.   - fixed some minor bugs
  198.   - fixed problems with TeXPERT running in OS/2 2.1 fullscreen sessions
  199.   - DOS Version now generally available
  200. Version 1.3 (06/04/1993):
  201.   - more options in menu "TeX-Options" (auto-save, start programs in window/
  202.     fullscreen, maximized/minimized, etc)
  203.   - integrated clipboard (cut, copy, paste)
  204.   - bug fixed in handling of small blocks
  205. Version 1.2:
  206.   - changed name to TeXPERT because of conflicts with DOS TeXShell
  207.   - changed maximum size of environment file to 100 lines
  208.     (previously 20 lines)
  209.   - changed macro handling:
  210.     - macros can be given a name
  211.     - macros are now stored in an ASCII file,
  212.       so old macros cannot be used with new TeXPERT
  213.   - changed TeX-options:
  214.     - entry for name of environment file now in Editor-Options
  215.     - TeX-menu can now be freely configured
  216.       (count and purpose of menu entries is variable)
  217.       some examples:
  218.       - you can include an editor of your choice in the TeX-Menu
  219.         (if you don't like wordstar)
  220.       - you can include different TeX's, for examples plain, latex,
  221.         amstex, and so on
  222.     - Options are now stored in an ASCII file.
  223.       so the old configuration file cannot be used with new TeXPERT.
  224.  
  225. Version 1.1 (called TeXShell):
  226.   - Initial release
  227.  
  228.  
  229. 9.English:
  230. ----------
  231. TeXPERT was originally written in German, so please understand that the
  232. English translation is quite bad (you may get a feeling how translated
  233. English programs sound in German's ear ...).
  234.  
  235.  
  236. 10.Registration:
  237. ----------------
  238. TeXPERT is Shareware. To register send a nice postcard of your home village
  239. with some comments on TeXPERT to:
  240.    Johannes Martin
  241.    Pfarrer-Dorn-Straße 26
  242.    D-55127 Mainz
  243.    Germany
  244. In addition, any donation is appreciated ...
  245.  
  246.  
  247. 11.Copying:
  248. -----------
  249. You are allowed to copy this program under the condition that you
  250. - take no money for it,
  251. - leave the copyright statement unchanged,
  252. - copy all files included in this package (see section 0).
  253.