home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / htmepm98.zip / README < prev   
Text File  |  1995-09-01  |  11KB  |  251 lines
  1.  
  2. HTML Extensions for EPM (Version 0.98)
  3. ======================================
  4.  
  5. New features of version 0.98: see the end of this file.
  6.  
  7. Legal stuff
  8. See the file license.txt
  9.  
  10. Contents
  11. The HTMEPM98.ZIP package contains 6 files:
  12.     README         - This file.
  13.     LICENSE.TXT    - License information (basically taken from IBM).
  14.     HTMLTAGS.E     - The E source code of the HTM extensions.
  15.     HTMLTAGS.EX    - Compiled code for EPM 5.51a (the editor supplied with Warp)
  16.     HTMLTAGS.551   - Compiled code for EPM 5.51  (the editor supplied with OS/2 2.1)
  17.     FILE_ID.DIZ    - Brief description of the package
  18.  
  19. Rationale
  20. The widening popularity of the World Wide Web has created the need for
  21. writing documents using the HTML format.  There are some simple editors
  22. available that give HTML Editing capabilities but limited general editing
  23. features.  I have worked the other way around, giving menu-driven HTML
  24. editing tools to a very powerful Editor.  I took inspiration from the
  25. Customized version of EPM distributed freely by IBM as CSTEPM.ZIP that
  26. includes support for SGML, TeX,...
  27.  
  28.  
  29. Installation
  30. The IBM OS/2 EPM Enhanced Editor can be extended using macros written in a
  31. language called E. The E extensions can be added to the editor either the
  32. hard way by modifying and recompiling the epm and extra macros (you will
  33. need to download the ETPM compiler,standard macros,...)  or the easy way:
  34. since the 5.51 version, EPM allows for the use of External Modules that can be
  35. linked at any time, so I have supplied the HTML extensions as an external
  36. linkable module in a 16Kb single file named HTMLTAGS.EX (sic, .EX not
  37. .EXE).
  38.  
  39. Installation for Warp Users:
  40. All you need to do is to copy the HTMLTAGS.EX file into your \OS2\APPS directory
  41. (or wherever you have the EPM.EXE file). Now follow the steps indicated in
  42. the "COMMON SECTION"
  43.  
  44. Installation for OS/2 2.1 users:
  45. Copy the HTMLTAGS.551 file to your \OS2\APPS directory (or
  46. wherever you have the EPM.EXE file). Rename it as HTMLTAGS.EX.
  47. Now follow the steps indicated in the "COMMON SECTION".
  48.  
  49.  
  50. COMMON SECTION
  51. Start the EPM editor, open a Command Dialog Window (select Command then
  52. Command dialog):  then type 'link htmltags' (WITHOUT quotes).  The editor
  53. should inform you of the operation with a 'Link completed, module#n' message,
  54. and an HTML option should now be visible in the editor main menu.
  55. The extensions will last till the end of your session with EPM or until
  56. you unlink them using again a Command dialog window (you should
  57. now type 'unlink htmltags', WITHOUT quotes) and the HTML option
  58. will be removed from the main menu.
  59. If you want to have the extensions always linked you can either edit the
  60. standard macros and recompile them or (again the easy way) just open the
  61. settings notebook of the Enhanced Editor object in your Desktop and type
  62. as parameter to be passed to the program 'link htmltags' (WITH the single
  63. quotes now!).  From then on everytime you launch EPM by double-clicking on
  64. its icon the HTML extensions will be linked at start time so you won't
  65. need to reinstall them manually.
  66. Those using profile.erx to customize EPM can add 'link htmltags' to this file
  67. if they want the HTML extensions to be linked at start time.
  68.  
  69.  
  70. Compiling E Language Macros
  71. The E source of the extensions is provided so those willing to incorporate
  72. it permanently to EPM are free to do it.  It will need just a litle
  73. tweaking of your standard or customized macros to include it.  I am not an
  74. expert in writing E macros but if you have troubles just drop me a note
  75. and I will try to help.
  76.  
  77.  
  78. Using the Extensions
  79. I think the use of the extensions should be intuitive to anyone familiar
  80. with the HTML tagging.  The different tags that constitute the HyperText
  81. Mark-up Language can be embedded in the text selecting the HTML option
  82. that has been added to the editor main menu.  If the tag to be inserted is
  83. a single one (new paragraph, horizontal rule,...)  it is inserted at the
  84. cursor.  If the tag is "double" (i.e.  it needs a start tag and an end
  85. tag) then if there is no text area previously selected by dragging both
  86. tags are inserted at the cursor position and the cursor will be placed
  87. between the tags; if text is selected the tags will (usually) be placed
  88. encircling it.  Forms are supported in what seemed (to me) a useful way
  89. but I am open to receive any suggestion.
  90. The new Table option requires some explanations:
  91. Table support
  92. =============
  93. This version gives some support to the creation of tables in HTML. Basically,
  94. it transforms a set of data presented this way:
  95.  
  96. First Line: Caption of the Table
  97. Second Line: The "titles" of the columns (SINGLE WORDS separated by white
  98.   spaces)
  99. Third to Last Line: the name of the Row (SINGLE WORD) followed by the "values"
  100. of the row (separated by white spaces)
  101.  
  102. If you want an empty cell enter an asterisk in its place (as in the
  103. example data)
  104.  
  105. Example:
  106.  
  107. This is my DemoTable
  108.                FirstCol SecondCol ThirdCol
  109. FirstRow        V11       V12       V13
  110. SecondRow       V21       *       V23
  111. MyLongNameRow   V31       V32       V33
  112.  
  113.  
  114. Following the use of the Table option of HTMEPM your table is transformed
  115. into this HTML code that will be rendered by any HTML Browser:
  116. (beware that if you are using a proportional font in EPM the table
  117. will look unjustified, but will be rendered correctly by browsers.
  118. Set a fixed widht font in EPM to better appreciate what the macro does
  119. with your data)
  120.  
  121. <PRE>
  122. <B>This is my DemoTable</B>
  123. +---------------+---------------+---------------+---------------+
  124. |               |   FirstCol    |   SecondCol   |   ThirdCol    |
  125. +---------------+---------------+---------------+---------------+
  126. |   FirstRow    |      V11      |      V12      |      V13      |
  127. +---------------+---------------+---------------+---------------+
  128. |   SecondRow   |      V21      |               |      V23      |
  129. +---------------+---------------+---------------+---------------+
  130. | MyLongNameRow |      V31      |      V32      |      V33      |
  131. +---------------+---------------+---------------+---------------+
  132. </PRE>
  133.  
  134.  
  135. Your original data is left in place but commented out, as follows:
  136.  
  137. <!-- This is my DemoTable -->
  138. <!--               FirstCol SecondCol ThirdCol -->
  139. <!-- FirstRow        V11       V12       V13 -->
  140. <!-- SecondRow       V21       *       V23 -->
  141. <!-- MyLongNameRow   V31       V32       V33 -->
  142.  
  143. It's up to you to delete it or preserve for further editing.
  144.  
  145. Note that your original data don't need to be "justified"; the code generated will
  146. be the same with the following data:
  147.  
  148.  
  149. This is my DemoTable
  150. FirstCol SecondCol ThirdCol
  151. FirstRow V11 V12 V13
  152. SecondRow V21 * V23
  153. MyLongNameRow V31 V32 V33
  154.  
  155. The code takes care of the different sizes of the data, the number of
  156. rows and columns,... The basic limitation of this code is that you can
  157. only use single word names for rows and columns. The other condition is
  158. that data items (again single words) must be separated by white spaces.
  159. WARNING: you must select by dragging all the lines containing your table
  160. but NOT the preceding or following ones even if empty: if after applying
  161. the Table option you get strange results, UNDO and make sure you select
  162. only the table lines.
  163.  
  164. Popup Menu
  165. Some of the extensions can be selected If you right-click anywhere over
  166. EPM main windows:  a simplified HTML menu will pop-up for quicker access.
  167. If you recompile the code for EPM 6.x the HTML Menu will popup with
  168. Alt+Right clicking.
  169.  
  170. Viewing files with the WebExplorer
  171. The preview option is kept but it is only useful to launch the WebExplorer.
  172. Once the Explorer is running all you need to do to "view" the file you're
  173. editing is drag it from EPM to the Explorer, using the file icon of EPM
  174. (the icon on the top-left of EPM, that you should drag and then drop into
  175. the WebExplorer main window). Beware that (in my experience at least)
  176. you need to "prime" the Explorer (1.02) by dropping into it a file from any
  177. folder but not from the EPM. If the first drop to the WebExplorer comes
  178. from EPM, the Explorer crashes! Once you have "primed" it, you can drag &
  179. drop as many files as you want from EPM to WebExplorer without problems.
  180.  
  181. EPM Documentation
  182. The IBM documentation and tools needed to write and compile E macros can
  183. be found on several files in the /epm directory in software.watson.ibm.com
  184. and several other ftp sites .
  185.  
  186. EPMAPP.ZIP - Contains the compiler, the editor,...
  187. EPMMAC.ZIP - The standard macros used to compile EPM as supplied .
  188. EPMBOOK.ZIP - Documentation in INF format. It contains the EPM User's
  189. Guide that I can't understand why it is not included with OS/2 as this is
  190. the complete EPM guide. It also includes the EPM Technical Reference.
  191. CUSTEPM.ZIP - A customized version of EPM written by IBMers. Fully
  192. recommended if you want to study E Language macros.  My main source of
  193. inspiration when writing the HTML extensions.
  194.  
  195.  
  196. HTML Info (this may be outdated)
  197. If you are interested in HTML documentation, look in the Web. Some
  198. useful places are :
  199. http://www.ncsa.uiuc.edu/demoweb/html-primer.html
  200. http://www.w3.org/hypertext/WWW/MarkUp/MarkUp.html
  201. http://info.cern.ch/hypertext/WWW/Provider/Style/Introduction.html
  202. http://info.cern.ch/hypertext/WWW/MarkUp/SGML.html
  203. http://kuhttp.cc.ukans.edu/lynx_help/HTML_quick.html
  204.  
  205.  
  206.  
  207. UPDATE NOTES for 0.96 version
  208. - fixes some conflicts in the accelerator keys and some misplacements of
  209. the cursor after inserting tags.
  210. - the popup menus will pop now in the same position in the screen.
  211. - includes HTML+ style paragraphs (suggested by Terry Hamilton)
  212. - includes a rough 'preview' option (ideated by Ken Arway) to view the
  213. file with the WebExplorer.
  214. - Hightlight of HTML keywords. It can be turned on/off from the menu. When ON
  215. the tags inserted from the menu will be hightlighted. If you insert your
  216. own tags manually you can hightlight them by selecting 'Sintax hightlight
  217. On' from the menu. I have included the option for three colors: one to
  218. make the tags barely visible (LIGHT GREY on WHITE paper) and others (RED &
  219. BLUE) to make them more evidents.
  220.  
  221.  - Those  using EPM 6.x should recompile the source file: The
  222. popup menu would appear on Alt-Click2 instead of just Click2 to avoid
  223. conflicts with the standard popup menu of version 6.x
  224.  
  225.  
  226. UPDATE NOTES for 0.97 version
  227. - includes a compiled version for 5.51 users (OS/2 2.1)
  228. - fixes some conflicts with the selection keys
  229. - simplifies the Hightlight of HTML tags: now they're put in inverse video no matter what
  230. your background and text colors are. The menu item is ticked.
  231. - some new tags are included (most HTML 2.0 tags are now available)
  232. - fixes some misplacements of the cursor
  233. - users of version 6.x of EPM should recompile the macros using the
  234. source code included as I haven't been able to get the EPM beta 6.x version.
  235.  
  236. UPDATE NOTES for 0.98 version
  237. - Keyboard shortcuts for some of the tags
  238. - Fixed some errors in setting the Link Tags: now there is no duplication of
  239.   the URL scheme as it happened with 0.97
  240. - Image tag now offers a default text for non-graphics browsers
  241. - improved List Tags
  242. - Tables support
  243.  
  244. -------------------------------------------------------------------
  245.  
  246. September,2th,1995
  247. Eduardo Areitio
  248. Bilbao, Spain
  249. internet: areitio@ibm.net
  250.  
  251.