==========
March 8, 2000
Lee Daniel Crocker <lee@piclab.com>

I have put the Freenet FAQ and the Protocol Specification in XML
format using tags from the DocBook DTD (http://www.docbook.org)
for maximum flexibility and maintainability.  It should be simple
for anyone to make changes--just use the existing document as an
example of how to use the tags.

The source documents are:
  faq.xml               FAQ
  protocol.xml          Protocol Specification
These are the ones you should edit.

To produce the output format of these documents requires using an
XSLT stylesheet and transform tool such as Apache's Xalan.  If you
are not an XML-head you can just make changes to the source document
and email me to do the transform.  If you want to try your hand at
doing it yourself, you can copy the tools I used from the "tools"
directory at freenet.sourceforge.net.  You'll need to unpack and
build "tidy" for your machine, but xalan.jar and xerces.jar are
ready as is.   Look at the Makefile here for usage.

Each output format (HTML, plain text, etc.) should have its own
stylesheet; web.xml is complete and usable for most uses, so you'll
probably want to import it into the document-specific one.  I am
using small subset of the full DocBook tags; if you want to use any
tags I have not already used, be sure to update the stylesheets as
well.  The web.xsl stylesheet produces a full standalone HTML page.
If you want to make that a PHP .inc file you'll have to edit that
to remove lines at the top and bottom of the file to leave only the
contents of the <body> tag (remove the <body> tags themselves too).
The strip.awk program does this, but it assumes that the <body> and
</body> tags are on a line by themselves (as they will be after
using Xalan and Tidy as shown).

Be particularly cautious about adding new tags to the FAQ: we want
that to be easy for others to add to.
