home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / htmlkeys.zip / HtmlKeys.424 < prev    next >
Text File  |  1997-09-02  |  10KB  |  216 lines
  1.  
  2. <HTML >
  3. <HEAD>
  4. <TITLE>Marks HTML Macros for EPM</TITLE>
  5. </HEAD>
  6. <BODY BGCOLOR=#FFFFFF>
  7. <H1 ALIGN="CENTER">Marks Macros for EPM</H1>
  8.  
  9. Here another set of HTML macros for EPM.  Like those before Me, I've
  10. stolen ideas from those who have gone before me.  Making them a little
  11. better (I hope).  Thanks to those who have done the work upon which I
  12. built.  Special thanks to the <A HREF="http://www.htmlhelp.com/">Web Design Group</A>
  13. for creating the INF documentation Included.
  14.  
  15. <H2>Features</H2>
  16. <OL TYPE=1>
  17. <LI>Keystrokes to enter tags.
  18. <LI>Drag & Drop for URL objects, HTML files, images and Java classes.
  19. <LI>Help menu additions for HTML documentation.(If you have any)
  20. <LI>Defaults for tag arguments saved with each individual file.
  21. <LI>Navigational assistance.
  22. <LI>An optional Toolbar
  23. </OL>
  24.  
  25. This is 3.2 compliant, no Frames, no Blink or any other jackass tags.
  26.  
  27. <H2 ALIGN="LEFT">Installation</H2>
  28.  
  29. <H3 ALIGN="LEFT">Cautionary notes</H3>
  30. This file can be compiled as part of a larger package or as a linkable
  31. module.  Because of the Kludgy way I handled URL's
  32. with the data type <CITE>UniformResourceLocator</CITE>, it isn't recommended that
  33. it be compiled as part of your basic EPM package without setting <CODE>HTML_URL_KLUDGE</CODE>
  34. to 0.  In rare circumstances this can cause problems.  Because these macros use the field
  35. variable <CODE>.userstring</CODE> they shouldn't be compiled in any package where it might
  36. also be used.
  37.  
  38. <H3 ALIGN="LEFT">Installation (really)</H3>
  39.  
  40. <H4 ALIGN="LEFT">Where the files should go</H4>
  41. It depends.  I wrote these under version 603b, and haven"t tried them
  42. under earlier versions, and the paths are from the EPM6 version.
  43. If you don"t have it you might as well
  44. <A HREF="ftp://ftp.pc.ibm.com/pub/pccbbs/os2_util/epm603b.zip">get it</A>,
  45. it's free.
  46. <BR CLEAR=ALL>
  47. The files <SAMP>htmlkeys.e</SAMP> and <SAMP>htmlconst.e</SAMP> should go in in the directory
  48. <CODE>X\:EPM6\MAC</CODE>, or whatever directory you have all your <SAMP>*.e</SAMP> files.
  49. The <SAMP>*.erx</SAMP> files should go in <CODE>X:\EPM6</CODE> or wherever you have all your
  50. <SAMP>*.erx</SAMP> files. The file <SAMP>wilbur.inf</SAMP> should go somewhere in the path
  51. described by your <CODE>BOOKSHELF</CODE> environmental variable (or you could change the
  52. variable).  The Rexx <SAMP>*.cmd</SAMP> files should go somewhere in your <CODE>PATH</CODE>
  53. <H4 ALIGN="LEFT">Paths</H4>
  54.  
  55. If you haven't set your <CODE>EPMPATH</CODE> in your <SAMP>CONFIG.SYS</SAMP>, do it.
  56.  
  57. <H4 ALIGN="LEFT">Compiling it</H4>
  58. Edit the file <SAMP>WEBOPTIONS.E</SAMP> to suit your installation.<BR CLEAR=ALL>
  59. <BR CLEAR=ALL>
  60. The Variables are:
  61. <DL>
  62. <DT><CODE>JAVA_HTML_BROWSER</CODE>
  63. <DD>Fully qualified path to your browser (or just the name
  64. if it is in your PATH) and switches.
  65. <DT><CODE>HTML_IF_ARG_BLANK</CODE>
  66. <DD>Set this to "exit" if you want to abort a tag when mandatory arguments are
  67. not entered, otherwise you will be re-prompted
  68. <DT><CODE>HTML_URL_KLUDGE</CODE>
  69. <DD>Set to 0 to turn off the URL kludge.
  70. </DL>
  71.  
  72. <H5 ALIGN="LEFT">Linkable</H5>
  73.  
  74. Just type <KBD>etpm htmlkeys</KBD> and when you are ready to use it, from the command
  75. window type <KBD>link htmlkeys</KBD>
  76.  
  77. <H5 ALIGN="LEFT">As Part of a Larger Package</H5>
  78.  
  79. Enter the line <CODE>include 'htmlkeys.e'</CODE> in your <SAMP>MYSTUFF.E</SAMP> file
  80. and at the command line in the EPM directory type <KBD>etpm <I>package</I></KBD>, and you're ready to go.
  81.  
  82.  
  83. <H2 ALIGN="LEFT">Use</H2>
  84.  
  85. <H3 ALIGN="LEFT">Keyboard Entry</H3>
  86. Most of the <KBD>CTRL, ALT and F*</KBD> keys have been overridden to be shortcuts
  87. for tag entry.  You can find out which does which by looking at the menu.  Some tags will
  88. check to see if there is any text marked on on the screen.  If there is, it will be surrounded
  89. by the tag.  Otherwise they will be placed adjacent to one another with the cursor between them.
  90. Tags that normally occupy more than one line are inserted with opening tag where the cursor is.
  91. a blank line below it and the closing tag following the blank line and the cursor placed between
  92. the tags at <CODE>.col=1</CODE>.<BR>
  93. <BR>
  94. If a tag has arguments you will be prompted for the values.  If you enter a blank for a
  95. mandatory tag you will be prompted for the correct value or the tag will be aborted depending
  96. upon your configuration.  You can also abort a tag by entering or choosing <KBD>#OOPS</KBD>
  97. when prompted.<BR>
  98. <BR>
  99. The case of tags can be toggled with the <CITE>Toggle Case</CITE> menu item.
  100.  
  101. <H3 ALIGN="LEFT">Drag & Drop</H3>
  102.  
  103. All path separators are converted to UNIX style<BR>
  104. <BR>
  105. If the leading path of the file being edited is the same as that of a dropped object the
  106. portion that is identical will be removed for the tag, creating a relative url.<BR>
  107. <BR>
  108. For Example:<BR>
  109. <BR>
  110. If you are editing a file <SAMP>e:\foo\myfile.html</SAMP> and drop the file <SAMP>e:\foo\bar\a.gif</SAMP>,
  111. the path for the gif that will be entered is <SAMP>/bar/a.gif</SAMP>.
  112.  
  113. <H4 ALIGN="LEFT">HTML files</H4>
  114.  
  115. The Macros will scan the first 10 lines for a <CODE><TITLE></TITLE></CODE> pair
  116. and uses that for the text of the link.
  117.  
  118. <H4 ALIGN="LEFT">URL's</H4>
  119.  
  120. Dropping a URL will create a link, using the name of the object for the text of the link.
  121. <BLOCKQUOTE>For some reason EPM doesn't recognize data types of more that 18 characters, which
  122. is problematic for the data type <CODE>UniformResourceLocator.</CODE>
  123. I created a kludge to get around this.  It decides a file is a URL if it is only one line
  124. long and the text looks like a URL.  This kludge can be turned off by setting <CODE>HTML_URL_KLUDGE</CODE>
  125. to 0 in your <SAMP>WEBOPTIONS.E</SAMP> file</BLOCKQUOTE>
  126.  
  127. <H4 ALIGN="LEFT">Java classes</H4>
  128.  
  129. When you drop a Java class the EA's of the class are scanned for the arguments and parameters
  130. which are then placed in the tag.  These can be set using the included the Rexx script
  131. <SAMP>CLASSEA.CMD</SAMP>  Just type at the command prompt <KBD>classea [filename]</KBD> and
  132. follow the prompts.  In anyone out there knows where I can find some public Java classes for
  133. EA manipulation let me know, so I can make a nifty Java application to do this.
  134.  
  135. <H4 ALIGN="LEFT">Images</H4>
  136.  
  137. These macros recognize JPEGs and GIFs.  You can set the default values for the tag arguments
  138. for each image with the script <SAMP>imageEAs.cmd</SAMP> just like you do with Java
  139. classes.  Don't worry about setting the height and width for GIFs, those values will be taken
  140. from the files.
  141.  
  142. <H5 ALIGN="LEFT">GIFs</H5>
  143.  
  144. The width and height will be taken from the image and automatically entered in the tag.
  145.  
  146. <H5 ALIGN="LEFT">JPEGs</H5>
  147.  
  148. If I can ever figure out how to do so with JPEGs it will be done for them as well.
  149.  
  150. <H4 ALIGN="LEFT">XTML</H4>
  151.  
  152. <SAMP>XTML</SAMP> is a file extension I made up importable files.  It is a good place to
  153. place to put indices and maps.  When you drop one you will be prompted as to whether you want
  154. to load or import it.
  155.  
  156. <H3 ALIGN="LEFT">Tabbing</H3>
  157. The <KBD>CTRL-TAB</KBD> and <KBD>SHIFT-TAB</KBD> keys have been redefined to search for line
  158. for likely to need text entered.  If no such place is found the cursor is placed at the end
  159. of the line.  If it starts at the end of the line it goes to the next line.
  160. <KBD>CTRL-TAB</KBD> scans right and down and <KBD>SHIFT-TAB</KBD> scans left and
  161. up.
  162.  
  163. <H3 ALIGN="LEFT">Setting defaults</H3>
  164. The default argument's can be set by choosing the option from the interface sub menu.  You will
  165. be prompted for the argument to default and then the value for the argument.  This value will
  166. appear in entryboxes or at the top of listboxes, as appropriate.  If the value
  167. you enter or choose is proceeded with <CITE>AUTO_</CITE> you will not be prompted for the
  168. argument.  If you enter or choose AUTO_#OOPS the tag will be skipped.<BR>
  169. This can be used to turn off tags you never want to use.<BR>
  170. <BR>
  171. <STRONG>Care should be taken when using the AUTO_ feature.  If you do not have HTML_IF_ARG_BLANK
  172. set to exit you can get stuck in infinite loops if you set <CITE>AUTO_</CITE>(<I>some invalid value</I>) value
  173. for mandatory arguments.  I think I error trapped all instances where this is possible but
  174. I'm not sure</STRONG><BR>
  175. <BR>
  176. The defaults are automatically loaded when the file is loaded.  If you can reload them by
  177. choosing it from the menu.<BR>
  178. <BR>
  179. Changes to the defaults are not undoable.  You have to change then again manually.
  180.  
  181. <H2 ALIGN="LEFT">Known bugs and miscellaneous stuff</H2>
  182.  
  183. I know of no actual bugs.  The way I had to handle URL's with the Data Type
  184. <CITE>UniformResourceLocator</CITE>  EPM only seems to recognize data types of 18 or fewer
  185. characters.  If anyone can figure more elegant solution than what I'v done please tell me.<BR>
  186. <BR>
  187. I didn't include code for the entry of special characters.  The file was getting big enough,
  188. although I might add it in the future.  The code for frames is in there but commented out
  189. since I've decided that they are <FONT COLOR=#ff0000>EVIL</FONT>.  If you want frames you can
  190. uncomment it and recompile it.<BR>
  191. <BR>
  192. I thought about adding a table formatting routine but it required so many special markers that
  193. it was no easier than just entering the tags.
  194. <BR>
  195. I'm not fool enough to think that there is any way I can enforce any kind of shareware payment
  196. scheme.  If you find these useful contribute what you consider to be a fair amount to my
  197. Internet account.  Send a check to:
  198. <CENTER>
  199. CTS<BR>
  200. 8913 Complex Dr<BR>
  201. San Diego CA U.S. 92123-1413
  202. </CENTER>
  203. with a note telling them to credit the <EM>edantes</EM> account.  And, of course, anyone can
  204. distribute it.<BR>
  205. <BR>
  206. Send questions, comments. adulation, and bug reports to
  207. <A HREF="mailto:edantes@cts.com">edantes@cts.com</A><BR>
  208. <BR>
  209.  
  210. <STRONG><FONT COLOR=#ff0000><B>No Warrantee:</B>  This is available 'As Is'.  If anything bad
  211. happens to you I'm not res</FONT></STRONG>
  212.  
  213. </BODY>
  214. </HTML>
  215.  
  216.