Protege4DevDocs - Revision history

TaniaTudorache at 06:08, May 24, 2016

2016-05-24T06:08:52Z

TaniaTudorache at 09:29, December 4, 2015

2015-12-04T09:29:41Z

JenniferVendetti: removed link to client-server documentation. this will never be part of protege 4. link to documentation was moved to the page dedicated to protege 5 developer docs (accessible from the home page of the wiki)

2013-10-04T23:27:57Z

removed link to client-server documentation. this will never be part of protege 4. link to documentation was moved to the page dedicated to protege 5 developer docs (accessible from the home page of the wiki)

Tredmond: /* Protege 4 OWL editor in Eclipse or IntelliJ */

2013-08-02T18:16:57Z

‎Protege 4 OWL editor in Eclipse or IntelliJ

Tredmond: /* Protege 4 OWL editor in Eclipse or IntelliJ */

2013-08-02T17:09:43Z

‎Protege 4 OWL editor in Eclipse or IntelliJ

Tredmond: /* Protege 4 OWL editor in Eclipse or IntelliJ */

2013-08-02T17:06:21Z

‎Protege 4 OWL editor in Eclipse or IntelliJ

Tredmond: /* Protege 4 OWL editor in Eclipse or IntelliJ */

2013-08-02T17:05:39Z

‎Protege 4 OWL editor in Eclipse or IntelliJ

JenniferVendetti at 00:01, December 18, 2012

2012-12-18T00:01:51Z

Tredmond: /* Database Backends */

2012-05-23T19:28:13Z

‎Database Backends

Tredmond: /* Protege APIs */

2011-05-22T18:19:56Z

‎Protege APIs

@@ Line 1: / Line 1: @@
 <div class="orangeBox">
 <span class="orangeBoxTitle">Protege 4 Developer Documentation</span><br /><br />
-Pointers for developers of plugins and understanding the core APIs of Protege 4.
+Pointers for developers of plugins and understanding the core APIs of Protege 4. '''If you are interested in the Protege 5 Developer Documentation, please go to [[Protege5DevDocs|this page]].'''
 </div><br /><br />

@@ Line 29: / Line 29: @@
 * [[CompileProtege4InEclipseFromSvn|Setting up eclipse with Protege 4.1 and higher]] '''(Recommended for Protege 4.1+)'''<br/>This page gives directions for compiling and running Protege 4.1 and higher using Eclipse's plugin development framework.  It includes the OS X workaround  as well.
-* [[CompileProtege5InEclipseWithMaven|Setting up eclipse with Protege 4.1-5 using maven]] '''(Under development)'''<br/>This page shows how to use maven for compiling and running Protege 4.1-5 using  Eclipse's plugin development framework.  I think that ultimately this will be the preferred method of setting up eclipse but right now the build scripts are still under development.<br/>
+* [https://github.com/protegeproject/protege/wiki/Setup-in-Eclipse Setting up eclipse with Protege 4.1-5 using maven] ''' <br/>This page shows how to use maven for compiling and running Protege 4.1-5 using  Eclipse's plugin development framework. <br/>
 * [[CompileProtege4InIntelliJFromSvn|Setting up IntelliJ IDEA with Protege 4.1 and higher]] '''(Recommended for Protege 4.1+)'''<br/>This page gives directions for compiling and running Protege 4.1 and higher using IDEA's Osmorc plug-in.

@@ Line 104: / Line 104: @@
 There are now three database backends for the OWL API.  Very soon we expect to have a Protege plugin that enables all three backend mechanisms.  We have put together a [[Loading A DatabaseProject|document]] describing how two of the database backends can be used with the owl api.
 == Troubleshooting ==
 * [[SolvingClassLoaderProblems|Troubleshooting class loader issues]]
 * [[DealingWithJava5CompilerIssues|Troubleshooting and fixing problems with the Java 5 compiler]]

@@ Line 29: / Line 29: @@
 * [[CompileProtege4InEclipseFromSvn|Setting up eclipse with Protege 4.1 and higher]] '''(Recommended for Protege 4.1+)'''<br/>This page gives directions for compiling and running Protege 4.1 and higher using Eclipse's plugin development framework.  It includes the OS X workaround  as well.
-* [[CompileProtege5InEclipseWithMaven|Setting up eclipse with Protege 4.1-5 using maven]] '''(Under development)'''<br/>This page shows how to use maven for compiling and running Protege 4.1-5 using  Eclipse's plugin development framework.  I think that ultimately this will be the preferred method of setting up eclipse but right now the build scripts are still under development.</br>
+* [[CompileProtege5InEclipseWithMaven|Setting up eclipse with Protege 4.1-5 using maven]] '''(Under development)'''<br/>This page shows how to use maven for compiling and running Protege 4.1-5 using  Eclipse's plugin development framework.  I think that ultimately this will be the preferred method of setting up eclipse but right now the build scripts are still under development.<br/>
 * [[CompileProtege4InIntelliJFromSvn|Setting up IntelliJ IDEA with Protege 4.1 and higher]] '''(Recommended for Protege 4.1+)'''<br/>This page gives directions for compiling and running Protege 4.1 and higher using IDEA's Osmorc plug-in.

@@ Line 29: / Line 29: @@
 * [[CompileProtege4InEclipseFromSvn|Setting up eclipse with Protege 4.1 and higher]] '''(Recommended for Protege 4.1+)'''<br/>This page gives directions for compiling and running Protege 4.1 and higher using Eclipse's plugin development framework.  It includes the OS X workaround  as well.
-* [[CompileProtege5InEclipseWithMaven|Setting up eclipse with Protege 5 using maven]] '''Under development'''<br/>This page shows how to use maven to setup an eclipse session.  I think that ultimately this will be the preferred method of setting up eclipse but right now the build scripts are still under development.</br>
+* [[CompileProtege5InEclipseWithMaven|Setting up eclipse with Protege 4.1-5 using maven]] '''(Under development)'''<br/>This page shows how to use maven for compiling and running Protege 4.1-5 using  Eclipse's plugin development framework.  I think that ultimately this will be the preferred method of setting up eclipse but right now the build scripts are still under development.</br>
 * [[CompileProtege4InIntelliJFromSvn|Setting up IntelliJ IDEA with Protege 4.1 and higher]] '''(Recommended for Protege 4.1+)'''<br/>This page gives directions for compiling and running Protege 4.1 and higher using IDEA's Osmorc plug-in.

← Older revision		Revision as of 17:05, August 2, 2013
Line 29:		Line 29:

	* [[CompileProtege4InEclipseFromSvn\|Setting up eclipse with Protege 4.1 and higher]] '''(Recommended for Protege 4.1+)'''<br/>This page gives directions for compiling and running Protege 4.1 and higher using Eclipse's plugin development framework. It includes the OS X workaround as well.		* [[CompileProtege4InEclipseFromSvn\|Setting up eclipse with Protege 4.1 and higher]] '''(Recommended for Protege 4.1+)'''<br/>This page gives directions for compiling and running Protege 4.1 and higher using Eclipse's plugin development framework. It includes the OS X workaround as well.
		+	* [[CompileProtege5InEclipseWithMaven\|Setting up eclipse with Protege 5 using maven]] '''Under development'''<br/>This page shows how to use maven
		+	to setup an eclipse session. I think that ultimately this will be the preferred method of setting up eclipse but right now the build scripts are still under development.</br>
	* [[CompileProtege4InIntelliJFromSvn\|Setting up IntelliJ IDEA with Protege 4.1 and higher]] '''(Recommended for Protege 4.1+)'''<br/>This page gives directions for compiling and running Protege 4.1 and higher using IDEA's Osmorc plug-in.		* [[CompileProtege4InIntelliJFromSvn\|Setting up IntelliJ IDEA with Protege 4.1 and higher]] '''(Recommended for Protege 4.1+)'''<br/>This page gives directions for compiling and running Protege 4.1 and higher using IDEA's Osmorc plug-in.

@@ Line 9: / Line 9: @@
 == Guidelines ==
-Protege 4.1 will be compatible with both Java 5 and Java 6.  Unfortunately we need to continue supporting Java 5 because of problems with Java on the older Apple platforms (the PowerPC and 32 bit Macs).  If you are writing a plugin and you want to be available on all OS X platforms, then you must use Java 5.  Otherwise Java 6 works as long  as you understand that you are  excluding a  subset of the Apple  platforms.
+Protege 4.1 and higher will be compatible with both Java 5 and Java 6.  Unfortunately we need to continue supporting Java 5 because of problems with Java on the older Apple platforms (the PowerPC and 32 bit Macs).  If you are writing a plugin and you want to be available on all OS X platforms, then you must use Java 5.  Otherwise Java 6 works as long  as you understand that you are  excluding a  subset of the Apple  platforms.
 '''Please consider writing any P4 code as a plugin'''.<br />
@@ Line 28: / Line 28: @@
 === Protege 4 OWL editor in Eclipse or IntelliJ  ===
-* [[CompileProtege4InEclipseFromSvn|Setting up eclipse with Protege 4.1]] '''(Recommended for Protege 4.1)'''<br/>This page gives directions for compiling and running Protege  4.1 using Eclipse's plugin development framework.  It includes the OS X workaround  as well.
+* [[CompileProtege4InEclipseFromSvn|Setting up eclipse with Protege 4.1 and higher]] '''(Recommended for Protege 4.1+)'''<br/>This page gives directions for compiling and running Protege 4.1 and higher using Eclipse's plugin development framework.  It includes the OS X workaround  as well.
-* [[CompileProtege4InIntelliJFromSvn|Setting up IntelliJ IDEA with Protege 4.1]] '''(Recommended for Protege 4.1)'''<br/>This page gives directions for compiling and running Protege  4.1 using IDEA's Osmorc plug-in.
+* [[CompileProtege4InIntelliJFromSvn|Setting up IntelliJ IDEA with Protege 4.1 and higher]] '''(Recommended for Protege 4.1+)'''<br/>This page gives directions for compiling and running Protege 4.1 and higher using IDEA's Osmorc plug-in.
 === Protege 4 OWL editor in a Other IDEs ===
 There is no longer a page that describes how to set up an IDE other than eclipse or IntelliJ.  We welcome contributions from the community for directions on how to set up other developement environments.  In particular NetBeans  seems to have a following and it would be useful to have a page describing how to set up for that IDE.
-For an experienced Java developer, the [[#Building_Protege4.1_from_scratch_using_ant|ant build steps]] will probably provide enough hints to put together an arbitrary ide environment for Protege 4.1.
+For an experienced Java developer, the [[#Building_Protege4.1_from_scratch_using_ant|ant build steps]] will probably provide enough hints to put together an arbitrary IDE environment for Protege 4.1 and higher.
 == Writing A Plugin ==
@@ Line 63: / Line 63: @@
 === Updating to Protege 4.1 ===
-A short [[P4_1PortingGuide|guide]] to migrating plugins from Protege4.0 to Protege4.1 (in progress).
+A short [[P4_1PortingGuide|guide]] to migrating plugins from Protege 4.0 to Protege 4.1 (in progress).
-=== Building Protege4.1 from scratch using ant ===
+=== Building Protege 4.1 and higher from scratch using Ant ===
-The Protege 4.1 build process has been refactored since Protege 4.0.  This means that the locations of the various Protege 4.1 plugins is different than the corresponding locations in Protege 4.0.  There are several advantages of the new scheme:
+The Protege 4.1 and higher build process has been refactored since Protege 4.0.  This means that the locations of the various Protege 4.1 and higher plug-ins are different than the corresponding locations in Protege 4.0.  There are several advantages of the new scheme:
 * the build files are independent so that changes to one plugin can be propagated to the distribution by compiling just the plugin rather than the redoing an entire Protege build.
 * the build files autodetect the format of the protege distribution.  This means that a single build file for the os x application bundle (Protege.app) and a felix based distribution.
 * the new build process is much simpler allowing us to more easily update the various components.
-Although many readers of this section will not be planning on doing an ant build, these directions clarify the location of the various Protege 4.1 plugins in svn.
+Although many readers of this section will not be planning on doing an Ant build, these directions clarify the location of the various Protege 4.1 and higher plug-ins in svn.
 A very quick build (40 seconds) can be done with the following steps:
@@ Line 81: / Line 81: @@
 The manual steps are as follows.
-First  you must set the PROTEGE_HOME environment variable which is described [[ConfiguringAntBuildFiles|here]].  Then you can build Protege 4.1 by  following the following steps.
+First  you must set the PROTEGE_HOME environment variable which is described [[ConfiguringAntBuildFiles|here]].  Then you can build Protege 4.1 and higher by  following the following steps.
 # ''svn checkout http://smi-protege.stanford.edu/repos/protege/protege4/protege-base/trunk protege-base''
 # ''cd protege-base'' and ''ant install'' and ''cd ..''.  '''Warning:''' this step deletes the existing contents of ${PROTEGE_HOME}.

@@ Line 102: / Line 102: @@
 ===Database Backends===
-There are now two database backends for the OWL API.  Very soon we expect to have a Protege plugin that enables both backend mechanisms.  We have put together a [[Loading A DatabaseProject|document]] describing how both database backends can be used with the owl api.
+There are now three database backends for the OWL API.  Very soon we expect to have a Protege plugin that enables all three backend mechanisms.  We have put together a [[Loading A DatabaseProject|document]] describing how two of the database backends can be used with the owl api.
 ===Client-Server===

@@ Line 55: / Line 55: @@
 Here is a summary of the main parts of the [[P4APIOverview|Protege 4 API]] for gaining access to the model and various utilities.
-Also see the [http://protege.stanford.edu/protege/4.0/docs/api/ javadoc for Protege 4.0 code].
+Also see the [http://protege.stanford.edu/protege/4.1/docs/api/ javadoc for Protege 4.1 code].
 === UI components ===