Difference between revisions of "Protege5DevDocs"

From Protege Wiki

Jump to: navigation, search
Line 5: Line 5:
 
__TOC__<br />
 
__TOC__<br />
  
=== Accessing the source code ===
+
=== Building ===
 +
 
 +
==== Accessing the source code ====
 
Protege Desktop is open source and the code is freely [http://github.com/protegeproject/protege available] on GitHub.  Use the following Git command to get a local copy:
 
Protege Desktop is open source and the code is freely [http://github.com/protegeproject/protege available] on GitHub.  Use the following Git command to get a local copy:
  
Line 13: Line 15:
  
 
The source code for many Protege Desktop plug-ins has also been made available on GitHub under the [https://github.com/protegeproject Protege Project organization].
 
The source code for many Protege Desktop plug-ins has also been made available on GitHub under the [https://github.com/protegeproject Protege Project organization].
 
  
 
==== Building from source  ====
 
==== Building from source  ====
Details the steps necessary to downloareleasesd the Protege Desktop source code, and build a distribution from those sources.
+
The instructions for building from source are available on [https://github.com/protegeproject/protege/wiki/Building-from-Source GitHub].
 
+
To follow this step-by-step guide, you must have [http://maven.apache.org/ Maven] and [http://git-scm.com/ Git] installed.
+
 
+
* Get a copy of the Protege Desktop source code, i.e., "git clone https://github.com/protegeproject/protege.git protege".
+
* Change into the protege directory.
+
* Type mvn clean install.
+
 
+
Once the build completes, a usable Protege Desktop installation will have been created in:
+
 
+
protege/protege-distribution/target/protege-distribution-${version}-bin/Protege
+
 
+
Use the run.bat or run.sh scripts to launch Protege Desktop.
+
 
+
  
 
==== Building with Eclipse and other IDEs ====
 
==== Building with Eclipse and other IDEs ====

Revision as of 21:36, May 23, 2016

Protege Desktop 5.x Developer Documentation

This page is a top-level entry point for all developer documentation related to the Protege Desktop application, versions 5.0 and above.

Contents


Building

Accessing the source code

Protege Desktop is open source and the code is freely available on GitHub. Use the following Git command to get a local copy:

git clone https://github.com/protegeproject/protege.git protege

The source code for many Protege Desktop plug-ins has also been made available on GitHub under the Protege Project organization.

Building from source

The instructions for building from source are available on GitHub.

Building with Eclipse and other IDEs

We would welcome contributions from the community for setting up development environments other than Eclipse.


Protege APIs

Protege Core APIs

Here is a summary of the main parts of the Protege 4 API for gaining access to the model and various utilities.

The code for Protege core is available in GitHub.

UI components

The Protege core and the OWL editor kit both provide a large number of reuseable components and utilities for generating user interfaces for ontologies.


Developing a plugin

Client-server

Personal tools