o(rg).e(clipse).j(ubula).documentation.*
and o.e.j.client.ua.*
xsltproc
and xmllint
- known limitations building the documentationo.e.j.documentation/howTo/howTo.tracwiki
contains a howTo describing the general structure and way to write documentation via docbook for Jubula.
If you're using special characters within the documentation source make sure to use the correct XML / DocBook entity.
Due to external library dependencies (RelaxNG Schema + JING) the validation is currently a manual step to invoke before committing new content. Additional information for validation options can be discussed here.
To validate all documents invoke o.e.j.documentation> ant -f buildScript.xml validateDocumentation
. The output is placed to o.e.j.documentation/<manualType>/en/validate
.
As the documentation document structure makes use of XInclude the validation is happening on the completely inlined (via xmllint
) document <manualType>/en/validate/resolved.xml
keep in mind that the line number won't match the src-lines
To build all documents invoke o.e.j.documentation> ant -f buildScript.xml buildDocumentation
. The output is placed to o.e.j.documentation/<manualType>/en/build
. The documentation won't necessarily fail if there are validation problems so make sure to validate beforehand.