Difference between revisions of "PrF UG classes editing a class"

From Protege Wiki
Jump to: navigation, search
 
(6 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
== Editing a Class ==
 
== Editing a Class ==
  
{{PrF_UG_TOC_classes}}<div id='prf_ug'>
+
<noinclude>{{PrF_UG_TOC_classes}}<div id='prf_ug'></noinclude>
  
 
Using the [[PrF_UG_classes_class_editor|Class Editor]],
 
Using the [[PrF_UG_classes_class_editor|Class Editor]],
Line 8: Line 8:
 
name, notes, or template slot fields.
 
name, notes, or template slot fields.
  
<div>[[Image:PrF_UG_classes_class_editor.png|classes_class_editor]]</div>
+
<imagemap>
 +
Image:PrF_UG_classes_class_editor.png|frame|none|Class Editor
 +
rect 462  61 685 170 [[#Changing_Constraints        |Changing Constraints]]
 +
rect 237  62 457 174 [[#Changing_Class_Documentation |Changing Class Documentation]]
 +
rect  3  59 234 115 [[#Changing_the_Name_of_a_Class |Changing the Name of a Class]]
 +
rect 600  21 685  48 [[#Working_with_Class_Notes    |Working with Class Notes]]
 +
rect  5 120 233 172 [[#Changing_the_Role_of_a_Class |Changing the Role of a Class]]
 +
rect  6 179 691 488 [[#Working_with_Template_Slots  |Working with Template Slots]]
 +
desc none
 +
</imagemap>
  
 
Any changes you enter into the Class Editor take effect immediately.
 
Any changes you enter into the Class Editor take effect immediately.
Line 16: Line 25:
 
close {{#var:PrF}} without saving changes.
 
close {{#var:PrF}} without saving changes.
 
If you have made extensive changes to your knowledge base during the current session,
 
If you have made extensive changes to your knowledge base during the current session,
you may wish to
+
you may wish to [[PrF_UG_projects_saving_a_project|save]]
[[PrF_UG_projects_saving_a_project|save]]
+
or [[PrF_UG_projects_archive_project|archive]] the project
or
+
before editing classes.
[[PrF_UG_projects_archive_project|archive]]
 
the project before editing classes.
 
  
 
=== Working with Class Notes ===
 
=== Working with Class Notes ===
  
The
+
The [[PrF_UG_windows_yellow_stickies|note]] icons
[[PrF_UG_windows_yellow_stickies|note]]
+
([[Image:PrF_UG_windows_class_note.hide.gif|windows_class_note.hide]],
icons
+
[[Image:PrF_UG_windows_class_note.create.gif|windows_class_note.create]],
<div>[[Image:PrF_UG_windows_class_note.hide.gif|windows_class_note.hide]]</div>
+
[[Image:PrF_UG_windows_class_note.delete.gif|windows_class_note.delete]])
[[Image:PrF_UG_windows_class_note.create.gif|windows_class_note.create]]
 
[[Image:PrF_UG_windows_class_note.delete.gif|windows_class_note.delete]]
 
 
at the upper right of the Editor allow you work with class sticky notes.
 
at the upper right of the Editor allow you work with class sticky notes.
These notes,
+
These notes, which are not part of your ontology,
which are not part of your ontology,
+
can be used for todos or communication
can be used for todos or communication while you are developing your knowledge base.
+
while you are developing your knowledge base.
  
 
<ul class='a'>
 
<ul class='a'>
Line 39: Line 44:
 
     To hide or show all class notes,
 
     To hide or show all class notes,
 
     click the <b>Hide Class Notes</b>
 
     click the <b>Hide Class Notes</b>
     [[Image:PrF_UG_windows_class_note.hide.gif|windows_class_note.hide]]
+
     ([[Image:PrF_UG_windows_class_note.hide.gif|windows_class_note.hide]]) button.
    button.
 
 
     </p>
 
     </p>
  
Line 46: Line 50:
 
     To create a note for the current class,
 
     To create a note for the current class,
 
     click the <b>Create Class Note</b>
 
     click the <b>Create Class Note</b>
     [[Image:PrF_UG_windows_class_note.create.gif|windows_class_note.create]]
+
     ([[Image:PrF_UG_windows_class_note.create.gif|windows_class_note.create]]) button.
    button.
 
 
     </p>
 
     </p>
  
Line 53: Line 56:
 
     To delete a note from the current class,
 
     To delete a note from the current class,
 
     click the <b>Delete Class Note</b>
 
     click the <b>Delete Class Note</b>
     [[Image:PrF_UG_windows_class_note.delete.gif|windows_class_note.delete]]
+
     ([[Image:PrF_UG_windows_class_note.delete.gif|windows_class_note.delete]]) button
     button and then select the note from the list.
+
     and then select the note from the list.
 
     </p>
 
     </p>
 
</ul>
 
</ul>
  
 
For more information,
 
For more information,
see
+
see [[PrF_UG_windows_yellow_stickies|Working with Notes]].
[[PrF_UG_windows_yellow_stickies|Working with Notes]].
 
  
 
Notes are not available when working with the Editor as a free-standing window.
 
Notes are not available when working with the Editor as a free-standing window.
Line 80: Line 82:
 
</ul>
 
</ul>
  
<b>Note:</b> A recommended convention is to make the first character of each word in a class name uppercase and the rest lowercase,
+
<b>Note:</b>
 +
A recommended convention is to make the first character of each word
 +
in a class name uppercase and the rest lowercase,
 
and to separate words by underscores.
 
and to separate words by underscores.
  
Line 88: Line 92:
 
Concrete classes may have direct instances,
 
Concrete classes may have direct instances,
 
but do not have to;
 
but do not have to;
abstract classes cannot have direct instances. {{#var:PrF}} does not impose any restrictions on the role of your classes.
+
abstract classes cannot have direct instances.
 +
{{#var:PrF}} does not impose any restrictions on the role of your classes.
  
 
=== Changing Constraints ===
 
=== Changing Constraints ===
  
 
Class constraints are defined programmatically.
 
Class constraints are defined programmatically.
See
+
See [[PrF_UG_classes_constraints|Constraints]]
[[PrF_UG_classes_constraints|Constraints]]
 
 
for more information.
 
for more information.
  
Line 104: Line 108:
 
=== Working with Template Slots ===
 
=== Working with Template Slots ===
  
The
+
The [[PrF_UG_classes_template_slot_buttons|Template Slot buttons]]
[[PrF_UG_classes_template_slot_buttons|Template Slot buttons]]
+
at the [[PrF_UG_classes_template_slot_pane|Template Slots pane]]
at the
 
[[PrF_UG_classes_template_slot_pane|Template Slots pane]]
 
 
allow you to:
 
allow you to:
  
Line 114: Line 116:
 
     [[PrF_UG_slots_edit_top_level|edit a slot at the top level]]
 
     [[PrF_UG_slots_edit_top_level|edit a slot at the top level]]
 
     using the <b>View Top-level Slot</b>
 
     using the <b>View Top-level Slot</b>
     [[Image:PrF_UG_slots_slot.view_top_level.gif|slots_slot.view_top_level]]
+
     ([[Image:PrF_UG_slots_slot.view_top_level.gif|slots_slot.view_top_level]]) button.
    button.
 
 
     </p>
 
     </p>
  
Line 121: Line 122:
 
     [[PrF_UG_slots_override_slot|override a slot at the class using]]
 
     [[PrF_UG_slots_override_slot|override a slot at the class using]]
 
     the <b>View Slot Overrides</b>
 
     the <b>View Slot Overrides</b>
     [[Image:PrF_UG_slots_slot.view_overrides.gif|slots_slot.view_overrides]]
+
     ([[Image:PrF_UG_slots_slot.view_overrides.gif|slots_slot.view_overrides]]) button;
    button;
 
 
     slots that have been overridden are displayed with an override
 
     slots that have been overridden are displayed with an override
     [[Image:PrF_UG_slots_slot.overridden.gif|slots_slot.overridden]]
+
     ([[Image:PrF_UG_slots_slot.overridden.gif|slots_slot.overridden]]) icon.
    icon.
 
 
     </p>
 
     </p>
  
Line 131: Line 130:
 
     [[PrF_UG_slots_create_slot|create]]
 
     [[PrF_UG_slots_create_slot|create]]
 
     a new slot using the <b>Create Slot</b>
 
     a new slot using the <b>Create Slot</b>
     [[Image:PrF_UG_slots_slot.create.gif|slots_slot.create]]
+
     ([[Image:PrF_UG_slots_slot.create.gif|slots_slot.create]]) button.
    button.
 
 
     </p>
 
     </p>
  
Line 138: Line 136:
 
     [[PrF_UG_slots_remove_slot_overrides|remove slot overrides]]
 
     [[PrF_UG_slots_remove_slot_overrides|remove slot overrides]]
 
     using the <b>Remove Slot Overrides</b>
 
     using the <b>Remove Slot Overrides</b>
     [[Image:PrF_UG_slots_slot.remove_overrides.gif|slots_slot.remove_overrides]]
+
     ([[Image:PrF_UG_slots_slot.remove_overrides.gif|slots_slot.remove_overrides]]) button.
    button.
 
 
     </p>
 
     </p>
  
Line 146: Line 143:
 
     to the class,
 
     to the class,
 
     using the <b>Add Slot</b>
 
     using the <b>Add Slot</b>
     [[Image:PrF_UG_slots_slot.add.gif|slots_slot.add]]
+
     ([[Image:PrF_UG_slots_slot.add.gif|slots_slot.add]]) button.
    button.
 
 
     </p>
 
     </p>
  
Line 153: Line 149:
 
     [[PrF_UG_slots_removing_a_slot|remove a slot]]
 
     [[PrF_UG_slots_removing_a_slot|remove a slot]]
 
     from the class using the <b>Remove Slot</b>
 
     from the class using the <b>Remove Slot</b>
     [[Image:PrF_UG_slots_slot.remove.gif|slots_slot.remove]]
+
     ([[Image:PrF_UG_slots_slot.remove.gif|slots_slot.remove]]) button;
    button;
 
 
     the slot is removed from the class,
 
     the slot is removed from the class,
 
     but still exists in the knowledge base.
 
     but still exists in the knowledge base.
Line 161: Line 156:
  
 
For more information about working with slots,
 
For more information about working with slots,
see the
+
see the [[PrF_UG_slots|Slots Table of Contents]].
[[PrF_UG_slots|Slots Table of Contents]].
 
  
 
=== Other Class Editing Operations ===
 
=== Other Class Editing Operations ===
Line 170: Line 164:
 
To view or edit the information for several classes at once,
 
To view or edit the information for several classes at once,
 
select the classes one by one and click the <b>View Class</b>
 
select the classes one by one and click the <b>View Class</b>
<div>[[Image:PrF_UG_classes_class.view.gif|classes_class.view]]</div>
+
([[Image:PrF_UG_classes_class.view.gif|classes_class.view]])
 
[[PrF_UG_classes_class_buttons|button]]
 
[[PrF_UG_classes_class_buttons|button]]
to open the
+
to open the [[PrF_UG_classes_class_editor|Class Editor]]
[[PrF_UG_classes_class_editor|Class Editor]]
 
 
for every selected class.
 
for every selected class.
 
Opening a new Class Editor does not close the previous editor.
 
Opening a new Class Editor does not close the previous editor.
Line 181: Line 174:
 
==== Changing Superclasses ====
 
==== Changing Superclasses ====
  
To change the superclasses of a class,
+
To change the superclasses of a class, see:
see:
 
 
[[PrF_UG_classes_add_superclass|Adding a Superclass]],
 
[[PrF_UG_classes_add_superclass|Adding a Superclass]],
 
[[PrF_UG_classes_replace_superclass|Replacing a Superclass]],
 
[[PrF_UG_classes_replace_superclass|Replacing a Superclass]],
and
+
and [[PrF_UG_classes_remove_superclass|Removing a Superclass]].
[[PrF_UG_classes_remove_superclass|Removing a Superclass]].
 
  
</div>
+
 
 +
<noinclude></div></noinclude>

Latest revision as of 17:31, November 13, 2008

Editing a Class


Protege-Frames User's Guide
Classes
Classes Tab
Class Browser
Class Buttons
Class Hierarchy Window
Class Icons
Class Menu
Class Search Bar
Superclasses Pane
Class Editor
Constraints
Template Slots Pane
Template Slot Buttons
References Window
Creating a New Class
Creating Multiple Subclasses
Deleting a Class
Displaying the Class Editor
Editing a Class
Editing Template Slots
Finding a Class
Hiding a Class
Replacing a Superclass
Adding a Superclass
Jumping to A Superclass
Removing a Superclass
Viewing Class Relations
Classes & Instances Tab
Viewing References
Glossary, Editing Help

Using the Class Editor, you can view or edit a class's constraints, documentation, name, notes, or template slot fields.

Changing ConstraintsChanging Class DocumentationChanging the Name of a ClassWorking with Class NotesChanging the Role of a ClassWorking with Template Slots
Class Editor

Any changes you enter into the Class Editor take effect immediately. To make the changes permanent, save the knowledge base by selecting Save from the Project menu. To revert to the last saved version, close Protege-Frames without saving changes. If you have made extensive changes to your knowledge base during the current session, you may wish to save or archive the project before editing classes.

Working with Class Notes

The note icons (windows_class_note.hide, windows_class_note.create, windows_class_note.delete) at the upper right of the Editor allow you work with class sticky notes. These notes, which are not part of your ontology, can be used for todos or communication while you are developing your knowledge base.

  • To hide or show all class notes, click the Hide Class Notes (windows_class_note.hide) button.

  • To create a note for the current class, click the Create Class Note (windows_class_note.create) button.

  • To delete a note from the current class, click the Delete Class Note (windows_class_note.delete) button and then select the note from the list.

For more information, see Working with Notes.

Notes are not available when working with the Editor as a free-standing window.

Changing the Name of a Class

To change the name of a class, edit the name in the Name field. The following rules apply to class names:

  • The name must be a unique frame name in the knowledge base.

  • Class names are case sensitive.

Note: A recommended convention is to make the first character of each word in a class name uppercase and the rest lowercase, and to separate words by underscores.

Changing the Role of a Class

Select the new role from the Role menu. Concrete classes may have direct instances, but do not have to; abstract classes cannot have direct instances. Protege-Frames does not impose any restrictions on the role of your classes.

Changing Constraints

Class constraints are defined programmatically. See Constraints for more information.

Changing Class Documentation

To change the notes for a class, change the text directly in the Class Documentation pane.

Working with Template Slots

The Template Slot buttons at the Template Slots pane allow you to:

For more information about working with slots, see the Slots Table of Contents.

Other Class Editing Operations

Viewing Multiple Classes

To view or edit the information for several classes at once, select the classes one by one and click the View Class (classes_class.view) button to open the Class Editor for every selected class. Opening a new Class Editor does not close the previous editor. This allows you to compare the attributes for two or more classes. Edits can be made directly in any open Class Editor.

Changing Superclasses

To change the superclasses of a class, see: Adding a Superclass, Replacing a Superclass, and Removing a Superclass.