| commit | 84fd38892c26db9c160c286b91914fef4c6ac324 | [log] [tgz] |
|---|---|---|
| author | ddekany <ddekany@freemail.hu> | Wed Sep 02 02:30:42 2015 +0200 |
| committer | ddekany <ddekany@freemail.hu> | Wed Sep 02 02:30:42 2015 +0200 |
| tree | 4c03facf29000e238d7ebd53a99f120a85bf79c0 | |
| parent | 5c6bb80a8398c376e017244f522a553cfe3f501e [diff] |
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.properties file based on build.properties.samplenpm install from the project directory to install Node.js dependencies. This need to be repeated if you add new dependencies to gulpfile.js.To build Docgen:
ant all
This will create lib/docgen.jar and build/api.
For documentation see build/api/index.html. Especially, read the documentation of the Transform class there.
For some examples see src/test and test.xml, and of course, src/manual in the freemarker project.
For editing DocBook, we are using XXE with the src/xxe-addon installed.
If you run into dependency errors, you may need to issue:
ant update-deps
If you have modified docgen, and want to try the new version in the freemarker project, you will have to issue:
ant publish-override
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:
ant gulp
You need to run this:
ant ide-dependencies
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: