Mega Top 1

home *** CD-ROM | disk | FTP | other *** search

/ Mega Top 1 / os2_top1.zip / os2_top1 / APPS / TEKST / EPMTEX20 / DOC / INSTALL.DOC < prev next >

Wrap

Text File | 1994-08-16 | 17.2 KB | 412 lines

TeX Macro Enhancements for EPM 5.51a and EPM 6.00c Version 2.0 Installation/Upgrade Manual Jon Hacker Rodney Korte August 1994 Disclaimer: ~~~~~~~~~~~ See the attached license.txt file that is more or less pilfered from IBM's license agreement. CONTENTS ~~~~~~~~ Section 1: Installation of EPMTeX 2.0 (read this if you have never installed/used EPMTeX before) Section 2: Upgrading from EPMTeX 1.3 to 2.0 (jump to this if you want to upgrade as fast as possible and already know the basics of EPM and EPMTeX) ******************************************************************************** Section 1: Installation of EPMTeX 2.0 ~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~ Introduction: ~~~~~~~~~~~~ The E macro file tex.e, when compiled with the IBM enhanced Editor translator ETPM.EXE, will add a TeX pull down menu to the EPM menu bar and integrate TeX functions and commands within the editor. Requirements: ~~~~~~~~~~~~ The TeX E macro package supplied with this package needs to be compiled before it can be incorporated into EPM. You will need to obtain the complete EPM 5.51a package from IBM to do this. Alternatively, the package can also be used with the new 32 bit version 6.00 of EPM. WARNING: There are several versions of epm 5.51. Make sure you get the latest version. It should say 5.51a in the Product Information dialog box under the Help menu, and the epm.exe file should be dated August 3, 1993 with a file size of 33088 bytes. The EPM package is available for free from the following Internet sites: software.watson.ibm.com /pub/os2/os2fixes ftp-os2.cdrom.com /pub/os2/ibm/os2fixes It should also be available from major OS/2 BBS services. Installation of EPM 5.51a: ~~~~~~~~~~~~~~~~~~~~~~~~~ If you are not already familiar with compiling EPM macros on your machine, read this section for additional help. The installation of the EPM 5.51a package is sufficiently confusing that I will try to give some hints to get you going as fast as possible. The EPM package includes two hypertext files; the EPM User's Manual, and the EPM Technical Reference. Both of these manuals provide a wealth of information on EPM. It is highly recommended that you spend some time becoming familiar with EPM, and the E macro language by reading through them. 1) Decide on a location for your EPM files. I suggest something like \os2\epm or \epm. I would avoid using the \os2\apps directory where the binaries for EPM 5.51 are placed in the GA release of OS/2 2.1. There's just too much other crap in there already. 2) Unzip the EPM 5.51a files. You will want to take care where you put everything. I recommend the following directory structure as suggested in the EPMBBS.TXT file in the EPM package from IBM. EPMAPP.ZIP - Unzip into your epm directory (eg. \os2\epm) EPM.EXE - The 5.51a version of the editor ETPM.EXE - The 5.51a version of the macro compiler PMMORE.EXE - Useful for debugging Rexx macros; entering RXSHELL from EPM will start PMMORE and redirect STDOUT to this window. SAY and TRACE output will be displayed there. *.EX - the 5.51a version of the compiled macros EPMHELP.QHL - the updated "quick help" file EPMTECH.NDX - An index file for getting macro programmer help. EPMBK.ZIP - Unpack into a directory in your BOOKSHELF path EPMUSERS.INF - The EPM User's Guide EPMTECH.INF - The EPM Macro Programmer's Technical Reference EPMDLL.ZIP - Unpack into \os2\apps\dll or a directory in your LIBPATH. Delete the obsolete ETK*550.DLL files leftover from EPM 5.50. ETK*551.DLL - The E Toolkit DLLs. EPMMAC.ZIP - Create a subdirectory under EPM called E_MACROS and unzip into it. *.e - contains the macro files used to build the standard *.ex files. EPMHLP.ZIP - Updated EPM.HLP; unpack into \os2\help EMPSMP.ZIP - Create a subdirectory under EPM called sampmacs and unzip this file into it. *.e - Sample E macro code; includes both useful programs and building blocks that you can use in writing your own code. EPMREX.ZIP - Create a subdirectory under EPM called EREXX, unzip this file into it and add it to your EPMPATH. *.erx - contains some sample EPM / Rexx macros. EPMASI.ZIP - Create a subdirectory under EPM called myassist, unzip this file into it and add it to your EPMPATH. An alternative approach to syntax-assisted editing; makes it easy to add your own expansions. Includes sample files for OS/2 and PM APIs, C, and Bookmaster. EPMATR.ZIP - Create a subdirectory under EPM called epmattr, unzip this file into it and add it to your EPMPATH. Sample code for doing things with EPM's attribute support. 3) Edit your config.sys file and make sure that your new epm directory is included in your PATH statement. If you have IBM's TCP/IP networking package, make sure your epm directory comes before \tcpip\bin in your PATH, or delete the redundant EPM files as outlined in step (6). 4) Edit your config.sys file and make sure that the e_macros, sampmacs, erexx, myassist, and epmattr subdirectories are included in your EPMPATH. EPMPATH is used by the ETPM compiler to find macro files that are not in your current directory. 5) Use a file finding utility to hunt down all *.ex files. These are the compiled E macros that EPM executes. The GA release of OS/2 puts them in \os2\apps. Delete all redundant or older *.ex files on your system. You only need them in your EPM directory. Having multiple copies of the *.ex files may result in strange behaviour from EPM. ----- OPTIONAL ------------------------------------------------------------- 6) If you have IBM's TCP/IP networking package, there will be some more *.ex files in \tcpip\bin. You can delete most of these files, or, if you prefer, just make sure your your epm directory comes before \tcpip\bin in your PATH, WARNING: LEAVE THE FOLLOWING UNIQUE TO LAMAIL *.EX FILES IN \TCPIP\BIN ~~~~~~ EPMLIST.EX LAMEXTRA.EX MAILLIST.EX ----------------------------------------------------------------------------- 7) Find all copies of EPM.EXE (v 5.50) and delete them. Likely hiding places are \os2\apps and \tcpip\bin. You only need the one copy of epm.exe and it should be in your epm directory. As long as it is in your PATH lamail will find it. 8) Find all copies of ETK*550.DLL (v 5.50 dll's) and delete them. Likely hiding places are \os2\apps\dll and \tcpip\dll. You only need the v5.51a dll's and they should be put somewhere in your LIBPATH (\os2\apps\dll is as good as any) As long as it is in your LIBPATH lamail will find it. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ NOTE: Unfortunately, when you apply a CSD or Service Pack, copies of EPM will again be placed in \os2\apps or \tcpip\bin and you will need to do some housekeeping to get things back in order. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 9) I advise you get the spell checker option EPM_SPEL.ZIP for EPM. It is a nice thing to have and is available from the following INTERNET source. ftp-os2.cdrom.com /pub/os2/2_x/editors You will need to put the location of the dictionary (us.dct file) in the paths section of the EPM preferences notebook. I put mine in \epm\lexam. 10) Create the subdirectory EPMTEX in the EPM directory. Copy the contents of the EPMTeX macro package into it. Add this directory to your EPMPATH environment variable. (You could also copy them to the e_macros subdirectory of epm, but this is less desirable from the viewpoint of cleanliness :-) ). 11) You should now be ready to compile your E macros. First, though, reboot if you made any changes to config.sys. COMPILING THE EPMTeX MACROS: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1) Read the section in the EPM user's manual 'Changing the default configuration' to understand the use of EPM's configuration constants and what they can do. The binaries included with the EPM package were compiled with the constants defined in epmgcnf.smp in your e_macros subdirectory. If these are OK with you, copy epmgcnf.smp to a file called mycnf.e in your e_macros directory. You may then edit mycnf.e and add the TeX support switches as you wish. As an alternative, there is a file called texcnf.smp that is included with EPMTeX. If you would like to try it instead, copy it to a file called mycnf.e in your e_macros directory. Even better, make up your own to setup EPM as YOU want it. In any case, we would suggest that in your MYCNF.E file you enable the ring by including the following: MY_RING_ENABLED = 1 RING_OPTIONAL = 0 2) Copy the file texenv.smp to texenv.e and edit texenv.e to point to your TeX applications (the lines in there already are for a version of emTeX on my system. Yours will probably be different). We use the name texenv.smp in the distribution to avoid clobbering your own copy of texenv.e in case you are upgrading from a previous version of EPMTeX. 3) If you don't have a mystuff.e file in your e_macros directory, (maybe because this is your first stab at compiling E macros) then copy mystuff.add to mystuff.e. If you already have a mystuff.e file in your e_macros directory, then append the contents of mystuff.add to the end of it. 4) If you don't have a mymnuini.e file in your e_macros directory, then copy mymnuini.add to mymnuini.e. If you already have a mymnuini.e file in your e_macros directory (it is possible that you may already have an existing mymnuini.e file if you have made other modifications to EPM's menu bar already), then append the contents of mymnuini.add to it. 5) If you don't have a mykeyset.e file in your e_macros directory, then copy mykeyset.add to mykeyset.e. If you already have a mykeyset.e file in your e_macros directory, then append the contents of mykeyset.add to it. 6) If you don't have a mykeys.e file in your e_macros directory, then copy mykeys.add to mykeys.e. If you already have a mykeys.e file in your e_macros directory, then append the contents of mykeys.add to it. 7) To be safe, make backup copies of your epm.ex and extra.ex files in your epm directory. Then if things go awry you can get back to the original epm configuration. 8) Make the epm directory your current directory, and type ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ etpm epm The etpm compiler will execute and compile your epm.e macro. The TeX stuff in mystuff.e, mymnuini.e, mykeyset.e, and your config switches in mycnf.e will automatically be included. If etpm complains it can't find a file, you probably have your EPMPATH incorrectly defined. It should point to all directories containing E macro files (*.e). 9) If that goes well, type etpm extra This will compile the extra stuff that wouldn't all fit in the epm.ex file and generate a new extra.ex file. (Note: this step is unnecessary with EPM 6.00.) 10) If that goes well, type etpm tex This will compile the actual TeX support. 11) Verify that new epm.ex, extra.ex, and tex.ex files are in your epm directory. If they are, fire up epm with a TeX file and you should see the TeX submenu added to the EPM menu bar. 12) Read the epmtex.doc file for information on using the various TeX commands added with the EPMTeX package. During the installation, it may be helpful to turn the 'debug mode' feature on as explained in the epmtex.doc file. ******************************************************************************** Section 2: Upgrading from EPMTeX 1.3 to 2.0 ~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ There are a number of things done differently in v2.0 than in v1.3a (apologies!). This section specifically points out what things must be changed in order to upgrade. To understand the new options in v2.0, you will still need to peruse the epmtex.doc user manual. Changes to TEXENV.E: ~~~~~~~~~~~~~~~~~~~ Many things have been added to TEXENV.E. You should probably simply copy TEXENV.SMP to TEXENV.E and edit the new file to point to your TeX applications. Some notes however: TEX_EXEC will be the same except that the format ('plain', usually) should NOT be specified in this command variable. The format gets appended by EPMTeX. (See Format menu item in EPMTeX.doc.) The commands for printing and previewing should not change. (TEX_VIEW*, TEX_PRINT*) LATEX_* commands are no longer used. The LaTeX functionality is built into the Format mechanism. There are new TEX_FORMAT* variables to be defined. This is where the plain and latex formats are defined. The user can also defined up to two more formats, which one might use for defining german verions of plain and/or latex. TEX_USER_MENU_TEXT, TEX_USER_EXEC and TEX_USER_IS_CMD are no longer used. This functionality has been expanded so that the user can now define up to 2 specific commands. The user might wish to use these to define TeX commands for a different version of TeX or for german formats or whatever. (Note: If this is used for a TeX command, the format must be included in the command, which is different that for the TEX_EXEC definition.) Changes to constants in MYCNF.E: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The following constants are no longer used and should be removed from your MYCNF.E file: MY_TEX_FILE_TYPE TEX_LATEX_MODE TEX_USER_MODE TEX_LANDSCAPE_MODE The following are new constants, followed by possible values and default default values if the constant is not defined: TEX_FORMAT_TO_USE = 'Auto', 'plain', 'lplain' ( 'Auto' ) or actually *any* format you have on your system. This defines what format is passed to the TeX command when "TeX Document" is chosen. If 'Auto', EPMTeX will check the first line of the current file for the format to be used, and default to 'plain' if there is no directive there. (See texenv.e and EPMTeX.doc) TEX_ORIENTATION = 'Auto', 'Portrait', 'Landscape' ( 'Auto' ) This is used to determine which command (either normal or landscape, defined in texenv.e) will be called for "Previewing", "Printing", and the 2 user-defined commands. If 'Auto', EPMTeX will check the first line of the current file for the orientation to be used, and default to 'portrait' if there is no directive there. (See texenv.e) TEX_QUICK_KEYS = 0, 1 ( 1 ) Define S_F11 and S_F12 as "TeX Document" and "Locate Next Error". 0 = No, 1 = Yes TEX_USER_FILE_TYPES = 'ABC DEF GHI' ( '' ) Define all filetypes to trigger TeX support. Though more intelligible with them, spaces are not required. These are in addition to 'TEX STY LOG AUX'. We also suggest putting the following two lines in MYCNF.E (if they aren't already): MY_RING_ENABLED = 1 RING_OPTIONAL = 0 Changes to other 'MY'.E files: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ MYMNUINI.E must be modified. Delete the TeX support from version 1.3a and add the lines in MYMNUINI.ADD. MYKEYS.E must be created or modified. Add the lines in MYKEYS.ADD. MYKEYSET.E must be created or modified. Add the lines in MYKEYSET.ADD. MYSTUFF.E must be created or modified. Add the lines in MYSTUFF.ADD. Compiling EPM: ~~~~~~~~~~~~~ Make sure your custom files mycnf.e, mymnuini.e, mykeys.e, mykeyset.e, mystuff.e and the epmtex files tex.e, texkeys.e and texenv.e are in your EPMPATH and compile tex.e, epm.e, and extra.e. ie. etpm epm etpm extra (not necessary if you are using EPM 6.0 or above) etpm tex Fire up EPM and you should see the EPMTeX 2.0 menu support added to the menu bar. Enjoy!