home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 2 / amigaformatcd02.iso / comms / netsoftware / wwwcache.lha / Cache / Cache.doc next >
Encoding:
Text File  |  1995-09-28  |  10.5 KB  |  190 lines
  1.   $VER: Cache.www 1.4 (28.9.95) Stephan Lichtendahl
  2.  
  3.   Freeware
  4.  
  5. Purpose:
  6. Saves inlined images to harddisk to prevent them from being
  7. downloaded every time you want to see them. Then they can
  8. be loaded every time from harddisk instead, which is a bit
  9. faster :-)
  10. Also, HTML documents can be saved in a way that all remote
  11. links remain remote and links to documents, which are already
  12. on your harddisk, will automatically be replaced with local
  13. ones. A convenient hotlist as HTML document will be created.
  14.  
  15. Requirements:
  16. -AMosaic (tested with NoNet 1.2 and AmiTCP 1.3beta & 2.0pre-release versions)
  17. -probably OS3.x for inlined images to work
  18. -Arexx running
  19. -rexxsupport.library (tested with version 34.9)
  20. -rexxdossupport.library (tested with version 2.1 & 2.3)
  21. -requestfile for saving HTML documents (part of OS2/OS3 ?)
  22. -getstring for saving local documents (see below)
  23. -Pentium processor & 16MB ram for full 32bit multitasking, or an Amiga
  24.  
  25. Installation / Usage:
  26. 1. Copy the Cache.www Arexx script to rexx: or somewhere else, as
  27.  long as it's in your path.
  28.  
  29. 2. Copy the Cache directory to any place you want, but note that you
  30.  can't ever move it to another place, unless you use assigns in the
  31.  definition of the cachedir (see below).
  32.  It initially only contains some empty directory's (Images & HTMLs)
  33.  and some empty files (ImageList & HTMLlist) and a file (NrOfImage)
  34.  which contains only one number (0), also there is a Cache.html
  35.  document which will be updated with all HTML documents you save.
  36.  The images and HTMLs that are saved will be saved in the appropriate
  37.  directory and will be noted in the appropriate ..list file.
  38.  As the images will be saved with only a number as filename the file
  39.  NrOfImage will always contain the last number used. Never change it!
  40.  
  41. 3. Edit the Cache.www script with a text editor, make sure you only
  42.  change the following line (at the top):
  43.  
  44.  cachedir='AmiTCP:Cache/'
  45.  
  46.  This is the definition of the cache directory, you MUST change this
  47.  if you didn't put the cache directory in AmiTCP:
  48.  Note it is a good idea to use an assign in the definition to prevent
  49.  problems later on when the path of the cache directory changes.
  50.  The definition must not contain spaces or quotes " and must end
  51.  with a / or : character. You must put ' characters around it.
  52.  
  53.  Important: when using version 2.1 of rexxdossupport.library, change
  54.  both occurences of rexxdossupport.library a few lines below to
  55.  RexxDosSupport.library.
  56.  
  57. 4.If you want to run the Cache.www script from AMosaic, which is a very
  58.  good idea, add the following entrys to your env(arc):mosaic/prefs :
  59.  
  60.  RexxMacro<n>   Get/put images from/in cache   |"address command 'Run >Nil: Rx Cache.www'"
  61.  RexxMacro<n+1> Same as above & save this page |"address command 'Run >Nil: Rx Cache.www Save'"
  62.  RexxMacro<n+2> Reload cached page from the WWW|"address command 'Run >Nil: Rx Cache.www Load'"
  63.  RexxMacro<n+3> Remove page & images from cache|"address command 'Run >Nil: Rx Cache.www Remove'"
  64.  
  65.  with <n>,<n+1>,etc the numbers of the arexx macro. For some strange reason
  66.  it is necessary to 'Run' this arexx script instead of directly through
  67.  arexx, otherwise AMosaic hangs. Rx must be in the path (i recommend you
  68.  make Rx resident if you use arexx scripts alot).
  69.  Of course DelayImageLoads must be True, otherwise the script will not be
  70.  of much help. You can turn it off again in AMosaic when reading cached
  71.  documents with the options menu.
  72.  Note, that when using AmosaicPrefs long lines can be chopped off, in that
  73.  case use a normal text editor to edit the prefs file. Also the checkbox
  74.  gadget for DelayImageLoads doesn't work as expected: the checkmark is there
  75.  also when DelayImageLoads is false, just check it again by clicking on it.
  76.  
  77. 5.Run the script every time you want something to happen with the current
  78.  HTML document you are viewing in AMosaic.
  79.  -with inlined images which have not been loaded and aren't on your harddisk
  80.   nothing will happen (download them yourself)
  81.  -inlined images which are on your harddisk will be loaded and will be displayed
  82.  -inlined images which have been downloaded will be saved on harddisk
  83.  
  84.  Normally you would first execute the script to load all images already on your
  85.  harddisk, then manually download the rest of the images you want (or choose
  86.  'Load images in current' from AMosaic's 'Options' menu) and then run the script
  87.  again to save the ones you downloaded.
  88.  When you are viewing a remote document and there are images for it on harddisk
  89.  you will automatically view a copy of it (...localhost/T:temphtml... in the URL)
  90.  in which the images are loaded. But all links will still be remote ones!
  91.  
  92. 6.When you want to do the same as 5 but also save the document then choose that
  93.  menu item from the rexx macros. There are a number of differences between this
  94.  feature and the normal save document as HTML feature of AMosaic:
  95.  -All links in the document will still be remote ones (links are normally relative
  96.   to the current document, so they would be relative to your harddisk).
  97.  -If you are viewing a local document from the cache/HTMLs directory it will
  98.   automatically be saved under the same name. Handy when more inline images have
  99.   been cached, as those image links will then also be saved as local.
  100.   You can reload the original page from the WWW with the Load option (rx Cache.www
  101.   Load) and then maybe save it again with the Save option (rx Cache.www Save).
  102.  -If you are viewing a remote document, it's existence in the HTMLlist will be
  103.   checked, and if available the document will be saved under the same name (as
  104.   above). Otherwise a requester will ask you to give a filename, only filenames
  105.   in the cache/HTMLs directory are accepted, which don't exist already.
  106.  -When saving a document for the first time, ALL HTML documents already in the
  107.   cachedir/HTMLs directory will be checked for the URL of the current document
  108.   and replaced with a local URL pointing to the document on harddisk.
  109.   Also, the document title will be added to cachedir/Cache.html with a link to
  110.   the document you saved, so you can simply use that HTML page as a hotlist
  111.   to jump to all your HTML documents in cachedir/HTMLs.
  112.  -When saving a HTML document all links in the document are checked for existence
  113.   on your harddisk, links to documents already in the cachedir/HTMLs directory
  114.   will be replaced with local ones. (So you see it works both ways).
  115.  -You cannot save a document with ...localhost/T:temphtml... in the URL, which is
  116.   a copy of the current document created by Cache.www, you will automatically
  117.   move back to the original document. Same case with the Load option.
  118.  -When you try to save a local document not in the cachedir/HTMLs directory
  119.   (eg. the HTML documents you had already on your harddisk, or the ones which
  120.   were saved with the Save Document as HTML feature from AMosaic) you will be
  121.   prompted for a URL (you need getstring for this). If you don't change the URL
  122.   given, the URL saved for that document will not be of much use and all relative
  123.   links in the document will be absolute(ly) useless, as noted above.
  124.   You can see this, as AMosaic tries to load all images in the document.
  125.   If you enter the original URL for that document, however, all relative links
  126.   will be saved as remote ones with that URL in it, and you will be viewing
  127.   the new document in cachedir/HTMLs. Now you must save that one to check
  128.   for images already in cachedir/Images or links to documents already in
  129.   cachedir/HTMLs and let the script replace the URL's as appropriate.
  130.   You could use this feature to 'enhance' you old documents.
  131.  
  132. 7.You can view the saved document with the 'Open Local' menu-item from AMosaic,
  133.  as you would normally do, or 'Open Local' the cachedir/Cache.html and click on
  134.  the document you want. Then use the 'Load images in current' menu-item to
  135.  load all available images, if you had updated the document after those images
  136.  became available, otherwise just execute the Cache.www script (you could
  137.  always execute the CacheImages script to view all available images, local
  138.  images will be loaded automatically, cached images in a copy of the document).
  139.  
  140. 8.You can delete all images, HTML documents, reset ImageList, NrOfImage,
  141.  HTMLlist and Cache.html with the following command:
  142.  `rx Cache.www Image All HTML All' (this will always create all neccessary
  143.  files in cachedir, but NOT the necessary directorys).
  144.  You can delete a specific image with `rx Cache.www Image <image>' with
  145.  <image> the number of the image or the complete URL of the original
  146.  image. ImageList will be updated.
  147.  You can delete a specific HTML document with `rx Cache.www HTML <html>'
  148.  with <html> the local filename (without the path) or the complete URL
  149.  of the original document. HTMLlist and Cache.html will be updated.
  150.  You can also use `rx Cache.www Remove` or the equivalent menu-item to
  151.  delete the current HTML document and all its images, that is to say, the
  152.  ones that are visible (ie. loaded) at the moment (so use Flush Image Cache
  153.  from the AMosaic menu first, if you only want to delete the document).
  154.  
  155. Notes:
  156.  When deleting images or HTML documents from the cache directory, all HTML
  157.  documents in cachedir/HTMLs will be checked for the local URL of the image
  158.  or HTML document you delete and replaced with the original remote one.
  159.  This is the exact opposite of saving a HTML document (see above),  but NOT
  160.  of saving an image:
  161.  When saving an image no checks are made, so local documents can still have
  162.  the remote URL of that image. This is not much of a problem, however,
  163.  because when you run the script when viewing a document (local or remote)
  164.  automatically you will be viewing a copy (if necessary of course) in which
  165.  the local images will be loaded. The document links in it, will not
  166.  automatically be replaced with local ones for the HTML documents on your
  167.  harddisk (that would make browsing the WWW for updated documents impossible),
  168.  but when saving a HTML document all its links to HTML documents or images
  169.  already on your harddisk will be replaced by local ones and you will be
  170.  viewing the saved document.
  171.  Overwriting an image is only possible when you choose to download it before
  172.  you let the script load it from harddisk.
  173.  
  174.  Forms will also work with saved documents (provided that you have AMosaic 2.0).
  175.  In my experience forms-support in AMosaic 2.0beta is very buggy.
  176.  
  177.  All HTML documents, ImageList & HTMLlist cannot exceed 64Kbyte in file size
  178.  each. This is mainly because of the AMosaic <> Arexx interface, but should
  179.  be not much of a problem, i hope.
  180.  
  181.  
  182. Bugs,comments,suggestions,questions:
  183.  
  184. Stephan Lichtendahl - Netherlands
  185.  
  186. Amiga 1200/030/33MHz/MMU/FPU/6MB/385MB/OS3.0 & CD32
  187.  
  188. Email: stephan@stephan.et.tudelft.nl
  189.  
  190.