home *** CD-ROM | disk | FTP | other *** search
/ Pegasus Win & OS/2 Edition / Pegasus_Win_OS2.iso / os2 / anwend / epmbbs.txt < prev    next >
Text File  |  1992-09-28  |  6KB  |  114 lines
  1.                 Documentation for EPM update and macro support.
  2.                 ===============================================
  3.  
  4. What is EPM?
  5. ------------
  6.  
  7. The EPM editor is actually a simple application built on top of a very
  8. powerful editor toolkit.  EPM is programmable at a number of levels.
  9. The simplest way to configure EPM is from the Options menu; a number
  10. of features are pre-configured with support for multiple ways of doing
  11. things and to allow the specific method to be chosen dynamically and saved.
  12. (E.g., advanced marking mode or the simple CUA-style; Enter keys can be
  13. configured any one of 6 ways (in line mode), etc.)  The next level is
  14. writing Rexx macros.  This lets you do some fairly powerful things, but
  15. to take complete advantage of the editor, you have to go to a lower level.
  16. E macros are compiled into .ex files, which are interpreted at run time.
  17. You can control the macros at two levels.  One is by creating a MYCNF.E
  18. and setting flags in it which controls which of the various features
  19. we've already written are included in the .ex files; the second is to
  20. actually write your own macros.  The configuration flags are described in
  21. the User's Guide - enter the command VIEW EPMUSERS to see it.  The macro
  22. language is defined and described in the EPM Macro Programmer's Technical
  23. Reference - enter VIEW EPMTECH to see it.  Also, looking through the
  24. existing macros is a good way to become familiar with the language -
  25. particularly if you have any Rexx experience.
  26.  
  27. EPM can also be controlled via DDE (Dynamic Data Exchange); this is how
  28. we interact with the Workframe/2 product.  Finally, users can use the
  29. E Toolkit to embed one or more E-MLE's (Enhanced Multi-line Edit Controls)
  30. within their own application.  The latter two are still being documented;
  31. it is our intention to make this information available in the future.
  32.  
  33. (Note that the documentation included here is still being edited, but
  34. since many people have expressed interest, we thought it better to make it
  35. available now in a rough state so that people could get started using it.)
  36.  
  37. What is included here?
  38. ----------------------
  39.  
  40. This package consists of nine sets of files.  You have the option of
  41. replacing your current Enhanced Editor (EPM 5.50) with EPM 5.51, or
  42. adding EPM 5.51 to your system so that you can use either version.
  43. If you elect to replace the current EPM, then you can unpack EPMAPPS.ZIP
  44. into your \os2\apps directory, and you can erase the ETKE550.DLL and
  45. ETKR550.DLL from your \os2\apps\dll directory.  If you would rather
  46. keep both versions, then you can unpack EPMAPPS.ZIP into a new directory
  47. and either run EPM 5.51 from there, or ensure that your EPMPATH and PATH
  48. include that directory before \os2\apps when running EPM 5.51.
  49.  
  50. The contents of the files in this package are as follows.  You do not need
  51. to download or unpack all of them.
  52.  
  53. EPMAPP.ZIP - Unpack into \os2\apps, or as described above
  54.    EPM.EXE     - The 5.51 version of the editor
  55.    ETPM.EXE    - The 5.51 version of the macro compiler
  56.    PMMORE.EXE  - Useful for debugging Rexx macros; entering RXSHELL from
  57.                  EPM will start PMMORE and redirect STDOUT to this window.
  58.                  SAY and TRACE output will be displayed there.
  59.    *.EX        - the 5.51 version of the compiled macros
  60.    EPMHELP.QHL - the updated "quick help" file
  61.    EPMTECH.NDX - An index file for getting macro programmer help.
  62.  
  63. EPMBK.ZIP - Unpack into a directory in your BOOKSHELF setting
  64.    EPMUSERS.INF - The EPM User's Guide
  65.    EPMTECH.INF  - The EPM Macro Programmer's Technical Reference
  66.  
  67. EPMDLL.ZIP - Unpack into \os2\apps\dll or a directory in your LIBPATH
  68.    ETK*551.DLL - The E Toolkit DLLs.
  69.  
  70. EPMMAC.ZIP - Unpack into an E_MACROS directory and add to your EPMPATH.
  71.              - This contains the macros used to build the standard .ex files.
  72.  
  73. EPMHLP.ZIP - Updated EPM.HLP; unpack into \os2\help
  74.  
  75. EMPSMP.ZIP - Unpack into a sampmacs directory and add to your EPMPATH.
  76.    *.e - Sample E macro code; includes both useful programs and building
  77.          blocks that you can use in writing your own code.
  78.  
  79. EBOOKE.ZIP - Unpack into an EBOOKIE directory.
  80.    EBookie is an EPM add-on that makes it much easier to create tagged
  81.    source files.  Support is included for Bookmaster, Starter Set GML, and
  82.    IPF files (used to create OS/2 Help and View files).
  83.  
  84. LAMPDQ.ZIP - Unpack; contains a file to be uploaded to the host.
  85.    LAMPDQ lets you enter commands in EPM that will be executed on your
  86.    (logged on) VM host session and see the results in EPM.  Requires
  87.    Communications Manager.
  88.  
  89. EPMREX.ZIP - Unpack into a directory in your path.
  90.    *.erx - contains some sample EPM / Rexx macros.
  91.  
  92. The minimum you need in order to get EPM 5.51 is EPMAPPS and EPMDLL; add
  93. EPMHELP for the new help file.  If you want to recompile the macros,
  94. you'll need E_MACROS, and probably EPMBOOK for the documentation.  If you
  95. want to write your own macros, or if you just want to try some of the
  96. samples, get a copy of SAMPMACS.  EBOOKIE and LAMPDQ are only for those
  97. who require their somewhat specialized functions.
  98.  
  99. What about support?
  100. -------------------
  101.  
  102. All the sample code is provided "as-is", with no warranty of any kind.
  103. It was written by a number of different people, and some of the code is
  104. more polished than other pieces.
  105.  
  106. The EPM authors monitor the E-EDITOR CFORUM on the IBM OS/2 BBS's, and
  107. the Internet news group comp.os.os2.programmer.  We will try to answer
  108. questions asked in either place.  We do plan on monitoring Compuserve
  109. in the future.
  110.  
  111. (signed)
  112. The OS/2 Applications and Tools Group
  113. IBM Thomas J. Watson Research Center
  114.