Documentation for GnuCash Accounting Program.
XSLT Other
Latest commit 672dcdf Sep 18, 2016 @jralls jralls Merge branch 'maint'
Failed to load latest commit information.
fonts New fonts for building guide/ja/guide.pdf Jan 14, 2014
guide Merge branch 'maint' Sep 17, 2016
help Merge branch 'maint' for release of 2.6.14. Sep 16, 2016
stylesheet release 1.7.7 Jan 6, 2003
util Modify to work with Ubuntu Aug 29, 2016
xsl Fix commits of SASAKI Suguru patches for epub and mobi generation. Jul 26, 2011
.gitignore Add some extra entries to .gitignore so can use netbeans ide xlm edit… Aug 29, 2016
AUTHORS Remove e-mail from AUTHORS file Oct 8, 2015
COPYING-DOCS Initial import of makefiles, etc Nov 27, 2002
ChangeLog Release 2.6.14 Sep 16, 2016
HACKING Patches should be sent to gnucash-devel iso gnucash-patches Jan 29, 2013 Fix path of freshly added xml files Nov 9, 2014
NEWS Release 2.6.14 Sep 16, 2016
README Fix unclear statement re docbook stylesheets in README. Jun 22, 2016 Make autogen work in non-srcdir builds Feb 24, 2014 Merge branch 'maint' Mar 3, 2016
epub.make Add figures files to e-doc dependencies so that e-docs are rebuilt if… Nov 2, 2015 Apply Kebin HaleBoyes' patch to change Copyright to License in the SPEC. Apr 3, 2007
mobi.make Add figures files to e-doc dependencies so that e-docs are rebuilt if… Nov 2, 2015
omf.make More makefile cleanups: Oct 27, 2012
pdf.make Add figures files to e-doc dependencies so that e-docs are rebuilt if… Nov 2, 2015
xmldocs.make Better style for the *.png dependencies. Dec 20, 2015


              GnuCash Docs README file

This is the docs module for GnuCash. The docs can be accessed
from Yelp (the Gnome help browser) directly without any conversion.
If you wish to obtain a copy of the documentation in another format,
like html, pdf or others, see below under Other Formats.


* libxml2
* libxslt [Debian packed the required xsltproc in a separate package, 
           which depends on libxslt]
* docbook-xsl
* rarian or
  scrollkeeper >=0.3.4 (its ancestor)
* yelp (for viewing)

Additonal Requirements for Generating PDF:

* Apache fop  >= 0.95

For the Japanese PDF, Japanese fonts are included. If you want to use
other Japanese fonts you can use the with-japanese-fonts-dir,
--with-japanese-mincho-ttf, and --with-japanese-gothic-ttf configure
options to select them. fop's TTFReader can't, as of version 1.1
anyway, handle OpenType fonts.

Additional Requirements for Generating Mobipocket:

* Calibre (


The GnuCash docs team is actively seeking contributors. Even if you
only have time for reviewing, editing or translating the existing docs this
can help. PLEASE let us know via the gnucash-devel mailing list what
you can work on or help with.

See also:

This release of the docs module only uses the docbook-xsl stylesheets
to convert the docs to html. There are docbook stylesheets in
gnucash-docs/xsl/1.75.2/epub, ../fo, ../html, ../xhtml, and ../xhtml-1_1.
These docbook stylesheets are used and provided so that installing them
separately isn't necessary. You still need, however, a working docbook-xsl
setup to build and install these docs.

Other Formats

GnuCash-docs is written using docbook-xml. This allows it to be
outputted to alternative formats using external tools.

DocBook comes in two flavours - xml and sgml. GnuCash uses the xml flavour.

The documentation source comes with built-in commands to generate html, pdf
or epub output. For other formats, you will need to use external tools.

Note: if you use external tools to render HTML, remember to bring the images
from figures/ along with the final HTML. The browser will expect to find
the figures/ directory directly beneath the HTML directory:

* html, pdf, epub and mobi

You can generate the documentation in html, pdf, epub and mobi
using the autotools based build system that comes with the sources.

  cd gnucash-docs
  # If you don't need mobi
  # or, if you need mobi
  ./configure --with-mobi

=> This will tell you if you are missing some required tools.

To generate the documentation in html format, run

  make html

To generate the documentation in pdf format, instead run

  make pdf

To generate the documentation in epub format, instead run

  make epub

To generate the documentation in mobi format, instead run

  make mobi
  (Note: mobi is generated from epub, so this generates epub files as well.)

If you only wish to generate a subset of the documentation, you can
go into the directory for that subset and run the above make commands
from there. For example to only generate the English concepts guide:

  cd guide/C
  make html


  cd guide/C
  make pdf


  cd guide/C
  make epub


  cd guide/C
  make mobi

depending on the output format you require.

* XML/XSL-based tools:

If you have xmlto installed, this can be used to convert to other formats
but problems have been experienced with PDF generation. If you output
an XML-FO format using xmlto, you could use FOP to convert to PDF - this
step requires Java. See man xmlto for more information.

Formats available with xmlto include:
dvi  fo  html  htmlhelp  html-nochunks  javahelp  man  
pdf  ps  txt   xhtml     xhtml-nochunks

The problems with pdf apply equally to dvi AND ps output. Each gives a
long error output ending with: ! Emergency stop.

manpage output only works if manpages are outlined in the XML. 
There are no manpages in gnucash-docs.

xmlto uses xsltproc - the same tool and the same stylesheets as the main
make and install.


To convert the GnuCash Tutorial and Concepts Guide DocBook XML document 
to HTML and store the resulting HTML files in a separate directory use:

cd guide/C/
xmlto -o html-dir html gnucash-guide.xml

(html-dir/ will be created if it does not already exist.)

To convert the GnuCash Help Manual DocBook XML document to a single 
HTML file in the current directory use:
cd help/C/
xmlto html-nochunks gnucash-help.xml

Known Problems

Please send feedback to for any difficulties, 
hints or suggestions with the docs. There are a few known problems.

- Help documentation missing documentation for multi-currency support,
  Business module and OFX import. Menu description incomplete.

- Guide needs some updates still.

That's it for now! Please report any problems to the Gnome bugzilla at Then choose the 
component Documentation.

Feel free to append your updates also there.

With any problems you have, you can contact us in the following ways:
* quick questions via IRC
** en: irc:// 
: see

* translation related questions preferable via the local mailing lists
** de:
** es:
** fr:
** it:
** pt:
: or your recent translator

* other user questions should go to
** en:

* finally contributor questions via
** en:

your GnuCash Documentation Team

Original Author: 
Chris Lyttle