OraDoclet – Oracle Schema Documentation Generator Albert Guo [email_address]
Agenda <ul><li>What is OraDoclet </li></ul><ul><li>OraDoclet Installation </li></ul><ul><li>OraDoclet Usage </li></ul>
What is OraDoclet
Overview <ul><li>The purpose of OraDoclet is generation of the detailed database documentation resembling the JavaDoc styl...
OraDoclet Installation
OraDoclet Installation <ul><li>Requirements: </li></ul><ul><ul><li>a) Java Virtual Machine, version 1.4 or later.  http://...
OraDoclet Usage
OraDoclet Usage <ul><li>The most simple way to use OraDoclet is to run as a normal java application providing the necessar...
Generation Results
Upcoming SlideShare
Loading in …5
×

Ora Doclet Oracle Schema Documentation Generator

1,719 views

Published on

Published in: Technology, Business
0 Comments
0 Likes
Statistics
Notes
  • Be the first to comment

  • Be the first to like this

No Downloads
Views
Total views
1,719
On SlideShare
0
From Embeds
0
Number of Embeds
15
Actions
Shares
0
Downloads
9
Comments
0
Likes
0
Embeds 0
No embeds

No notes for slide

Ora Doclet Oracle Schema Documentation Generator

  1. 1. OraDoclet – Oracle Schema Documentation Generator Albert Guo [email_address]
  2. 2. Agenda <ul><li>What is OraDoclet </li></ul><ul><li>OraDoclet Installation </li></ul><ul><li>OraDoclet Usage </li></ul>
  3. 3. What is OraDoclet
  4. 4. Overview <ul><li>The purpose of OraDoclet is generation of the detailed database documentation resembling the JavaDoc style. </li></ul><ul><li>It is a custom doclet that functions either with the JavaDoc tool or as a standalone Java application. </li></ul><ul><li>The documentation generated has a form of static html files and describes all objects in the given Oracle database schema. </li></ul>
  5. 5. OraDoclet Installation
  6. 6. OraDoclet Installation <ul><li>Requirements: </li></ul><ul><ul><li>a) Java Virtual Machine, version 1.4 or later. http://java.sun.com </li></ul></ul><ul><ul><li>b) Oracle Server, version 8.1.6 or later. http://technet.oracle.com </li></ul></ul><ul><ul><li>c) Oracle Server Client (optional when using JDBC Thin driver) http://technet.oracle.com </li></ul></ul><ul><li>Installation process: </li></ul><ul><ul><li>a) Check the runtime environment. Type in shell &quot;java -version“ to see the version number </li></ul></ul><ul><ul><li>b) Unpack OraDoclet files into the destination directory </li></ul></ul><ul><ul><li>c) The compilation may require the following libraries in the class path: </li></ul></ul><ul><ul><ul><li>%JAVA_HOME%lib ools.jar </li></ul></ul></ul><ul><ul><ul><li>%ORACLE_HOME%jdbclibclasses12.zip,where %ORACLE_HOME% is the directory where Oracle client components located </li></ul></ul></ul>
  7. 7. OraDoclet Usage
  8. 8. OraDoclet Usage <ul><li>The most simple way to use OraDoclet is to run as a normal java application providing the necessary parameters in the command line. </li></ul><ul><ul><li>java net.oradoclet.OraDoclet <dbconnect> [<output_directory> [<copyright_notice>]] </li></ul></ul><ul><ul><li>java -classpath &quot;.;E:mylibOracleoradoclet.jar;E:mylibOracleojdbc14.jar&quot; net.oradoclet.OraDoclet pdm/pdm@140.119.120.200:1521:WIND E:myliboradoclet-0.2dbdoc PTC </li></ul></ul>
  9. 9. Generation Results

×