<HTML>
<HEAD>
  <TITLE>Museum 2.01</TITLE>
</HEAD>

<BODY>
<H1>Museum</H1>
<font size="2">Version 2.01 (25 Jun 1998) &copy; Musus Umbra 1998</font><br>

<h4>Contents</h4>
<ul>
  <li> <a href="#WhatIs">What is Museum?</a>
  <li> <a href="#Features">Features</a>
  <li> <a href="#Options">Options and configuration</a>
  <li> <a href="#Problems">Known problems</a>
  <li> <a href="#Licence">Licence, disclaimer, etc.</a>
  <li> <a href="#Contact">Contacting the author</a>
</ul>

<br>
<hr>
<br>

<a name="WhatIs"></a>
<h4>What is Museum?</h4>

<p>
Well, put simply, Museum is a handy way of collecting your <i>History</i> lists togther in one place if you use two (or more) different web browsers.
</p>

<p>
The original Museum was written some time ago as a tiny utility to create an HTML document from <i>Fresco</i>'s global History file.  As time went by, I found myself using it to access URLs from <i>Fresco</i>'s history with <i>Browse</i>, so I decided to extend the idea a little.
</p>

<p>
Museum 2 will create a single HTML 'links' document for a number of different History files from different browsers. E.g. it can be used to create a history file for <i>Fresco</i> and <i>Browse</i> in one page - which will be loaded into whichever browser is loaded.  This makes 'sharing' a history between two (or more) browsers a doddle.
</p>

<br>
<hr>
<br>

<a name="Features"></a>
<h4>Features</h4>

<p>
Museum tries to be helpful in a couple of ways:
<ul>
  <li> Pages titled <i>An error occurred</i> (such as those generated
       by <i>WebServe</i>) will have their URL substituted for the the
       (unhelpful) description in the generated HTML.
  <li> The generated file itself is omitted from the listing :-)
</ul>
</p>

<p>
It's easy to extend the list of descriptions that won't be included, or that will be replaced with URLs;  open <i>!Museum</i> and edit the <tt>skip</tt> and <tt>replace</tt> files.<br>
These files should have one description per line, and any lines beginning with whitespace (e.g. tab, space, etc) will be skipped. 
</p> 

<br>
<hr>
<br>

<a name="Options"></a>
<h4>Options and Configuration</h4>

<p>
As it stands, the only configuration available is specifying which history list(s) you want Museum to work with.
</p>

<p>
Museum understands the history files belonging to:
<ul>
  <li> Fresco
  <li> Browse (and VoyBrowse)
  <li> ArcWeb (and WebVoyage)
</ul>
(If someone cares to send me a <i>Webster XL</i> history file, I'll be happy to extend the code).
</p>

<p>
As supplied, Museum tries to use <i>Fresco</i>'s and <i>Browse</i>'s history files, but you can easily change this:
<ul>
<li> Open the <i>!Museum</i> application (i.e. <i>shift-double-click</i> on it)
<li> Load the <i>!Run</i> file into a text editor (e.g. drag the file to <i>!Edit</i>'s icon on the iconbar)
<li> Locate the (prominently marked) line that begins:<br>
<tt>run Museum:Museum</tt>
<li> Alter this line to suit your tastes.
</ul>
<br>
Don't alter the <tt>run Museum:Museum Museum:History</tt> part of the line unless you know what you're doing;  it's the bits after this that allow you to specify which browsers to use.
</p>

<p>The options are specified as sets of three values:
<ol>
<li> The browser type that the history file belongs to;<br>
     This can be:
     <ul>
       <li> <tt>-a</tt> for <i>ArcWeb</i> (or <i>WebVoyage</i>)
       <li> <tt>-b</tt> for <i>Browse</i> (or <i>VoyBrowse</i>)
       <li> <tt>-f</tt> for <i>Fresco</i>
     </ul>

<li> The name of the browser.  This is used for the history list heading in
     the generated page, and also for the 'contents' links at the top of the
     document (if more than one history is requested).<br>
     Things to note:
     <ul>
       <li> It should be a name that is suitable for use in a
            &lt;A NAME=&quot;&gt; label.  <i>Fresco</i> is slightly
            fussier than <i>Browse</i> about this, BTW.<br>
            Basically, this just means no spaces or punctuation.

       <li> It's only used for the label anchors and headings - beyond that
            it has no relevance.
     </ul>

<li> The location of the history file.<br>
     This depends on the browser in question.  The usual locations (AFAIK)
     are:
     <ul>
       <li> <i>Fresco</i>:<br>
       <tt><i>&lt;Fresco$Dir&gt;.History</i></tt>
       <li> <i>Browse</i>:<br>
       <tt><i>&lt;Wimp$ScrapDir&gt;.WWW.Browse.History</i></tt>
       <li> <i>VoyBrowse</i>:<br>
       <tt><i>&lt;Wimp$ScrapDir&gt;.WWW.VoyBrowse.History</i></tt>
       <li> <i>ArcWeb</i>:<br>
       <tt><i>ArcWebCache:History</i></tt>
       <li> <i>WebVoyage</i><br>
       <tt><i>&lt;VTiInternet$Dir&gt;.User.WWWCache.History</i></tt>
     </ul>
</ol>
</p>

<p>
So, for example, to have <i>Fresco</i>'s history, then <i>Browse</i>'s you could use:<br>
<tt>run Museum:Museum Museum:History -f Fresco &lt;Fresco$dir&gt;.History -b Browse &lt;Wimp$ScrapDir&gt;.WWW.Browse.History</tt><br>
(and indeed, these are the options as supplied).
</p>

<p>
To have <i>VoyBrowse</i>'s and then <i>ArcWeb</i>'s you could use:<br>
<tt>run Museum:Museum Museum:History -b VoyBrowse &lt;Wimp$ScrapDir&gt;.WWW.VoyBrowse.History -a ArcWebCache:History</tt>
</p>

<br>
<hr>
<br>

<a name="Problems"></a>
<h4>Known Problems</h4>

<ul>
  <li> <b>!Museum must be on a writable medium</b><br>
       This is because (by default) the HTML document is created inside
       !Museum.  To alter this, you need to edit first argument passed
       to museum in the !Run file.  Hopefully it's obvious how.
  <li> <b>local:// file:/ and file:// transports</b><br>
       Just to be really annoying, the three types of browser supported all
       use slightly different methods of specifying local files (i.e. ones
       on your discs that they can load directly rather than having to
       'fetch')<br>
       <i>ArcWeb</i> uses <tt>local://</tt>, <i>Fresco</i> uses <tt>file:/</tt>
       and <i>Browse</i> uses <tt>file://</tt> at the start of such URLs.<br>
       There's not much Museum can do about this; if it is a problem for you
       then <a href="mailto:musus@argonet.co.uk?subject=Museum">drop me an
       email</a> and I'll see about changing things.<br>
       It's not too hard to deal with, but it requires a significant change
       to Museum so I'm not going to do it unless someone asks for it.
  <li> <b>Corrupt <i>Fresco</i> history lists</b>
       This is almost certainly <i>Fresco</i>'s fault, I'm afraid.  It tends
       to show up as a strange description in the generated HTML after which
       URLs are given as descriptions, and vice versa.<br>
       In that it shouldn't happen and isn't that common, I have no plans to
       try to make Museum smart enough to cope with it.
</ul>

<br>
<hr>
<br>

<a name="Licence"></a>
<h4>Licence and Disclaimer</h4>
<font size="2">
This software is the property of Musus Umbra.<br>
Permission is granted for unlimited personal use & modification.<br>
Permission is granted for redistribution (by any method) provided that:
<ul>
<li> No charge is made for this software.  A reasonable charge may be made for media / handling / etc. This software is <b>free</b>.
<li> Any distributed copy of this software must be unaltered and entire.<br>
You may not distribute modified / incomplete copies of this software.  If you fix a bug / add a feature, let me know so that I can update the master copy.
</ul>
<br>
As usual with freeware, there is no warranty of any kind.  The author cannot
be held responsible for any loss/damage arising from the use/inability to
use this software.  It is the user's responsibility to determine the fitness
of this software for any purpose they put it to.
<br>
(But if it doesn't work, I will try to help :-)
</font>

<br>
<hr>
<br>

<a name="Contact"></a>
<h4>Contacting the Author</h4>

<p>
I can most easily be contacted by email as <a href="mailto:musus@argonet.co.uk">musus@argonet.co.uk</a><br>and have a website at <a href="http://www.argonet.co.uk/users/musus/">http://www.argonet.co.uk/users/musus/</a>
</p>

</BODY></HTML>