|author||ddekany <firstname.lastname@example.org>||Wed Sep 02 02:30:42 2015 +0200|
|committer||ddekany <email@example.com>||Wed Sep 02 02:30:42 2015 +0200|
Updated for 2.3.24-pre01
Docgen was originally written to generate HTML pages from the DocBook 5 XML that the FreeMarker Manual is written in. As such, it‘s not a general purpose DocBook 5 to HTML converter, however, we use it for other projects as well, so it’s not entirely specialized either.
You must have the following libraries installed to build this project:
Before building for the first time:
build.propertiesfile based on
npm installfrom the project directory to install Node.js dependencies. This need to be repeated if you add new dependencies to
To build Docgen:
This will create
For documentation see
build/api/index.html. Especially, read the documentation of the
Transform class there.
For some examples see
test.xml, and of course,
src/manual in the
For editing DocBook, we are using XXE with the
If you run into dependency errors, you may need to issue:
If you have modified
docgen, and want to try the new version in the
freemarker project, you will have to issue:
This will shadow the
docgen artifact that comes from the Ivy repo on freemarker.org. Then, in the
freemarker project you have to issue
ant update-deps so that it picks up your version.
To compile LESS and JS separately from the regular ant build, run:
You need to run this:
This will create an
ide-dependencies library that contains all the jars that you have to add to the classpath in the IDE. Note that here we assume that you have run the build or at least
ant update-deps earlier.
You could also use IvyDE instead, with configuration “IDE”, but as the dependencies hardly ever change, it's unnecessary.
The icon font in this project was built using IcoMoon and contains selected icons from: