About
OraDocletPlus is an enhanced version of the OraDoclet database documentation generator available at http://oradoclet.sourceforge.net/
The tool will automatically generate a set of HTML documents based on the Oracle database schema that you connect it to. It will pull our pretty much all meta-data about the schema, including indexes, column comments, foreign keys, and PL/SQL source code.
I threw these changes together as I needed to generate some database schema documentation quickly and found the original OraDoclet to be a pretty good solution, although it had a couple of bugs, looked very out of date and hasn’t been updated in quite a while.
Note that the original author of OraDoclet was Vladimir Katchourovski – kudos to him for creating a concise & simple tool.
Enhancements
The differences between OraDocletPlus and the original OraDoclet are:
- OraDoclet had a show-stopper bug where it didn’t eliminate invalid characters from filenames, so it would fail if objects contained things like “\”, “/” or “:”
- Overhaul across codebase to remove table layouts, and inline HTML presentation code
- Added element id’s and classes to assist with styling
- Added a default style.css, using CSS 2 & CSS 3 styles which gets generated into documentation
Licence
It is licenced under the GPL 2.0 licence, the same as the original OraDoclet.
Example
Check out the example output from the standard Oracle “hr” schema.
Download
The code is now maintained at GitHub – check out the project page for source code. Any contributions and fixes are welcome!
You can download the latest binary JAR here – https://github.com/rjnichols/oradocletplus/raw/master/oradocletplus.jar
Usage
Ensure that you have the library jars available in the lib/ sub-folder from where you’re running from (if you unzipped the above package, and you ran from where you unzipped, you should be fine).
java -jar oradocletplus.jar username/password@hostname:port:sid <output_directory> [<copyright_notice>]
e.g.
java -jar oradocletplus.jar fred/password@localhost:1521:mydb c:/temp/oradocs "My Company Inc."
Like you, I had to quickly put together some system documentation for an Oracle database and found this webpage. I had to make a couple of minor adjustments in order to get it working.
1) None of the links in the triggers-index.html, contstaints-index.html or the indexs-index.html file were operational. The table name in the link was capitalised, but the actual page names were lower case.
2) Some anchors did not work outside of IE, because there was a # at the start of the anchor name.
Did you want me to submit any changes I have made? The project looks like it hasn’t been touched in a couple of years, so I wasn’t sure if you wanted to bother maintaining any fixes.
Jeremy Pyman
The code has been moved to GitHub – this should make it easier to get contributions and provide updates.