commit | f2d211526159553af99e427dd07c5f26e9caef57 | [log] [tgz] |
---|---|---|
author | edendramis <evangeliad@gmail.com> | Sun Apr 26 00:00:16 2015 -0700 |
committer | edendramis <evangeliad@gmail.com> | Sun Apr 26 00:00:16 2015 -0700 |
tree | 9882447f23a536ba8b3cfff1827a50d0dfaafbb1 | |
parent | a5e73b3f8f9bd64e7d003239e5680707e2b24793 [diff] |
cleaning up offline mode
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.
Issue:
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.