Difference between revisions of "ProtegeDesktopUserDocs"

From Protege Wiki
Jump to: navigation, search
(→‎Adding Plugins)
 
(134 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
<div class="orangeBox">
+
= Protege Desktop User Documentation =
−
<span class="orangeBoxTitle">Protege 4.x 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 alpha and we are interested in soliciting your feedback.  We 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__
  
−
== General ==
 
  
−
=== Protege 4 "to do" list ===
+
== Build status & release notes ==
 +
 
 +
The latest version of Protege Desktop is '''5.5''':
 +
 
 +
* [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]
 +
 
 +
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]].
 +
 
 +
== Bugs & feature requests ==
 +
 
 +
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.
 +
 
 +
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 [[Protege-OWL_4_FAQ | most commonly asked questions]] about Protege Desktop.
 +
 
 +
 
 +
== Getting started / tutorials ==
 +
 
 +
The Getting started and tutorials have been moved to the [[Main_Page|main page]] of the wiki.
 +
 
 +
 
 +
== Editor features ==
 +
 
 +
* [[Protege4Features | Overview of features]] - a quick summary of the editor
 +
* [[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
  
−
Below is a "to-do" list of things that we are working on integrating into Protege 4.  Please note that these items are not listed in any particular order of priority.  If you have a question about the status of any line item, please post a message on the [http://mailman.stanford.edu/mailman/listinfo/p4-feedback Protege 4 mailing list].
+
== Advanced features ==
  
−
* Protege-Frames editor (currently we only have the OWL editor)
+
* [[BeanShell | The Bean Shell]] - Making complex queries against an ontology.
−
* Protege Web client
+
* [[Protege4ClientServer | The Protege 4 Server]]
−
* Protege Services
 
−
* Client-server support
 
−
* Better SWRL support in the Protege-OWL editor
 
−
* Better modularization support
 
−
* Support for collaborative ontology development
 
−
* Forms and browser slot patterns in the Protege-OWL editor
 
−
* A database back-end
 
  
  
−
== User Interface ==
+
== Further setup / configuration ==
  
−
=== Protege-OWL ===
+
* [[ChangingTheHeapSize|Adding more memory]]
 +
* [[EnablingDoubleClick|Double-clicking on OWL files]]
 +
* [[ClearingP4Preferences|Dealing with Protege preferences problems]]
 +
* [[Working with firewalls and proxies]]
  
−
* [[Protege4GettingStarted | Getting started with the Protege-OWL editor]]
 
−
* [[Protege4Features | Overview of new features in the Protege-OWL editor]]
 
−
* [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] (<strong>[[Protege4TutorialErrata|errata page]]</strong>)
 
−
* [[Protege4Shortcuts | Menu and keyboard shortcuts]]
 
−
* [[DLQueryTab | DL Query tab]]
 
−
* [[Manchester_OWL_Syntax|Manchester OWL Syntax]]
 
−
* [[How_Owl_Imports_Work|OWL Imports]]
 
  
−
== Viewing and Adding Plug-ins to the Wiki ==
+
== Plugins ==
  
−
=== Protege-OWL ===
+
=== Finding plug-ins ===
  
−
==== Viewing Plugins ====
+
* Protege will find plugins and updates for you. See our [[EnablePluginAutoUpdate|Auto Update]] page.
  
−
To see a listing of plug-ins specific to the Protege-OWL editor, go to the Wiki article for the [[Protege-OWL_4.0 | 4.x version of the Protege-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.
+
* [[Protege-OWL_4.0 | Plugins for Protege]] - the list of all plugins compatible with different versions is available [[Protege_Plugin_Library|here]].
  
−
The CO-ODE group at the University of Manchester is the biggest contributor of plug-ins to the Protege-OWL editor.  As such, users may be interested to look at the [http://www.co-ode.org/downloads/protege-x/plugins/ Protege 4 Plugins] page on the CO-ODE Web site, which a listing of only those plug-ins developed at the University of Manchester.  This is a good place to go to download the source code for CO-ODE developed plug-ins.
+
* [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
  
−
==== Adding Plugins ====
+
=== Advertising plug-ins ===
  
−
If you have developed a plug-in for Protege-OWL 4.0 and you would like to contribute it to the community, follow the following steps:
+
If you have developed a plug-in for Protege and you would like to contribute it to the community,
−
* Click the [[Special:AddPage/Form:Plugin|New Plugin Link]].  You may want to right click and choose a new window.
+
please see [[Protege4Contributing#Plugins|contributing plugins]].
−
* Choose a name for the page  that  discusses the new plugin (e.g. "Sub Ontology Tab").
 
−
* Click "Add or Edit"
 
−
* Be sure to add  "Protege-OWL" (exactly like so without the quotes) in the Works with field.  Also give the plugin a type (commonly "Tab Widget").
 
−
* Fill in the other fields and save.
 
−
* Click the create new version and use the naming convention described.  Without this step the plugin will not show up in the plugin list below.
 
−
* Make the plugin compatible with "Protege-OWL 4.0".
 
−
* When you are done save the page and make sure that your plugin shows up on the [[Protege-OWL_4.0 |4.x version of the Protege-OWL editor]] page.  It seems for some reason this page often does not update for a while so you may need to come back later.
 
−
Some useful links when adding a plugin page to the wiki are the following:
 
−
* [[Organization]] shows all the types of organizations that are currently known.  There are some duplicates already.
 
−
* [[Category:Plugin]] is useful because it lists both the different plugin types (e.g. view, import, export, etc) and also has a list of all the plugins currently known.
 
−
* [[Category:Person|People]] lists the people who are known to this ontology.
 
  
−
== Wish list ==
 
  
−
To follow is list of considerations for improving Protege 4, its documentation, and/or this Wiki.
+
== Contributing ==
  
−
* 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.
+
Please see this page for details on how you can [[Protege4Contributing|contribute]].
−
* Consider an "Add Tab" feature in the Tabs menu that would allow users to add an empty tab (e.g., "My Tab"), and thus have a place to assemble personal layouts from a clean starting point.  Perhaps provide a minimum of one empty "My Tab" in the user interface.
 

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.

Retrieved from "https://protegewiki.stanford.edu/index.php?title=ProtegeDesktopUserDocs&oldid=13776"