Difference between revisions of "Changes Tab"
m (→Clean-up of the Changes Ontology) |
(added how to use the ChAO in db mode) |
||
| Line 28: | Line 28: | ||
Documentation for the Changes Tab (including how to use this tab in client-server mode) is available in the form of a PDF document: http://smi-protege.stanford.edu/svn/change-management/trunk/docs/ChangesDoc.pdf | Documentation for the Changes Tab (including how to use this tab in client-server mode) is available in the form of a PDF document: http://smi-protege.stanford.edu/svn/change-management/trunk/docs/ChangesDoc.pdf | ||
| + | === How to store the Changes and Annotations ontology in a database === | ||
| − | === Clean | + | If you have an existing changes and annotation ontology (ChAO) associated to your project, then it is probably stored as RDF(S) files. For example, if you enabled the Changes Tab for the pizza.pprj project, then you would see in the pizza folder the following files: |
| + | |||
| + | <code><pre> | ||
| + | pizza_folder | ||
| + | |____pizza.pprj | ||
| + | |____annotation_pizza.pprj | ||
| + | |____annotation_pizza.rdfs | ||
| + | |____annotation_pizza.rdf | ||
| + | </pre></code> | ||
| + | |||
| + | Starting with '''Protege 3.4 beta 507''', it is possible to store the ChAO ontology using the database backend. For this, you only need to convert the existing annotations project to use the "Protege database" backend. Step-by-step guide on the pizza example from above: | ||
| + | |||
| + | # Open the annotation_pizza.pprj in Protege | ||
| + | # File menu -> Convert Project to Format... select "Protege Database" | ||
| + | # Follow the wizard steps. You will need to enter the db table name, driver, url, etc. | ||
| + | # Save using the same project name - so override the old pprj file (in the example, annotation_pizza.pprj) | ||
| + | |||
| + | To avoid confusion you can move or delete the old rdfs and rdf files (annotation_pizza.rdfs, annotation_pizza.rdf). This is only an optional step. | ||
| + | |||
| + | The next time you start Protege with the Changes Tab or with [http://protege.stanford.edu/doc/collab-protege/ Collaborative Protege], it will use the new database backed changes and annotation ontology. | ||
| + | |||
| + | |||
| + | === Clean up of the Changes Ontology === | ||
Starting with Protege 3.4 beta 129, we have added a new feature available through the Changes menu (which is activated when the ChangesTab is visible). Users are able to delete from the Changes ontology the change instances and/or the annotation instances. The user is also able to create an archive of the current Changes ontology before the delete operation. | Starting with Protege 3.4 beta 129, we have added a new feature available through the Changes menu (which is activated when the ChangesTab is visible). Users are able to delete from the Changes ontology the change instances and/or the annotation instances. The user is also able to create an archive of the current Changes ontology before the delete operation. | ||
Revision as of 23:17, October 13, 2008
Changes Tab
| Type | Tab Widget |
| Author(s) | William Liu, Tania Tudorache, Timothy Redmond |
| Last Update | 2008/01/09 |
| License | Mozilla Public License |
| Homepage | Changes Tab website |
| For Application | |
| Topic(s) | |
| Affiliation |
Allows users to track and annotate changes to Protege ontologies.
Contents
Versions & Compatibility
This section lists available versions of Changes Tab.
| Version | Compatible with | Dependencies |
|---|---|---|
| Changes Tab 1.0 | Protege-Frames 3.4.4 Protege-OWL 3.4.4 Protege Client-Server 3.4.4 |
If you click on the button below to add a new version of Changes Tab, you will be asked to define a page title for the new version. Please adhere to the naming convention of Changes Tab X.X.X when you define the new page!
Changelog
| Version | Changes in this version |
|---|---|
| Changes Tab 1.0 | no release notes were maintained for this version |
More Information
Installation
The Changes Tab is bundled with the "full" installation of Protege.
Source Code
The source code for the Changes Tab is available in the Protege Subversion repository: http://smi-protege.stanford.edu/svn/change-management/trunk/.
Documentation
Documentation for the Changes Tab (including how to use this tab in client-server mode) is available in the form of a PDF document: http://smi-protege.stanford.edu/svn/change-management/trunk/docs/ChangesDoc.pdf
How to store the Changes and Annotations ontology in a database
If you have an existing changes and annotation ontology (ChAO) associated to your project, then it is probably stored as RDF(S) files. For example, if you enabled the Changes Tab for the pizza.pprj project, then you would see in the pizza folder the following files:
pizza_folder
|____pizza.pprj
|____annotation_pizza.pprj
|____annotation_pizza.rdfs
|____annotation_pizza.rdf
Starting with Protege 3.4 beta 507, it is possible to store the ChAO ontology using the database backend. For this, you only need to convert the existing annotations project to use the "Protege database" backend. Step-by-step guide on the pizza example from above:
- Open the annotation_pizza.pprj in Protege
- File menu -> Convert Project to Format... select "Protege Database"
- Follow the wizard steps. You will need to enter the db table name, driver, url, etc.
- Save using the same project name - so override the old pprj file (in the example, annotation_pizza.pprj)
To avoid confusion you can move or delete the old rdfs and rdf files (annotation_pizza.rdfs, annotation_pizza.rdf). This is only an optional step.
The next time you start Protege with the Changes Tab or with Collaborative Protege, it will use the new database backed changes and annotation ontology.
Clean up of the Changes Ontology
Starting with Protege 3.4 beta 129, we have added a new feature available through the Changes menu (which is activated when the ChangesTab is visible). Users are able to delete from the Changes ontology the change instances and/or the annotation instances. The user is also able to create an archive of the current Changes ontology before the delete operation.
This feature is available by going in the Changes Menu -> Clean-up Changes Ontology. The following dialog will come up:
- If the user selects Delete annotations - then all the annotations in the Changes ontology will be deleted.
- If the user selects Delete changes - then all the changes in the Changes ontology will be deleted.
- If the user selects Archive changes ontology before deleting - then an archive of the current version of the Changes ontology will be created before the deletion takes place. The archive will be saved in a subdirectory of the folder where the Changes ontology resides. The subfolder will have the name "annotation_prjName.parc" (prjName is the name of the main project). Inside this folder multiple archives (from different times) of the Changes ontology may be present. The subfolders of the "parc" folder are named using the date and time of the archival. For example, if the archival of the Changes ontolog of pizza (annotation_pizza.pprj) took place at 2008-03-13 at 10:03:04, then the following folder strcuture will be created:
annotation_pizza.parc
|___ 2008.03.14_10.03.04
|____annotation_pizza.pprj
|____annotation_pizza.rdfs
|____annotation_pizza.rdf
Make sure to save the Changes ontology to make the modifications permanent. You can save the Changes ontology, either from Changes Menu -> Save Changes Ontology, or by saving the domain project (File menu -> Save).
Note: This functionality is available in stand-alone mode. In client-server mode, the "Clean-up changes ontology" will not be available.
Level of Support
Please post questions about the Changes Tab on the protege-discussion mailing list.
