Difference between revisions of "ProtegeDesktopUserDocs"

From Protege Wiki
Jump to: navigation, search
(Protege-OWL Editor: Added expression editor page)
 
(93 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<div class="orangeBox">
+
= Protege Desktop User Documentation =
<span class="orangeBoxTitle">Protege 4 User Documentation</span><br /><br />
+
 
This page contains a collection of links to documentation for end users of the Protege 4.x series.<br /><br />
+
This page is the official documentation home for the '''Protege Desktop application versions 4, 5 and higher'''.   
Protege 4.0 is currently in beta and we are interested in soliciting your feedbackWe have set up a mailing list specifically for discussion about Protege 4.0.  You can subscribe to the list via the list information page: http://mailman.stanford.edu/mailman/listinfo/p4-feedback.
+
 
</div><br />
 
  
 
__TOC__
 
__TOC__
  
== Protege-OWL Editor ==
 
  
=== [[Protege-OWL_4_FAQ | Protege-OWL FAQ]] ===
+
== Build status & release notes ==
We have put together a wiki page to answer the most commonly asked questions about the 4.x series of the Protege application:
 
  
 +
The latest version of Protege Desktop is '''5.5''':
  
=== Getting started / Tutorials ===
+
* [https://github.com/protegeproject/protege-distribution/releases Release notes]
 +
* [[Install_Protege5|Installation instructions]]
 +
* [http://protege.stanford.edu/products.php#desktop-protege Download latest version of Protege]
  
* [[Protege4GettingStarted | Getting started with the Protege-OWL editor]] a short guide to the interface
+
You may also download [[Protege_Desktop_Old_Versions|previous versions of Protege]] and read the complete list of release notes. Older Protege 5.0 beta release notes are available [[Protege_5.0_Beta_Release_Notes|here]].
* [[Protege4Pizzas10Minutes | Pizzas in 10 minutes: A demo of modelling shortcuts]] a quickstart guide to creating your first OWL ontology
 
* [http://www.co-ode.org/resources/tutorials/protege-owl-tutorial.php A Practical Guide to Building OWL Ontologies using Protege 4 and CO-ODE Tools] a substantial guide to OWL and ontology engineering
 
''Please note that we are actively maintaining an [[Protege4TutorialErrata|errata page]] for the practical guide.''
 
  
 +
== Bugs & feature requests ==
  
=== Editor Features ===
+
Before you report a bug or feature request, check the [http://protege-project.136.n4.nabble.com/ Protege mailing lists archives] to ensure it hasn't already been reported. If the item is not currently open or you have further information or a question about an existing item, please post a message on the [http://mailman.stanford.edu/mailman/listinfo/protege-user protege-user mailing list].  Give as much detail as possible (including examples or ontologies if possible) as this will help us track things down more quickly.
  
* [[Protege4Features | Overview of features]] a quick summary of the editor
+
Current GitHub issue tracker: https://github.com/protegeproject/protege/issues?state=open
* [[Protege4Views | P4 views guide]] a list of all of the default views that are distributed with P4
 
* [[Protege4Shortcuts | P4 menu guide]] all of the default menus explained in detail (with keyboard shortcuts)
 
* [[Protege4Preferences | P4 preferences guide]] customising P4 to your needs
 
  
  
* [[Protege4NamingAndRendering|Naming and rendering of entities]] a note on naming things in OWL and configuring P4 to support your naming conventions
+
== Frequently asked questions ==
* [[Protege4ExpressionEditor | P4 expression editor]] adding and editing OWL expressions in P4
 
* [[Manchester_OWL_Syntax|Manchester OWL Syntax]] an overview of the default syntax used by P4
 
* [[DLQueryTab | DL Query tab]] how to query using arbitrary class expressions in OWL
 
* [[P4AnonymousClasses|Anonymous classes]] support in P4 for class expressions
 
  
 +
We've put together a wiki page to answer the [[Protege-OWL_4_FAQ | most commonly asked questions]] about Protege Desktop.
  
* [[How_Owl_Imports_Work|OWL Imports]] modular ontology support in OWL and P4
 
* [[Protege4AxiomAnnotations|Axiom annotations]] how to annotate at axiom level in P4
 
  
 +
== Getting started / tutorials ==
  
=== Further setup / configuration ===
+
The Getting started and tutorials have been moved to the [[Main_Page|main page]] of the wiki.
* [[ChangingTheHeapSize|Adding more memory]]
 
*  [[EnablingDoubleClick|Double-clicking on OWL files]]
 
  
<br />
 
  
== Protege 4 Plugins ==
+
== Editor features ==
  
=== Finding Plugins ===
+
* [[Protege4Features | Overview of features]] - a quick summary of the editor
* From build 104 P4 will find plugins and updates for you. See our [[EnablePluginAutoUpdate|Auto Update]] page.
+
* [[Protege4Views | Protege views guide]] - a list of all of the default views that are distributed with Protege
 +
* [[Protege4Shortcuts | Protege menu guide]] - all of the default menus explained in detail (with keyboard shortcuts)
 +
* [[Protege4Preferences | Protege preferences guide]] - customizing Protege to your needs
 +
* [[Protege4NamingAndRendering|Naming and rendering of entities]] - a note on naming things in OWL and configuring Protege to support your naming conventions
 +
* [[Protege4ExpressionEditor | Protege expression editor]] - adding and editing OWL expressions in Protege
 +
* [[Manchester_OWL_Syntax|Manchester OWL Syntax]] - an overview of the default syntax used by Protege
 +
* [[DLQueryTab | DL Query tab]] - how to query using arbitrary class expressions in OWL
 +
* [[Importing_Ontologies_in_P41|OWL Imports]] -  modular ontology support in OWL and Protege
 +
* [[Protege4AxiomAnnotations|Axiom annotations]] - how to annotate at axiom level in Protege
 +
* [[Protege4OWLDiff|Protege OWL Diff]] - compare two versions of an ontology
  
* [[Protege-OWL_4.0 | Plugins for Protege 4.x OWL editor]] - the list of "Compatible Plugins" on this page is the result of a semantic query that gathers all plug-ins that have declared themselves compatible with the 4.x version of the Protege-OWL editor.
+
== Advanced features ==
  
* [http://www.co-ode.org/downloads/protege-x/plugins/ CO-ODE Protege 4.x Plugins] - the CO-ODE group at the University of Manchester is the biggest contributor of plug-ins to the Protege-OWL editor. This is a good place to go to download early releases and source code for CO-ODE developed plug-ins.
+
* [[BeanShell | The Bean Shell]] - Making complex queries against an ontology.
 +
* [[Protege4ClientServer | The Protege 4 Server]]
  
=== Advertising Plugins ===
 
If you have developed a plug-in for Protege-OWL 4.0 and you would like to contribute it to the community, please see [[Protege4Contributing#Plugins| Contributing plugins]]
 
  
== Protege 4 Status ==
+
== Further setup / configuration ==
  
=== Beta announcement ===
+
* [[ChangingTheHeapSize|Adding more memory]]
We are pleased to announce that Protege 4 transitioned from alpha to beta on August 22, 2008.  '''[[Protege 4 beta announcement|(Read More)]]'''
+
* [[EnablingDoubleClick|Double-clicking on OWL files]]
 +
* [[ClearingP4Preferences|Dealing with Protege preferences problems]]
 +
* [[Working with firewalls and proxies]]
  
=== Release notes ===
 
To help you decide whether to update, [http://protege.stanford.edu/download/protege4/release-notes.html release notes] exist for all updates to each successive release.
 
  
=== Bugs and feature requests ===
+
== Plugins ==
If you have a new request or potential bug, please first check the lists below as it may have already been reported.
 
  
If the item is not currently open or you have further information or a question about an existing item, please post a message on the [http://mailman.stanford.edu/mailman/listinfo/p4-feedback Protege 4 mailing list].
+
=== Finding plug-ins ===
  
Please give as much detail as possible (including examples or ontologies if possible) as this will help us track things down more quickly.
+
* Protege will find plugins and updates for you. See our [[EnablePluginAutoUpdate|Auto Update]] page.
  
* [https://bmir-gforge.stanford.edu/gf/project/owleditor/tracker/?action=TrackerItemBrowse&tracker_id=121 Feature request tracker] - a searchable list of features that have been requested (and implemented)
+
* [[Protege-OWL_4.0 | Plugins for Protege]] - the list of all plugins compatible with different versions is available [[Protege_Plugin_Library|here]].
  
* [https://bmir-gforge.stanford.edu/gf/project/owleditor/tracker/?action=TrackerItemBrowse&tracker_id=118 Bugtracker] - a searchable list of reported and resolved bugs
+
* [https://github.com/co-ode-owl-plugins CO-ODE Protege Plugins] - the CO-ODE group at the University of Manchester is the biggest contributor of plug-ins to the Protege editor. The CO-ODE plugins that are compatible with your installation of Protege will show up when going in the File menu -> Check for plugins
  
=== Documentation TODO list ===
+
=== Advertising plug-ins ===
To follow is list of considerations for improving Protege 4 itself, Protege 4 documentation, and this wiki.
 
  
* Convert [http://www.co-ode.org/resources/tutorials/protege-owl-tutorial.php A Practical Guide Guide to Building Ontologies...] to a collection of Wiki pages so that the guide can be more easily shared, searched, modified, commented on, referenced by section, extended, etc.
+
If you have developed a plug-in for Protege and you would like to contribute it to the community,
 +
please see [[Protege4Contributing#Plugins|contributing plugins]].
  
  
== Contributing to Protege 4 ==
+
== Contributing ==
  
 
Please see this page for details on how you can [[Protege4Contributing|contribute]].
 
Please see this page for details on how you can [[Protege4Contributing|contribute]].

Latest revision as of 14:19, December 22, 2021

Protege Desktop User Documentation

This page is the official documentation home for the Protege Desktop application versions 4, 5 and higher.



Build status & release notes

The latest version of Protege Desktop is 5.5:

You may also download previous versions of Protege and read the complete list of release notes. Older Protege 5.0 beta release notes are available here.

Bugs & feature requests

Before you report a bug or feature request, check the Protege mailing lists archives to ensure it hasn't already been reported. If the item is not currently open or you have further information or a question about an existing item, please post a message on the protege-user mailing list. Give as much detail as possible (including examples or ontologies if possible) as this will help us track things down more quickly.

Current GitHub issue tracker: https://github.com/protegeproject/protege/issues?state=open


Frequently asked questions

We've put together a wiki page to answer the most commonly asked questions about Protege Desktop.


Getting started / tutorials

The Getting started and tutorials have been moved to the main page of the wiki.


Editor features

Advanced features


Further setup / configuration


Plugins

Finding plug-ins

  • Protege will find plugins and updates for you. See our Auto Update page.
  • CO-ODE Protege Plugins - the CO-ODE group at the University of Manchester is the biggest contributor of plug-ins to the Protege editor. The CO-ODE plugins that are compatible with your installation of Protege will show up when going in the File menu -> Check for plugins

Advertising plug-ins

If you have developed a plug-in for Protege and you would like to contribute it to the community, please see contributing plugins.


Contributing

Please see this page for details on how you can contribute.