commit | f135eea76b805463e3f0d978f1bb094ac421ed96 | [log] [tgz] |
---|---|---|
author | edendramis <evangeliad@gmail.com> | Sun May 03 00:13:56 2015 -0700 |
committer | edendramis <evangeliad@gmail.com> | Sun May 03 00:13:56 2015 -0700 |
tree | cddfd6d565de7fc40f9882d00d6b2eb87cd0c169 | |
parent | 9e022ce3f3a6bb92152a827b299d787aff8305e9 [diff] |
removing site name from og:title
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.
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.
ant gulp
Notes:
build.properties
file and set nodeJsCommand
. (See build.properties.sample
.)npm install
to install dependencies, then ant gulp
to compile dependencies.The icon font in this project was built using IcoMoon and contains selected icons from: