home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / wps / editor / epmtools / epmbbs.txt < prev    next >
Text File  |  1993-10-28  |  8KB  |  162 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.  See the package ETKBBS for sample E Toolkit
  31. programs.
  32.  
  33.  
  34. What is included here?
  35. ----------------------
  36.  
  37. This package consists of eleven sets of files.  You have the option of
  38. replacing your current Enhanced Editor (EPM 5.50) with EPM 5.51, or
  39. adding EPM 5.51 to your system so that you can use either version.
  40. If you elect to replace the current EPM, then you can unpack EPMAPPS.ZIP
  41. into your \os2\apps directory, and you can erase the ETKE550.DLL and
  42. ETKR550.DLL from your \os2\apps\dll directory.  If you would rather
  43. keep both versions, then you can unpack EPMAPPS.ZIP into a new directory
  44. and either run EPM 5.51 from there, or ensure that your EPMPATH and PATH
  45. include that directory before \os2\apps when running EPM 5.51.
  46.  
  47. The contents of the files in this package are as follows.  You do not need
  48. to download or unpack all of them.
  49.  
  50. EPMAPP.ZIP - Unpack into \os2\apps, or as described above
  51.    EPM.EXE     - The 5.51 version of the editor
  52.    ETPM.EXE    - The 5.51 version of the macro compiler
  53.    PMMORE.EXE  - Useful for debugging Rexx macros; entering RXSHELL from
  54.                  EPM will start PMMORE and redirect STDOUT to this window.
  55.                  SAY and TRACE output will be displayed there.
  56.    *.EX        - the 5.51 version of the compiled macros
  57.    EPMHELP.QHL - the updated "quick help" file
  58.    EPMTECH.NDX - An index file for getting macro programmer help.
  59.  
  60. EPMBK.ZIP - Unpack into a directory in your BOOKSHELF setting
  61.    EPMUSERS.INF - The EPM User's Guide
  62.    EPMTECH.INF  - The EPM Macro Programmer's Technical Reference
  63.  
  64. EPMDLL.ZIP - Unpack into \os2\apps\dll or a directory in your LIBPATH
  65.    ETK*551.DLL - The E Toolkit DLLs.
  66.  
  67. EPMMAC.ZIP - Unpack into an E_MACROS directory and add to your EPMPATH.
  68.              - This contains the macros used to build the standard .ex files.
  69.  
  70. EPMHLP.ZIP - Updated EPM.HLP; unpack into \os2\help
  71.  
  72. EPMSMP.ZIP - Unpack into a sampmacs directory and add to your EPMPATH.
  73.    *.e - Sample E macro code; includes both useful programs and building
  74.          blocks that you can use in writing your own code.
  75.  
  76. EBOOKE.ZIP - Unpack into an EBOOKIE directory.
  77.    EBookie is an EPM add-on that makes it much easier to create tagged
  78.    source files.  Support is included for Bookmaster, Starter Set GML, and
  79.    IPF files (used to create OS/2 Help and View files).
  80.  
  81. LAMPDQ.ZIP - Unpack; contains a file to be uploaded to the host.
  82.    LAMPDQ lets you enter commands in EPM that will be executed on your
  83.    (logged on) VM host session and see the results in EPM.  Requires
  84.    Communications Manager.
  85.  
  86. EPMREX.ZIP - Unpack into a directory in your path.
  87.    *.erx - contains some sample EPM / Rexx macros.
  88.  
  89. EPMASI.ZIP - Unpack into a myassist directory and add to your EPMPATH.
  90.    An alternative approach to syntax-assisted editing; makes it easy to
  91.    add your own expansions.  Includes sample files for OS/2 and PM APIs,
  92.    C, and Bookmaster.
  93.  
  94. EPMATR.ZIP - Unpack into an epmattr directory and add to your EPMPATH.
  95.    Sample code for doing things with EPM's attribute support.
  96.  
  97. The minimum you need in order to get EPM 5.51 is EPMAPPS and EPMDLL; add
  98. EPMHELP for the new help file.  If you want to recompile the macros,
  99. you'll need E_MACROS, and probably EPMBOOK for the documentation.  If you
  100. want to write your own macros, or if you just want to try some of the
  101. samples, get a copy of SAMPMACS.  EBOOKIE and LAMPDQ are only for those
  102. who require their somewhat specialized functions.
  103.  
  104. There are READ.ME files included in EPMMAC, EPMSMP, EBOOKE and LAMPDQ.
  105.  
  106. What about support?
  107. -------------------
  108.  
  109. All the sample code is provided "as-is", with no warranty of any kind.
  110. It was written by a number of different people, and some of the code is
  111. more polished than other pieces.
  112.  
  113. The EPM authors monitor the E-EDITOR CFORUM on the IBM OS/2 BBS's, and
  114. the Internet news group comp.os.os2.programmer.  We will try to answer
  115. questions asked in either place.  We do plan on monitoring Compuserve
  116. in the future.
  117.  
  118. (signed)
  119. The OS/2 Applications and Tools Group
  120. IBM Thomas J. Watson Research Center
  121.  
  122.    Updates
  123.    =======
  124. 1992/09/23  EPMBBS.TXT - Mention the 4 included READ.ME files
  125.             EPMMAC.ZIP - Don't allow SAVEAS if a file is locked.
  126.             EPMBK.ZIP  - Added description of all configuration constants.
  127.             LAMPDQ.ZIP - Updated old syntax.
  128.  
  129. 1992/10/16  EPMAPP.ZIP, EPMDLL.ZIP - Various fixes, including:
  130.  - Top of file markers were invisible in DBCS countries if DB code page
  131.    was in use.
  132.  - Problems with long lists of files from the file dialog.
  133.  - Dropping filespecs containing spaces on the EPM icon.
  134.  
  135.             EPMMAC.ZIP - Fixes and enhancements, including:
  136.  - DRAG_ALWAYS_MARKS constant
  137.  - BACKUP_PATH supports '=' to back up to same directory as source file
  138.  - Error checking for BACKUP_PATH if HOST_SUPPORT = 'EMUL'
  139.  
  140.             EPMBK.ZIP  - Various updates.
  141.             EPMSMP.ZIP - DOSCALLS and EA updated; new SAVEALL.E.
  142.             LAMPDQ.ZIP - Use HOSTCOPYDRIVE instead of Hostdrive.
  143.  
  144. 1993/03/29  EPMDLL.ZIP, EPMAPP.ZIP, EPMBK.ZIP, EPMHLP.ZIP, EPMMAC.ZIP
  145.             - Various updates.  Biggest change is new print support.
  146.               Also a number of new configuration constants.
  147.             EPMSMP.ZIP - New EPMPRT.E to add a Printer Codes menu, and
  148.               additions to DOSCALLS.E.
  149.             EPMASI.ZIP, EPMATR.ZIP
  150.             - New additions to package; see descriptions above.
  151.  
  152. 1993/07/19  EPMDLL.ZIP, EPMAPP.ZIP, EPMBK.ZIP, EPMHLP.ZIP, EPMMAC.ZIP
  153.             - Various updates.  Includes fix for trap when pasting tabs,
  154.               and for "Raw ASCII Dump" print of marked area printing
  155.               entire file.
  156.  
  157. 1993/08/05  EPMDLL.ZIP, EPMAPP.ZIP, EPMMAC.ZIP
  158.             - Ensure we get a pure pallette, so circles aren't fuzzy.
  159.             - Added a workaround for when OS/2 2.1 leaves the EPM.INI file
  160.               read-only.
  161.             - Various other small fixes.
  162.