Our documentation relies on XSLT and XSL-FO with DocBook-based XML source files to generate the PDF, HTML, and HTML Help release files. We use NAnt for executing a build process that takes the XML source files and tranforms them into the various outputs.
NOTE: These are installation instructions for the Windows platform.
TIP: See [How do I get read-only access to the source control repository?] to obtain the latest documentation source files.
To build the iBATIS.NET documentation from the latest SVN XML source files, you will first need to download DocBook-XSL, Apache FOP, xsltproc, and NAnt. Additionally, make sure that the Microsoft HTML Help compiler (
DocBook-XSL can be downloaded from http://sourceforge.net/projects/docbook/ . Currently, we are using version 1.65.1 to build our documentation. Extract the files to the
\docs \docbook \common \fo \html \htmlhelp \images \lib
More information on DocBook and XSLT can be found at http://www.docbook.org/ and http://www.w3.org/TR/xslt .
To use Apache FOP, you must have Java installed and on your path. Download the binary distribution of Apache FOP from http://xml.apache.org/fop/ . At this time, we are using version 0.20.5 to build our documentation. Extract the files to the
\docs \fop \build \conf \docs \examples \lib
You should find an
More information on XSL-FO can be found at http://www.w3.org/TR/xsl/slice6.html#fo-section .
There are a number of xsltproc-related files to download. Go to http://www.zlatkovic.com/pub/libxml/ or to ftp://xmlsoft.org/win32/ to download the following:
You will need to extract certain files from those downloaded archive files so that you end up with an xsltproc directory file structure that looks like the following:
\docs \xsltproc iconv.dll libexslt.dll libxml2.dll libxslt.dll xsltproc.exe zlib1.dll
More information on xsltproc can be found at http://xmlsoft.org/XSLT/xsltproc2.html or http://www.zlatkovic.com/libxml.en.html .
Download and install the latest version of NAnt from http://nant.sourceforge.net/ . Make sure that the Nant executable (nant.bat) can be found on your path (try
If you are using Visual Studio.NET, you may already have the HTML Help Workshop installed. A typical installation would place it in the
C:\Program Files\HTML Help Workshop
If you do not have the HTML Help Workshop installed, you can install it from your Visual Studio.NET CDs or see http://msdn.microsoft.com/library/en-us/htmlhelp/html/hworiHTMLHelpStartPage.asp for more information on downloading the HTML Help SDK.
Make sure that the HTML Help compiler (hhc.exe) can be found on your path (try
If everything is in place, you will be able to start the NAnt build process through the command line by simply navigating to the
Since NAnt build files provide for various build targets, you can view these targets using
- To generate all documentation, just enter
- To generate all DataMapper-specific documentation, enter
- To generate all DataAccess-specific documentation, enter