home *** CD-ROM | disk | FTP | other *** search
/ Spanish Scene 3 / SpanishScene3.iso / programas / m_martÖn-ind / htmless.lha / HTMLess / HTMLess.doc < prev    next >
Text File  |  1998-04-11  |  19KB  |  490 lines
  1. *****************************************
  2. *        `HTMLess'  v3.0        *
  3. *       An OriginalWare release by      *
  4. *        Troglobyte/Darkness        *
  5. *****************************************
  6. $VER:HTMLess.doc v3.0 11.Apr.98 Troglobyte/Darkness
  7.  
  8. Contents
  9. ========
  10.  
  11. 1. Introduction
  12. 2. Workbench usage and ToolTypes
  13. 3. 1. CLI usage
  14.    2. Directory Opus usage
  15. 4. History
  16. 5. Bugs
  17. 6. OriginalWare?
  18. 7. Also available...
  19. 8. Thanks to...
  20. 9. Credits
  21.  
  22. 1. Introduction
  23. ===============
  24.  
  25. HTMLess is just another utility to extract the text inside HTML files (Web
  26. pages) and convert it to a readable standard text format.It can be used to
  27. test your own Web pages, if you get any strange text as result, will mean an
  28. error in the HTML source code (or a bug in my program :).
  29.  
  30. I released the first version in April'96, since then I received lot of EMails
  31. with bugs, ideas and support who keep me busy developing and improving HTMLess,
  32. I released 6 improved versions, today 11.Apr.98, two years later, a new release
  33. is ready: v3.0, I hope this new version could fill the needs of everybody, my
  34. goal was a small, eficient, fast, easy to use and reliable Amiga program to
  35. convert Web HTML pages to readable text files.
  36. I hope all you will find HTMLess useful.
  37.  
  38. The main features are:
  39.  
  40.  - Fast, written 100% in assembler. (Even faster since v1.2, and the fastest
  41.    with the new in v1.3 CLI option -w or the ToolType WINDOW disabled)
  42.  - Small but powerful utility (only 15000 bytes, uncrunched).
  43.  - CLI and Workbench usage.
  44.  - Load HTML files from a source dir and save TEXT files to another dir.  [v3.0]
  45.  - ToolTypes support.                         [New since v2.0]
  46.  - Admit filenames as CLI parameters (can be launched from a
  47.    DiskMaster/DirOpus type program to autoconvert HTML's).
  48.  - All non-ASCII chars are converted.
  49.  - Output text could be formatted to any number of columns for easy reading.
  50.  - Can keep [href's] (like WWW adresses) in the output text.
  51.  - Can keep META info and internal comments in the output text.    [New since v2.3]
  52.  - .HTML or .HTM filename suffix could be changed to your own defined text
  53.    extension.                             [New since v2.0]
  54.  - The program will report any kind of errors.
  55.  - Very easy to use...just try it.
  56.  - WYSIAWYG (WhatYouSawIsAlmostWhatYouGet)
  57.  - Great results (complex AI routines used *8).
  58.  - HTML Lists converted to text lists.
  59.  - `HTMLess' is a wonderful name. 
  60.  - No annoying requesters when starting/using/quitting program.
  61.  - It's OriginalWare (OriginalWhat?) and it's only Amiga (Yeah!).
  62.  
  63. The only requirement is the "ReqTools.library" by Nico Francois and Magnus
  64. Holmgren who fortunately is continuing the development of the indispensable
  65. reqtools library.
  66.  
  67. If you need a custom version of this program (for a personal necessity);
  68. contact me and I will try to make a customized version for you (if it isn't
  69. too difficult or too much work).
  70.  
  71. If you think the sources (100% assembler) could be useful for you (to include
  72. in a program you are developing or for learning purposes) just contact me and
  73. ask for them.
  74.  
  75.  
  76. 2. Workbench usage and ToolTypes
  77. ================================
  78.  
  79. 2.1 Workbench usage:
  80.  
  81. Just launch the program and use the file requester to select the HTML file to
  82. load and to choose the name to save the text file.
  83. (Since v1.1 this `complex' option works *8)
  84. [New since v1.2]
  85. The program will ask for another filename after saving the converted file,
  86. when you don't have more HTML files to convert, Cancel or Close the file
  87. requester to exit. (Use the icon ToolType SINGLE for just one use)
  88.  
  89. 2.2 ToolTypes [New since v2.0]
  90.  
  91. The ToolTypes of the icon will be used as default configuration.
  92. The ToolTypes are equivalent to the CLI options, but if used, all the CLI
  93. options will prevail over the ToolTypes options.
  94.  
  95. COLUMNS=x    Number of columns to format the text (x is a number, 0<x<9999)
  96.         (If x=0 the text will be `formated' like the original file)
  97. HTTP        Insert href's in the output text between "[...]" chars.
  98. WINDOW        Open a Workbench window to display info.This option is
  99.         incompatible with YAK commodity, if you use YAK disable this.
  100. SINGLE        Convert just one file and exit without asking for a new file.
  101. AUTOSAVE    Save the text without a file requester.
  102. OVERWRITE    Overwrite the original HTML file, so use with caution.
  103. EXTENSION=text  Add a text extension to the savename.
  104. PATH=Dir    Select the default load directory.
  105. [New since v2.3]
  106. META        Insert META info and comments of the HTML source file in the
  107.         output text between "{...}" chars.
  108. [New since v2.5]
  109. TEXT        Check files and converts only true HTML files.(Check <HTML> tag)
  110. [New since v3.0]
  111. DESTINATION=Dir    Select the default save directory.
  112.  
  113. To disable options use brackets with the ToolType.
  114. Example : 
  115. WINDOW        Window enabled
  116. (WINDOW)    Window disabled
  117.  
  118.  
  119. 3.1. CLI usage
  120. ==============
  121.  
  122. Just write the command `HTMLess' with your favourite options in any CLI/Shell
  123. window.
  124.  
  125.  `HTMLess [?] [-Cxx] [-H] [-M] [-W] [-S] [-A] [-O] [-E...] [-D=dir] [-P] [filename/path]'
  126.  
  127. Write just the options or the options and the path or filename (if not
  128. filename is given or if there is any kind of problem a file requester
  129. will be used with your defined path).
  130. Options must be ahead of the file name and must be after a "-" char.
  131. Options can be together or alone (-c20h or -c -h20),  and written in capital
  132. or small letters (-HC5, -hc5 or -hC5)
  133. The -Etext option must be used separated from the others options (-hc5 -e.txt)
  134. to avoid the confusion of taking the text as a CLI option.
  135.  
  136. The available options are: 
  137.  -h     : if used "href's" will be removed.By default "href's" are included
  138.           in the output text between "[...]" chars.
  139.  -cXXXX : XXXX are 1 to 4 numbers (-c10,-c200,-c0080) to select the size of
  140.           the columns of the formated text (default size is 80 columns).
  141.       If the number is zero, text won't be formatted (-c0,-c0000)
  142. [New since v1.2]
  143.  ?, -? or -help : give CLI USAGE: info.
  144. [New since v1.3]
  145.  -w     : when used HTMLess window won't be opened.And the conversion will
  146.           be really faster; try it.Errors will be reported to the CLI
  147.           window, if there is any opened.
  148.  -p     : you can define the path to your favourite HTML directory
  149.       Used without specifying later a [path] is useless.
  150. [New since v2.0]
  151.  -s     : Single use, 
  152.  -a     : AutoSave, save without a requester asking for the filename. 
  153.  -o     : Overwrite, use with caution, will overwrite original file.
  154.  -e.TXT : Add a text extension to the original filename (you define the text).
  155.       .HTML or .HTM extensions are automatically removed.
  156. [New since v2.3]
  157.  -m     : if used "META" info and comments will be added in the output text
  158.        between "{...}" chars.By default, META info and comments are removed.
  159. [New since v2.5]
  160.  -t    : check files and converts only true HTML files.(Check <HTML> tag)
  161. [New since v3.0]
  162.  -d    : select the default save directory "RAM:".
  163.  -d=DIR    : choose your own save directory (Remember to use the '=' char)
  164.  
  165.  
  166. Examples:
  167.  
  168. 1. HTMLess -hc80 File1.html
  169.    Results : A text file "File1.text" without [href's] and formated to 80
  170.              columns will be saved.
  171.  
  172. 2. HTMLess -h -c0040 File2.htm
  173.    Results : A text file "File2.txt" without [href's] and formated to 40
  174.              columns will be saved.
  175.  
  176. 3. HTMLess -c0 File3.txt
  177.    Results : A text file with the same name "File3.txt" with [href's] and
  178.    unformated text will be saved.
  179.  
  180. 4. HTMLess -p RAM:Temp/HTML    (RAM:Temp/HTML is a path, not a file)
  181.    Results : File requester with the files in the directory: `RAM:Temp/HTML/...'
  182.  
  183. 5. HTMLess -e.Document File5.html
  184.    Results : A text file with the name "File5.Document"
  185.  
  186. 6. HTMLess -d=RAM:Temp/Text File6.html    ("RAM:Temp/Text" is a path, not a file)
  187.    Results : Text file "File6.text" saved in directory: `RAM:Temp/Text'
  188.  
  189.  
  190. Common errors :
  191.  
  192. 1. Options must be after a "-" char always.
  193.    BAD: HTMLess -h c80 File1.html
  194.    OK : HTMLess -hc80 File1.html
  195.    OK : HTMLess -h -c80 File1.html
  196.  
  197. 2. Options must be ahead of the filename.
  198.    BAD: HTMLess File1.htm -c20h
  199.    OK : HTMLess -c20h File1.htm
  200.    
  201.  
  202. 3.2. Directory Opus usage
  203. =========================
  204.  
  205. Information for using HTMLess with Directory Opus :
  206.  
  207.  o Create a new button and name it HTMLess or whatever.
  208.  
  209.  o Set the cycle gadget to AmigaDos command.
  210.  
  211.  o Use the command line as <path-to-program>:HTMLess -W -S -E.txt {f}
  212.  
  213.  o Select the following flags in the listview :
  214.  
  215.     CD Source
  216.     Do all files
  217.     Output Window
  218.  
  219. Note: This applies to DirectoryOpus 4 but probably works with later versions.
  220.  
  221.  
  222. Then you can select as many html files as you like, click on the new button and
  223. they will all be converted and saved in the same path with a .txt extension.
  224.  
  225. Note: This applies to DirectoryOpus 4 but probably works with later versions.
  226.  
  227. Information provided by: Anthony (Xerra) Brice - anthony@backyard.demon.co.uk
  228.  
  229.  
  230. 4. History
  231. ==========
  232.  
  233. Version 1.0 ( 1.April.1996) :
  234.  - First official release.
  235.  
  236. Version 1.1 ( 5.April.1996) :
  237.  - Fixed Workbench icon bug (Sorry about that stupid icon type error).
  238.  - All non-ASCII chars are supported now. (Not really, try v1.2)
  239.  - Improved conversion of HTML Lists (now are more readable).
  240.  - Some extra Line Feeds are removed (but not all, to make readable a lot
  241.    of not-very-standard HTML Web pages)
  242.  - A rarely Guru bug with small files fixed.
  243.  - Last char of the text isn't deleted now.
  244.  
  245. Version 1.2 (12.April.1996) :
  246.  - Even more speed: a lot faster when Fast memory is available. (Test it)
  247.  - You can convert several files without reloading HTMLess.  (Otto von Ruggins)
  248.  - ">" by "}", and "<" by "{" bug removed.              (Markus Krajewski)
  249.  - CLI Usage info.                              (Alfredo Soro)
  250.  - All non-ASCII chars are supported now (I said the same in v1.1 *8)
  251.  - Some rare and little system-unfriendly bugs removed.
  252.  - Improved conversion for some HTML commands ( </P>, <DT> y <H....>)
  253.  - Spaces removed at the end of lines.
  254.  - More helpful people included in this doc (Look: 6.Thanks to... *8)
  255.  
  256. Version 1.3 (16.April.1996) :
  257.  - New CLI option. -w : no window will be opened and the conversion is FASTER.
  258.  - New CLI option. -p : will permit define your own path as default dir.
  259.  - Problem with YAK commodity detected, but not fixed yet.      (John Turgoose) 
  260.  - Even more helpful people included in this doc (Look: 8.Thanks to... *8)
  261.  
  262. Version 2.0 ( 1.May.1996) :
  263.  - Added Workbench icon ToolTypes support (All the CLI options have a ToolType)
  264.  - Almost all the duplicated text titles are removed now.
  265.  - Bug fixed: filesize limit of 64 KB removed.              (Markus Krajewski)
  266.  - Bug fixed: TABS (tabulator chars) are accepted.         (Markus Krajewski)
  267.  - New WB/CLI option. -A : AutoSave, no save-filename requester. 
  268.  - New WB/CLI option. -O : OverWrite original file! (Use with caution!)
  269.  - New WB/CLI option. -S : Single use, convert just one file and exit.
  270.  - New WB/CLI option. -E.text : Add a text extension to the filename. 
  271.  - Still even more helpful people included in this doc (Read: 8.Thanks to...*8)
  272.  
  273. Version 2.1 (23.Jul.1996) :
  274.  - Lame Bug fixed: Now works without Fast RAM. (I.Gallego, G.A.Gomez & I.Sofke)
  275.  - Still even more helpful people included in this doc (Read: 8.Thanks to...*8)
  276.  
  277. Version 2.2 (20.Nov.1996) :
  278.  - Now META info can be included in the text betwen {...} chars.
  279.  - Bug fixed: filename betwen "..." chars are acepted.          (Eric Giroux)
  280.  - Still even more helpful people included in this doc (Read: 8.Thanks to...*8)
  281.  
  282. Version 2.3 (30.Nov.1996) :
  283.  - Now META info and comments can be included in the text betwen {...} chars,
  284.    with the ToolType META or the CLI option: -M.
  285.  - Improved conversion for clearer formated output results.
  286.  - This Doc was fully revised and updated.
  287.  - Bug fixed: sometimes the first and last lines were cutted.
  288.  - Bug fixed: duplicated titles removed of the new text file.
  289.  
  290. Version 2.4 (30.Jan.1997) :
  291.  - Improved conversion for clearer formated text.
  292.  - New Email address.
  293.  
  294. Version 2.5 (16.Mar.1997) :
  295.  - New WB/CLI option. -t : check if it's a true HTML file before converting
  296.    the file to text                        (Kai Nikulainen)
  297.  - Added info in this doc (3.2.) to configure HTMLess as a Directory Opus
  298.    button                             (Anthony Brice)
  299.  - Bug fixed: removed more HTML codes from output text        (Sascha Pfalz)
  300.  - Bug fixed: added some extended ASCII chars
  301.  - Bug fixed: </TD> tag works again
  302.  - Bug fixed: correct length of formatted lines with TABS
  303.  - New HTMLess filesize is 15.000 bytes (uncrunched).
  304.  
  305. Version 3.0 (11.Abr.1998) :
  306.  - Load and save requesters remember his own directory (everybody want it). 
  307.  - New WB/CLI option. -d : choose a destination dir for converted files. 
  308.  - The "Formating..." spelling mistake corrected        (Fredrik Ismyren)  
  309.  - Bug fixed : file requester contents are updated now        (Carlos Gonzalez)
  310.  - Bug fixed : some extra spaces removed            (Kai Hofmann)
  311.  - More non standard chars converted to readable Amiga ASCII standard.
  312.  - Of course,  more helpful people included in this doc (Read: 8.Thanks to...)
  313.  - A megabonus ultrasecret minioption for registered users :). 
  314.  - And HTMLess filesize is still 15.000 bytes (uncrunched).
  315.  
  316.  
  317. ToDo List:
  318.  - Fix all the bugs that will be discovered by users (Don't try so hard *8)
  319.  - Fix the strange YAK BUG listed in `5. Bugs'.
  320.  - Display improved formated LISTS.
  321.  - Display improved formated TABLES.
  322.  - Option to convert bold and italic tags as ANSI.
  323.  
  324.  
  325. 5. Bugs
  326. =======
  327.  
  328. [New since v1.3]
  329. There is an unknown bug in some Amigas, looks like there is a compatibility
  330. problem with the YAK commodity (thanks to John Turgoose for this info).So
  331. try to disable/unload/stop/turn off YAK when using HTMLess.
  332. The problem is a warning Guru (yellow) each time you run HTMLess, after
  333. that you can't close the HTMLess window.Since v1.3 I included a new CLI option
  334. (-w), when used HTMLess don't open his own window, but will report errors
  335. to the CLI window, if it's open.As an added bonus with this option turned
  336. on the conversion is a lot faster.
  337.  
  338. There isn't anymore KNOWN bugs at the moment in all the Amigas tested but...
  339.  
  340. If you find any bug or problem, contact me at the previous address.Please,
  341. send me a detailed report of the problem and of your Amiga computer if
  342. possible; thanks.
  343.  
  344. If you found the problem with a particular file, send me too a copy of
  345. the file.
  346.  
  347. Don't forget to tell me the current version of my program you are using.
  348.  
  349.  
  350. 6. OriginalWare ?
  351. =================
  352.  
  353. This  utility  is OriginalWare.That means if you like this program you must
  354. buy  an  original Amiga program or game, or send the money to the author of
  355. any ShareWare program or game you are using often.
  356. (This includes me, $5, $10 or a program made by you will be welcome *8)
  357.  
  358. There  are  lots  of  great Amiga software like `DiskMaster', `Remind',
  359. `MultiCX', `Spot', `ReqTools.library', `Deluxe Galaga', `APlayer' and a
  360. lot more that you won't never regret to spend your money.
  361.  
  362. If you do this you support the Amiga, and if you support AMIGA you support
  363. US.Support software authors and you will get more and better software.
  364.  
  365.  
  366. This program could be included in any PD compilation at a symbolic price,
  367. but you must send me a copy of the CD/Floppy Disk/... compilation or get
  368. a written permission from me.
  369.  
  370. Aminet and Fred Fish collections are specifically allowed to include it
  371. absolutely free.
  372.  
  373. This program could be freely included in any Web page or FTP site, but
  374. send me an EMail to know it (I can include your page address in this doc).
  375.  
  376. For using this in commercial products, my written permission is required.
  377. Inclusion in magazines and diskmags will be allowed, if you send me a copy of
  378. this publication.
  379.        
  380.  
  381. 7. Also available...
  382. ====================
  383.  
  384. Others quality Amiga PD products available from me :
  385.  
  386. Aminet recent uploads :
  387.  
  388. FormaText.lha v1.0   text/misc     12K Format texts to your chosen columns size 
  389. HTMLess.lha   v3.0   text/hyper     17K v3.0 Converts HTML files in text files.
  390. DarkSound.lha v2.5   util/boot   53K v2.5 Changes Workbench Sounds each boot.
  391. MagiCA64.lha  v1.1   misc/emu     6K Converts A64/64 files to MagiC64 format.  
  392. Progress.lha  v1.0   demo/intro  73K In Progress/Darkness.1st at Euskal Party
  393. Vectoram.lha  v1.3   dev/misc    15K Draw and edit 2D vectors for demos/games
  394. TheRace5.lha  v1.5   game/2play  59K Great 100m Running game, 0-4 players.
  395.  
  396. Available soon:
  397.  
  398. ELF.lha       v1.0   text/misc         Erase Line Feeds.Use for Word Procesors.
  399.  
  400. All them are 100% written in pure assembler for speed and are very system 
  401. friendly in all types of Amiga computers (or that is what I hope *8).
  402.  
  403.  
  404. 8. Thanks to...
  405. ===============
  406.  
  407. First a very special THANK to Jon B. Peterson from San Angelo (Texas, USA),
  408. Brian Jones (Calgary, Canada) and Mick Domoney (Scamton, UK) for being the
  409. first persons to send me some money for my work.
  410.  
  411. Alfredo Soro.es for the first ßeta testing.
  412. Otto Von Ruggins for the first bug report and some tests.
  413. Philippe Duchenne.be for reporting some bugs and interesting ideas.
  414. Markus Krajewski.de for lots of bugs and nice ideas.
  415. Geoff Milnes for another bug report.
  416. John Turgoose.ca for the problem with the YAK commodity.
  417. Jerome Chesnot.fr for EMail support, even "TheRace" support. (R.A.M. is great!)
  418. David Cassidy.uk for don't forget me *8) .
  419. Jose Vergara.es for Fido EMail support.
  420. Andrew Bruno.au for EMail support. 
  421. Mikael Osterhed.it for EMail support.
  422. Glenn Zieman for EMail support and suggestions.
  423. Joerg Plate.de for EMail suggestions.
  424. Derik Pyper.ca for nice EMail support.
  425. Adriano Altorio.it for EMail support.
  426. David de Groot.be for nice EMail support.
  427. Dareen Enns for EMail suggestions.
  428. Peter Soderber.se for EMail support.
  429. Ignacio Gallego.es for the Fast RAM bug.
  430. Gustavo Adolfo Gomez.ve for the Fast RAM bug and nice EMail.
  431. Ivan Sofic.yu for the Fast RAM bug report.
  432. Eric Giroux for the filename betwen "..." chars loading bug.
  433. Emmanuel Poirier.fr for Email support.
  434. Kai Nikulainen.fi for suggest the new <HTML> tag check.
  435. John Conant.us for Email support and a strange crash report.  
  436. Anthony Brice.uk for Email support and Directory Opus info.
  437. Miguel Angel Perez Valdenebro.es for Email support.
  438. Sascha Pfalz.de for Email support and a bug report with examples.
  439. Carl Butler.us for email support.
  440. Christian Beck for EMail suggestions.
  441. Kai Hofmann.de for EMail suggestions and bug reports.
  442. Fredrik Ismyren.se for the spelling mistake report.  
  443. Carlos Gonzalez Nuñez.es for the dirs not updated bug and Email support.
  444.  
  445. Hipnooxis.es for ALL the help and show me to use and respect the Amiga O.S.
  446.  
  447. Knackosoft.de/TRSI for being my best `invisible' friend.
  448.  
  449. To `Atletico de Madrid', the best football team in Spain.
  450.  
  451. To all the Amiga developers for all the new, fun and useful stuff.
  452.  
  453. To all the Amiga users (you!) worldwide for their trust in the Amiga.
  454.  
  455. To Amiga Technologies for continue the development of the Amiga...for a while.
  456.  
  457. To VIScorp for support the Amiga...for a while?
  458.  
  459. To Gateway 2000 for ...
  460.  
  461. To whoever will be the next to bring light to the Amiga...
  462.  
  463. To the Amiga...
  464.  
  465.  
  466. 9. Credits
  467. ==========
  468.  
  469. All code © 1998 by Troglobyte/Darkness.
  470.  
  471. Send money ($), BUGS, comments, improvements, ideas, advices, mags,
  472. suggestions,  complains, and nice  PD  stuff  (like Demos, Games or
  473. Utilities).
  474.  
  475.             M. Martin Vivaldi
  476.              Av. America 60
  477.               Madrid 28028
  478.                  SPAIN
  479.  
  480. Or NetMail me at :
  481.  
  482.  Internet : manuel@webmedia.es
  483.  
  484.  
  485. Remember:
  486.  
  487.       Only Amiga make it possible... Only Amiga make it fun.
  488.  
  489.  
  490.