XML PRM Tools, release 10
=========================

Introduction
------------

This directory contains the tools necessary to build the RISC OS PRM
documentation using the XML documentation format. The XML documentation
format allows a structured means of documenting RISC OS APIs in a manner
consistent with the PRMs. The intention is that this can be expanded
to produce other output formats. At present, however, the only complete
output format is that of HTML. HTML and Impression format output are
being worked on but will take time.


Caveat
------
The XML tools must be installed to a disc which supports long filenames.
Attempting to install the tools on discs which do not support long filenames
will result in a corrupt installation.


Installation
------------
1. Use the Boot Install configuration tool to install the supplied !Boot
   directory. This will merge the Catalogs and Library with your boot
   sequence.
2. Place !PRMinXML in a directory where you can access it easily.
3. Reboot to ensure that !Catalogs and the Library directory are added
   correctly.


Contents
--------
!Catalogs -    This resource contains the XML and SGML catalogs for use
               by the XML tools. Catalogs from other resources can be
               installed here if necessary. This should be done manually
               as yet.

!PRMinXML -    This is the tool you can use to generate output files from
               the source XML. Whilst the output can be automated using
               the command line tools, during development it may be simpler
               to use this application.

Library -      XML tools for processing XSLT and XML files :
                 xmlCatalog 1.17 (based on libxml2 2.4.20)
                 xmlLint    1.20 (based on libxml2 2.4.20)
                 xsltproc   1.25 (based on libxml2 2.4.20/libxslt 1.0.16)

Docs -         Documentation for the components :
                 xmltools/html - Documentation for xmlCatalog and xmlLint.
                 xmltools/xml  - XML source for the above document.
                 xsltproc/html - Documentation for xsltproc.

Licences -     Licences for the components of this release.

Structure -    Text file documenting the format of the XML files for
               documenting the PRM-style files.

Examples -     Examples of XML files using the PRM documentation format.
               These have been selected nearly at random but should provide
               a good indication of the use of the documentation.


Sources
-------
Sources for, and the latest release of, the XML tools used in this release
can be found at http://homepage.ntlworld.com/justin.fletcher/XML/ for the
foreseeable future.


Contact
-------
Justin Fletcher <justin.fletcher@ntlworld.com>
