ConfiguringAntBuildFiles - Revision history

Tredmond: /* Using and Configuring Protege Ant Build Scripts */

2011-06-17T15:07:07Z

‎Using and Configuring Protege Ant Build Scripts

Tredmond: /* Using and Configuring Protege Ant Build Scripts */

2011-06-17T15:04:16Z

‎Using and Configuring Protege Ant Build Scripts

Tredmond at 14:50, June 17, 2011

2011-06-17T14:50:40Z

Tredmond: /* Missing protege libraries */ (checkpoint save)

2011-06-17T14:45:37Z

‎Missing protege libraries: (checkpoint save)

Tredmond at 14:40, June 17, 2011

2011-06-17T14:40:03Z

Tredmond: /* Missing protege libraries */ (checkpoint save)

2011-06-17T14:38:17Z

‎Missing protege libraries: (checkpoint save)

Tredmond at 14:36, June 17, 2011

2011-06-17T14:36:12Z

Tredmond: (checkpoint save)

2011-06-17T14:34:33Z

(checkpoint save)

Tredmond: (checkpoint save)

2011-06-17T14:32:57Z

(checkpoint save)

Tredmond: /* How the Protege ant scripts work */ (checkpoint save)

2011-06-17T14:29:31Z

‎How the Protege ant scripts work: (checkpoint save)

@@ Line 17: / Line 17: @@
              ...
 </pre>
-This is a very flexible technique and can be used to override any variables in the called ant script.  This type of technique is being used at NCI to create custom builds of the NCI Protege in a controlled and consistent fashion.
+This is a very flexible technique and can be used to override any variables in the called ant script.  This type of technique is being used at NCI to create custom builds of the NCI Protege in a controlled and consistent fashion.  This technique is also being used by the [http://smi-protege.stanford.edu/repos/protege/protege4/misc/composite Protege 4 composite projects] to make it easy to build and debug various customized Protege 4 installations.
 = How the Protege ant scripts work =

@@ Line 7: / Line 7: @@
 * OS x machines are unix machines so all the unix techniques apply.  However, in addition to this there is the<br><pre>             ~/.MacOSX/environment.plist</pre><br> file which contains a set of properties.  The advantage of using this file is that it is invoked before applications that are invoked with a double click.  There is a nice page about this [http://www.working-software.com/node/31 here].  So it might make sense to put environment property values in here that are seen by an IDE which is started with a double click.
 * On windows systems, right click on MyComputer and select settings. Then find Environment Variables and click then locate PROTEGE_HOME, press edit and change to the path to protege.
-* In eclipse follows [[CompileProtege4InEclipseOneProject#Setting_up_an_ant_build_script|these directions]] and then go to the environment settings page and add the environment setting.
+* In eclipse, the ant runnable configuration has a section which allows you to control the environment variables that the ant script sees.
 In addition to the above, any variable in a Protege ant script can be configured by setting the value in a local.properties file.  This is useful for an installation into a non-Protege application such as a tomcat web server.

← Older revision		Revision as of 14:50, June 17, 2011
Line 372:		Line 372:
	<li>org.semanticweb.owl.owlapi.jar: this is the [http://owlapi.sourceforge.net Manchester OWL api] packaged as a Protege bundle</li>		<li>org.semanticweb.owl.owlapi.jar: this is the [http://owlapi.sourceforge.net Manchester OWL api] packaged as a Protege bundle</li>
	</ul>		</ul>
		+	Right after it informs you that it finds these libraries, it tells you that it could not find the org.protege.owl.diff.jar library. To make this build script work you will need to checkout the sources for this library from [http://smi-protege.stanford.edu/repos/protege/protege4/libraries/org.protege.owl.diff/trunk here] and build and install that library. Here I show how I build that library and then I am able to build and install the difference editor plugin:
		+	<pre>
		+	[tredmond@Saturn org.protege.owl.diff]$ ant clean install
		+	Buildfile: /home/tredmond/dev/workspaces/protege4.1/org.protege.owl.diff/build.xml
		+
		+	clean:
		+	[delete] Deleting directory /home/tredmond/dev/workspaces/protege4.1/org.protege.owl.diff/build
		+
		+	init:
		+	[mkdir] Created dir: /home/tredmond/dev/workspaces/protege4.1/org.protege.owl.diff/build
		+	[mkdir] Created dir: /home/tredmond/dev/workspaces/protege4.1/org.protege.owl.diff/build/classes
		+	[mkdir] Created dir: /home/tredmond/dev/workspaces/protege4.1/org.protege.owl.diff/build/classes/lib
		+	[mkdir] Created dir: /home/tredmond/dev/workspaces/protege4.1/org.protege.owl.diff/build/lib
		+
		+	checkProtegeLibs:
		+	[echo] **********************************************************
		+	[echo] Using Protege Home = /home/tredmond/dev/workspaces/protege4.1/Protege
		+	[echo] Using Java Version = 1.5
		+	[echo] **********************************************************
		+
		+	checkProtegeLibsAndReport:
		+
		+	buildlibs:
		+	[unjar] Expanding: /home/tredmond/dev/workspaces/protege4.1/Protege/bundles/org.protege.common.jar into /home/tredmond/dev/workspaces/protege4.1/org.protege.owl.diff/build
		+
		+	compile:
		+	[javac] Compiling 46 source files to /home/tredmond/dev/workspaces/protege4.1/org.protege.owl.diff/build/classes
		+
		+	build.manifest:
		+	[copy] Copying 1 file to /home/tredmond/dev/workspaces/protege4.1/org.protege.owl.diff/build
		+
		+	copy.resources:
		+	[copy] Copying 1 file to /home/tredmond/dev/workspaces/protege4.1/org.protege.owl.diff/build/classes
		+	[copy] Copying 2 files to /home/tredmond/dev/workspaces/protege4.1/org.protege.owl.diff/build/classes
		+	[mkdir] Created dir: /home/tredmond/dev/workspaces/protege4.1/org.protege.owl.diff/build/classes/META-INF
		+	[copy] Copying 1 file to /home/tredmond/dev/workspaces/protege4.1/org.protege.owl.diff/build/classes/META-INF
		+
		+	create.update.properties:
		+
		+	jar:
		+	[jar] Building jar: /home/tredmond/dev/workspaces/protege4.1/org.protege.owl.diff/build/org.protege.owl.diff.jar
		+
		+	install:
		+	[copy] Copying 1 file to /home/tredmond/dev/workspaces/protege4.1/Protege/plugins
		+
		+	BUILD SUCCESSFUL
		+	Total time: 2 seconds
		+	[tredmond@Saturn org.protege.owl.diff]$ cd ../org.protege.editor.owl.diff
		+	[tredmond@Saturn org.protege.editor.owl.diff]$ ant clean install
		+	Buildfile: /home/tredmond/dev/workspaces/protege4.1/org.protege.editor.owl.diff/build.xml
		+
		+	clean:
		+	[delete] Deleting directory /home/tredmond/dev/workspaces/protege4.1/org.protege.editor.owl.diff/build
		+
		+	init:
		+	[mkdir] Created dir: /home/tredmond/dev/workspaces/protege4.1/org.protege.editor.owl.diff/build
		+	[mkdir] Created dir: /home/tredmond/dev/workspaces/protege4.1/org.protege.editor.owl.diff/build/classes
		+	[mkdir] Created dir: /home/tredmond/dev/workspaces/protege4.1/org.protege.editor.owl.diff/build/classes/lib
		+	[mkdir] Created dir: /home/tredmond/dev/workspaces/protege4.1/org.protege.editor.owl.diff/build/lib
		+
		+	checkProtegeLibs:
		+	[echo] **********************************************************
		+	[echo] Using Protege Home = /home/tredmond/dev/workspaces/protege4.1/Protege
		+	[echo] Using Java Version = 1.5
		+	[echo] **********************************************************
		+
		+	checkProtegeLibsAndReport:
		+
		+	buildlibs:
		+	[unjar] Expanding: /home/tredmond/dev/workspaces/protege4.1/Protege/bundles/org.protege.common.jar into /home/tredmond/dev/workspaces/protege4.1/org.protege.editor.owl.diff/build
		+
		+	compile:
		+	[javac] Compiling 10 source files to /home/tredmond/dev/workspaces/protege4.1/org.protege.editor.owl.diff/build/classes
		+
		+	build.manifest:
		+	[copy] Copying 1 file to /home/tredmond/dev/workspaces/protege4.1/org.protege.editor.owl.diff/build
		+
		+	copy.resources:
		+	[copy] Copying 3 files to /home/tredmond/dev/workspaces/protege4.1/org.protege.editor.owl.diff/build/classes
		+	[mkdir] Created dir: /home/tredmond/dev/workspaces/protege4.1/org.protege.editor.owl.diff/build/classes/META-INF
		+	[copy] Copying 1 file to /home/tredmond/dev/workspaces/protege4.1/org.protege.editor.owl.diff/build/classes/META-INF
		+
		+	create.update.properties:
		+
		+	jar:
		+	[jar] Building jar: /home/tredmond/dev/workspaces/protege4.1/org.protege.editor.owl.diff/build/org.protege.editor.owl.diff.jar
		+
		+	install:
		+	[copy] Copying 1 file to /home/tredmond/dev/workspaces/protege4.1/Protege/plugins
		+
		+	BUILD SUCCESSFUL
		+	Total time: 1 second
		+	[tredmond@Saturn org.protege.editor.owl.diff]$
		+	</pre>

@@ Line 352: / Line 352: @@
 The ''-v'' option generates a lot of output most of which you will ignore.  But scroll up from the bottom and you will see the lines:
 <pre>
 checkProtegeLibs:
       [echo] **********************************************************
@@ Line 387: / Line 363: @@
 [available] Found file: /home/tredmond/dev/workspaces/protege4.1/Protege/plugins/org.semanticweb.owl.owlapi.jar
 [available] Unable to find file /home/tredmond/dev/workspaces/protege4.1/Protege/plugins/org.protege.owl.diff.jar
 </pre>

@@ Line 350: / Line 350: @@
 [tredmond@Saturn org.protege.editor.owl.diff]$
 </pre>
-The
+The ''-v'' option generates a lot of output most of which you will ignore.  But scroll up from the bottom and you will see the lines:

@@ Line 281: / Line 281: @@
 /home/tredmond/dev/workspaces/protege4.1/org.protege.editor.owl.diff/build.xml:80: missing protege libraries
 </pre>
-It would be nice if this message was more helpful but I haven't figured out how to do that yet.  To find out what  library is missing run the ant script with the '''-v''' parameter.
+It would be nice if this message was more helpful but I haven't figured out how to do that yet.  To find out what  library is missing run the ant script with the ''-v'' parameter:

← Older revision		Revision as of 14:36, June 17, 2011
Line 281:		Line 281:
	/home/tredmond/dev/workspaces/protege4.1/org.protege.editor.owl.diff/build.xml:80: missing protege libraries		/home/tredmond/dev/workspaces/protege4.1/org.protege.editor.owl.diff/build.xml:80: missing protege libraries
	</pre>		</pre>
		+	It would be nice if this message was more helpful but I haven't figured out how to do that yet. To find out what library is missing run the ant script with the '''-v''' parameter.

← Older revision		Revision as of 14:34, June 17, 2011
Line 268:		Line 268:
	First make sure that your PROTEGE_HOME environment variable is pointing to a real Protege distribution. This message is telling you that there is some library that this plugin depends on that is not being found as a plugin in the Protege installation. I will give a Protege 4 example in this case to illustrate the problem and how you can fix it.		First make sure that your PROTEGE_HOME environment variable is pointing to a real Protege distribution. This message is telling you that there is some library that this plugin depends on that is not being found as a plugin in the Protege installation. I will give a Protege 4 example in this case to illustrate the problem and how you can fix it.

−	I will use then Protege 4 difference plugin as an example because it is a good example of a project with a dependency. It can be checked out from svn [http://smi-protege.stanford.edu/repos/protege/protege4/plugins/org.protege.editor.owl.diff/trunk here].	+	I will use then Protege 4 difference plugin as an example because it is a good example of a project with a dependency. It can be checked out from svn [http://smi-protege.stanford.edu/repos/protege/protege4/plugins/org.protege.editor.owl.diff/trunk here]. If you check this out and run it you may see the following message:
		+	<pre>
		+	checkProtegeLibsAndReport:
		+	[echo] Missing protege libraries. You need to set
		+	[echo] the PROTEGE_HOME environment variable to a
		+	[echo] protege installation directory where the
		+	[echo] appropriate plugins have been installed.
		+	[echo] Alternatively set the jar libs in local.properties (protege.lib=...)
		+	[echo] Use the -v option to ant to see what jars are missing.
		+
		+	BUILD FAILED
		+	/home/tredmond/dev/workspaces/protege4.1/org.protege.editor.owl.diff/build.xml:80: missing protege libraries
		+	</pre>

← Older revision		Revision as of 14:32, June 17, 2011
Line 266:		Line 266:
	== Missing protege libraries ==		== Missing protege libraries ==

−	First make sure that your PROTEGE_HOME environment variable is pointing to a real Protege distribution. This message is telling you that there is some library that this plugin depends on that is	+	First make sure that your PROTEGE_HOME environment variable is pointing to a real Protege distribution. This message is telling you that there is some library that this plugin depends on that is not being found as a plugin in the Protege installation. I will give a Protege 4 example in this case to illustrate the problem and how you can fix it.
		+
		+	I will use then Protege 4 difference plugin as an example because it is a good example of a project with a dependency. It can be checked out from svn [http://smi-protege.stanford.edu/repos/protege/protege4/plugins/org.protege.editor.owl.diff/trunk here].

@@ Line 21: / Line 21: @@
 = How the Protege ant scripts work =
-The philosophy of the Protege build scripts is to use the PROTEGE_HOME environment variable as a pointer to the Protege installation directory and as a repository of the latest jars.  We will show how this works by demonstrating how to quickly build a Protege 3 installation containing a few basic plugins.  I have chosen Protege 3 rather than Protege 4 in this case because the main Protege 4.0 build file does not follow the paradigm that I am about to describe.  However in Protege 4.1 this approach is already in use and several of the co-ode Protege 4 plugins use this approach also.
+The philosophy of the Protege build scripts is to use the PROTEGE_HOME environment variable as a pointer to the Protege installation directory and as a repository of the latest jars.  We will show how this works by demonstrating how to quickly build a Protege 3 installation containing a few basic plugins.  This page uses Protege 3 examples but the Protege 4.1 build files work in exactly the same way (except that in that case PROTEGE_HOME must point to a Protege 4.1 installation directory rather than a Protege 3 installation directory).
 We will start by creating an empty directory and installing the core Protege 3 implementation into that directory.  Please note that this build script was run on a very slow machine and will run much faster on modern platforms.
@@ Line 261: / Line 261: @@
 [tredmond@Andromeda standard-extensions]$
 </pre>