home *** CD-ROM | disk | FTP | other *** search
/ Collection of Hack-Phreak Scene Programs / cleanhpvac.zip / cleanhpvac / HTMLCO18.ZIP / HTMLCON.TXT < prev   
Text File  |  1995-04-24  |  13KB  |  335 lines
  1.  
  2.                 HTMLCon Version 1.8 (June, 1995)
  3.                An HTM(L) to ASCII Document Converter
  4.  
  5.  
  6.                        Satore Township
  7.                        P.O. Box 750836
  8.                    Petaluma, CA 94975-0836
  9.  
  10.         WWW to http://www.crl.com/~mikekell/index.html
  11.          FTP to ftp.crl.com/ftp/users/ro/mikekell/ftp
  12.  
  13.       This program may be distributed freely as long as no
  14.       modifications are made to it or this documentation.  We
  15.       ask that you register this program if you find it useful.
  16.       The registration fee of $7.00 (U.S., by check) should be
  17.       mailed to Satore Township at the address given above. If
  18.       you register this program and provide us with your e-mail
  19.       address, we will provide you with the command to eliminate
  20.       the registration request screen which appears when the
  21.       program is initiated.
  22.  
  23.       E-mail to mikekell@crl.com for comments or suggestions.
  24.  
  25.  
  26.                        About the Program
  27.                        -----------------
  28.  
  29. HTMLCon converts HTML/HTM files to standard ASCII files, making them ready  
  30. for viewing, editing or printing with standard DOS, OS/2 or Windows tools.  
  31. HTMLCon operates under MSDOS or under any program capable of providing an 
  32. MSDOS session and using COMMAND.COM as a command interpreter.  After 
  33. processing the input document, output will be displayed on a viewer or 
  34. editor of your choice, or printed if you choose.
  35.  
  36. HTMLCon recognizes HTML symbology through HTML+ level as of this date.
  37. It will automatically detect HTML files created in either an MSDOS or
  38. UNIX environment and process them correctly.  HTMLCon will attempt to
  39. process the raw HTML file such that the output is as readable as
  40. possible, eliminating unfavorable formatting to every extent practical.
  41.  
  42. A variety of options are available as defined in the control file
  43. (HTMLCON.INI).  The control file is necessary for the proper operation 
  44. of HTMLCon.  This file may be modified with any text editor and is
  45. heavily commented to allow you to set various options.
  46.    
  47.  
  48.                             Installation
  49.                             ------------
  50.  
  51. Copy HTMLCON.EXE and HTMLCON.INI to a new directory of your choice.
  52. Now set the environment variable "HTMLCON" to point to the directory
  53. where HTMLCON.INI resides.  This will allow you to run the program
  54. from any location on your system.  For example, if you put HTMLCON.EXE
  55. and HTMLCON.INI in the directory C:\UTILS, use the following command
  56. in your AUTOEXEC.BAT file:
  57.  
  58.                          SET HTMLCON=C:\UTILS
  59.  
  60. Notice that a trailing backslash should not be used with the environment
  61. variable HTMLCON.  Even if HTMLCon is unable to locate the HTMLCON.INI
  62. file it will operate, however none of the important directives in the
  63. HTMLCON.INI file will be used.  If HTMLCon is unable to locate the control
  64. file it will advise of the problem, wait thirty seconds, then proceed
  65. with processing the files you have selected using default values.
  66.  
  67. The program is now ready to run.  Source files may be located in any 
  68. directory.  Output files will be created in the directory from which 
  69. HTMLCon was run.  If you are using the optional filter file (HTMLCON.FIL),
  70. it should be located in the same directory as HTMLCON.EXE and HTMLCON.INI.
  71.  
  72.  
  73.  
  74.                               Operation
  75.                               ---------
  76.  
  77. HTMLCon can be operated in the interactive mode by running "HTMLCon"
  78. from the MSDOS session.  It can also be run without operator
  79. intervention by using the following command line arguments:
  80.  
  81. HTMLCon input_file[.html] line_length output_file[.ASC], or
  82. HTMLCon input_file[.html] output_file[.ASC], or
  83. HTMLCon input_file[.html]
  84.  
  85. where "line_length" indicates where HTMLCon should try to break a line
  86. for the output file, using values between 40 and 200 characters per
  87. line.  Preferences can be stated in HTMLCON.INI as shown below.  The
  88. default file extensions can be overridden on the command line for both
  89. input and output files (as well as in the HTMLCON.INI file).
  90.  
  91. HTMLCon has the ability to process multiple input files.  When used
  92. in this mode HTMLCon will automatically assign the file extension '.ASC'
  93. to all output files unless the default file extension has been changed
  94. in the HTMLCON.INI file.  HTMLCon will automatically detect the multiple file
  95. input mode by the presence of a '*' or '?' in the input file name.
  96.  
  97. For example, suppose that HTMLCon resides in the directory "C:\HTMLCON"
  98. and that there are several HTM/HTML files in the directory "C:\HTMLWRIT"
  99. that you wish to process.  First, move to the "C:\HTMLCON" directory,
  100. then issue the command "HTMLCON C:\HTMLWRIT\*.html".  HTMLCon will
  101. process the files, one-by-one, asking you each time if you wish to
  102. proceed with processing the next file.  When asked if you wish to
  103. proceed, you will be given the following options: Y)es (the default), N)o
  104. (no to this file only), Q)uit (quit processing all files), or A)ll
  105. (process all of the remaining files without pausing).
  106.  
  107. HTMLCon also has the ability to print processed files.  By placing the
  108. following line in the HTMLCON.INI file you are able to activate printing
  109. capabilities:
  110.  
  111.                          useprinter=yes
  112.  
  113. This command will tell HTMLCon to query each file processed to be sent
  114. to LPT1.  You may respond Y)es or N)o to the query (default YES).  If
  115. the above line does not appear in the HTMLCON.INI file then HTMLCon will
  116. not ask about printing files after they are processed.  Please note that
  117. HTMLCon will only use LPT1 and provides no other processing to the
  118. output file.  HTMLCon assumes you have a printer connected to LPT1 if you
  119. use this option and further assumes that the printer is working
  120. properly.
  121.  
  122. Images found in the HTM file are output as [IMAGE], HREF references as
  123. [*].  Forms are properly noted and marked, as is preformatted text and
  124. other special HTML symbols.  Derivatives are ignored except when the
  125. text is preformatted and unless the special HTMLCON.FIL file is used.
  126.  
  127. HTMLCon can make use of a special filter file (HTMLCON.FIL in the
  128. default directory) in order to translate HTML ENTITIES of the user's
  129. choice.  Use of this filter is activated by the statement
  130. "usefilter=yes" in the HTMLCON.INI file (see below).  The user may
  131. define up to 300 such filters in the HTMLCON.FIL file.  See the
  132. sample HTMLCON.FIL file for further details.  This is an advanced
  133. feature and is not necessary for non-demanding HTMLCon use.
  134.  
  135. Since the HTM Language is evolving continuously, it is possible that
  136. HTMLCon may not recognize certain symbols properly.  Also, since there
  137. is great variation in the creation of HTML documents, it may not be
  138. possible to ideally format all output.  Problems with the output will be
  139. corrected in future versions and we ask that you let us know of any
  140. problems by sending us e-mail, including the original HTML document that
  141. is not being processed correctly.
  142.  
  143.  
  144.                        HTMLCon Control File
  145.                        --------------------
  146.  
  147. The control file should be named HTMLCON.INI and exist in the same
  148. directory as HTMLCon.  Here is a sample, with explanations, of the
  149. control file:
  150.  
  151. # HTMLCon Initialization File (current through version 1.8)
  152. # ---------------------------------------------------------
  153. #
  154. # ----- ABOUT THE HTMLCON.INI CONTROL FILE -----
  155. #
  156. # Lines beginning with a pound sign are considered comments.
  157. # All other lines are considered instructions and must exactly follow
  158. # the format described in this sample file.  Arguments are seperated
  159. # by an equal sign (=) which must not be preceeded or succeeded by
  160. # a space or tab.
  161. #
  162. #
  163. # ----- DEFINING THE OUTPUT LINE LENGTH -----
  164. #
  165. # Define the default point at which HTMLCon should attempt to break a
  166. # line for the output file.  The break is not guaranteed to occur at
  167. # this point, but as close to it as possible to retain the syntax of
  168. # the input line.  Default=65.
  169. #
  170. linebreak=75
  171. #
  172. #
  173. # ----- COLLECTING STATISTICS -----
  174. #
  175. # Statistics can be compiled and written to the output file.  Default=No.
  176. # Use of this function does not increase the processing time and it does
  177. # provide some interesting information in the output file.
  178. #
  179. statistics=yes
  180. #
  181. #
  182. # ----- VIEWING OR PROCESSING THE OUTPUT FILE AUTOMATICALLY -----
  183. #
  184. # You may launch another program after HTMLCon finishes its work.  This
  185. # may be an ASCII file viewer, editor, or whatever.  The launched program
  186. # must be able to take the output file name as an argument.  In order to
  187. # accomplish this you must provide the FULL PATH to your program.  This
  188. # is a handy function to allow you to automatically and immediately see
  189. # the results of the HTMLCon conversion process.
  190. #
  191. #launchprog=c:\utils\list.com
  192. #
  193. #
  194. # ----- FINDING AND REPLACING THINGS -----
  195. #
  196. # Find and replace:  you may specify up to 50 strings to be located in
  197. # the HTML file and replaced in the ASCII output file.  These will be a
  198. # direct replacement using the two commands "find=" and "replace=".  Each
  199. # "find" element will be replaced by a "replace" element, therefore you
  200. # cannot have a "find=" statement without a following "replace=" statement.
  201. # To specify leading or ending spaces in a statement, surround the statement
  202. # with quotations (").  The strings cannot exceed 40 characters each.
  203. #
  204. find=" -- "
  205. replace=--
  206. #
  207. # Here is an example replacing all HTMLCon reference symbols [*] with just *.
  208. #
  209. #find=[*]
  210. #replace=*
  211. #
  212. # Or just ignore all references altogether...
  213. #
  214. #find=[*]
  215. #replace=
  216. #
  217. # And replace all HTMLCon image symbols [IMAGE] with a shorter one.
  218. #
  219. #find=[IMAGE]
  220. #replace=[I]
  221. #
  222. # Or just ignore them altogether...
  223. #
  224. #find=[IMAGE]
  225. #replace=
  226. #
  227. # And replace all HTMLCon list/tab markers with two spaces.
  228. #
  229. find=->
  230. replace="  "
  231. #
  232. # Or replace the list/tab markers with something else...
  233. #
  234. #find=->
  235. #replace=|
  236. #
  237. # Or just ignore them altogether...
  238. #
  239. #find=->
  240. #replace=
  241. #
  242. #
  243. # ----- KEEPING THE AUTHOR'S ORIGINAL FORMATTING -----
  244. #
  245. # You may elect to keep the formatting characteristics of the original
  246. # HTML file intact.  This will preserve white spaces, line breaks, etc. as
  247. # originally constructed by the author of the HTML page.  This option
  248. # will also eliminate the HTMLCon tab markers (->) and replace them with
  249. # four spaces to indicate tab lists. Uncomment the following line to
  250. # preserve the original formatting:
  251. #
  252. #keepformatting=yes
  253. #
  254. #
  255. # ----- IGNORING HTMLCON'S MARKERS IN THE OUTPUT FILE -----
  256. #
  257. # You may choose to have HTMLCon not replace certain HTML constructs
  258. # with its own markers (for example, HTMLCon replaces URL references
  259. # with the symbol [*]).  To have HTMLCon simply ignore its own symbols and
  260. # not reference certain items in the original HTML file, uncomment the
  261. # next line:
  262. #
  263. #ignoresymbols=yes
  264. #
  265. #
  266. # ----- PRESERVING HREF MARKERS IN THE OUTPUT FILE -----
  267. #
  268. # You may instruct HTMLCon to preserve all <A HREF...> constructs when
  269. # converting the HTML file.  These references will be preserved intact,
  270. # without modification.  To use this feature, uncomment the next line:
  271. #
  272. #keephref=yes
  273. #
  274. #
  275. # ----- ELIMINATING ADVERTISEMENTS AND DELAYS -----
  276. #
  277. # Eliminate the advertisements and delays
  278. # [available to registered users only]
  279. #
  280. #
  281. # ----- PRINTING THE OUTPUT FILE ON LPT1 -----
  282. #
  283. # If you would like the option to send the processed file to LPT1
  284. # then uncomment the next line:
  285. #
  286. #useprinter=yes
  287. #
  288. # Note that you may only send the processed file to a line printer
  289. # attached to LPT1 and that HTMLCon assumes the printer is connected
  290. # and operating properly.
  291. #
  292. #
  293. # ----- SPEED PROCESSING MULTIPLE FILES -----
  294. #
  295. # Uncomment the following line to tell HTMLCon to NEVER pause for any
  296. # prompt, including the call to your file viewer or other
  297. # post-processor.
  298. #
  299. #nopause=yes
  300. #
  301. #
  302. # ----- IGNORING CERTAIN FILE TYPES -----
  303. #
  304. # The following directive lists file extensions which should always be
  305. # ignored by HTMLCon.  If an input file name contains one of these
  306. # extensions than it will never be processed.  Note that the file
  307. # extension must always include the "." in this directive:
  308. #
  309. ignore=.ZIP.EXE.COM.LZH.GIF.LPG.ARC.ASC.SYS.INI.TXT.DOC
  310. #
  311. #
  312. # ----- USING USER-DEFINED FILTERS -----
  313. #
  314. # Uncomment the next directive to have HTMLCon apply a set of filter
  315. # replacements contained in the file HTMLCON.FIL in HTMLCon's default
  316. # directory.  This filter file will find and replace HTML ENTITIES
  317. # in your output file.
  318. #
  319. usefilter=yes
  320. #
  321. #
  322. # ----- CHANGING THE DEFAULT OUTPUT FILE NAME EXTENSION -----
  323. #
  324. # HTMLCon normally uses the default file extension ".ASC" when multiple
  325. # files are processed or the file extension is not specified.  You may
  326. # specify your own default file extension using the following command.
  327. # This file extension MUST be preceeded by a "." and contain no more than
  328. # three characters.
  329. #
  330. #extension=.TXT
  331. #
  332. #
  333. # End of file
  334.  
  335.