/trunk/README (rHEAD)

 $Id: README 1683 2005-12-21 00:59:00Z brucerob $
 
  Heml is a suite of xml-related tools which explore the presentation
  and encoding of historical events. It uses the Cocoon2 web publication
  engine.  The current version of Heml is 0.7.1; it is built upon the
  2.1.8 version of Cocoon and the 2003-09-17 Heml XML Schema, and very
  experimental right now.
 
 
  This repository comprises the Heml java code, xslt stylesheets
  and related materials as well as sample documents. It is designed
  specifically to be built as a block within the Cocoon framework. It
  requires:
 
  2. Cocoon build environment 2.1.7
 
  3. An eXist build environment, provided as a block. Get the latest from
     http://heml.mta.ca/releases/exist_as_block
 
  The code and build environment are tested on Linux and Windows 2000.
 
  Once you have unpacked Cocoon and, if desired, Exist as a block, set the
  environment variables $COCOON_HOME to your cocoon directory, $EXIST_HOME
  to your exist_as_block and $HEML_HOME to the directory in which the Heml
  code appears.
 
  From within the Heml directory, run 'build.sh'. It will first modify
  your cocoon directory to include a 'block' for heml (as well as the
  libraries it requires) then build cocoon.
 
  Cocoon 2.1.x has a stripped-down servlet engine built in, so at
  this point all you need do is run './cocoon.sh servlet' from within the
  now-compiled cocoon directory, and cocoon
  will appear at http://localhost:8888. You can either follow the
  samples/blocks/heml links or go directly
  to http://localhost:8888/samples/blocks/heml/
  (omitting the final slash will cause an error to be declared).
 
  Heml will list 'Local Documents' on the sidebar. Samples are given;
  you may add to these.
 
  To fill the XML database, go to 'Add Files to XML Database' and click
  on 'Load Local Files Into XML Database'. It will complain that
  'O events were added' but in fact they're there. You may also add files
  using the 'Add File to Heml XML Database' field on the same page.
 
 
  Enjoy,
 
  Bruce Robertson Dept. of Classics, Mount Allison University, NB,
  Canada brobertson@mta.ca 2005/12/20