Protege3DevDocs

Protege 3 Developer Documentation

Please note that we are slowly trying to move developer documentation off of the main Protege Web site and onto this Wiki. We feel that this will better serve the community as users will (hopefully) make contributions and corrections to our body of documentation.

Because the migration of documentation to the Wiki is ongoing, you should also check the main Protege Web site for Protege 3 developer documentation: http://protege.stanford.edu/doc/dev.html.

Programming Tips & Tricks

General (common to Protege-Frames & Protege-OWL)

• Protege Programming Development Kit (PDK)
• Compiling and Running Protege-Frames and OWL in a Java Development Environment (e.g., Eclipse)
• Working with forms
  • Adding and removing tabs programmatically
  • Using a Protege tab plug-in in your own application
  • Using Protege forms in other applications
  • Changing forms programtically
  • Making slot-widgets read-only programmatically
  • Working with the graph widget
• Client-Server (Multi-user mode)
  • Considerations when porting tab widget plug-ins to client-server mode
  • Adding and removing users programmatically in client-server mode
  • Accessing a remote protege server programatically
• Collaboration features
  • Accessing the collaboration features programmatically (Changes and Annotation API)
• Accessing the Lucene Query plug-in programatically
• Tips for handling multiple threads writing to a Protege knowledge-base
• How to implement compression over rmi

Protege-OWL Specific

• Working with the Protege-OWL API
  • Protege-OWL API (high level overview)
  • Protege-OWL API Programmer's Guide
  • Protege-OWL API Javadoc
  • How to import an ontology using the Protege-OWL API
  • How to invoke the Protege-OWL Java Code Generator using the API
  • Protege-OWL & Jena integration
• The Reasoning API
  • Protege-OWL reasoner API
  • Protege-OWL reasoner plug-in
• OWL Database
  • Converting an OWL Model to a database project
  • How to load a Protege-OWL ontology from a Protege database using the API
• Configuring the User Interface using the API
  • How to use the OWL Classes panel in your own application
  • How to set the browser slot pattern to rdfs:label (or other property) using the API

Protege-Frames Specific

• How to load a Protege-Frames ontology from a Protege database using the API
  
  

Plug-in Development

General (common to Protege-Frames & Protege-OWL)

• Notes for developers on migrating plug-ins to Protege 3.4 build 500 (and higher)
• Learn how to create a manifest and JAR file for your plug-in
• Tips for packaging your plug-in for distribution
• Instructions for declaring dependencies between Protege plug-ins
• How to make your plug-in's documentation available to users from within Protege