home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-387-Vol-3of3.iso / e / epmtex12.zip / INSTALL.DOC < prev    next >
Text File  |  1993-02-19  |  15KB  |  355 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. Introduction:
  10. ~~~~~~~~~~~~
  11. The E macro file tex.e when compiled with the IBM enhanced Editor translator 
  12. ETPM.EXE will add a TeX pull down menu to the EPM menu bar to files with
  13. extensions .tex*, .sty, or .bbl.  A custom TeX extension can also be
  14. specified by defining MY_TEX_FILE_TYPE in the user's mycnf.e file.
  15.  
  16. Menu items in the TeX pull down menu allow the user to TeX (or LaTeX), preview 
  17. (portrait and landscape), and print (portrait and landscape) the TeX file 
  18. currently active in EPM.  A custom 'user' mode may also be defined for special
  19. needs unique to the user.
  20.  
  21. The E macro file texkeys.e when compiled with the IBM enhanced Editor translator
  22. ETPM.EXE will add TeX syntax assist and TeX accelerator keys to files with
  23. extensions .tex*, .sty, or .bbl.  A custom TeX extension can also be specified
  24. by defining MY_TEX_FILE_TYPE in the user's mycnf.e file.
  25.  
  26. German users are advised to read the section 'Support for German Users' at the
  27. end of this document.  Other languages can be added in a similar way.
  28.  
  29.  
  30. Requirements:
  31. ~~~~~~~~~~~~
  32. The TeX E macro package supplied with this package needs to be compiled before 
  33. it can be incorporated into EPM.  You will need to obtain the complete EPM 5.51 
  34. package from IBM to do this.  
  35.  
  36. The EPM package is available for free from the following Internet sites:
  37.  
  38. software.watson.ibm.com   /pub/os2/epm
  39. ftp-os2.nmsu.edu          /pub/os2/ibm/epm
  40.  
  41. It should also be available from major OS/2 BBS services.
  42.  
  43.  
  44. Installation of EPM 5.51:
  45. ~~~~~~~~~~~~~~~~~~~~~~~~
  46. If you are not already familiar with compiling EPM macros on your machine, read
  47. this section for additional help.
  48.  
  49. The installation of the EPM 5.51 package is sufficiently confusing that I will 
  50. try to give some hints to get you going as fast as possible.  
  51.  
  52. The EPM package includes two hypertext files; the EPM User's Manual, and the EPM 
  53. Technical Reference.  Both of these manuals provide a wealth of information on 
  54. EPM.  It is highly recommended that you spend some time becoming familiar with 
  55. EPM, and the E macro language by reading through them.  
  56.  
  57.  
  58. 1) Decide on a location for your EPM files.  I suggest something like
  59.    \os2\epm or \epm.  I would avoid using the \os2\apps directory 
  60.    where the binaries for EPM 5.50 are placed in the GA release of OS/2 2.0.
  61.    There's just too much other crap in there already.
  62.  
  63. 2) Unzip the EPM 5.51 files.  You will want to take care where you put
  64.    everything.  I recommend the following directory structure as suggested in
  65.    the EPMBBS.TXT file in the EPM package from IBM.
  66.  
  67. EPMAPP.ZIP - Unzip into your epm directory (eg \os2\epm)
  68.    EPM.EXE     - The 5.51 version of the editor
  69.    ETPM.EXE    - The 5.51 version of the macro compiler
  70.    PMMORE.EXE  - Useful for debugging Rexx macros; entering RXSHELL from
  71.                  EPM will start PMMORE and redirect STDOUT to this window.
  72.                  SAY and TRACE output will be displayed there.
  73.    *.EX        - the 5.51 version of the compiled macros
  74.    EPMHELP.QHL - the updated "quick help" file
  75.    EPMTECH.NDX - An index file for getting macro programmer help.
  76.  
  77. EPMBK.ZIP - Unpack into a directory in your BOOKSHELF path
  78.    EPMUSERS.INF - The EPM User's Guide
  79.    EPMTECH.INF  - The EPM Macro Programmer's Technical Reference
  80.  
  81. EPMDLL.ZIP - Unpack into \os2\apps\dll or a directory in your LIBPATH. Delete
  82.              the obsolete ETK*550.DLL files leftover from EPM 5.50.
  83.     ETK*551.DLL - The E Toolkit DLLs.
  84.  
  85. EPMMAC.ZIP - Create a subdirectory under EPM called E_MACROS and unzip into it.
  86.      *.e - contains the macro files used to build the standard
  87.            *.ex files.
  88.  
  89. EPMHLP.ZIP - Updated EPM.HLP; unpack into \os2\help
  90.  
  91. EMPSMP.ZIP - Create a subdirectory under EPM called sampmacs and unzip this file
  92.              into it.
  93.      *.e - Sample E macro code; includes both useful programs and
  94.            building blocks that you can use in writing your own code.
  95.  
  96.  
  97. 3) Edit your config.sys file and make sure that your new epm directory
  98.    is included in you PATH statement.  If you have IBM's TCP/IP networking
  99.    package, make sure your epm directory comes before \tcpip\bin in your PATH,
  100.    or delete the redundant EPM files as outlined in step (6).
  101.  
  102. 4) Edit your config.sys file and make sure that the e_macros and sampmacs
  103.    subdirectories are included in your EPMPATH.  EPMPATH is used by the ETPM
  104.    compiler to find macro files that are not in your current directory.
  105.  
  106. 5) Use a file finding utility to hunt down all *.ex files.  These are
  107.    the compiled E macros that EPM executes.  The GA release of OS/2 puts them 
  108.    in \os2\apps.  Delete all redundant or older *.ex files on your system.  You
  109.    only need them in your EPM directory.  Having multiple copies of the *.ex
  110.    files may result in unpredictable behaviour from EPM.
  111.  
  112. ----- OPTIONAL -------------------------------------------------------------
  113. 6) If you have IBM's TCP/IP networking package, there will be some more *.ex 
  114.    files in \tcpip\bin.  You can delete most of these files, or, if you prefer,
  115.    just make sure your your epm directory comes before \tcpip\bin in your PATH,
  116.  
  117. WARNING: LEAVE THE FOLLOWING UNIQUE TO LAMAIL *.EX FILES IN \TCPIP\BIN
  118.                              ~~~~~~
  119.           EPMLIST.EX
  120.           LAMEXTRA.EX
  121.           MAILLIST.EX
  122. -----------------------------------------------------------------------------
  123.  
  124. 7) Find all copies of EPM.EXE (v 5.50) and delete them.  Likely hiding places
  125.    are \os2\apps and \tcpip\bin.  You only need the one copy of epm.exe and it
  126.    should be in your epm directory.  As long as it is in your PATH lamail will
  127.    find it.
  128.  
  129. 8) Find all copies of ETK*550.DLL (v 5.50 dll's) and delete them.  Likely
  130.    hiding places are \os2\apps\dll  and \tcpip\dll.  You only need the v5.51
  131.    dll's and they should be put somewhere in your LIBPATH (\os2\apps\dll is as
  132.    good as any) As long as it is in your LIBPATH lamail will find it.
  133.  
  134.  
  135. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  136. NOTE: Unfortunately, when you apply a CSD or Service Pack, copies of
  137.       EPM will again be placed in \os2\apps or \tcpip\bin and you will need
  138.       to do some housekeeping to get things back in order.
  139. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  140.  
  141. 9)  I advise you get the spell checker option EPM_SPEL.ZIP for EPM.  It is a
  142.     nice thing to have and is available from the following INTERNET source.
  143.  
  144.                ftp-os2.nmsu.edu          /pub/os2/2.0/editors
  145.  
  146.     You will need to put the location of the dictionary (us.dct file) in the
  147.     paths section of the EPM preferences notebook.  I put mine in 
  148.     \os2\dictionary.
  149.  
  150. 10) Copy the contents of the EPMTeX macro package to the e_macros subdirectory.
  151.  
  152. 11) You should now be ready to compile your E macros.  First, though, reboot
  153.     if you made any changes to config.sys.
  154.  
  155.  
  156. COMPILING E MACROS;
  157. ~~~~~~~~~~~~~~~~~~
  158. 1)  Read the section in the EPM user's manual 'Changing the default
  159.     configuration' to understand the use of EPM's configuration constants and
  160.     what they can do.  The binaries included with the EPM package were compiled
  161.     with the constants defined in epmgcnf.smp in your e_macros subdirectory.  If
  162.     these are OK with you, copy epmgcnf.smp to a file called mycnf.e in your
  163.     e_macros directory.
  164.  
  165.     As an alternative, there is a file called jonscnf.e that is included with
  166.     my tex macro.  If you would like to try it instead, copy it to a file called
  167.     mycnf.e in your e_macros directory.  Even better, make up your own to setup
  168.     EPM as YOU want it.
  169.  
  170. 2)  Edit tex.e to point to your TeX applications.  You will need to edit the
  171.     following lines:  (the lines in there already are for a version of EMTEX on 
  172.     my system.  Yours will probably be different.)
  173.  
  174. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  175. NOTE:  For reasons of speed, I do not load the command processor in spawned
  176.        shells by specifying the /n option in the start command.  This means that
  177.        batch files will not run ( ie. TEX_EXEC=d:\mytex\texit.cmd ) since there
  178.        is no interpreter!
  179.  
  180.        If you want to specify a batch file as the executable in a *.EXEC
  181.        variable, then change the corresponding *_IS_CMD variable to 1.
  182.  
  183.        ie.  TEX_EXEC = 'd:\texit.cmd'
  184.             TEX_IS_CMD = 1
  185.  
  186.        Do not use the ^&plain or ^&lplain argument in the start command when
  187.        using batch files as the arguments will not make it through to the
  188.        command.
  189.  
  190.        ie.  if you specify TEX_EXEC = 'd:\texit.cmd ^&lplain' then texit.cmd
  191.        will not receive any arguments.  But, TEX_EXEC = 'd:\texit.cmd' works
  192.        fine!
  193.  
  194.        I have no explanation for this weirdness!  Ask someone smarter.
  195.  
  196.        If you want to run a previewer that is not a PM application, add the
  197.        switch /win or /fs as appropriate in the start commands in the command
  198.        procedure 'texvw'.
  199.  
  200.  
  201. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  202.  
  203. -- TEX_EXEC points to your plain TeX compiler.  The current TeX filename loaded
  204. -- into EPM will be appended to it.
  205.  
  206. eg. TEX_EXEC = 'd:\emtex\bin\tex386.exe ^&plain'
  207.     TEX_IS_CMD = 1
  208.  
  209. -- LATEX_EXEC points to your LaTeX compiler.  The current TeX filename loaded
  210. -- into EPM will be appended to it.
  211.  
  212. eg. LATEX_EXEC = 'd:\emtex\bin\tex386.exe ^&lplain'
  213.     LATEX_IS_CMD = 1
  214.  
  215.  
  216. -- TEX_VIEW_EXEC points to your TeX portrait previewer.  The dvi file
  217. -- associated with the TeX file loaded into EPM will be appended to it.
  218.  
  219. eg. TEX_VIEW_EXEC = 'd:\emtex\dviscr\dvipm7.exe @d:\emtex\dviscr\dvipm.cnf'
  220.     TEX_VIEW_IS_CMD = 0
  221.  
  222. -- TEX_VIEWLA_EXEC points to your TeX landscape previewer.  The dvi file
  223. -- associated with the TeX file loaded into EPM will be appended to it.
  224.  
  225. eg. TEX_VIEWLA_EXEC = 'd:\emtex\dviscr\dvipm7.exe @d:\emtex\dviscr\dvipmla.cnf'
  226.     TEX_VIEWLA_IS_CMD = 0
  227.  
  228. -- TEX_PRINT_EXEC points to your TeX portrait dvi driver.  The dvi
  229. -- file associated with the TeX file loaded into EPM will be appended to it.
  230.  
  231. eg. TEX_PRINT_EXEC = 'd:\emtex\dvidrv\dvihplj7.exe @d:\emtex\dvidrv\lj.cnf'
  232.     TEX_PRINT_IS_CMD = 0
  233.  
  234.  
  235. -- TEX_PRINTLA_EXEC points to your TeX landscape dvi driver.  The dvi
  236. -- file associated with the TeX file loaded into EPM will be appended to it.
  237.  
  238. eg. TEX_PRINTLA_EXEC = 'd:\emtex\dvidrv\dvihplj7.exe @d:\emtex\dvidrv\lj.cnf /tr1'
  239.     TEX_PRINTLA_IS_CMD = 0
  240.  
  241.  
  242.  
  243. OPTIONAL:
  244.    You can define a special mode (German, AMS, Bibtex, ?)  that will appear on
  245.    the TeX menu here.  To do this, define TEX_USER_MENU_TEXT with the desired
  246.    label to appear on the menu.  When this mode is selected, the following
  247.    variables will be used when TeXing 
  248.  
  249.    Put the label that will show up on the TeX pulldown menu here (use '' to disable
  250.    the user mode completely).  Use a ~ to specify the accelerator letter.
  251.  
  252. eg. TEX_USER_MENU_TEXT = '~BibTeX'
  253.  
  254.    These point to the executables you wish to run when user mode is on and you TeX
  255.    the document.   The current TeX filename loaded into EPM will be appended to it.
  256.  
  257.     TEX_USER_EXEC = 'd:\emtex\bibtex.cmd'
  258.     TEX_USER_IS_CMD = 1
  259.     LATEX_USER_EXEC = 'd:\emtex\bibtex.cmd'
  260.     LATEX_USER_IS_CMD = 1
  261.  
  262.  
  263.  
  264. 3)  If you already have a mystuff.e file in your e_macros directory, simply
  265.     add the following line to the end of it
  266.  
  267.     include 'tex.e'
  268.  
  269.     If you don't have a mystuff.e file (maybe because this is your first
  270.     stab at compiling E macros) then copy tex.e to mystuff.e.  
  271.  
  272. 4)  Make sure mymnuini.e exists in your e_macros directory.  It is possible that
  273.     you may already have an existing mymnuini.e file if you have made other
  274.     modifications to EPM's menu bar already.  If so, you will need to append the
  275.     mymnuini.e file from this package to your existing mymnuini.e file.
  276.  
  277. 5)  To be safe, make backup copies of your epm.ex and extra.ex files in your
  278.     epm directory.  Then if things go awry you can get back to the original
  279.     epm configuration.
  280.  
  281. 6)  Make the epm directory your current directory, and type
  282.     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  283.     etpm epm
  284.  
  285.     The etpm compiler will execute and compile your epm.e macro.  The TeX stuff
  286.     in mystuff.e and mymnuini.e and your config switches in mycnf.e will
  287.     automatically be included.  If etpm complains it can't find a file, you
  288.     probably have your EPMPATH incorrectly defined.  It should point to all
  289.     directories containing E macro files (*.e).
  290.  
  291. 7)  If that goes well then type
  292.  
  293.     etpm extra
  294.  
  295.     This will compile the extra stuff that wouldn't all fit in the epm.ex
  296.     file and generate a new extra.ex file.
  297.  
  298. 8)  Verify that new epm.ex and extra.ex files are in your epm directory.  If
  299.     they are, fire up epm with a TeX file (files with extensions .tex*, .sty,
  300.     or .bbl) and you should get the TeX submenu added to the EPM menu
  301.     bar.
  302.  
  303. 9)  Read the epmtex.doc file for information on using the various TeX commands
  304.     added with the EPMTeX package.  During the installation, it may be helpful 
  305.     to turn the 'debug mode' feature on as explained in the epmtex.doc file.
  306.  
  307.  
  308. OPTIONAL STUFF:
  309. ~~~~~~~~~~~~~~
  310.  
  311. I have included an optional E source file epmlex.tex that is a modified version 
  312. of epmlex.e, the E source code for EPM's spelling checker and thesaurus.  Using 
  313. this version of epmlex will cause the EPM spell checker to ignore words starting 
  314. with the TeX escape character '\' (most of the time, it's not perfect) . To use
  315. this modified version you will need to recompile as follows.  In the interest of 
  316. speed, it also disables script file support, which shouldn't matter to most 
  317. people outside of IBM, 
  318.  
  319. 1) Backup the original epmlex.e file in your e_macros directory.
  320.  
  321. 2) Copy epmlex.tex to a file called epmlex.e.
  322.  
  323. 3)  Make the epm directory your current directory, and type
  324.     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  325.     etpm epmlex
  326.  
  327.  
  328.  
  329. Support for German Users:
  330. ~~~~~~~~~~~~~~~~~~~~~~~~
  331.  
  332. German users who wish to add a german language mode to the pulldown menu will 
  333. want to rename the following file prior to compiling the macros.
  334.  
  335. rename  gtex.e  to  tex.e
  336.  
  337. The german language mode can be used to optionally specify the use of plaing or
  338. lplaing formats when TeXing a document.  This is an example of using using the
  339. tex.e 'user' mode for a special purpose.
  340.  
  341. You will also need to edit the following lines:
  342.  
  343. -- TEX_USER_EXEC points to your german plaing TeX compiler.  The current TeX filename loaded
  344. -- into EPM will be appended to it.
  345.  
  346. eg.  TEX_USER_EXEC = 'e=d:\emtex\tex386.exe ^&plaing'
  347.      TEX_USER_IS_CMD =0
  348.  
  349. -- LATEX_USER_EXEC points to your german LaTeX compiler.  The current TeX filename loaded
  350. -- into EPM will be appended to it.
  351.  
  352. eg.  LATEX_USER_EXEC = 'd:\emtex\tex386.exe ^&lplaing'
  353.      LATEX_USER_IS_CMD =0
  354.  
  355.