Difference between revisions of "Protege4DevDocs"

From Protege Wiki
Jump to: navigation, search
(Compiling and Running the Protege-OWL editor)
(Working with the Protege source code)
Line 8: Line 8:
 
== Working with the Protege source code ==
 
== Working with the Protege source code ==
  
=== Compiling and Running the Protege-OWL editor ===
 
  
Right now we only have documents for how to work with eclipse.  But I believe that developers using other IDE's will be able to follow these instructions (making the necessary changes as they go).  Please feel free to add links describing how to get Protege 4 to compile and run in other IDE's.
 
  
The following two links cover much the same ground.  They describe how to download, compile and run the protege 4 sources in a development environment.
+
=== Compiling and Running the Protege-OWL editor in a Generic IDE ===
  
* [http://www.cs.man.ac.uk/~iannonel/eclipseSetup/eclipseSetupMain.html Compile and run the Protege 4 OWL Editor in Eclipse]  <b>(External link)</b> - this page gives directions for compiling Protege 4.0 sources in Eclipse where ''all bundles are encapsulated in one Eclipse project''
+
This section describes how to set up an IDE for plugin development. We describe this in two steps - first the core Protege sources are downloaded and compiled and then a plugin project is created.  While these instructions were put together using eclipse we believe that they can be applied to other development environments and we welcome contributions from people using other development environments.
* [[CompileProtege4InEclipseOneProject|Compile and run the Protege-OWL editor in Eclipse]] <b>In Progress</b> - this page gives directions for compiling Protege 4.0 sources in Eclipse where ''all bundles are encapsulated in one Eclipse project''.
 
  
The next link covers the problem of compiling and running a plugin in a development environment.
+
* Downloading, compiling and running the core Protege sources.  The following two links cover much the same  ground.
 +
** [http://www.cs.man.ac.uk/~iannonel/eclipseSetup/eclipseSetupMain.html Compile and run the Protege 4 OWL Editor in Eclipse]  <b>(External link)</b> - this page gives directions for compiling Protege 4.0 sources in Eclipse where ''all bundles are encapsulated in one Eclipse project''
 +
** [[CompileProtege4InEclipseOneProject|Compile and run the Protege-OWL editor in Eclipse]] <b>In Progress</b> - this page gives directions for compiling Protege 4.0 sources in Eclipse where ''all bundles are encapsulated in one Eclipse project''.
 +
* Compiling and running a plugin.
 +
** [[CompileProtege4PluginInEclipseOneProject|Setting up the IDE environment for a plugin in Eclipse]]  <b>(In Progress)</b> -this page gives directions for setting up eclipse to do development work on a plugin.
  
* [[CompileProtege4PluginInEclipseOneProject|Setting up the IDE environment for a plugin in Eclipse]]  <b>(In Progress)</b> -this page gives directions for setting up eclipse to do development work on a plugin.
+
=== Compiling and Running a Plugin for Eclipse Users Only (Windows and Linux only) ===
 
 
=== Eclipse Only Instructions ===
 
  
 
Unlike the approaches for plugin development described above, the following instructions are only relevant to eclipse developers.  The eclipse environment has special support for OSGi and is - as far as I know - the best IDE environment for developing OSGI applications.  Unfortunately there are some issues  with taking advantage of this support that have not yet been worked out (involving Swing vs. SWT) so this documentation is still not complete.
 
Unlike the approaches for plugin development described above, the following instructions are only relevant to eclipse developers.  The eclipse environment has special support for OSGi and is - as far as I know - the best IDE environment for developing OSGI applications.  Unfortunately there are some issues  with taking advantage of this support that have not yet been worked out (involving Swing vs. SWT) so this documentation is still not complete.

Revision as of 07:02, April 17, 2008

Protege 4 Developer Documentation

This page is still somewhat under construction...



Working with the Protege source code

Compiling and Running the Protege-OWL editor in a Generic IDE

This section describes how to set up an IDE for plugin development. We describe this in two steps - first the core Protege sources are downloaded and compiled and then a plugin project is created. While these instructions were put together using eclipse we believe that they can be applied to other development environments and we welcome contributions from people using other development environments.

Compiling and Running a Plugin for Eclipse Users Only (Windows and Linux only)

Unlike the approaches for plugin development described above, the following instructions are only relevant to eclipse developers. The eclipse environment has special support for OSGi and is - as far as I know - the best IDE environment for developing OSGI applications. Unfortunately there are some issues with taking advantage of this support that have not yet been worked out (involving Swing vs. SWT) so this documentation is still not complete.

Writing a simple view plugin (with example code)

A short guide to writing a plug-in to show the class hierarchy. This doesn't delve deeply into setting up your build environment, but concentrates on a simple code example and making sure you understand the components and the structure of a plug-in.

Troubleshooting