home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / htmlepm.zip / README < prev   
Text File  |  1995-06-02  |  5KB  |  106 lines
  1.  
  2. HTML Extensions for EPM (Version 0.95)
  3. =================================
  4.  
  5. Legal stuff
  6. See the file license.txt
  7.  
  8. Contents
  9. The HTMLEPM.ZIP package contains 4 files:  
  10.    README - This file. 
  11.    LICENSE.TXT- License information (basically taken from IBM).
  12.    HTMLTAGS.E - The E source code of the HTM extensions.
  13.    HTMLTAGS.EX - The compiled code.
  14.  
  15. Rationale
  16. The widening popularity of the World Wide Web has created the need for
  17. writing documents using the HTML format.  There are some simple editors
  18. available that give HTML Editing capabilities but limited general editing
  19. features.  I have worked the other way around, giving menu-driven HTML
  20. editing tools to a very powerful Editor.  I took inspiration from the
  21. Customized version of EPM distributed freely by IBM as CSTEPM.ZIP that
  22. includes support for SGML, TeX,...
  23.  
  24.  
  25. Installation
  26. The IBM OS/2 EPM Enhanced Editor can be extended using macros written in a
  27. language called E. The E extensions can be added to the editor either the
  28. hard way by modifying and recompiling the epm and extra macros (you will
  29. need to download the ETPM compiler,standard macros,...)  or the easy way:
  30. the EPM 5.51 version allows for the use of External Modules that can be
  31. linked at any time, so I have supplied the HTML extensions as an external
  32. linkable module in a 10Kb single file named HTMLTAGS.EX (sic, .EX not
  33. .EXE).
  34. All you need to do is to copy this file into your \OS2\APPS directory (or
  35. wherever you have the EPM.EXE file).  Start the EPM editor, open a Command
  36. Dialog Window (select Command then Command dialog):  then type 'link
  37. htmltags' (WITHOUT quotes).  The editor should inform you of the operation
  38. with a 'Link completed, module#n' message, and an HTML option should now
  39. be visible in the editor main menu.  The extensions will last till the end
  40. of your session with EPM or until you unlink them using again a Command
  41. dialog window (you should now type 'unlink htmltags', WITHOUT quotes).
  42. and the HTML option will be removed from the main menu.
  43. If you want to have the extensions always linked you can either edit the
  44. standard macros and recompile them or (again the easy way) just open the
  45. settings notebook of the Enhanced Editor object in your Desktop and type
  46. as parameter to be passed to the program 'link htmltags' (WITH the single
  47. quotes now!).  From then on everytime you start EPM by double-clicking on
  48. its icon the HTML extensions will be linked at start time so you won't
  49. need to reinstall them manually.
  50.  
  51.  
  52. Compiling E Language Macros
  53. The E source of the extensions is provided so those willing to incorporate
  54. it permanently to EPM are free to do it.  It will need just a litle
  55. tweaking of your standard or customized macros to include it.  I am not an
  56. expert in writing E macros but if you have troubles just drop me a note
  57. and I will try to help.
  58.  
  59.  
  60. Using the Extensions
  61. I think the use of the extensions should be intuitive to anyone familiar
  62. with the HTML tagging.  The different tags that constitute the HyperText
  63. Mark-up Language can be embedded in the text selecting the HTML option
  64. that has been added to the editor main menu.  If the tag to be inserted is
  65. a single one (new paragraph, horizontal rule,...)  it is inserted at the
  66. cursor.  If the tag is "double" (i.e.  it needs a start tag and an end 
  67. tag) then if there is no text area previously selected by dragging both
  68. tags are inserted at the cursor position and the cursor will be placed
  69. between the tags; if text is selected the tags will (usually) be placed
  70. encircling it.  Forms are supported in what seemed (to me) a useful way 
  71. but I am open to receive any suggestion.
  72. Some of the extensions can be selected If you right-click anywhere over 
  73. EPM:  a simplified HTML menu will pop-up for quicker access.
  74.  
  75.  
  76. EPM Documentation
  77. The IBM documentation and tools needed to write and compile E macros can
  78. be found on several files in the /epm directory in software.watson.ibm.com
  79. and several other ftp sites .
  80.  
  81. EPMAPP.ZIP - Contains the compiler, the editor,...  
  82. EPMMAC.ZIP - The standard macros used to compile EPM as supplied .
  83. EPMBOOK.ZIP - Documentation in INF format. It contains the EPM User's
  84. Guide that I can't understand why it is not included with OS/2 as this is 
  85. the complete EPM guide. It also includes the EPM Technical Reference.
  86. CUSTEPM.ZIP - A customized version of EPM written by IBMers. Fully
  87. recommended if you want to study E Language macros.  My main source of
  88. inspiration when writing the HTML extensions.
  89.  
  90.  
  91. HTML Info
  92. If you are interested in HTML documentation, look in the Web. Some
  93. useful places are :
  94. http://www.ncsa.uiuc.edu/demoweb/html-primer.html
  95. http://www.w3.org/hypertext/WWW/MarkUp/MarkUp.html
  96. http://info.cern.ch/hypertext/WWW/Provider/Style/Introduction.html
  97. http://info.cern.ch/hypertext/WWW/MarkUp/SGML.html
  98. http://kuhttp.cc.ukans.edu/lynx_help/HTML_quick.html
  99.  
  100. -------------------------------------------------------------------
  101.  
  102. June 2th,1995 
  103. Eduardo Areitio 
  104. internet:  areitio@ibm.net
  105.  
  106.