summaryrefslogtreecommitdiffstats
path: root/doc/keys.README
diff options
context:
space:
mode:
Diffstat (limited to 'doc/keys.README')
-rw-r--r--doc/keys.README26
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/keys.README b/doc/keys.README
new file mode 100644
index 000000000..7a71c758a
--- /dev/null
+++ b/doc/keys.README
@@ -0,0 +1,26 @@
+To generate HTML and SVG files from keys.xml, you'll need an XSLT
+processor. Any decent XSLT 1.0 or XSLT 2.0 processor should work. For example:
+
+I. Using xsltproc (available on most Linux systems):
+
+xsltproc keys-html.xsl keys.xml > keys.html
+xsltproc keys-svg.xsl keys.xml > keys.svg
+
+II. Using Saxon (a Java processor that works on any Java-supporting platform):
+
+1. Install Java
+
+2. Install Saxon (http://saxon.sf.net) so that saxon.jar is in your Java classpath
+
+3. Run:
+
+java net.sf.saxon.Transform doc/keys.xml doc/keys-svg.xsl > icons/keys.svg
+java net.sf.saxon.Transform doc/keys.xml doc/keys-html.xsl > doc/keys.html
+
+(for Saxon 7.*) or
+
+java com.icl.saxon.StyleSheet doc/keys.xml doc/keys-svg.xsl > icons/keys.svg
+java com.icl.saxon.StyleSheet doc/keys.xml doc/keys-html.xsl > doc/keys.html
+
+(for Saxon 6.*)
+