Difference between revisions of "Collaborative Protege"
Line 1: | Line 1: | ||
{{Plugin | {{Plugin | ||
− | |Description=Collaborative Protégé is an extension of the existing Protégé system that supports collaborative ontology editing. In addition to the common ontology editing operations, it enables annotation of both ontology components and ontology changes. It supports the searching and filtering of user annotations based on different criteria. | + | |Description=Collaborative Protégé is an extension of the existing Protégé system that supports collaborative ontology editing. In addition to the common ontology editing operations, it enables annotation of both ontology components and ontology changes. It supports the searching and filtering of user annotations based on different criteria. |
|PluginType=Project | |PluginType=Project | ||
|ForApplication1=Protege-Frames | |ForApplication1=Protege-Frames | ||
Line 30: | Line 30: | ||
Collaborative Protégé is distributed with the full installation of Protégé starting with Protégé version 3.3 beta399. You may use Collaborative Protégé both in stand-alone mode and in multi-user mode. The installation guide will use as an example the Newspaper project distributed in the examples/newspaper folder in the Protégé installation directory. | Collaborative Protégé is distributed with the full installation of Protégé starting with Protégé version 3.3 beta399. You may use Collaborative Protégé both in stand-alone mode and in multi-user mode. The installation guide will use as an example the Newspaper project distributed in the examples/newspaper folder in the Protégé installation directory. | ||
− | Stand-alone mode | + | '''Stand-alone mode''' |
1. Install the full distribution of the latest version of Protégé. | 1. Install the full distribution of the latest version of Protégé. | ||
− | |||
2. Start Protégé. | 2. Start Protégé. | ||
− | |||
3. Open the newspaper.pprj project from the examples/newspaper folder in the Protégé installation directory. | 3. Open the newspaper.pprj project from the examples/newspaper folder in the Protégé installation directory. | ||
− | |||
4. Enable the ChangesTab from the Project -> Configure menu. | 4. Enable the ChangesTab from the Project -> Configure menu. | ||
− | |||
5. In the Project -> Configure -> Options panel enable the Track changes checkbox. Click on OK and exit the Configuration panel. | 5. In the Project -> Configure -> Options panel enable the Track changes checkbox. Click on OK and exit the Configuration panel. | ||
− | |||
6. Disable the ChangesTab from the Project -> Configure menu. | 6. Disable the ChangesTab from the Project -> Configure menu. | ||
− | |||
7. Save the project. Check in the examples/newspaper folder that a project annotation_newspaper.pprj was created. | 7. Save the project. Check in the examples/newspaper folder that a project annotation_newspaper.pprj was created. | ||
− | |||
8. Close the project and reopen it. You should see the collaborative panel. | 8. Close the project and reopen it. You should see the collaborative panel. | ||
− | Multi-user mode | + | '''Multi-user mode''' |
If you want to use Collaborative Protégé in multi-user mode, you will need to do some additional steps. | If you want to use Collaborative Protégé in multi-user mode, you will need to do some additional steps. | ||
1. Do all the steps for the installation in Stand-alone mode. | 1. Do all the steps for the installation in Stand-alone mode. | ||
− | |||
2. Open the metaproject.pprj project from the examples/server folder in the Protégé installation directory. | 2. Open the metaproject.pprj project from the examples/server folder in the Protégé installation directory. | ||
− | |||
3. In the ClsesTab, select the class Project and create a new template slot called annotationProject. | 3. In the ClsesTab, select the class Project and create a new template slot called annotationProject. | ||
The slot should have value type Instance and allowed classes Project. | The slot should have value type Instance and allowed classes Project. | ||
− | |||
4. In the InstanceTab, create a new instance of Project for the annotation_newspaper.pprj. | 4. In the InstanceTab, create a new instance of Project for the annotation_newspaper.pprj. | ||
The name of the instance is not important. The location slot should point to the location of | The name of the instance is not important. The location slot should point to the location of | ||
the annotation project. For this example, the value of the location slot should be: | the annotation project. For this example, the value of the location slot should be: | ||
examples/newspaper/annotation_newspaper.pprj. | examples/newspaper/annotation_newspaper.pprj. | ||
− | |||
5. Select the Newspaper instance and set as value of annotationProject slot the Project instance | 5. Select the Newspaper instance and set as value of annotationProject slot the Project instance | ||
created in the previous step. | created in the previous step. | ||
− | |||
6. Save the project and close Protégé. | 6. Save the project and close Protégé. | ||
− | Test the Protégé server and client: | + | '''Test the Protégé server and client:''' |
1. Start the Protégé server by using the run_protege_server start script. | 1. Start the Protégé server by using the run_protege_server start script. | ||
− | |||
2. Start a Protégé client: Start Protégé and select the Server mode in the Open Project dialog. | 2. Start a Protégé client: Start Protégé and select the Server mode in the Open Project dialog. | ||
− | |||
3. In the Server panel, leave all the default entries like they are. | 3. In the Server panel, leave all the default entries like they are. | ||
(Hostname: localhost, User: Guest, Password: guest). Click on OK. | (Hostname: localhost, User: Guest, Password: guest). Click on OK. | ||
− | |||
4. In the Select Project panel, select the Newspaper project. When the project is displayed, | 4. In the Select Project panel, select the Newspaper project. When the project is displayed, | ||
you should see also the collaborative pabel. | you should see also the collaborative pabel. |
Revision as of 14:42, October 20, 2008
Collaborative Protege
Collaborative Protégé is an extension of the existing Protégé system that supports collaborative ontology editing. In addition to the common ontology editing operations, it enables annotation of both ontology components and ontology changes. It supports the searching and filtering of user annotations based on different criteria.
Versions & Compatibility
This section lists available versions of Collaborative Protege.
No version information available.
If you click on the button below to add a new version of Collaborative Protege, you will be asked to define a page title for the new version. Please adhere to the naming convention of Collaborative Protege X.X.X when you define the new page!
Changelog
No version information available.
More Details
In Collaborative Protégé we have implemented two types of voting mechanisms that can be used for voting of change proposals. Multiple users may edit the same ontology at the same time. In multi-user mode, all changes made by one user are seen immediately by other users.There are two working modes available for Collaborative Protégé. Both modes support multiple users working on an ontology:
1. The multi-user mode - allows mutiple clients to edit simultaneously the same ontology hosted on a Protégé server. All changes made by one client are immediately visible by other clients. This mode is also referred to as client-server mode, or concurrent mode and requires a client-server setup. This mode is based on the implementation of the multi-user Protégé and is the preferred mode in which Collaborative Protégé should be run.
2. The standalone mode - allows multiple users to access the same ontology in succession. The ontology can be stored on a shared netword drive and all clients will access the same project files. However, simultaneous access is not possible. This mode is also referred to as the consecutive mode.
This user guide applies to both multi-user and standalone mode of Collaborative Protégé.
Installation Guide
Collaborative Protégé is distributed with the full installation of Protégé starting with Protégé version 3.3 beta399. You may use Collaborative Protégé both in stand-alone mode and in multi-user mode. The installation guide will use as an example the Newspaper project distributed in the examples/newspaper folder in the Protégé installation directory.
Stand-alone mode
1. Install the full distribution of the latest version of Protégé. 2. Start Protégé. 3. Open the newspaper.pprj project from the examples/newspaper folder in the Protégé installation directory. 4. Enable the ChangesTab from the Project -> Configure menu. 5. In the Project -> Configure -> Options panel enable the Track changes checkbox. Click on OK and exit the Configuration panel. 6. Disable the ChangesTab from the Project -> Configure menu. 7. Save the project. Check in the examples/newspaper folder that a project annotation_newspaper.pprj was created. 8. Close the project and reopen it. You should see the collaborative panel.
Multi-user mode
If you want to use Collaborative Protégé in multi-user mode, you will need to do some additional steps.
1. Do all the steps for the installation in Stand-alone mode. 2. Open the metaproject.pprj project from the examples/server folder in the Protégé installation directory. 3. In the ClsesTab, select the class Project and create a new template slot called annotationProject. The slot should have value type Instance and allowed classes Project. 4. In the InstanceTab, create a new instance of Project for the annotation_newspaper.pprj. The name of the instance is not important. The location slot should point to the location of the annotation project. For this example, the value of the location slot should be: examples/newspaper/annotation_newspaper.pprj. 5. Select the Newspaper instance and set as value of annotationProject slot the Project instance created in the previous step. 6. Save the project and close Protégé.
Test the Protégé server and client:
1. Start the Protégé server by using the run_protege_server start script. 2. Start a Protégé client: Start Protégé and select the Server mode in the Open Project dialog. 3. In the Server panel, leave all the default entries like they are. (Hostname: localhost, User: Guest, Password: guest). Click on OK. 4. In the Select Project panel, select the Newspaper project. When the project is displayed, you should see also the collaborative pabel.
Collaborative Protege is documented on the main Protege Website: http://protege.stanford.edu/doc/collab-protege/.