You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@etch.apache.org by fi...@apache.org on 2011/07/07 13:06:29 UTC
svn commit: r1143759 - in /incubator/etch/trunk/doc: Makefile README.txt
docs/C/main.xml libs/etch-pdf.xsl
Author: fitzner
Date: Thu Jul 7 11:06:28 2011
New Revision: 1143759
URL: http://svn.apache.org/viewvc?rev=1143759&view=rev
Log:
[ETCH-115]
Add support for windows docbook build
Modified:
incubator/etch/trunk/doc/Makefile
incubator/etch/trunk/doc/README.txt
incubator/etch/trunk/doc/docs/C/main.xml
incubator/etch/trunk/doc/libs/etch-pdf.xsl
Modified: incubator/etch/trunk/doc/Makefile
URL: http://svn.apache.org/viewvc/incubator/etch/trunk/doc/Makefile?rev=1143759&r1=1143758&r2=1143759&view=diff
==============================================================================
--- incubator/etch/trunk/doc/Makefile (original)
+++ incubator/etch/trunk/doc/Makefile Thu Jul 7 11:06:28 2011
@@ -32,6 +32,10 @@ CP=cp
# XSL Processors
XSLTPROC=/usr/bin/xsltproc
+# Apache FOP
+# Windows
+#FOP=C:/etch/external/fop/1.0/fop.bat
+# Linux
FOP=/usr/bin/fop
# IETF language tags
@@ -54,9 +58,7 @@ all: html pdf
clean:
$(RM) -rf $(BASE)
-
html: html-style
-
if [ $(LANG) != "C" ]; then \
@echo "documents have to translated"; \
fi
@@ -71,7 +73,6 @@ html-style:
pdf:
-
if [ $(LANG) != "C" ]; then \
@echo "documents have to translated"; \
fi
Modified: incubator/etch/trunk/doc/README.txt
URL: http://svn.apache.org/viewvc/incubator/etch/trunk/doc/README.txt?rev=1143759&r1=1143758&r2=1143759&view=diff
==============================================================================
--- incubator/etch/trunk/doc/README.txt (original)
+++ incubator/etch/trunk/doc/README.txt Thu Jul 7 11:06:28 2011
@@ -17,12 +17,19 @@
# under the License.
#
-Currently only Linux is supported to generate the documentation
-based on docbook. For doing it with windows the Makefile has to
-be adjusted.
+# General
+
+Etch documentation is based on docbook 4.5. If you would
+like to generate the documentation, Linux is the preferred
+way how to do it at the moment. The Windows documentation
+process is currently under development and will be available
+in the near future.
+
+# Linux setup
If you would like to generate the documentation, you need the
following components.
+
- sudo apt-get install docbook
- sudo apt-get install docbook-xsl
- sudo apt-get install docbook-xsl-doc-pdf
@@ -39,7 +46,24 @@ information.
- http://offo.sourceforge.net/hyphenation/fop-stable/installation.html
- http://xmlgraphics.apache.org/fop/1.0/hyphenation.html
-Getting further information, see here
+# Windows setup
+
+If you would like to generate the documentation, you need the
+following components.
+
+- cygwin installation and the following packages
+-- xslt parser
+-- docbook for version 4.5
+- Apache FOP http://xmlgraphics.apache.org/fop/download.html#binary
+
+- Change still the following files:
+-- Makefile; set the FOP variable to the fop binary etc. FOP=C:/etch/external/fop/1.0/fop.bat
+-- Set the correct docbook import file etc
+ <xsl:import href="/usr/share/sgml/docbook/xsl-ns-stylesheets/fo/docbook.xsl"/>
+
+# Links
+
+Getting further information about docbook, see here
- http://docbook.org/tdg/en/html/docbook.html
- http://www.sagehill.net/docbookxsl/preface.html#WhatIsDocbook
- http://docbook.sourceforge.net/release/xsl/current/doc/html/
Modified: incubator/etch/trunk/doc/docs/C/main.xml
URL: http://svn.apache.org/viewvc/incubator/etch/trunk/doc/docs/C/main.xml?rev=1143759&r1=1143758&r2=1143759&view=diff
==============================================================================
--- incubator/etch/trunk/doc/docs/C/main.xml (original)
+++ incubator/etch/trunk/doc/docs/C/main.xml Thu Jul 7 11:06:28 2011
@@ -12,7 +12,7 @@
<title>Etch Documentation</title>
<abstract>
<para>
- This is the reference documentation for Apache Etch.
+ This is the reference documentation for Apache Etch.
</para>
</abstract>
</bookinfo>
Modified: incubator/etch/trunk/doc/libs/etch-pdf.xsl
URL: http://svn.apache.org/viewvc/incubator/etch/trunk/doc/libs/etch-pdf.xsl?rev=1143759&r1=1143758&r2=1143759&view=diff
==============================================================================
--- incubator/etch/trunk/doc/libs/etch-pdf.xsl (original)
+++ incubator/etch/trunk/doc/libs/etch-pdf.xsl Thu Jul 7 11:06:28 2011
@@ -22,8 +22,10 @@
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:fo="http://www.w3.org/1999/XSL/Format">
-<!-- Import the new xsl -->
+<!-- Linux -->
<xsl:import href="/usr/share/xml/docbook/stylesheet/nwalsh/fo/docbook.xsl"/>
+<!-- Windows -->
+<!-- <xsl:import href="/usr/share/sgml/docbook/xsl-ns-stylesheets/fo/docbook.xsl"/> -->
<!-- *************************************************** -->
<!-- **************** Page Settings ****************** -->