(C) Copyright IBM Corporation 2001, 2002, 2003. All Rights Reserved.
 This file is part of the DITA package on IBM's developerWorks site.
 See license.txt for disclaimers.

README FOR XSLT SCRIPTS

The XSLT scripts are modularized for reuse of functionality.  For
processing using the core information types, you only need a few
scripts:

dita2html_shell.xsl
    - Converts a DITA XML topic to an HTML page.

ditaview_shell.xsl
    - Converts a DITA XML topic to HTML but generates links as
      references to the DITA XML source files.  If you add an XSLT
      processing instruction to the top of each DITA source file, you
	  can navigate source files in an XSLT-capable browser such as
      Internet Explorer 6 so you can view the HTML rendering without
      having to generate output files.  For examples of the XSLT
      processing instruction, see /doc/*.xml

dita2fo_shell.xsl
    - Converts a DITA XML topic to an XSL-FO file.  You can then
      process the XSL-FO file with an FO processor such as Apache FOP
      to produce a PDF.

map2html.xsl
    - Converts a DITA map and all topices referenced by the map to
      HTML pages.  You can also generate an Eclipse Help
      table-of-contents file.  See /samples/MAP-README.txt for the
      details. 

topicmerge.xsl
    - Merges a DITA map and all topices referenced by the map to
      create a single DITA XML file.  The XML file can then be
	  processed with dita2fo_shell.xsl and an XSL-FO processor to
	  generate the map as a rough PDF book.

If you look at the *_shell.xsl files, you will see that the shell XSLT
scripts import the modules that provide the real processing.  If you
create new information types, you can reuse the same modules in your
own shell XSLT scripts.  For examples of this approach, look at the
/demo/*/*_shell.xsl files.

Two shell files in this directory relate to demonstrated function in
the source file, doc/DITA-tweaks.xml: myoverrides.xsl (a demonstration
of some of the processing tweaks mentioned in that topic) and 
IBMoverrides.xsl, a demonstration of using tweaks to create output
that is customized to a specific company or brand.


RUNNING XSLT SCRIPTS

To run these XSLT scripts, you need to install an XSLT processor.

There are many options for XSLT processor.  For one example, you can
install a Java  runtime (JRE) and an XSLT processor such as Saxon.

JRE
    - Get a JRE (or a JDK bundling a JRE) such as the Sun J2SE plaform:

          http://java.sun.com/j2se/downloads.html

      Java  comes with an install program.

Saxon
    - http://saxon.sourceforge.net/

      To install Saxon, you unzip the package and add the saxon.jar 
      file to the CLASSPATH environment variable.

Using Saxon, you could run dita2html_shell.xsl with commands similar to

    cd doc
    java com.icl.saxon.StyleSheet -o DITA-readme.html DITA-readme.xml dita2html_shell.xsl


Java is a registered trademark of Sun Microsystems, Inc..
