Diff for /bookie/www/setup.html between versions 1.1 and 1.8

version 1.1, 2001/01/20 23:33:37 version 1.8, 2001/03/26 08:02:09
Line 1 Line 1
   Setup instructions for Bookie:
   
Setup instructions for Bookie.<p>
 
 If you're just browsing or don't need to edit files directly, you can look  If you're just browsing or don't need to edit files directly, you can look
 at Bookie through the <a  at Bookie through the <a
 href="http://www.mozdev.org/source/browse/bookie/">web interface</a>.  href="http://www.mozdev.org/source/browse/bookie/">web interface</a>.
   
If you want to contribute to Bookie or compile it, then you should grab a<p>If you want to contribute to Bookie or compile it, then you should grab a
CVS <a href="www.cvshome.com">client</a> and set up a workspace for bookie.CVS <a href="http://www.cvshome.com">client</a> and set up a workspace for bookie.
 
 <p>You download bookie by doing this (you only need to login once, the password
 is guest).
   
   <pre>
  cvs -d :pserver:guest@mozdev.org:/cvs login   cvs -d :pserver:guest@mozdev.org:/cvs login
  cvs -d :pserver:guest@mozdev.org:/cvs co bookie   cvs -d :pserver:guest@mozdev.org:/cvs co bookie
   </pre>
   
   <p>You need to have a database set up with a database schema.  Look in
   ./sql/solid for an example schema.  
   
   <p>The database needs data in order to work.  I wrote /scripts/import.pl
   which takes in my bookmarks.html file from Netscape and pumps it into the
   database.  The script relies on <code>HTML::Filter</code> and
   <code>HTML::TokeParser</code>, which you may need to download from
   ActivePerl or CPAN.
   
   <p> You can start the server from the root directory with: 
   
   <blockquote>
   <code>java bookie.xmlrpc.BookieServer -Dbookie.logging=./scripts/logging.properties
   -Dbookie.database=./scripts/database.properties</code><br>
   </blockquote>
   
   <p>There's an Ant script in ./scripts/ which handles compilation and testing.
   
After doing this, you'll see files in the workspace.  The Java server will<p>Right now, the only way you get useful data is with the test class
compile, but I use a custom made tool which pretty much no-one else uses, so<code>ClientTest</code>, which reads in the RDF to a memory model and writes
you may want to try putting it together with ANT.out the answer to some queries (like 'what children does the root node
have?').  More is on the way.
The Java server talks to a database on the backend.  I use <a 
href="http://www.solidtech.com">Solid</a>, but any JDBC compliant driver 
should work (I don't use any complicated SQL).  You can edit the JDBC 
driver: it's defined in bookie.properties in the scripts directory. 
 
The database DDL scripts are in the /sql/solid directory.  They work fine 
for me... again, if you're using another database, you probably want to 
tweak these.  Any additions are welcomed. 
 
The database needs data in order to work.  I wrote /scripts/import.pl which 
takes in my bookmarks.html file from Netscape and pumps it into the 
database.  It actually relies on a couple of none standard modules which you 
may need to download from ActivePerl or CPAN. 
 
After you've started the database, and compiled the Java, you probably want 
to add a couple of things to your classpath.  In the /lib directory, I've 
added some JAR files which are needed by Bookie to work.  After adding those 
files (and the JDBC driver, if it's not already included), you can start the 
server by using /scripts/server.bat. 
 
There is a very simple client available which I have been using for 
debugging.  You can run the client by using /scripts/client.bat.  It's good 
enough to send text to the server and get a response back, which is all I 
really need from it.  I'm divided as to how much time I should spend on, 
since working on the client would take time away from working on the Mozilla 
integration. 
 
The mozilla integration is in a sorry state.  The basic problem is that I 
don't understand Javascript, and I only have a hazy idea of the way that 
Mozilla organizes their network code.  As a result, I've spent much time 
flailing around trying to get some very simple things trying to work. 
Again, any assistance is appreciated. 
   
 If these directions are unclear or confusing, please e-mail me at <a href="mailto:will_sargent@yahoo.com">will_sargent@yahoo.com</a>  
   
   <p>
   Will.

Removed from v.1.1  
changed lines
  Added in v.1.8


FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>