Difference between revisions of "PrF UG classes class editor"
| (8 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
== The Class Editor == | == The Class Editor == | ||
| − | {{PrF_UG_TOC_classes}}<div id='prf_ug'> | + | <noinclude>{{PrF_UG_TOC_classes}}<div id='prf_ug'></noinclude> |
The Class Editor can be used to define and edit the attributes of a class. | The Class Editor can be used to define and edit the attributes of a class. | ||
Click on a link or an area of the picture to jump to a summary. | Click on a link or an area of the picture to jump to a summary. | ||
| − | See also | + | See also [[PrF_UG_classes_create_class|Creating a Class]], |
| − | [[PrF_UG_classes_create_class|Creating a Class]], | ||
[[PrF_UG_classes_view_class|Displaying the Class Editor]], | [[PrF_UG_classes_view_class|Displaying the Class Editor]], | ||
[[PrF_UG_classes_editing_a_class|Editing a Class]], | [[PrF_UG_classes_editing_a_class|Editing a Class]], | ||
| − | and | + | and [[PrF_UG_classes_edit_template_slots|Editing Template Slots]]. |
| − | [[PrF_UG_classes_edit_template_slots|Editing Template Slots]]. | ||
| − | < | + | <imagemap> |
| + | Image:PrF_UG_classes_class_editor.png|frame|none|Class Editor | ||
| + | rect 462 61 685 170 [[#The_Class_Constraints_Pane |The Class Constraints pane]] | ||
| + | rect 237 62 457 174 [[#The_Class_Documentation_Pane |The Class Documentation pane]] | ||
| + | rect 3 59 234 115 [[#The_Class_Name_Field |The Class Name field]] | ||
| + | rect 600 21 685 48 [[#Note_Icons |Note icons]] | ||
| + | rect 5 120 233 172 [[#The_Class_Role_Menu |The Class Role menu]] | ||
| + | rect 237 62 457 174 [[#The_Class_Documentation_Pane |The Class Documentation pane]] | ||
| + | rect 6 179 691 488 [[#The_Template_Slots_Pane |The Template Slots pane]] | ||
| + | desc none | ||
| + | </imagemap> | ||
=== Note Icons === | === Note Icons === | ||
| − | The | + | The [[PrF_UG_windows_yellow_stickies|note]] icons |
| − | [[PrF_UG_windows_yellow_stickies|note]] | ||
| − | icons | ||
([[Image:PrF_UG_windows_class_note.hide.gif|windows_class_note.hide]], | ([[Image:PrF_UG_windows_class_note.hide.gif|windows_class_note.hide]], | ||
[[Image:PrF_UG_windows_class_note.create.gif|windows_class_note.create]], | [[Image:PrF_UG_windows_class_note.create.gif|windows_class_note.create]], | ||
[[Image:PrF_UG_windows_class_note.delete.gif|windows_class_note.delete]]) | [[Image:PrF_UG_windows_class_note.delete.gif|windows_class_note.delete]]) | ||
at the upper right of the Editor allow you to work with class sticky notes. | at the upper right of the Editor allow you to 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 while you are developing your knowledge base. | can be used for todos or communication while you are developing your knowledge base. | ||
They can be hidden using the <b>Hide Class Notes</b> | They can be hidden using the <b>Hide Class Notes</b> | ||
| − | + | ([[Image:PrF_UG_windows_class_note.hide.gif|windows_class_note.hide]]) button. | |
| − | button. | + | For information on how to add notes to any frame (class, instance, or slot), |
| − | For information on how to add notes to any frame (class, | + | see [[PrF_UG_windows_yellow_stickies|Working with Notes]]. |
| − | instance, | ||
| − | or slot), | ||
| − | see | ||
| − | [[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 41: | Line 42: | ||
The Name field allows you to name your class. | The Name field allows you to name your class. | ||
| − | When a class is created, | + | When a class is created, it is given a default name, such as newspaper_Class_1. |
| − | it is given a default name, | ||
| − | such as newspaper_Class_1. | ||
You can change the name of a new or existing class by highlighting the name and overwriting it. | You can change the name of a new or existing class by highlighting the name and overwriting it. | ||
The following rules apply to class names: | The following rules apply to class names: | ||
| Line 57: | Line 56: | ||
</ul> | </ul> | ||
| − | A recommended convention is to make the first character of each word in a class name uppercase and the rest lowercase, | + | 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 with underscores. | and to separate words with underscores. | ||
| Line 75: | Line 75: | ||
</ul> | </ul> | ||
| − | {{#var:PrF}} sets the role to <b>Concrete</b>, | + | {{#var:PrF}} sets the role to <b>Concrete</b>, by default. |
| − | by default. {{#var:PrF}} does not impose any restrictions on the role of your classes. | + | {{#var:PrF}} does not impose any restrictions on the role of your classes. |
| − | One common modeling convention is to make all leaf | + | One common modeling convention |
| − | (bottom-level) | + | is to make all leaf (bottom-level) classes concrete, |
| − | classes concrete, | + | and all interior (higher-level, non-leaf) classes abstract. |
| − | and all interior | ||
| − | (higher-level, | ||
| − | non-leaf) | ||
| − | classes abstract. | ||
=== The Class Constraints Pane === | === The Class Constraints Pane === | ||
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. | ||
=== The Class Documentation Pane === | === The Class Documentation Pane === | ||
| − | The Class Documentation pane allows you to enter a text description of the class and other relevant information. | + | The Class Documentation pane allows you |
| + | to enter a text description of the class and other relevant information. | ||
These notes are part of your ontology. | These notes are part of your ontology. | ||
Filling in this field is optional, | Filling in this field is optional, | ||
| Line 102: | Line 98: | ||
The Template Slots pane displays the direct and inherited slots for the selected class. | The Template Slots pane displays the direct and inherited slots for the selected class. | ||
| − | Slots, | + | Slots, which represent properties of your class, |
| − | which represent properties of your class, | ||
are a crucial part of your knowledge base. | are a crucial part of your knowledge base. | ||
In the example, | In the example, | ||
<b>Editor</b> has several slots which appear in the Template Slots pane. | <b>Editor</b> has several slots which appear in the Template Slots pane. | ||
| − | For a full description, | + | For a full description, see the separate |
| − | see the separate | + | [[PrF_UG_classes_template_slot_pane|Template Slots pane]] topic. |
| − | [[PrF_UG_classes_template_slot_pane|Template Slots | ||
| − | topic. | ||
| − | </div> | + | |
| + | <noinclude></div></noinclude> | ||
Latest revision as of 16:22, November 13, 2008
The Class Editor
The Class Editor can be used to define and edit the attributes of a class. Click on a link or an area of the picture to jump to a summary. See also Creating a Class, Displaying the Class Editor, Editing a Class, and Editing Template Slots.
Note Icons
The note icons
(
,
,
)
at the upper right of the Editor allow you to 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.
They can be hidden using the Hide Class Notes
() button.
For information on how to add notes to any frame (class, instance, or slot),
see Working with Notes.
Notes are not available when working with the Editor as a free-standing window.
The Class Name Field
The Name field allows you to name your class. When a class is created, it is given a default name, such as newspaper_Class_1. You can change the name of a new or existing class by highlighting the name and overwriting it. The following rules apply to class names:
The name must be a unique class name in the knowledge base.
Class names are case sensitive.
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 with underscores.
The Class Role Menu
The Role menu allows you to choose the role of your class: concrete or abstract.
Concrete classes may have direct instances.
Abstract classes cannot have direct instances.
Protege-Frames sets the role to Concrete, by default. Protege-Frames does not impose any restrictions on the role of your classes. One common modeling convention is to make all leaf (bottom-level) classes concrete, and all interior (higher-level, non-leaf) classes abstract.
The Class Constraints Pane
Class constraints are defined programmatically. See Constraints for more information.
The Class Documentation Pane
The Class Documentation pane allows you to enter a text description of the class and other relevant information. These notes are part of your ontology. Filling in this field is optional, but is recommended to aid in the maintenance of the knowledge base.
The Template Slots Pane
The Template Slots pane displays the direct and inherited slots for the selected class. Slots, which represent properties of your class, are a crucial part of your knowledge base. In the example, Editor has several slots which appear in the Template Slots pane. For a full description, see the separate Template Slots pane topic.
