DTDDoc - DTD Documentation Tool
This little tool is here to help you to document your DTD's efficiently. It
is a straightforward extension of the javadoc concept and a not so
straightforward implementation of some of the concepts solidified by
Advantages of DTDDoc over competition (let's do some marketing :))
- DTDDoc builds documentation for collections of DTD's, not for
- DTDDoc gives easy to read cardinality information (it's a
little more clever than it seems).
- DTDDoc supports multiple character encodings, so you can write
your documentation in polish or greek if you want.
The secret aim of this
is also to figure out a proper way to
document DTD's... That's a little bit more philosophical and that's what
is really interesting here. All contributions are welcome. My current
ideas are :
- Programmers read/write the DTD. Therefore the documentation should be
easy to read/write for them.
- Documentation should be automatically checkable because we are merely
humans. The "tag" (like in javadoc tags) idea works fine for that.
- Documentation should be easy to navigate. HTML presentation might