1 files changed, 56 insertions, 0 deletions
diff --git a/wiki-to-help/README b/wiki-to-help/README
new file mode 100644
index 0000000000..2f254ac0a1
--- /dev/null
+++ b/wiki-to-help/README
@@ -0,0 +1,56 @@
+
+Conversion of an XML-Dump to platformspecific help files
+--------------------------------------------------------
+
+1 INSTALLATION
+
+The following programs are required:
+ - mwlib
+ - python
+ - python-lxml
+ - xsltproc
+ - unzip
+ - docbook-xsl-stylesheets
+
+HHC-Installer depends on:
+ - wine
+ - cabextract
+ - wget
+
+1.1 On GNU and UNIX
+
+ - Install wine
+ - Execute HHC/install_hhc.sh
+
+1.2 On Windows
+
+ - Install HHC from http://go.microsoft.com/fwlink/?LinkId=14188
+
+2 USAGE
+
+See ./convert.py -h
+
+For the correct operation, you need to modify htmlhelp.xsl to point to your
+docbook-xsl-stylesheets installation, like:
+
+--- a/helpcontent2/wiki-to-help/htmlhelp.xsl
++++ b/helpcontent2/wiki-to-help/htmlhelp.xsl
+@@ -16,8 +16,8 @@
+ 
+      ******************************************************************** -->
+ 
+-<xsl:import href="xsl/html/chunk.xsl"/>
++<xsl:import href="/usr/share/xml/docbook/stylesheet/nwalsh/1.76.1/html/chunk.xsl"/>
+ <xsl:param name="htmlhelp.use.hhk" select="1"></xsl:param>
+-<xsl:include href="xsl/htmlhelp/htmlhelp-common.xsl"/>
++<xsl:include href="/usr/share/xml/docbook/stylesheet/nwalsh/1.76.1/htmlhelp/htmlhelp-common.xsl"/>
+ 
+ </xsl:stylesheet>
+
+
+3 LICENSE
+
+The following applies to all files if not stated differently
+
+ - Licensed under GNU LGPLv3 or later / MPL
+ - Copyright 2011 Timo Richter