home *** CD-ROM | disk | FTP | other *** search
/ Magazyn Amiga 12 / MA_Cover_12.iso / internet / gethelp / gethelp.readme < prev    next >
Encoding:
Text File  |  1999-06-08  |  2.7 KB  |  65 lines
  1. Short:    Browse+search compressed HTML docs
  2. Uploader: bsrogers@cobweb.com.au (Brendan Rogers)
  3. Author:   bsrogers@cobweb.com.au (Brendan Rogers)
  4. Type:     text/hyper
  5. Replaces: text/hyper/GetHelp.lha
  6. Version:  1.1
  7. Requires: OpenURL 2.0, LhA, MUI for SearchHTML
  8.  
  9. GetHelp Description
  10. ===================
  11. The goal of this project was to make HTML format help documents easier to
  12. contend with on the Amiga. Suppose someone has constructed help documentation
  13. in HTML, complete with graphics, links to web sites, email addresses etc.
  14. What is actually a single document traditionally arrives as a multitude of
  15. smaller files - HTML pages and images.
  16.  
  17. The end user doesn't need a bunch of small files, the browser does...
  18. Your filesystem will love you as you have cut down a multitude of small files
  19. into just one archive. GetHelp will unarchive and cache all the small files to
  20. Ram:T as you open them, then delete them when you've finished.
  21.  
  22. The GetHelp system allows you to use an HTML document like an Amigaguide
  23. document - a single hypertext help file. Because its compressed, a GetHelp
  24. file will generally be much smaller than the equivalent Amigaguide file.
  25. Try constructing a '.help' file from an Amiguide document that has been
  26. converted to HTML using GuideML or equivalent tools. My PCDoom_FAQ.guide (386kB)
  27. has been trimmed to a PCDOOM_FAQ.help (222kB). 
  28.  
  29. Gethelp also opens the door for a comprehensive hypertext based help system on
  30. the Amiga, referencing each document with a single click and navigating in a
  31. browser environment - see the included examples!
  32.  
  33. SearchHTML
  34. ----------
  35. All browsers allow simple text search of the currently displayed file.
  36. This release includes a global document search utility which will generate
  37. a list of files which match your search parameters.
  38.  
  39. Installation and notes
  40. ----------------------
  41. There is no installer required for this installation, just follow the
  42. instructions in the HTML documentation. Take care to note the limitations
  43. section. Once GetHelp is installed and your browser configured, you will be
  44. able to access "GetHelp.help" from your browser instead.
  45.  
  46. C Source for SearchHTML is included in the hope a C guru will critique /
  47. improve it for me!! Any suggestions welcome.(that goes for my arexx too!)
  48.  
  49. History 
  50. ========
  51. 1.1 - removed limitation on use of spaces in filenames and paths
  52.     - REALLY included SearchHTML executable this time(sorry!)
  53.  
  54. 1.0 - second aminet release
  55.     - handles .htm suffix as well as .html
  56.     - includes SearchHTML utility
  57.  
  58. 0.9 - incorporated OpenURL2.0 to simplify and shorten the script
  59.  
  60. 0.8 - modified arguments to lhA command for better compatibility
  61.  
  62. 0.7 - Initial aminet release.
  63.       Had some feedback that the lha command was not working for some people.
  64.       Thanks to Neil Botwick for his suggestions.
  65.