From 13d47319c2e234a28beb8f35158123dfe56b7e74 Mon Sep 17 00:00:00 2001
From: Chris Dolan <chris@iSlug>
Date: Wed, 18 Oct 2006 21:04:23 -0500
Subject: [PATCH] Work on docs:  - Add explicit index.html for file:// browsing
  - Add MacOSX+Fink instructions  - More Planet migration details  - Clean up
 docs header a little

---
 docs/docs.css          |  4 ++++
 docs/docs.js           |  9 ++++-----
 docs/installation.html | 42 ++++++++++++++++++++++++++++++++++++++++--
 docs/migration.html    | 18 ++++++++++++++++++
 4 files changed, 66 insertions(+), 7 deletions(-)

diff --git a/docs/docs.css b/docs/docs.css
index 5049baa..916db69 100644
--- a/docs/docs.css
+++ b/docs/docs.css
@@ -49,6 +49,10 @@ ul, ul.outer > li {
   margin: -15px 0 20px -15px !important;
 }
 
+.z .logo {
+ color: magenta;
+}
+
 .z p {
   margin: 14px 0 10px 15px !important;
 }
diff --git a/docs/docs.js b/docs/docs.js
index 229b13c..001f7c8 100644
--- a/docs/docs.js
+++ b/docs/docs.js
@@ -2,7 +2,6 @@ window.onload=function() {
   var vindex = document.URL.lastIndexOf('venus/');
   if (vindex<0) vindex = document.URL.lastIndexOf('planet/');
   var base = document.URL.substring(0,vindex+6);
-  if (vindex<0) vindex = '..';
 
   var body = document.getElementsByTagName('body')[0];
   var div = document.createElement('div');
@@ -10,7 +9,7 @@ window.onload=function() {
   var h1 = document.createElement('h1');
   var span = document.createElement('span');
   span.appendChild(document.createTextNode('\u2640'));
-  span.setAttribute('style','color: magenta');
+  span.setAttribute('class','logo');
   h1.appendChild(span);
   h1.appendChild(document.createTextNode(' Planet Venus'));
 
@@ -24,17 +23,17 @@ window.onload=function() {
 
   p = document.createElement('p');
   var a = document.createElement('a');
-  a.setAttribute('href',base);
+  a.setAttribute('href',base+'index.html');
   a.appendChild(document.createTextNode('Download'));
   p.appendChild(a);
   p.appendChild(document.createTextNode(" \u00b7 "));
   a = document.createElement('a');
-  a.setAttribute('href',base+'docs/');
+  a.setAttribute('href',base+'docs/index.html');
   a.appendChild(document.createTextNode('Documentation'));
   p.appendChild(a);
   p.appendChild(document.createTextNode(" \u00b7 "));
   a = document.createElement('a');
-  a.setAttribute('href',base+'tests/');
+  a.setAttribute('href',base+'tests/index.html');
   a.appendChild(document.createTextNode('Unit tests'));
   p.appendChild(a);
   p.appendChild(document.createTextNode(" \u00b7 "));
diff --git a/docs/installation.html b/docs/installation.html
index 8d62ad7..233087b 100644
--- a/docs/installation.html
+++ b/docs/installation.html
@@ -29,11 +29,16 @@ module which was introduced in Python 2.4.</li>
 <a href="http://librdf.org/">librdf</a>.</li>
 </ul>
 
-<h3>Instructions</h3>
+<h3>General Instructions</h3>
+
+<p>
+These instructions apply to any platform.  Check the instructions
+below for more specific instructions for your platform.
+</p>
 
 <ol>
 <li><p>If you are reading this online, you will need to
-<a href="..">download</a> and extract the files into a folder somewhere.
+<a href="../index.html">download</a> and extract the files into a folder somewhere.
 You can place this wherever you like, <code>~/planet</code>
 and <code>~/venus</code> are good
 choices, but so's anywhere else you prefer.</p></li>
@@ -63,5 +68,38 @@ right directory.</p></li>
 <li><p>(Optional)</p>
 <p>Build your own themes, templates, or filters!  And share!</p></li>
 </ol>
+
+<h3>Mac OS X and Fink Instructions</h3>
+
+<p>
+The <a href="http://fink.sourceforge.net/">Fink Project</a> packages
+various open source software for MacOS.  This makes it a little easier
+to get started with projects like Planet Venus.
+</p>
+
+<p>
+Note: in the following, we recommend explicitly
+using <code>python2.4</code>.  As of this writing, Fink is starting to
+support <code>python2.5</code> but the XML libraries, for example, are
+not yet ported to the newer python so Venus will be less featureful.
+</p>
+
+<ol>
+ <li><p>Install the XCode development tools from your Mac OS X install
+        disks</p></li>
+ <li><p><a href="http://fink.sourceforge.net/download/">Download</a>
+        and install Fink</p></li>
+ <li><p>Tell fink to install the Planet Venus prerequisites:<br />
+        <code>fink install python24 celementtree-py24 bzr-py24 libxslt-py24
+        libxml2-py24</code></p></li>
+ <li><p><a href="../index.html">Download</a> and extract the Venus files into a
+        folder somewhere</p></li>
+ <li><p>Run the tests: <code>python2.4 runtests.py</code><br /> This
+        will warn you that the RDF library is missing, but that's
+        OK.</p></li>
+ <li><p>Continue with the general steps above, starting with Step 3.  You
+        may want to explicitly specify <code>python2.4</code>.</p></li>
+</ol>
+
 </body>
 </html>
diff --git a/docs/migration.html b/docs/migration.html
index 36072f6..d97ce6e 100644
--- a/docs/migration.html
+++ b/docs/migration.html
@@ -19,6 +19,24 @@ of the cache has changed dramatically.</li>
 though some <a href="config.html">configuration</a> options (e.g.,
 <code>days_per_page</code>) have not yet been implemented</li>
 <li>No testing has been done on Python 2.1, and it is presumed not to work.</li>
+<li>To take advantage of all features, you should install the optional
+XML and RDF libraries described on
+the <a href="installation.html">Installation</a> page.</li>
+</ul>
+
+<p>
+Common changes to config.ini include:
+</p>
+<ul>
+ <li><p>Filename changes:<br />
+<pre>
+examples/fancy/index.html.tmpl => themes/classic_fancy/index.html.tmpl
+examples/atom.xml.tmpl         => themes/common/atom.xml.xslt
+examples/rss20.xml.tmpl        => themes/common/rss20.xml.tmpl
+examples/rss10.xml.tmpl        => themes/common/rss10.xml.tmpl
+examples/opml.xml.tmpl         => themes/common/opml.xml.xslt
+examples/foafroll.xml.tmpl     => themes/common/foafroll.xml.xslt
+</pre></p></li>
 </ul>
 </body>
 </html>