Difference between revisions of "Protege5DevDocs"

From Protege Wiki

Jump to: navigation, search
Line 15: Line 15:
  
  
=== Building from source  ===
+
==== Building from source  ====
Details the steps necessary to download the Protege Desktop source code, and build a distribution from those sources.
+
Details the steps necessary to downloareleasesd the Protege Desktop source code, and build a distribution from those sources.
  
 
To follow this step-by-step guide, you must have [http://maven.apache.org/ Maven] and [http://git-scm.com/ Git] installed.
 
To follow this step-by-step guide, you must have [http://maven.apache.org/ Maven] and [http://git-scm.com/ Git] installed.
Line 31: Line 31:
  
  
=== Building with Eclipse and other IDEs ===
+
==== Building with Eclipse and other IDEs ====
 
We would welcome contributions from the community for setting up development environments other than Eclipse.
 
We would welcome contributions from the community for setting up development environments other than Eclipse.
  
 
* [https://github.com/protegeproject/protege/wiki/Setup-in-Eclipse Building with Eclipse]
 
* [https://github.com/protegeproject/protege/wiki/Setup-in-Eclipse Building with Eclipse]
 +
 +
 +
=== Protege APIs ===
 +
 +
==== Protege Core APIs ====
 +
 +
Here is a summary of the main parts of the [[P4APIOverview|Protege 4 API]] for gaining access to the model and various utilities.
 +
 +
The code for Protege core is available in [https://github.com/protegeproject/protege GitHub].
 +
 +
==== UI components ====
 +
 +
The Protege core and the OWL editor kit both provide a large number of [[P4UiComponentSummary|reuseable components]] and utilities for generating user interfaces for ontologies.
 +
 +
 +
=== Developing a plugin ===
  
  

Revision as of 21:32, 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


Accessing 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

Details the steps necessary to downloareleasesd the Protege Desktop source code, and build a distribution from those sources.

To follow this step-by-step guide, you must have Maven and Git installed.

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

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