home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-387-Vol-3of3.iso / e / epmtex12.zip / EPMTEX.DOC < prev    next >
Text File  |  1993-02-19  |  12KB  |  314 lines
  1.                        TeX Macro Enhancements for EPM 5.51
  2.  
  3.                                   Version  1.2c
  4.  
  5.                                    Jon Hacker
  6.  
  7.                                   Feb 17, 1993
  8.  
  9. Disclaimer:
  10. ~~~~~~~~~~~
  11.  
  12. See the attached license.txt file that I more or less pilfered from IBM's
  13. license agreement.
  14.  
  15.  
  16. Introduction:
  17. ~~~~~~~~~~~~
  18. The E macro file tex.e when compiled with the IBM enhanced Editor translator
  19. ETPM.EXE will add a TeX pull down menu to the EPM menu bar to files with
  20. extensions .tex*, .sty, or .bbl.  A custom TeX extension can also be
  21. specified by defining MY_TEX_FILE_TYPE in the user's mycnf.e file.
  22.  
  23. Menu items in the TeX pull down menu allow the user to TeX (or LaTeX), preview
  24. (portrait and landscape), and print (portrait and landscape) the TeX file
  25. currently active in EPM.  A custom 'user' mode may also be defined for special
  26. needs unique to the user.
  27.  
  28. The E macro file texkeys.e when included will add TeX syntax assist and TeX 
  29. accelerator keys to files with extensions .tex*, .sty, or .bbl.  A custom
  30. TeX extension can also be specified by defining MY_TEX_FILE_TYPE in the user's 
  31. mycnf.e file.  
  32.  
  33. German users are advised to read the section 'Support for German Users' at the 
  34. end of this document.
  35.  
  36.  
  37. Installation:
  38. ~~~~~~~~~~~~
  39. For installation instructions see the file install.doc included with this 
  40. package.
  41.  
  42.  
  43. Using the EPM Pull Down Menu for TeX:
  44. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  45. This is a brief description of the menu items that appear on the TeX sub-menu 
  46. after installing the tex.e portion of EPMTeX V1.2c.  The TeX menu will only
  47. be loaded for files with extensions .tex*, .bbl, and .sty.  You can
  48. also specify an extension of your own choice by defining the variable
  49. MY_TEX_FILE_TYPE in your mycnf.e file.
  50.  
  51. (Note: this is a new feature, please let me know what you think of it!)  
  52.  
  53. >TeX Document.
  54.  
  55.    Calls the version of TeX specified by the variable TEX_EXEC in the tex.e file 
  56.    (or LATEX_EXEC if latex mode is selected) with the name of the current file
  57.    appended.  Note that the appended filename is specified with UNIX type 
  58.    directory delimiters (ie.  '/') so that TeX will not barf.  
  59.  
  60.    If a 'user' mode was defined (see install.doc) then the executable file 
  61.    specified by the variable TEX_USER_EXEC in the tex.e file (or LATEX_USER_EXEC 
  62.    if latex mode is selected) will be run with the name of the current file
  63.    appended when the 'user' mode is selected.
  64.  
  65.    If the Auto Save option is checked in the TeX pulldown menu, the current file
  66.    will first be saved to disk if the version in EPM memory has been modified.
  67.  
  68. >Preview Document
  69.  
  70.    Calls the TeX previewer specified by the variable TEX_VIEW_EXEC (or 
  71.    TEX_VIEWLA_EXEC if landscape mode is selected) with the name of the 
  72.    associated DVI file for the current file loaded in EPM appended.  
  73.  
  74.    The TeX previewer specified by the variable TEX_VIEW_EXEC should be the
  75.    previewer used for portrait orientation.  The TeX previewer specified by the
  76.    variable TEX_VIEWLA_EXEC should be the previewer used for landscape
  77.    orientation.
  78.  
  79.    If the Auto LOG Delete option is checked in the TeX pulldown menu, the 
  80.    associated LOG file for the current file will be automatically deleted if 
  81.    it exists.
  82.  
  83. >Print Document
  84.  
  85.    Calls the TeX dvi printer driver specified by the variable TEX_PRINT_EXEC (or 
  86.    TEX_PRINTLA_EXEC if landscape mode is selected) with the name of the 
  87.    associated DVI file for the current file loaded in EPM appended.  
  88.  
  89.    The TeX printer driver specified by the variable TEX_PRINT_EXEC should be the 
  90.    printer driver used for portrait orientation.  The TeX printer driver 
  91.    specified by the variable TEX_PRINTLA_EXEC should be the printer driver used 
  92.    for landscape orientation.  
  93.  
  94.    If the Auto LOG Delete option is checked in the TeX pulldown menu, the 
  95.    associated LOG file for the current file will be automatically deleted if 
  96.    it exists.
  97.  
  98.  
  99. > Delete LOG File
  100.  
  101.    If file exists, this command will delete the associated LOG file for the
  102.    current file loaded in EPM.
  103.  
  104. > Delete DVI File
  105.  
  106.    If file exists, this command will delete the associated DVI file for the
  107.    current file loaded in EPM.
  108.  
  109. > Latex Mode
  110.  
  111.    If enabled (checkmark beside menu entry), the version of TeX specified by the
  112.    variable LATEX_EXEC is called to TeX the document.  Otherwise, the version of
  113.    TeX specified by the variable TEX_EXEC is called to TeX the document.
  114.  
  115. >  'User' Mode
  116.  
  117.    If TEX_USER_MENU_TEXT was defined in tex.e, it will show up here.
  118.  
  119.    If enabled (checkmark beside menu entry), the version of TeX specified by the
  120.    variable TEX_USER_EXEC (or LATEX_USER_EXEC if in latex mode) is called to TeX 
  121.    the document.  Otherwise, the version of TeX specified by the variable 
  122.    TEX_EXEC (or LATEX_EXEC if in latex mode) is called to TeX the document.  
  123.  
  124.  
  125. > Landscape Mode
  126.  
  127.    If enabled (checkmark beside menu entry), the landscape versions of the TeX
  128.    previewer and printer driver are used (specified by TEX_VIEWLA_EXEC and
  129.    TEX_PRINTLA_EXEC respectively).  Otherwise, the portrait versions of
  130.    the TeX previewer and printer driver (specified by TEX_VIEW_EXEC and 
  131.    TEX_PRINT_EXEC respectively) are used.  
  132.  
  133.  
  134. > Auto LOG Delete
  135.  
  136.    If enabled (checkmark beside menu entry) the associated LOG file for the
  137.    current file will be automatically deleted if it exists when a preview or
  138.    print command is executed.
  139.  
  140. > Auto Save
  141.  
  142.    If enabled (checkmark beside menu entry) the current file will first be
  143.    saved to disk if the version in EPM memory has been modified before the
  144.    document is TeX'd.
  145.  
  146. > Syntax Expansion
  147.  
  148.    NOTE:
  149.    This option is not available if TeX syntax assist was not included at compile
  150.    time (default is to include it.  Set TEX_SYNTAX_ASSIST = 0 to not include it.).
  151.  
  152.    If enabled (checkmark beside menu entry) then the built-in TeX syntax
  153.    expansions will be enabled.  This is equivalent to typing 'expand on' at the
  154.    EPM command line.  The start-up mode is defined by the configuration constant
  155.    MY_EXPAND_ON described in the EPM documentation.
  156.  
  157. > Debug mode
  158.  
  159.    If enabled (checkmark beside menu entry) the contents of the command 
  160.    line sent to the OS/2 'start' command will be displayed on the EPM message 
  161.    line.  This can be useful when debugging the various TeX commands during the
  162.    installation of the EPMTeX enhancements.  It is normally turned off.  Note
  163.    that a list of recent messages can be retrieved in EPM under
  164.    options->messages.
  165.  
  166.  
  167.  
  168. Using the TeX Syntax Assist for EPM:
  169. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  170.  
  171. The TeX syntax assist provided with EPMTeX was developed by Jo Koenen.  If you 
  172. have suggestions, or better yet source code, that will expand the functionality 
  173. of this section we would love to hear from you.  
  174.  
  175. This is a brief description of the syntax assist and accelerator keys
  176. added if TEX_SYNTAX_ASSIST is included at compile time.
  177.   
  178.  
  179. > Syntax Expansion:
  180.  
  181. If TEX_SYNTAX_ASSIST = 1 is specified in your mycnf.e file, then the following 
  182. syntax expansions will be defined.
  183.  
  184. Loading a file with the extension .tex*, .sty or .bbl into EPM enables the
  185. following enhancements: (the vertical bar | denotes the cursor position)
  186.  
  187.  
  188. 1.  \be (including the blank after \be !!)  will be expanded to
  189.     \begin{|}
  190.  
  191.     now you can enter a TeX-word like itemize
  192.  
  193.     \begin{itemize}
  194.  
  195.     press enter and you get
  196.  
  197.     \begin{itemize}
  198.     |
  199.     \end{itemize}
  200.  
  201. 2.   \it  (including the blank) will be expanded to
  202.      \item |
  203.  
  204. 3.    \ci  (including the blank) will be expanded to
  205.       \cite{|}
  206.  
  207. That's all I (Jo) have done so far, but it is all source code, therefore
  208. it's expandable. Every suggestion is welcome.
  209.  
  210. >Accelerator Keys:
  211.  
  212. If TEX_WANT_ACCELERATOR_KEYS = 1 is specified in your mycnf.e file and syntax 
  213. expansion is enabled, then the following TeX accelerator keys will be defined.  
  214.  
  215. Key assignments (the vertical bar | marks the curor position):
  216.  
  217.     alt-a:=eqnarray|
  218.     alt-b:=\begin{|} \end{}
  219.     alt-c:=\cite{|}
  220.     alt-f:=\frac{|}{}
  221.     alt-i:=itemize|
  222.     alt-l:=\label{|}
  223.     alt-m:=\mbox{|}
  224.     alt-q:=equation|
  225.     alt-r:=\begin{tabular}{|c||}
  226.             \end{tabular}
  227.      {    :={|}
  228.      $    :=$|$
  229.  
  230.  
  231. Configuration Constants:
  232. ~~~~~~~~~~~~~~~~~~~~~~~
  233.  
  234.    The following configuration constants may be included in your mycnf.e file to
  235.    control syntax expansion support and define the start-up behaviour of the
  236.    'Latex mode', 'User mode' (if defined), 'Landscape mode', 'Auto LOG delete',
  237.    'Auto Save', and 'Debug mode' options.
  238.  
  239.  TEX_SYNTAX_ASSIST
  240.    Set to 1 to include TeX Syntax assist in EPM.  Set to 0 to not include
  241.    this option.  Default is (1), option on.
  242.  
  243.  TEX_WANT_ACCELERATOR_KEYS
  244.    Set to 1 to include TeX keyboard accelerator key definitions in EPM.  Set to 
  245.    0 to leave the keyboard alone.  Default is (0), option off.  Requires
  246.    TEX_SYNTAX_ASSIST = 1 to be set to have affect.
  247.  
  248.  TEX_LATEX_MODE
  249.    Set to 0 to turn EPMTeX latex mode off at start-up.  Set to 1 to turn mode on
  250.    at start-up.  Default is (0), latex mode off.
  251.  
  252.  TEX_USER_MODE
  253.    Set to 0 to turn EPMTeX 'user' mode off at start-up.  Set to 1 to turn mode
  254.    on at start-up.  Default is (0), user mode off.  The 'user' mode is only
  255.    defined if TEX_USER_MENU_TEXT is defined in tex.e (see install.doc).
  256.  
  257.  TEX_LANDSCAPE_MODE
  258.    Set to 0 to turn EPMTeX landscape mode off at start-up.  Set to 1 to turn 
  259.    mode on at start-up.  Default is (0), landscape mode off.
  260.  
  261.  TEX_AUTO_DELETE_LOG      
  262.    Set to 0 to turn EPMTeX log file auto-delete option off at start-up. Set to 1
  263.    to turn option on at start-up.  Default is (1), option on.
  264.  
  265.   TEX_AUTO_SAVE_DOC        
  266.    Set to 0 to turn EPMTeX smart save before TeX option off at start-up. Set to
  267.    1 to turn option on at start-up.  Default is (1), option on.
  268.  
  269.   TEX_DEBUG_MODE           
  270.    Set to 0 to turn EPMTeX debug mode off at start-up.  Set to 1 to turn option
  271.    on at start-up.  Default is (0), option off.
  272.  
  273.  
  274. Support for German Users:
  275. ~~~~~~~~~~~~~~~~~~~~~~~~
  276.  
  277. German users who compiled the german versions of epmtex.e (see install.doc for 
  278. more info) have an additional mode for german hyphenation.
  279.  
  280. > German Mode
  281.  
  282.    If enabled (checkmark beside menu entry), the version of TeX specified by the
  283.    variable TEX_USER_EXEC (or LATEX_USER_EXEC if in Latex mode) is called to TeX 
  284.    the document.  Otherwise, the version of TeX specified by the variable 
  285.    TEX_EXEC (or LATEX_EXEC if in latex mode) is called to TeX the document.  The 
  286.    german mode can be used to specify support for german hyphenation (ie.  
  287.    plaing and lplaing format files).  It is an example of the use of the 'user'
  288.    mode of EPMTeX.
  289.  
  290.  
  291. Support for emTeX's DVIPM betatest 1.4s:
  292. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  293.    This is only available in the German version for now (Jo wrote it).  If 
  294.    there is enough interest I will put it in the general version as well.
  295.  
  296.    The current release of DVIPM 1.4s has the following bug:  viewing a DVI-file
  297.    and TeXing this file again without closing dvipm causes an error because TeX 
  298.    can't write to the DVI-file opened by the previewer.  Therefore, you can't 
  299.    use the reload feature of DVIPM since the file has to be unloaded before 
  300.    TeXing and loaded again to view the DVI-file.  This will be changed in 
  301.    release 1.4t.  In the german mode I included a workaround.  
  302.  
  303. > Copy to temp.dvi
  304.    Copies myfile.dvi to temp.dvi
  305.  
  306. > Preview temp.dvi
  307.    loads the previewer with temp.dvi
  308.  
  309.    Now it's possible to TeX the document, while the DVIPM is running with temp.dvi.
  310.    Copying  myfile.dvi to temp.dvi works without an error although temp.dvi is used by
  311.    the previewer. File Reload with DVIPM reads the new temp.dvi. As a timesaving
  312.    result, DVIPM has to be loaded only once.
  313.  
  314.