Protege-Frames User's Guide

This user's guide describes how to use the Protege-Frames editor. If you are unfamiliar with Protege or the Protege-Frames editor, please click "Introductory Topics" in the table of contents on the right-hand side of this page to find detailed explanations of both.

Please use the navigation bars on the right-hand side of pages to navigate this user's guide.

protege-frames editor

Questions about Protege-Frames?

Please post questions and comments about this guide and/or the Protege-Frames editor on the protege-discussion mailing list.

Interested in making edits to the guide?

If you are interested in contributing edits to the Protege-Frames User's Guide, please refer to our help topics section, which has important details about editing and the structure of this guide.

See Also

• Protege website
• Getting Started with Protege-Frames tutorial: html, pdf
• Initial Protege Frames tutorial
• Getting Started with Protege-OWL 3.x
• Getting Started with Protege-OWL 4.x
• Protege-OWL Tutorial:
  • Edition 1.0, for Protege 3.x
  • Edition 1.1, for Protege 4.x
    
    

Introductory Topics

This section of the User's Guide covers a variety of introductory topics.

To return to the main table of contents, click the User's Guide link (located at the top of the table of contents on the right-hand side of this page).

Using this Guide

The User's Guide documents how to use , an integrated knowledge-base development and management system. These pages include descriptions of the user interface, along with step-by-step instructions for completing specific tasks. Screenshots of a Newspaper Example are used to illustrate the explanations through most of this guide's pages.

Navigation

We assume that you are familiar with your operating-system platform and with using an Internet browser. You can navigate among topics by using your browser's Back and Forward buttons, or by using the list of top-level topics in the left-hand frame.

Each of the Guide's topics (e.g., subsystems) has an initial "index" page that lists all pages associated with that topics. There is also a "global" index page.

At the bottom of every page, there is a Next link. By following these links, you can visit every page. On all but the initial page, there are Prev and Up links. Clicking on the Prev link will take you to the "previous" page in the document. Clicking on the Up link will take you to the relevant index page.

OS Conventions

In most cases where Microsoft Windows uses the Control key, Apple's Mac OS X uses the Command key. To help remind you of this fact, we use the wording "Ctrl (Cmd)".

What is Protege?

is a free, open-source platform

that provides a growing user community with a suite of tools to construct domain models and knowledge-based applications with ontologies. At its core, implements a rich set of knowledge-modeling structures and actions that support the creation, visualization, and manipulation of ontologies in various representation formats.

can be customized to provide domain-friendly support

for creating knowledge models and entering data. Further, can be extended by way of a plug-in architecture and a Java-based Application Programming Interface (API) for building knowledge-based tools and applications.

An ontology describes the concepts and relationships that are important in a particular domain, providing a vocabulary for that domain as well as a computerized specification of the meaning of terms used in the vocabulary. Ontologies range from taxonomies and classifications, database schemas, to fully axiomatized theories. In recent years, ontologies have been adopted in many business and scientific communities as a way to share, reuse, and process domain knowledge. Ontologies are now central to many applications such as scientific knowledge portals, information management and integration systems, electronic commerce, and semantic web services.

The main assumption of is that knowledge-based systems are usually very expensive to build and maintain. For example, the expectation is that knowledge-based system development is a team effort, including both developers and domain experts who may have less familiarity with computer software.

is designed to guide developers and domain experts

through the process of system development.

is designed to allow developers

to reuse domain ontologies and problem-solving methods, thereby shortening the time needed for development and program maintenance. Several applications can use the same domain ontology to solve different problems, and the same problem-solving method can be used with different ontologies. For more information about building knowledge-based systems and the approach, see Planning a Project.

The platform supports two main ways of modeling ontologies:

• The [[PrF_UG_intro_what_is_protege_frames|]] editor enables users to build and populate ontologies that are frame-based, in accordance with the Open Knowledge Base Connectivity (OKBC) protocol. Specifically, it provides a full-fledged user interface and knowledge server to support users in constructing and storing frame-based domain ontologies, customizing data entry forms, and entering instance data.

• The [[PrF_UG_files_owl_support|]] editor enables users to build ontologies for the Semantic Web, in particular in the W3C's Web Ontology Language (OWL).

  Note: This User's Guide describes how to use the interface. If you wish to use the OWL extension to , see the CO-ODE website for documentation and examples.

What is Protege-Frames?

Note: This User's Guide describes how to use the interface. If you wish to use the OWL extension to , see:

The editor enables users to build and populate ontologies that are frame-based, using a knowledge model which is compatible with the Open Knowledge Base Connectivity (OKBC) protocol. In this model, an ontology consists of:

• a set of classes, organized in a subsumption hierarchy to represent a domain's salient concepts

• a set of slots, associated to classes to describe their properties and relationships

• a set of instances of those classes - individual exemplars of the concepts that hold specific values for their properties

Features of include:

• A wide set of user interface elements that can be customized to enable users to model knowledge and enter data in domain-friendly forms.

• A plug-in architecture that can be extended with custom-designed elements, such as:

  • graphical components (e.g., graphs and tables)

  • media (e.g., sound, images, and video)

  • various storage formats (e.g., RDF, XML, HTML, and database back-ends)

• additional support tools (e.g., for ontology management, ontology visualization, inference and reasoning, etc.)

• A Java-based Application Programming Interface (API) that makes it possible for plug-ins and other applications to access, use, and display ontologies created with .

Planning a Project

The development of a successful knowledge-based system, built with , is more of an art than a science. Nonetheless, we can suggest a standard pattern of use that new users should follow to avoid some possible problems of systems development.

is designed to support iterative development,

where there are cycles of revision to the ontologies and other components of the knowledge-based system.

Developers should not expect to "complete" ontology development without considering other aspects of the process. In particular, Knowledge Acquisition (KA) is critical to any knowledge-based system. For the development of a successful project, we would recommend the following steps:

1. Plan for the application and expected uses of the knowledge base. This usually means working with domain experts that have a set of problems that could be solved with knowledge-base technology.

2. Build an initial small ontology of classes and slots.

3. When you have built this ontology (and later, when you have extended it or opened it from a file), you can directly view forms for entering instance knowledge into the ontology, because generates initial forms "on the fly", in its role as a KA-tool generator.

4. You use these forms for acquiring slot values of your test instances. At this point, it is usually appropriate to show the ontology and the filled-out instance forms to the domain experts or your expected users. This inevitably leads to a set of revisions, both to the ontology (2.) and to the forms (5.). Note that ontology modifications can be expensive; some changes could necessitate rebuilding some or all of the knowledge base.

5. Customize the forms to a refined knowledge-acquisition tool, as explained in the Forms strand. While constructing this customized version of the KA-subtool, further design problems in the original ontology may become apparent. If necessary, revise the ontology and repeat at 4.

6. With your domain experts, build a somewhat larger knowledge-base that can be tested with your application or problem-solving method.

7. Test the full application with your end-users. This step can lead to further revisions to the ontology and the KA-subtool.

The picture below shows the typical workflow for a project. The large arrowheads indicate the forward progression through the process, while the small arrowheads show places where revisions are usually necessary (either to the ontology or the knowledge-acquisition tool).

typical workflow for a project

At the heart of a successful project is the design of the class and slot structure of the ontology. In particular, the model you use in building your ontology must balance the needs of the domain expert when building a knowledge base (at knowledge-acquisition time) against the requirements of your problem-solving method or application (at run-time). Hopefully, these are not too contradictory! Ontology developers should therefore both:

• Model the domain with a set of problems and a problem-solving method in mind.

• Design the ontology so that it can be used to generate and customize an appropriate KA-tool for a specific set of users.

A simple problem, taken from the Newspaper Example, could be finding all advertisements that are more expensive than some threshold. To handle this problem, one should create an "advertisements" class that includes prices and publication dates. Spreading this information across all publication issues would make it more difficult for the problem-solver to access all instances of advertisements and their prices.

A Newspaper Example

Throughout this guide, we provide examples and screenshots from a fictitious "newspaper" example. We designed this example to be intuitive. This example is distributed as part of the installation and is located in the examples directory in the application directory.

There are a variety of possible uses for a knowledge base of newspaper data. Our example knowledge base includes:

• a list of all published articles, indicating when published, in what section, etc.

• information about standard sections of the newspaper (Business, Lifestyle, Sports, etc.)

• employee information

• advertising information

There are a variety of applications that might use information in this knowledge base. For example, one could build:

• a system for retrieving, organizing and answering queries about published articles

• a system for analyzing advertisement revenues or pricing

• a system for reviewing the organization of the employees, making sure that reporters are balanced appropriately among editors and that each section of the newspaper has a responsible editor

As this is an artificial example, we have not built any of these applications, but we hope this example will give a flavor of how knowledge bases, ontologies, and knowledge-acquisition tools can be designed with .

Extending

includes an application programmer interface,

the API, that allows a Java programmer to extend the system. The API provides the Java packages and classes for complex operations such as creating new widgets:

• Tab widget - a user interface tab that appears in the main window alongside system tabs such as the Classes tab. The Queries tab is an example of a tab-widget plug-in.

• Slot widget - appears on a form and is used to view and acquire a value for a slot at an instance. The TextFieldWidget, used for acquiring and displaying strings, is an example of a slot-widget plug-in.

• Back-end - specifies the mechanism that will use for storage (either as text or in a database). The RDF back-end is an example of a back-end plug-in.

• Createproject - takes a file in a source format produced by another program and creates the closest possible "natural" knowledge-base.

• Export - provides an extensible mechanism for exporting knowledge-bases in a variety of formats, both file and database. This plug-in type is related to back-end plug-ins, but is much easier to develop and serves a somewhat different need.

• Project - allows manipulation of a project and 's project UI.

API documentation is available at:

http://protege.stanford.edu/doc/pdk/index.html

Starting with 3.2 beta, you can programmatically add your own configuration tab to the project configuration panel. The tab will also appear in the Configure dialog box. Instructions for this can be found on the Wiki at:

http://protege.cim3.net/cgi-bin/wiki.pl?AddingUserDefinedProjectConfigPanel

Projects

This section of the User's Guide covers the concepts of understanding, creating, and using projects.

Note: Before you create and use projects, you should be confident with the basic interface.

To return to the main table of contents, click the User's Guide link (located at the top of the table of contents on the right-hand side of this page).

Creating a Project

There are two ways to create a new project:

• create a completely new project

• create a project from existing text files or from a table in a JDBC database

To create a project:

1. Create a new project:

   • create a project on startup by selecting Create New Project from the start-up dialog

   • or create a new project from the window by selecting File | Create New, clicking the New Project button, or entering Ctrl-N (Cmd-N). The Create New Project dialog box will open.

     

     Create New Project dialog

2. The following project types support the format:

   • [[PrF_UG_files_protege_files|]] Files

   • [[PrF_UG_files_database_backend|]] Database

   • Experimental XML Normally, unless you have a need for a specific structure (e.g., for exporting files), you would select Files. If you wish to help the development of the XML backend, you can select Experimental XML.

3. To import a project from existing files, select Create from Existing Sources. You can create a project from existing files in Files or Database format.

   

   Create from Existing Sources checkbox (checked)

   To create a new, empty project, leave this unchecked (the default).

4. Click Finish. The window will open and the standard tabs will become visible. An initialized knowledge base will be created, containing the system classes rooted in :THING. No instances will be created. You can now structure your project by creating your classes and slots. (See Creating a New Class and Creating a Slot for more information.)

5. To save the project to disk, select Save from the File menu.

6. Enter a name for your project in the Project line of the dialog box. This is the name of your project (.pprj) file. also creates internal files for its own use. By default, these files are given the same name, with a different extension.

Opening a Project

You can open an existing project when you start , from within the window, or from a list of recent projects. No matter what format your project is in, you can create, open, and save your projects directly via the .pprj file. You do not need to name or access other file types unless you wish to build a project. To save the open project to disk after you have edited it, select Save Project from the File menu.

Opening a Project When You Start

To open an existing project when you first start :

1. Start . A dialog box will appear, allowing you to create a new project, open a recent project, or get help.

   

   Welcome to Protege dialog

2. To open a project in the list of Recently Accessed Projects, highlight its name and click OK.

3. To open a project that is not listed, click Open Existing Project. Locate the .pprj project you wish to open and click OK.

   

   Open Project dialog

Opening a Project within

1. Select Open Project... from the File menu, click the Open Project () button or type Ctrl-O (Cmd-O). A Project dialog box will appear, allowing you to select the project.

2. Select the .pprj project you wish to open.

3. Click OK.

For Windows systems, you can also open a project by double-clicking on the .pprj file in Windows Explorer.

Opening a Recent Project within

maintains a list of recently opened projects.

To open a recent project:

1. Select Open Recent Project from the File menu.

2. Select the project you want.

Importing a Project

Importing a project creates a new project and .pprj file, based on files which contain your ontology information in one of the supported formats. When you import a project, a .pprj file is built, based on the information in your existing files.

To do this, create a new project and make sure that Create from Existing Sources is checked in the Create New Project dialog box.

Create from Existing Sources checkbox (checked)

You can import a project from the following project types:

• Text Files: You can import a project from a pair of text files describing the class/slot (e.g., abc.pont) and instance (e.g., abc.pins) information. Importing a text project can be used, for example, for updating from /Win to .

• Database Table: You can import a project from a single table in a JDBC database.

You can not import an XML file into using the XML backend.

will generate default forms for all classes in the imported project.

Saving a Project

To save a project:

1. Select File | Save Project, click the Save Project () button, or type Ctrl-S (Cmd-S).

2. If this is a new project, you will be prompted for the name and location. Choose a name and location for the .pprj file; the other files will be created automatically. If you do not specify a location for the project, by default, the project will be saved in the directory where is installed. If you are saving a database project, you will need to supply additional information; see Database Format.

3. Click OK.

For more information, see the following topics:

• See Archiving a Project for information on how to archive a version of the current project.

• See Renaming a Project for information on how to save the current project with a new name.

• See Project Formats for information on how to convert or export the project to a different format.

Converting a Project to Another Project Type

You can convert a project from one backend format (project type) to another. You will see no difference in the interface when you work with your project, but all changes to to the project are stored in the new format. See Understanding Project Types for more information.

You can convert between the following formats:

• Files (the default) creates two text files in format. See Files.

• Database creates the project as a table in a JDBC database. To do this, you must have a database installed and configured on your system. See Database Format.

• Experimental XML saves the project in XML format. See Experimental XML Format.

Note: You can also convert a file to [[PrF_UG_files_owl_support|]] format and vice versa. In this case, however, you will see a significant difference, because of the differences between the and capabilities and interfaces.

To convert a file to a different format:

1. Select File | Convert Project to Format...

2. Select the format you want in the Select Format dialog box.

   

   Select Format dialog

3. Fill out any required information when requested; see the specific formats for more information.

4. Click OK.

Exporting a Project

Exporting a project creates a snapshot of the current version in the selected format, while leaving the project itself unchanged.

To export a project:

1. Select File | Export Project... and select the desired format from the cascading menu.

2. Fill out any necessary information:

   • For CLIPS files, select the name and location for your files. See Exporting to CLIPS for more information.

   • For HTML format, fill in the Export HTML Configuration Options. See Saving an HTML View for more information.

3. Click OK.

Renaming a Project

To save a project under a new name:

1. Select File | Save Project As....

2. Navigate to the location where you want to save the file and enter the new name for the .pprj file in the Project line of the window.

3. By default, the new names are entered automatically for any additional files in the project (for example, .pont and .pins files for standard text format). However, you can choose to give a different name to these files. You might want to do this, for example, if you are creating a new .pprj file which still accesses the old .pont and .pins file names. In this case, enter the names you want for the .pont and .pins files.

4. Click OK.

For more information, see the following topics:

• See Archiving a Project for information on how to archive a version of the current project.

• See Project Formats for information on how to convert or export the project to a different format.

Setting Preferences

You can set some basic preferences for the interface, using the Preferences dialog box.

Preferences dialog

Note: You can set additional configuration options by choosing Project | Configuration. Preferences apply to all projects, while Configuration applies to the current project.

To use the Preferences dialog:

1. Select File Preferences...

2. You can set the following preferences:

   • Show Welcome Dialog on Start-up: You can choose whether or not to see the Welcome dialog box each time you start . This dialog asks you to open, import, or create a new project. If you choose to disable the Welcome dialog box, you can perform these actions from the menus.

   • Capitalize Slot Widget Names: This controls an aspect of the Forms interface. To distinguish slot names from class names, a recommended convention is to make internal slot names lowercase. If this option is selected, automatically capitalizes the names of slots on the forms it creates.

   • User Name: The user name is shown on sticky notes. The default name is the login name you use to access your computer system. If you wish to customize the displayed name, select Use Specified Name and enter your desired name in the entry box.

3. Once you have set the Preferences to your satisfaction, click OK to implement your changes.

Archiving a Project

You can archive the current version of a project. Archiving saves a time-stamped copy of the project in a subfolder of your project folder. You can revert to a previously archived project at any time. This provides a form of version control for .

To archive the current version of a project:

1. Select Project | Archive or click the Archive Current Version () button near the top of the window.

2. If you wish, enter a comment:

   

   Archive Project dialog

3. Click OK.

Reverting to an Archived Version of a Project

You can revert to any archived version of your project.

1. Select Project | Revert to a Previous Version or click the Revert to a Previous Version () button at the top of the window.

2. All archived versions are displayed in the Revert to Archived Version dialog:

   

   Revert to Archived Version dialog

3. Select the version you wish to revert to. If you wish, you can select to archive the current version before reverting.

4. Click OK.

Including a Project

You can include an existing project in your current project. An included project stays as a separate project which you can open and edit separately; edits made in the file for the included project will appear in the including project the next time it is loaded. This allows you to build a single large project from one or more smaller projects.

With an included project:

• you can

  • view and refer to the frames of the included project, e.g., you can create a subclass of an included class or associate an included slot to a class

  • edit instances from the included project and create new instances for included classes

  • edit included forms

  • edit and override included slots

• you cannot

  • make edits that would affect classes in the included project, e.g., you cannot edit or delete an included class

Including a project

To include a project into an existing project:

1. Select Manage Included Projects from the Project menu. The current project, and its included projects, if any, will be shown in a project hierarchy.

2. Click the Add Project () button, at the top right of the Manage Included Projects dialog box.

3. In the Select Project dialog box, browse to the location of the project you want to include and select the .pprj file of the desired project.

4. Click Open.

5. The included project will be shown in the dialog box, with "(not loaded)" after it to indicate that the actual inclusion process has not yet taken place. If the included project already includes any other projects, they will also be added to the hierarchy.

   

   Manage Included Projects dialog

6. To include additional projects, repeat steps 2-6.

7. Click OK. You will see a warning:

   

   save/reload warning dialog

8. Click OK.

9. If there are any classes that are duplicated in your project, you will see a warning:

   

   duplicated class warning dialog

10. Click Close to continue. will include your files at this time.

The project is included into your current project. Frames in the included project appear with pale icons (e.g., , ) to show they cannot be edited.

Included Projects and Duplicate Class Names

If an included project defines a class that is already defined in the including project (i.e., has the same name), then one of the duplicate class definitions is ignored. (Usually the included definition is used, but there is no hard rule about this.) A warning is given at load time (Duplicate class definition was ignored") and the project is loaded. All references to the class work from both projects, because the reference mechanism uses the class name.

This feature allows you to exchange the included project - for example, with a different version. Ignoring duplicate classes also allows for the situation where one project (A) is included in two separate projects (B and C), which in turn are included in a final larger project (D):

multiple inclusion diagram

Activating an Included Project

In a project that has included projects, you can choose which project to activate. This restricts the frames you can view in the window to the ones from the project you have chosen. Note that you are still working with your including project and you cannot make edits which would affect the included project.

• Activating an included project hides all projects at the same or higher level as that project.

• Activating the current (top-level) project shows all frames and forms in the entire project hierarchy.

To activate an included project:

1. Select Manage Included Projects from the Project menu. The current project, and its included projects, if any, will be shown in a project hierarchy.

2. Select the project that you want to activate.

3. Click the Activate Selected Project button at the top right of the Manage Included Projects dialog box.

4. Unless you are activating the top-level project, you will receive a warning:

   

   "Changing the active project..." warning dialog

5. Click Yes to continue. Your project view will change.

Removing an Included Project

Removing an included project removes that project and any included projects it may have.

1. Select Manage Included Projects from the Project menu. The current project, and its included projects, if any, will be shown in a project hierarchy.

2. Highlight the project you want to remove.

3. Click the Remove Project () button, at the top right of the Manage Included Projects dialog box.

4. To remove additional projects, repeat steps 2-3.

5. Click OK. You will see a warning:

   

   save/reload warning dialog

6. Click OK to remove the project. You will see a number of warnings. Classes that were included from the project; any classes you created subordinate to those classes will still appear as subclasses of :UNDEFINED. For example:

   • Let's say you have a project A.

   • Then, you include project B in project A.

   • From project B, you get a class called X.

   • In project A, you make a bunch of subclasses of X.

   • Then, you remove project B from project A.

   • keeps all the subclasses of X that were created in project A, but they are now subclasses of a class called :UNDEFINED, because when you removed included project B, you lost class X.

Merging an Included Project

Merging an included project takes all the frames of the included project and directly incorporates them into the current project. After this, you can edit these frames just like the other frames in your project.

After a merge, the dynamic link to the included project has been broken and any further changes to the project file for the included project will not appear in the current project. The included project no longer appears in the Manage Included Projects dialog box.

To merge an included project:

1. Select Project | Merge Included Projects.

2. In the Merge Included Projects dialog box, select the project you want to merge.

   

   Merge Included Projects dialog

3. Click OK.

Configuring a Project

You can change the project configuration using the project Configure dialog box. This dialog box allows you to customize your project window.

Note: You can set additional preferences by choosing File | Preferences. Preferences apply to all projects, while Configuration applies to the current project.

Configuring the Project Tab Widgets

To configure which tabs are displayed:

1. Select Configure... from the Project menu. The Configure dialog box will open.

   

   Configure dialog, Tab widgets tab

2. Make sure that Tab Widgets is selected. It will show the tabs that are available for your project. Marked tabs are visible; others are hidden.

   • By default, a project displays the following tabs: Clses, Slot, Forms, Instances, and Queries.

   • A number of other tabs are available, such as the KAToolTab (Knowledge Acquisition Tool) and the ClsesandInstancesTab.

   • You may see additional tabs for plug-ins you have installed.

   • If you have installed OWL capability, but are not using an OWL project, you will see a list of possible tabs that are not loaded.

3. To hide a tab, remove the mark from in front of it. For example, if you are giving your project to someone to let them enter instances, you might wish to hide the other tabs. You can also hide the current tab by selecting Window | Close Current View from the project window.

4. If you wish to display a tab, add a mark in front of it. For example, you might want to display the Classes and Instances tab for a unified view of your classes and instances.

5. To change the order in which the tabs appear in the project window, highlight the tab you want to move and use the up () and down () icons to move the tab up or down in the list. A tab's position (left to right) in the window is correlated with its position (top to bottom) in the Configure dialog. For example, to have the Classes and Instances tab appear at the far left of the window, move it to the top of the list in the Configure dialog.

6. Click OK to close the dialog box and see your new configuration.

Configuring Project Options

To change project options:

1. Select Project | Configure...

2. Select the Options tab in the Configure dialog box.

   

   Configure dialog, Options tab

3. This tab provides the following options:

   • Display Hidden Frames: Allows you to toggle whether or not you can see any frames you have hidden. (You can hide a frame by selecting it, clicking the right mouse button, and choosing Hide from the menu.)

   • Display Confirmation Dialog on 'Remove' Operations: Allows you to add a warning when you perform a remove, such as removing a slot from a class. Recall that when you remove a slot, the slot remains in the project, but is simply removed from the current class. Regardless of the setting in this dialog box, you always receive a warning when you delete a frame from the project.

   • Allow Knowledge-Base Changes: Deselecting this item locks the knowledge base so that it cannot be changed by the viewer.

   • Update Modification Slots: Four system slots (attached to the :INSTANCE-ANNOTATION system class) keep track of the creator, modifier, and timestamps for any frame modification. The system will record this information automatically if you put these slots on the instance (attach them as template slots to the class) and check the box.

   • Enable Journaling: Allows you to keep a record of all the changes that you make to a project. Changes are stored in an ASCII (text) file, with one line for each change you make. The journaling file is created in the same directory as the project, with a .pjrn extension. It can be read using any text editor.

   • Capitalize Slot Widget Labels: This controls an aspect of the Forms interface. To distinguish slot names from class names, a recommended convention is to make internal slot names lowercase. If you use this convention and still want the names on your forms to be capitalized, select this option.

   • Use Tabbed Forms for Multi-Type Instances: Controls the display of the Instance Editor for multi-type instances.

4. If you wish to select an option, click to mark it.

5. If you wish to remove an option, click to remove the mark.

6. Click OK to close the dialog box and see your new configuration.

Project Metrics

Project metrics provide information about the number of frames in the current project. This information can be useful in analyzing performance issues.

Viewing Project Metrics

To view project metrics, select Project | Metrics:

Metrics dialog

Scalability and Tuning

has successfully handled "simulated" knowledge bases

(generated by a program) as large as 5M frames (classes & instances). Actual knowledge bases as large as 100K frames give acceptable UI performance if supported by the database backend.

For file-based projects, the primary impact of increasing the number of frames is that the project takes longer to load (load time is roughly proportional to the number of frames). For database projects, slow operations include expanding a class with a lot of direct subclasses and displaying the instances for a class with many instances.

Aside from limiting the size of the knowledge base, the most important thing to tune is the heap size. For more information, see Scalability and Tuning.

Using Undo

You can undo your actions using the Undo command on the Edit menu or by clicking the Undo () button at the top of the window.

To redo a command, use Edit | Redo or click the Redo () button.

allows multiple levels of undo and redo.

When you use Undo, your project will be restored to its previous state. In most cases, you will not see any difference. However, while always creates a state that is logically identical to the initial state you were in, in some cases internal state will be represented in a slightly different way. For example, classes or instances might appear in a different order in the .pont or .pins files.

When you use certain advanced features, you may see a minor difference in the user interface. For example, if you are using the Graph Widget, some elements on the graph may appear in a slightly different location. The project has not been affected in any other way.

Project Types

This section of the User's Guide covers the concepts of understanding, creating, and using project types.

Note: Before you create and use project types, you should be confident with the basic interface. You should also be comfortable with projects.

To return to the main table of contents, click the User's Guide link (located at the top of the table of contents on the right-hand side of this page).

Understanding Project Types

Every project stores two kinds of information:

• -specific information, stored in a .pprj (Protégé project) file

• Information about the project ontology (classes, slots, etc.) and project instances, stored in one or more additional files.

No matter which format you choose, the information specific to the interface is saved in a .pprj file. You can create, open, and save your projects directly via the .pprj file. You do not need to name or access any other files unless you wish to import a project.

Choosing the project type, or backend, determines how the project ontology and instances are stored.

supports three file formats:

• Files (the default) creates two text files in format. See Files.

• Database creates the project as a table in a JDBC database. To do this, you must have a database installed and configured on your system. See Database Format.

• Experimental XML saves the project in XML format. See Experimental XML Format.

Normally, for a project, you would select Files or Experimental XML. If you have installed support for additional backends, e.g., if you selected BASIC + OWL as your installation, you will see additional file formats.

If you decide you wish to change your project type, e.g., from Files to Experimental XML, you can convert your project. This changes the format of the backend, while leaving the .pprj file unchanged.

still uses the .pprj file to access the project.

You should not see a difference within .

You can also export a project to CLIPS or HTML formats. In this case, the project itself stays the same, but a snapshot of the current version is created in the selected format.

Files

You can save the ontology-related information for a project in [/design/clips.html Files format], a CLIPS-based text format that has been the default file format for for many years.

In a project, information specific to the user interface is stored in a dedicated project (.pprj) file. Internally, maintains two files in addition to the .pprj file; these files contain further information about the ontology and instances of the project. When you open a .pprj file, automatically loads these files. By default, the additional files are saved in the following format:

• A text file with the extension pont (Protege ontology) contains the class and slot information.

• A text file the extension pins (Protege instances) contains the instance information.

See Understanding Project Types for more information about project types.

Importing Files

If you have an ontology that is stored in two text files, but do not have a .pprj file, you can import those files and create a new project file. To create a project from text files:

1. Select New Project from the File menu. The Create New Project dialog box will open.

   

   Create New Project dialog, "Protege Files ..." selected

2. To import a project from text files, select Create from Existing Sources.

   

   Create from Existing Sources checkbox (checked)

3. Select Files as the project type.

4. Click Next.

5. Locate the files you want to use as the ontology (.pont) and instances (.pins) files:

   

   Create New Project dialog

6. If you are finished, click Finish.

7. If you wish to include any existing projects in the project you are building, click Next. Then click the Add () button, locate the project you want to include, and click OK. You can include multiple projects by repeating this step. Click Finish when you are done including.

will create a project file from your class and instance information.

To save your project and give it a name, select Save from the Project menu.

Converting a Project to Files

1. Select File | Convert Project to Format...

2. Select Files in the Select Format dialog box.

   

   Select Format dialog, "Protege Files ..." selected

3. Click OK.

Database Format

You can save the ontology-related information for a project as a single table in a [/design/jdbc_backend.html JDBC database]. Note that this is a "flat" table that does not use any special database constructs to represent the information. Information specific to the user interface is stored in a separate project (.pprj) file. See Understanding Project Types for more information about these files.

Requirements

Before you create a Database project, you will need to do the following:

• Make sure you have a database program installed on your system.

• Make sure you have a JDBC driver that is compatible with your database and the version of the Java VM that you are using.

  • If you are using Microsoft Access, you don't need to acquire a JDBC driver; it's already bundled into the JDK. (not recommended option due to slow performance)

  • Otherwise, acquire a driver and rename it to "driver.jar" (or "driver1.jar" or "driver2.jar", if you have several). Add this driver to the installation directory (not the plugins directory).

You can store multiple projects in the same database by giving their tables different names.

Note: When a project is saved in a JDBC database, backend changes to the database (for example, changes to slots, classes, and instances) are committed as soon as they are made. However, changes to the User Interface (stored in the .pprj file) are not committed until you save the project, for example by clicking Save.

Creating or Importing a Database Project

1. Select New Project from the File menu. The Create New Project dialog box will open.

   

   Create New Project dialog box, "Protege Database" selected

2. To import a project from existing files, select Create from Existing Sources. To create a new, empty project, leave this blank (the default).

   

   Create from Existing Sources checkbox (checked)

3. Select Database as the project type.

4. Click Next.

5. A Database dialog box will be displayed.

   

   Database dialog box

6. Enter the class name of your JDBC driver in the JDBC Driver line of the dialog box. The class name can be found in the documentation provided with your particular driver. (For Microsoft Access, use: sun.jdbc.odbc.JdbcOdbcDriver)

7. Enter the URL for your database in the JDBC URL line.

   Note: For Microsoft Access, navigate to the "ODBC Data Source Administrator" dialog via the Control Panel and add a User DSN for your Access database. If you're unfamiliar with how to find this dialog or how to add a User DSN, please refer to Microsoft Windows Help. Your URL will look like: jdbc:odbc:<User DSN name>

8. Enter the name for the database table where you will be storing the information. If you are importing a file, enter the name of the table that contains the information you wish to import. This field is required.

9. If your database requires a username and/or password, enter these in the appropriate lines of the dialog box.

10. Click Finish.

To save your project and give it a name, select Save from the File menu. See Saving a Project for more information.

Converting a Project to a Database

1. Select File | Convert Project to Format...

2. Select Database in the Select Format dialog box.

   

   Select Format dialog, "Protege Database" selected

3. In the Database dialog box, fill out the required information, as described above.

Experimental XML Format

Currently, the XML backend for is still under development. The intent is to eventually make this the default backend for , once it has become stable and supports the full feature set.

You can create a new XML project by selecting File | Create Project and then selecting Experimental XML File in the Create New Project dialog:

Create New Project, "Experimental ..." selected

You can also convert an existing project to XML by selecting File | Convert Project and then selecting Experimental XML File in the Convert Project dialog box.

Note: The XML backend uses its own Schema and will not let you import an arbitrary XML file into .

The first time you save an XML project, creates the following files:

• a .pprj file, which contains -specific UI information

• a .xml file, which contains XML-encoded ontology information for the knowledge base\

uses a single XML Schema file that is optimized to work with the  model.

All information in the knowledge base is treated as "instances". The format of these instances, described in the Schema file, is designed to be simple, readable, and easily processible by XSLT in straightforward ways. The Schema is available at:

http://protege.stanford.edu/xml/schema/protege.xsd

Feedback on the Schema is strongly solicited. The schema should not be considered fixed at this point and users should not rely on this backend functioning correctly or upon the schema remaining fixed from build to build. We do encourage you to try it out and report any problems that you see.

Note: This backend cannot be used to generate XML Schema files. For example, it does not turn classes in into XML Schema complex types. An export mechanism that does this may eventually be developed separately.

Note: This User's Guide describes how to use the interface. If you wish to use the OWL extension to , see the CO-ODE website for documentation and examples.

In addition to the editor, which these help topics document,

supplies a separate [/protege-owl.html  editor],

which enables users to build ontologies for the Semantic Web, in particular in the W3C's Web Ontology Language (OWL). See the [/protege-owl.html overview] for a description of and see the CO-ODE website for documentation, sample ontologies, and additional OWL plug-ins.

"An OWL ontology may include descriptions of classes, properties, and their instances. Given such an ontology, the OWL formal semantics specifies how to derive its logical consequences, i.e., facts not literally present in the ontology, but entailed by the semantics. These entailments may be based on a single document or multiple distributed documents that have been combined using defined OWL mechanisms." (see the OWL Web Ontology Language Guide)

Although uses the engine to display and manage projects, the logic and user interface of and are substantially different. You should determine which model suits your project and do all your project creation and editing in either or , rather than attempting to switch between modes. Although there is substantial overlap between the two models, both and have features which are not supported by the other.

Following are some of the differences between and .

•  :

  • primarily object-oriented (frame-based) with classes and slots

  • builds classes and adds or creates attributes

  • supports frames-specific constructs, such as Abstract classes

•  :

  • based on Description Logic

  • defines classes by their logical characteristics

  • supports advanced OWL features

To install :

1. Download the Full version of from the website.

2. Once the installer has downloaded, double-click to start the installation.

3. During the installation wizard, select "Basic + OWL". This will install , the OWL Plugin, and selected other plugins that are suited for OWL.

   

   Choose Components dialog

If your installation has been successful, you should see the entries "OWL Files" and "OWL Database" in the listing of project formats at 's start-up screen.

If you do not see a Project Type called OWL Files when you attempt to create a new project, there may have been something wrong with the way was installed.

1. Check that a folder named plugins/edu.stanford.smi.protegex.owl is present in your installation directory. Make sure that this folder is not empty (you should see some .jar files and other things). If the folder and its contents are not present, they can be downloaded and unzipped into the plugins folder by hand.

2. If you cannot get OWL projects to load, try re-installing . Make sure that you select Basic+OWL as your installation type.

3. Finally, refer to the OWL Plugin web pages to see if any changes have been made to the installation or running process.

RDF(S) Support in

allows you

to create and edit Resource Description Framework (RDF) schema and instance data. (For more information about RDF, see http://www.w3.org/RDF.)

provides the following types

of RDF (Schema) support:

• [[#Protege-OWL_and_RDF_S_|]] (recommended)

• an RDF backend for

• additional RDF(S) plug-ins for , including Sesame and Joseki support

and RDF(S)

OWL is an extension of RDF, so any RDF project can also be regarded as an OWL project which simply does not use the advanced OWL features. Although the focus of the OWL Plugin is on OWL ontologies, it can also be used to edit RDF ontologies and RDF Schema files or databases. However, we don't recommend mixing pure RDF(S) elements with OWL elements in OWL ontologies.

The following steps show how to:

• import or create a file in RDF(S) format using

• add RDF(S) support to an existing OWL project

These steps address the file format only; for additional information, see the resources page.

Please note the following limitations:

• Although you may see the full OWL interface when editing an RDF(S) project, it is your responsibility to avoid using OWL-specific elements in your project.

• Currently, when you go to import (open from an existing) RDF(S) file, there is no separate RDF format option. You need to select OWL Files (.owl or .rdf) and later select RDF Schema or Pure RDF Schema without OWL.

• When you save your RDF(S) project, the interface currently does not save separate RDFS and RDF files; instead, it combines everything in a single file that is given a .owl extension. This may be fixed in future versions.

Note that the use of RDF in is not necessarily compatible with the RDF Backend for , which was initially developed prior to the existence of OWL. Overall, the RDF support in provides cleaner semantics and a richer set of modeling elements.

Importing or Creating an RDF(S) Project with

1. Create a new project, either by selecting Create New Project from the start-up dialog or File | Create New in the window.

2. Select OWL Files (.owl or .rdf) as the Project Type.

   

   Create New Project dialog, "OWL Files ..." selected

3. If you are importing an existing file, make sure to check Create from Existing Sources, located at the top of the dialog box. If you are creating a new RDF file, leave it unchecked (default).

   

   Create from Existing Sources checkbox (checked)

4. Click Next.

5. Specify any common ontologies to use and click Next.

6. Specify your default RDF namespace and click Next.

7. You can now choose your language profile. For an RDF project, select RDF Schema or Pure RDF Schema without OWL.

   

   Create New Project dialog, "Pure RDF ..." selected

Activating RDF(S) Support in an OWL Project

To activate RDF(S) support in an existing project:

1. Select the OWL | Preferences menu option.

2. In the OWL Preferences dialog, activate an RDF profile by changing the Language Profile to RDF Schema or Pure RDF Schema without OWL.

   

   OWL Preferences dialog, General tab, "Pure RDF ..." selected

3. Click Close.

4. The window will display buttons to create pure RDFS classes and RDF properties. In particular:

• If you chose RDF Schema, there will be an additional button on the Properties tab, which can be used to create RDF properties:

  

  Property tab with extra buttons

  You can also decide whether new classes shall be RDFS classes or OWL classes using "Create class using metaclass", or you can make rdfs:Class the default metaclass (both with a right-click on the classes tree in the OWLClasses tab).

• If you chose Pure RDF Schema without OWL, the buttons on the Properties tab will be restricted to RDF properties:

  

  Property tab

RDF Backend for

You can use to design RDF schema and create the corresponding instance data. You can also view and edit your existing RDF files in . The RDF backend for was developed prior to the development of the OWL interface and is not necessarily compatible with . With the advent of , it is no longer under active development, but some support is still available.

• Instructions on creating or converting a file using the RDF backend

Note: This backend is actually an RDFS/RDF backend which saves a schema file (RDFS) and an instance file (RDF).

This interface has a number of limitations:

• The backend uses the standard GUI, which is not RDF(S) -specific. It is not clear how you can enter RDF specific elements. You see exactly the same GUI as for "normal" .

• Only the RDF Schema namespace (http://www.w3.org/TR/1999/PR-rdf-schema-19990303) is supported when saving (on import, the new namespace is also recognized).

• Namespace abbreviations cannot be edited (they are automatically generated).

• rdfs:seeAlso, rdfs:isDefinedBy, rdfs:label, container, and reified statements are not supported.

• Multiple types for a single resource were not supported, prior to the 3.3 release.

• You cannot make changes to the standard meta classes. (i.e., rdf:Resource, rdf:Property, rdfs:Class, etc.)

• XML Schema data types are not recognized as rdfs:Literal (but it is unclear that they should be).

Additional RDF Plug-ins

The community has written additional RDF plug-ins to support other RDF frameworks:

• [/rdfs-db/ RDF(s)-DB Backend Plugin]: Store/retrieve RDFS ontologies in the Sesame RDF framework.

• Protege2Joseki: Import/export ontologies from/to Joseki RDF Server.

Using the RDF Backend

Although it is recommended to use for RDF(S) projects,

also has an RDF backend you can use for  projects.

The backend does not work with .

Creating an RDF(S) Project with the Backend

1. Create a new project, either by selecting Create New Project from the start-up dialog or File | Create New in the window.

2. Select Resource Description Framework (RDF) as the Project Type.

3. If you are importing an existing file, make sure to check Create from Existing Sources, located at the top of the dialog box. If you are creating a new RDF file, leave it unchecked (default).

   

   Create from Existing Sources checkbox (checked)

4. To select or change the name or location of the .pprj file, enter the information you want in the Project line of the dialog box. Be sure to give the file a .pprj extension. If you do not specify a location for the project, by default, the project is saved in the directory where is installed.

5. will create two files: one for the schema (classes and slots) and the other for the instances. By default, these use the name of the existing .pprj file. If you wish to change the name of the schema file, type the new name in the Classes file name line of the dialog box. Make sure to give the file an .rdfs extension.

6. If you wish to change the name of the instances file, type the new name in the Instances file name line of the dialog box. Make sure to give the file an .rdf extension.

7. Click OK.

Note: You should create new RDF classes as subclasses of rdfs:Resource.

Converting a Project to RDF Format

Note: Subclasses of :THING from a non-RDF project will become subclasses of rdfs:Resource when you save as RDF.

After you have chosen your format, choose the name and location for the project, as follows:

1. Select Convert to Format... from the File menu.

2. Select Resource Description Framework (RDF) in the Select Format dialog box.

3. When you have selected Resource Description Framework (RDF), the RDF dialog box will be displayed.

4. To select or change the name or location of the .pprj file, enter the information you want in the Project line of the dialog box. Be sure to give the file a .pprj extension. To browse for a new location, click the Add () button. If you do not specify a location for the project, by default, the project is saved in the directory where is installed.

5. will create two files: one for the schema (classes and slots) and the other for the instances. By default, these use the name of the existing .pprj file. If you wish to change the name of the schema file, type the new name in the Classes file name line of the dialog box. Make sure to give the file an .rdfs extension.

6. If you wish to change the name of the instances file, type the new name in the Instances file name line of the dialog box. Make sure to give the file an .rdf extension.

7. Click OK.

Exporting a Project to CLIPS

The current version of uses CLIPS (C Language Integrated Production System) as its internal file format. However, in order to support advanced features, the CLIPS generated by may not conform to the CLIPS standard.

You can export a conformant CLIPS view of your project. This will not affect the format of your project; it simply produces a CLIPS file that reflects the project's current state. Note, however, that because of the limitations of CLIPS with respect to , you may lose information during exporting. This means, for example, that if you re-import an exported file, it may not fully recapture the original project.

To export your project to CLIPS text files:

1. Select Export to Format from the File menu and select CLIPS from the submenu. The Clips Files to Export dialog box will be displayed.

   

   Clips Files to Export dialog box

2. Enter the names for your classes and instances files. If you want to save the file(s) in a different location from the default, type the new location in the Output Directory line or click the Add () button to navigate to the desired location.

3. Click OK. The CLIPS files will be created in the selected location.

Exporting a Project to HTML

You can generate an HTML view of a project. This allows you to view all or part of the class hierarchy and, optionally, all the instances. The output consists of an index page, which gives the class hierarchy for the project, including links to individual pages for each the class. Class pages include slot descriptions and optional instances. If instances are selected, they have individual pages and appear in the index hierarchy and under each class.

You can generate HTML pages for the entire project, or restrict the output to a subset of the project.

Generating HTML Output

To generate HTML for a project:

1. Select File | Export to Format and select HTML from the submenu. The Export HTML Configuration Options dialog box will be displayed.

   

   Export HTML Configuration Options dialog box, General tab

2. Change your settings, if desired. The effect of the different settings is described below. (We recommend changing the output directory; otherwise, the files will be saved directly in the application directory.)

3. Click OK.

Output Format

Using the default options produces the following HTML output:

• an index page, showing the class hierarchy; the example shown is for a subset of the newspaper project, with Layout_info selected as the root class

  

  index page, "Layout_info" selected

• a page for each class, showing its superclasses, subclasses, slots, and instances; the selection of classes is customizable

  

  page for "Section" Class

• a page for each slot, showing its facets and their values; the list of slots is customizable

• a page for each instance of the chosen classes; you can choose to omit instances from the HTML web

Output Options

The effect of the different settings is described below.

General Tab

• Configuration Name: Allows you to name and save the current settings in the dialog box. A saved setting is added to the menu; you can reload it by selecting it from the menu. To save your settings, enter a name and then click Save. This will save the current state of the HTML Export Configuration Options dialog box. Note that if you do not click Save, your settings will not be changed. Also, if you make additional changes without clicking Save, they will not be saved.

• Output Directory: (recommended) Allows you to choose a directory where the HTML files will be saved. By default, they are saved directly in the application directory. You can type a pathname directly in the entry bar or use the button to navigate to the desired directory.

• Root Classes: Restricts the HTML output to the chosen classes and all their subordinate classes. By default, the root class is :THING, which will generate output for all classes in the hierarchy, including hidden system classes. To restrict your view to a smaller section of the project, first delete the :THING class using the Delete Class button, then add one or more classes by clicking the Add Class button and selecting the classes you want in the dialog box. Any class you choose will be included in the tree, along with all of its subclasses.

• Show Instances: Select this option to generate a page for each instance subordinate to your chosen root classes. If you do not wish to include instance pages in your output, deselect this option.

• Sort Subclasses: Users can reorder classes manually in the Protege class tree and Protege will remember the order. To ensure that the project to be exported in alphabetical order, you'll need to use this option.

• Use numbering for instance lists: Numbers the instance lists shown for each class.

Slots Tab

This tab allows you to select which slots are displayed. A selected slot is shown at each class where it occurs and a page is generated for that slot.

HTML Exports Configuration Options, Slots tab

Facets Tab

This tab allows you to select which slot facets are displayed. A selected facet, and its value, is shown for each slot where it appears.

HTML Exports Configuration Options, Facets tab

Customization Tab

This tab allows you to customize the header, footer, and stylesheet of the output. Note that the default style sheet displays the icons for you.

HTML Exports Configuration Options, Customization tab

Window Management

This section of the User's Guide covers the concepts of managing windows.

Note: Before you create and use project types, you should be confident with the basic interface. You should also be comfortable with projects and project types.

To return to the main table of contents, click the User's Guide link (located at the top of the table of contents on the right-hand side of this page).

Cascading All Editor Windows

allows you to have multiple free-standing Editor windows open at a time.

Each Editor displays the information for a class, instance, or slot. In addition, you may choose to detach one or more of the tabs. As you continue to work with a project, you may find that these windows get hidden, or that the screen gets cluttered.

To cascade all open Editor windows, select Windows | Cascade Windows. All open Editor windows will be brought to the front and cascaded.

Closing All Windows

To close all open Editor windows, select the Window | Close All Windows menu item. All open Editor windows will be closed. The main window will remain open. If you have detached a tab, it will be re-attached to the main window.

Detaching the Current View

You can detach one or more of the tabs (Classes, Slots, etc.) and display them in free-standing windows. This allows you to view multiple tabs at the same time. For example, you could detach the Classes tab and display it in a separate window.

Detaching

To detach a tab:

1. Click on the tab that you want to detach, making sure that it is the current view displayed in the window.

2. Select Window | Detach Current View. The tab you have selected will be detached.

Re-attaching

To restore a detached view and reincorporate it as a tab:

1. Click on the standard Close button at the top right. Instead of closing the tab completely, this will close the detached window and redisplay the information as a tab.

To completely remove a tab from view, close the view using Window | Close Current View.

Closing the Current Tab

You can choose not to display a tab by closing it. For example, if you do not wish to edit Forms, you might choose to close the Forms tab. You might also close a tab for a plugin you are not planning to use in this project. A closed tab will no longer display in your project, but will display in other projects.

Closing

To close a tab:

1. Click on the tab that you want to close, making sure that it is the current view displayed in the window.

2. Select Window | Close Current View. The selected tab will no longer display.

You can also close a tab using the Configure dialog box.

Restoring a Closed Tab

To restore a closed tab, you can use the Configure dialog box:

1. Select Project | Configure....

2. Make sure Tab Widgets is selected.

3. To display a hidden tab, make sure the box is checked.

4. Click OK.

Working With a Small Window

displays a lot of information in many of its windows.

In some cases, if your window is sized to fit on a smaller screen, not all of the information will appear. In this case, you might have trouble finding some of the following:

• the Superclasses pane at the Classes tab

• the Classes pane at the Slots tab

• the Query Library pane and the Search Results pane at the Queries tab

To view or enlarge these areas, try any of the following:

• Enlarge the window by dragging it. A hidden section will usually appear if the window becomes large enough.

• Drag the slider bar to the position where the hidden section should be. For example, to view the Search Results pane, place the cursor over the slider bar at the right of the window, and drag the bar to the left. To view the Superclasses pane, Query Library pane, or Classes pane, place the cursor over the slider bar at the bottom left of the window and drag the bar up.

• If your window is very small, you can toggle between two panes by clicking on the arrows on the slider bar. For example, to toggle between the Query Editor and the Query Library pane, click the up arrow on the slider bar to display only the Query Library pane; click the down arrow to display only the Query Editor.

You can also customize the distance between any of the panes, using the slider bars in the same way.

Synchronizing Class Trees

Often, when you switch between tabs in , you wish to see the same class highlighted at either tab - or synchronized. You can synchronize between the Classes, Forms, and Instances tabs in two ways:

• auto-synchronize (default)

• synchronize manually

Automatically Synchronizing Class Trees

To turn the automatic synchronizing option on or off:

1. Select Window | Automatically Synchronize Class Trees.

When synchronizing is enabled (the default), this option shows a check mark.

Synchronizing Manually

If the Automatically Synchronize Class Trees setting is turned off, you can still synchronize a Classes, Forms, or Instances tab with the last one of these tabs you visited. To do this:

1. Select Window | Synchronize Class Trees.

Working With Notes

allows you add a note to the Editor for any frame;

that is, a class, instance, or slot. These notes, which are not part of the ontology structure, float over the Editor for that frame.

The buttons for working with a note are located at the top right of the Editor. This picture shows them in the Class Editor:

Class Editor header, showing buttons

These buttons allow you to add, delete, display, or hide a note.

Adding a Note

To add a note to a frame:

1. Click the Create Note (, , ) icon at the top right of the Editor (e.g., Class Editor, Instance Editor, etc.) A yellow note will be created.

   

   Sticky note (empty)

2. Click in the note and type the desired text.

   

   Sticky note (filled)

As always, you can resize or reposition the note by dragging. However, you cannot move it out of the Editor window.

Deleting a Note

To remove a note:

1. Click the Delete Note (, , ) button at the top right of the Editor.

2. If there is only one note, you will be prompted to confirm the deletion. Click OK.

3. If there is more than one note, a list of notes will be displayed. Select the note you wish to delete and click OK.

   

   Select a note... dialog

Hiding Existing Notes

You can hide all existing notes for the current tab. When you do this:

• Only the notes for the current tab (Classes, Slots, or Instances) are hidden.

• New notes that you create after hiding will display. To hide additional notes, first display all notes and then hide them again.

To hide all existing notes for the current tab:

1. Click the Hide Notes (, , ) button at the top right of the Editor. The button will change to show that notes have been hidden.

Displaying Hidden Notes

When notes have been hidden, the Hide Notes button changes to show it has been selected:

Hide Notes button

To display all notes for the current tab:

1. Click the Hide Notes icon.

Classes

This section of the User's Guide covers the concepts of understanding, creating, and using classes.

Note: Before you create and use classes, you should be confident with the basic interface. You should also be comfortable with projects, project types, and windows.

To return to the main table of contents, click the User's Guide link (located at the top of the table of contents on the right-hand side of this page).

The Classes Tab

The Classes tab provides a single window in which you may view, create, and edit classes, which model concepts in your domain - usually objects, such as article or author.

The tab consists of two panes:

1. The Class Browser at the left shows the classes in your project and allows you to make edits that modify the class hierarchy. For example, you might create, delete, or move a class or work with superclasses and metaclasses.

2. When a single class is selected, the Class Editor on the right shows the properties of the selected class and allows you to edit class-specific attributes, such as class sticky notes, class name, role, any constraints, and template slots. The Class Editor can also be displayed as a separate window by clicking the View Class () icon in the Class Browser.

Click on an area in the picture to view more information:

Classes tab, "Editor" and "Author" selected

For information about the Classes user interface and about accomplishing specific tasks, see the Classes Table of Contents.

The Class Browser

The Class Browser, at the left of the Classes tab, displays the classes in the knowledge base as a tree. The Class Browser includes the following:

1. The Class buttons allow you to create (), view/edit (), view references to (), and delete () classes in your knowledge base.

2. The Relations menu () allows you to view relations between classes: you can display the entire hierarchy (default) or restrict the display only to those classes that are related to a selected class.

3. The Class Hierarchy window displays your class hierarchy. Icons give additional information about your classes. In this window, you can:

   • rearrange the class hierarchy using "drag-and-drop"; see Moving a Class for more information.

   • select a class to see its information displayed in the Class Editor to the right.

   • right-click a class to use the cascading Class menu, which allows you to create, delete, and hide classes, as well as work with metaclasses.

4. The Class lookup bar allows you to find a class in the Class Relationship window by typing all or part of the class name and clicking the Search for Class () button.

5. The Superclasses pane allows you to add and remove superclasses for a class, as well as jump to a different superclass in the hierarchy view.

Click on a region or name in the illustration to jump to a description:

Class Browser, "Editor" and "Author" selected

The Class Buttons

The class buttons (, , , ), located at the top right of the Class Browser, allow you to view and edit, view references to, create, or delete a class.

top of Class Browser

The buttons have the following actions:

• The View Class button () opens the Class Editor for the highlighted class. This allows you to view or edit the class.

• The View References to Class button () opens the References window, which shows all the frames that reference the highlighted class. See Viewing References.

• The Create Class button () creates a new class as a subclass of the highlighted class.

• The Delete Class button () deletes the highlighted class and all of its subclasses.

If the Create Class or Delete Class button is grayed out, this indicates that the current class cannot be edited or deleted. A non-editable class always has a pale class icon to its left. A class cannot be edited if it is a system class or if it is included from another project.

Additional Buttons

The buttons above have the same operation wherever they appear. Additional buttons in the interface allow you to add and remove the classes specified in a slot, field, or other relationship.

• The Add Class button () displays a dialog box that allows you to select one or more existing classes.

• The Remove Class button () removes the class from the current relationship without deleting it from the knowledge base.

The Class Hierarchy Window

The Class Hierarchy window in the Class Browser displays the classes for the project and allows you to rearrange your hierarchy using "drag-and-drop". By default, the Class window displays the class structure of your knowledge base, with all classes shown as descending, directly or indirectly, from the system class :THING.

Class Hierarchy window

Description

This window shows the following:

• Subclasses appear below their superclasses and are indented to the right.

• Hierarchy icons indicate how much or how little of the hierarchy is displayed:

  • An "expanded" icon () means that all direct subclasses of the class are displayed.

  • A "collapsed" icon () means that the class has direct subclasses which are not currently displayed. You can click on this icon to toggle it.

  • If no icon is displayed, the class has no direct subclasses.

  Tip: You can also display all classes below a class by right-clicking the class and selecting Expand from the cascading Class Menu.

• The currently selected class is shown with a highlight.

• Classes with more than one superclass appear more than once in the tree.

• Class icons show information about your class (e.g., the class role).

Note: You can also change the view from the default to view the class relations for a selected class. Most of the time, however, you will work with the default hierarchy view.

Tasks

The Class Hierarchy window allows you to perform the following tasks:

• You can select a class by clicking on it.

• You can edit the attributes of a class in the Class Editor. When a class is selected, the Class Editor appears to the right. You can also open the Class Editor for one or more selected classes by clicking the View Class () button.

• You can create a new class by clicking the Create Class () button and creating and editing its attributes in the Class Editor.

• You can delete a class by clicking the Delete Class () button.

• You can search for a class by typing all or part of the class name in the Class lookup bar and then clicking the Find Class () button.

• You can work with metaclasses and hidden classes, using the right mouse button. See the Class menu for more information.

You can also rearrange the superclass/subclass relationships:

• You can move a class to another superclass by selecting the class, dragging it directly over the new superclass, and then dropping it.

• You can add an additional superclass to a class by selecting the class, dragging it over the additional superclass, and holding down the Ctrl (Cmd) key while you drop it.

For additional superclass tasks that you can perform, see the Superclasses pane.

The Class Icons

The icons in the Class window provide information about the structure of your knowledge base and the nature of your classes.

Class Icons

Classes are indicated by round golden icons. Additional properties of the icons give information about the type of class:

A solid icon indicates a concrete class; that is, a class that may have direct instances:

A hollow icon (with a hole) indicates an abstract class; that is, a class that cannot have direct instances. Abstract classes can have subclasses:

A pale icon indicates a system class or a class that has been included from another project. These classes cannot be edited. See Including a Project for more information:

A gray icon indicates a hidden class. You can use hidden classes to restrict a user's view of your knowledge base while retaining the structure of the larger project. You choose whether or not to display the hidden classes in a project using the Configure dialog box.

Hierarchy Icons

The following icons give information about the display of the class hierarchy:

Note: To display all subclasses below a class, right-click the class and select Expand from the cascading Class menu.

The Class Menu

Whenever you have a class selected, you can access the cascading class menu by clicking the right mouse button. This menu allows you to perform a number of class-related tasks.

To access the class menu:

1. Select a class in the Class Browser.

2. Click the right mouse button. The cascading class menu is displayed.

   

   cascading class menu, "Create Class" selected

3. Make your selection and click the left mouse button.

The class menu allows you to perform the following tasks. Not all tasks are available at all times; tasks that cannot be performed are grayed out.

• Create Class: Creates a class that is subordinate to the highlighted class. This operation is identical to clicking the Create Class () button.

•   Create Subclass using Metaclass...: If you have added metaclasses to your project, this allows you to create a new class, subordinate to the highlighted class, using a metaclass as a template. See Creating a Class Using a Metaclass for more information.

• Delete Class: Deletes the highlighted class and all of its subclasses, removing it from the current project. This operation is identical to the Delete Class () button.

•   Change metaclass: Changes the metaclass of the highlighted class. See Changing the Metaclass of a Class for more information.

•   Change metaclass of subclasses: Changes the metaclass of all subordinate classes to the metaclass of the highlighted class.

• Hide class: Makes the highlighted class hidden. If the class is already hidden, the selection is Make class visible.

•   Set as Default Metaclass: Makes the selected metaclass the default; that is, new classes will automatically be created using this as a template.

•   Set as Default Slot Metaclass: Makes the selected metaclass the default slot metaclass; that is, new slots will be created using this as a template.

• Expand: Shows all classes that are subordinate to the highlighted class. This is a multi-level display operation that is more extensive than clicking the icon, which only shows the next level of direct subclasses.

• Collapse: Hides all classes that are subordinate to the highlighted class.

  Metaclasses are an advanced feature; you should have a good understanding of before you use metaclasses.

The Class Search Bar

The Class Search Bar in the Class Browser allows you to type the name of a class and locate it in the Class window by clicking the Search for Class () button.

Class Search Bar

The Superclasses Pane

The Superclasses pane, at the bottom of the Class Browser, displays all superclasses of the currently selected class.

Superclasses pane, in Class Browser

Note: If you cannot see the Superclasses pane, your window may be too small. You can see the pane by enlarging your window or by dragging the slider bar at the bottom of the Class Browser. See Working With a Small Window for more information.

Viewing the List of Superclasses

To see a list of all superclasses of a given class, highlight any occurrence of the class in the Class Browser. The Superclasses pane automatically displays a list of all of the superclasses of the selected class.

Adding a Superclass

To add a superclass to the selected class, click the Add Superclass () button, highlight the class you want as an additional superclass in the Select Class window, then click OK. See Adding a Superclass for more information.

Removing a Superclass

To remove a superclass from the list of superclasses for the selected class, highlight the superclass you want to remove and click the Remove Superclass () button. The superclass/subclass relationship is broken, but the superclass is not deleted from the knowledge base. See Removing a Superclass for more information.

Locating Another Superclass

To jump to a different superclass in the Class Browser, click on any superclass in the Superclasses pane. The highlight in the Class Browser automatically moves to the occurrence of the class which is directly under the chosen superclass. If the occurrence is not currently visible in the Class Browser,

automatically scrolls to the correct location

and expands the hierarchy to make the class visible. See Jumping to Another Superclass for more information.

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.

Class Editor

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.

sets the role to Concrete, by default.
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.

Constraints

builds relationships

(e.g., between classes and instances, slots and slot facets). However, these relationships may be insufficient to capture all the constraints that hold among the frames of the knowledge base. Typically, does not offer a way of relating the values of different slots attached to a given class, nor does it help in relating the slot values of different instances of a class.

For example, in the newspaper project, one might want to state that editors should have a higher salary than the employees for whom they are responsible (i.e., a constraint that involves the Editor and Employee classes and the salary and responsible_for slots).

The Axiom Language (PAL) extends the knowledge modeling environment with support for writing and storing logical constraints and queries about frames in a knowledge base. PAL is a plugin toolset that comprises engines for checking constraints and running queries on knowledge bases, as well as a set of useful user interface components. PAL's primary purpose is to support the definition of arbitrary logical constraints on the frames of a knowledge base.

Information about constraints can be found in the [/paltabs/PAL_tabs.html PAL section] of the Plugins Library, including a [/paltabs/pal-quickguide/index.html quick reference guide] and [/paltabs/pal-documentation/index.htm comprehensive documentation].

The Template Slots Pane

The Template Slots pane, at the bottom of the Class Editor, 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, Article has a number of slots which appear in the Template Slots pane.

Template Slots pane

The Template Slot Buttons

The buttons at the upper right of the Template Slots pane allow you to edit, override, add, and remove slots. See the separate Template Slot buttons topic for more information.

You can also view, create, and delete slots directly from the Slots tab. See the Slot buttons for more information.

The Template Slot Menu

Right-clicking anywhere in the Template Slots pane brings up the Template Slot menu, which allows you to edit, override, add, and remove slots. These are the same actions provided by the Template Slot buttons.

Template Slot menu

The Slot Icons

The icons at the left of the column give information about the slot.

Slot Summary Columns

The columns in the Slot Templates pane summarize the slot properties; these can be viewed and edited in the Slot Editor or Slots tab.

The Template Slot Buttons

The Template Slot buttons, located at the top right of the Template Slots pane, allow you to view/edit, override, create, remove overrides, add, or remove a slot for the current class. You can also access these commands by right-clicking on the slot and selecting an action from the Template Slot menu.

Template Slots menu, "View Top-Level Slot" selected

Note: You can also view and create slots directly from the Slots tab, as well as deleting a slot from the project. See the Slot buttons for more information.

The buttons have the following actions:

The References Window

In a complex project, it is possible to have many different relationships between classes, instances, and slots. A reference for a frame is any other frame that has a direct relationship to it. The References window can be viewed by selecting an item and clicking on the References ( or ) button. See

     Viewing References for more information.

References to Advertisement dialog, "name" selected

It is also possible to view those classes that are related through a particular slot, using the Relations Menu.

Examples

For example, references for a class include:

• any superclasses of the class

• any direct subclasses of the class

• any instances of the class

• any direct slots (inherited slots are not considered to be references)

• any notes at the class

• the metaclass of the class

For a slot, references include:

• any superslots or subslots

• :STANDARD-SLOT or other slot metaclass

• any classes that have the slot attached as a direct slot

The References window allows you to view a list of all the references of a selected frame.

The View Buttons

The Frame Column

This column shows the name of each frame that references the highlighted item. The type of frame is indicated by a class icon, slot icon, or instance icon ().

The Slot Column

This column specifies the slot that actually references the selected item. Note that provides standard slots which indicate the relationship between the selected item and the referencing frame. For example:

The name of any other slot in the project may also appear in this column.

The Facet Column

This column gives information about the facet value for certain types of references and gives information about the slot relationships between classes. For example, an item may appear as a value for a slot which is called by that frame.

In the illustration above, the class Author appears as an Allowed Class for the slot author, as shown in the second row. In addition, the slot author appears as a slot for the class Article. Therefore, Article references Author. This reference appears in the fifth row in the example.

For an embedded reference of this type, the facet value column specifies whether the selected item appears as an Allowed Class or an Allowed Superclass.

Creating a New Class

To create a new class:

1. In the Class Browser, highlight the class that you want to be the superclass of the new class.

   

   Class Browser, "Author" class highlighted

2. Click the Create Class () button in the class buttons area at the right of the Class Browser. Alternatively, you can click the right mouse button and select Create Class from the class menu.

   

   Class menu, "Create Class" selected

3. The new class will be added under the highlighted class. It will have a default name, such as newspaper_Class_1.

   

   addition of newspaper_Class_1 class

4. Use the Class Editor to name the class, choose its role, create constraints, and create and edit slots. See Editing a Class for more information.

Class Editor

Creating Multiple Subclasses

supplies a wizard

that lets you quickly create multiple subclasses of a selected class.

1. At the Classes tab, select the class you want as a superclass for the classes you create.

2. Select Tools | Wizards, then select Create multiple subclasses from the submenu.

3. Set your options:

   • To have all classes you create begin the same way, enter an optional prefix.

     

     Create multiple subclasses dialog, entering a prefix

   • To have all classes you create end the same way, enter an optional suffix.

   • If you select Tab indent to create hierarchy, you can use tab indents, as described in Step 5.

4. Enter your class names:

   • Type the name of a class, then press Enter to begin entering a second class.

   • You can edit or delete the name of any class you have already entered by moving the cursor to that name. You can also cut and paste text within and between class names.

   • If you enter an invalid character (e.g., /) in a class name, the name will be highlighted in red. You can edit the class name from the keyboard, or you can click Tidy to have automatically substitute an underscore (_) for each invalid character.

5. To create subclasses of a class, make sure that Tab indent to create hierarchy is selected. Then, use the tab key to create a hierarchy:

   • No tabs means the class will be a direct subclass of the selected superclass.

   • A single tab means the class will be a subclass of the nearest untabbed class above it in the list.

   • N tabs means the class will be a subclass of the nearest class with N-1 tabs above it in the list. For example, suppose you are creating subclasses of Superclass and you enter the following:

   1. Subclass direct subclass of Superclass

   2. Subclass_II direct subclass of Superclass

   3. SubSubclass subclass of Subclass_II

   4. SubSubSubclass subclass of SubSubclass

   5. SubSubclass_III direct subclass of Superclass

      Note: Extra Tab characters will be ignored. For example, if you insert a Tab before the first class name in the list, it will still be created as a direct subclass of the selected superclass.

6. Click Finish or type Ctrl-Enter (Cmd-Enter). The wizard will display a list of classes that have been added. This is informational only - you cannot cancel at this point.

   

   Create multiple subclasses dialog, result display

7. Click Finish to exit the wizard.

   

   wizard exited; result appears

The new classes will inherit all the properties of their superclass. If you wish to make any additional edits to your classes (e.g., attach an additional slot or override an inherited slot), use the Class Editor.

Deleting a Class

Deleting a class deletes the class and all of its subclasses. Once a class has been deleted, it cannot be recovered. You may wish to archive your project before deleting.

Deleting a Single Class

To delete a class from the knowledge base:

1. Highlight the class you want to delete in the Class Browser.

2. Click the Delete Class () button or click the right mouse button and choose Delete selected class from the Class menu.

3. You will be prompted for confirmation. Click OK. The selected class and any subclasses will be deleted.

Deleting Multiple Classes

To delete multiple classes:

1. Highlight one or more classes in the Class Browser. To highlight multiple classes, hold down the Ctrl (Cmd) key while clicking each class. To highlight a range of classes, click the first class, then hold down the Shift key and click the last class in the range.

2. Click the Delete Class () button. You cannot use the Class menu to delete multiple classes.

3. You will be prompted for confirmation. Click OK.

Undeletable Classes

The following types of classes cannot be deleted:

• system classes

• classes included from another project

Displaying the Class Editor

You can view or edit an existing class using the Class Editor.

Note: If the class is a system class or has been included from another project, it cannot be edited. Included classes are shown with a pale class icon to the left.

Whenever you enter changes into the Class Editor, they are immediately visible everywhere in the project. To write the changes to disk, select File | Save Project.

Using the Classes Tab

To view or edit a class from the Classes tab:

1. Select the class you want to edit in the Class Browser in the Classes tab.

2. Enter the updated information directly in the Class Editor to the right.

Displaying the Class Editor as a Free-standing Window

You can open the Class Editor to view or edit a class anywhere the View Class () button appears, including the following locations:

• the Classes tab

• the Class Browser at the Instances tab

• the Allowed Superclasses pane for a slot of type Class

• the Class Entry field at the Queries tab

• the References window

To view or edit a class using the Class Editor:

1. Select the class you want to edit.

2. Click the View Class () icon at the upper right of the pane to open the Class Editor as a free-standing window.

To view or edit the information for several classes at once, open a separate Class Editor for each 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.

Managing Multiple Editors

If you have multiple editor windows open, you can manage them as follows:

• Cascade multiple windows by selecting Windows | Cascade Windows.

• Close all open editor windows by selecting Windows | Close All Windows.

Editing a Class

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

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 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 (, , ) 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 () button.

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

• To delete a note from the current class, click the Delete Class Note () 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.

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:

• edit a slot at the top level using the View Top-level Slot () button.

• override a slot at the class using the View Slot Overrides () button; slots that have been overridden are displayed with an override () icon.

• create a new slot using the Create Slot () button.

• remove slot overrides using the Remove Slot Overrides () button.

• add an existing slot to the class, using the Add Slot () button.

• remove a slot from the class using the Remove Slot () button; the slot is removed from the class, but still exists in the knowledge base.

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 () 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.

Editing Template Slots

The Template Slots pane in the Class Editor allows you to add, clear, create, edit, override, and remove slots.

Editing a Top-level Slot

To edit a slot at the top level:

1. Highlight the slot name in the Template Slots pane.

2. Click the View Top-level Slot () button at the top right of the pane. The Slot Editor will be displayed.

3. Use the Slot Editor to edit slot properties such as Name, Type, and Cardinality, and to add notes. See Viewing a Slot for more information on how to edit a slot.

Overriding a Slot at a Class

To override a slot at the class:

1. Highlight the slot name in the Template Slots pane.

2. Click the View Slot Overrides () button at the top right of the pane. The Slot Editor will be displayed.

3. Use the Slot Editor to edit slot properties such as Name, Type, and Cardinality, and to add notes. See Viewing a Slot and Overriding Slot Properties at a Class for more information.

Your class can have slots that were inherited () from a superclass. If the slot is inherited, there are limitations on the edits that can be performed. Direct slots, which were created or added at the level of the slot, have no editing restrictions.

If you edit a slot at the class level, the slot is displayed with an override () icon.

Creating a New Slot

You can define a new slot for your class.

1. Make sure the correct class is highlighted in the Class Browser.

2. Click the Create Slot () button at the top right of the pane. The Slot Editor will be displayed.

3. Use the Slot Editor to edit slot properties such as Name, Type, and Cardinality, and to add notes. See Creating a Slot for more information on how to create a slot.

A direct slot is displayed with a blue () icon.

Clearing Slot Overrides

If you have overridden a slot at the class, you can remove your overrides and use the top-level definition of the slot:

1. Highlight the slot name in the Template Slots pane.

2. Click the Remove Slot Overrides () button at the top right of the pane. Any changes you made at the class level are removed and the top-level definition of the slot is used. See Removing Overrides From a Slot for more information.

Adding an Existing Slot to a Class

Once slots have been created, you can add them to more than one class. For example, the Prototype_Newspaper class has a Weekday slot, which can be used to choose among the days of the week. If you were creating a new type of employee who wrote a weekly feature, you might want to reuse this slot.

To choose a pre-existing slot to add to your class:

1. Make sure the correct class is highlighted in the Class Browser.

2. Click the Add Slot () button at the top right of the pane. The Select Slots dialog box displays all the slots that you can add to the class.

3. Highlight the slot that you wish to add to your class.

4. Click OK.

The new slot is added to the Template Slots pane. It is a directly-attached slot and is displayed with a blue () icon. You do not need to name the slot; however, you may need to override its facets. If you wish to override the facets on the slot, you may click the View Top-level Slot () or View Slot Overrides () button to display the Slot Editor. See Viewing a Slot for more information.

Removing a Slot

You can remove any direct slot that appears in the Template Slots pane. To remove a slot:

1. Highlight the slot

2. Click the Remove Slot () button. The slot will be removed from the class.

Note that the slot has not been deleted from the knowledge base. It will still appear in the Select Slots dialog box (see

      Adding an Existing Slot to a Class, above)

and the Slots tab. See Deleting a Slot for more information.

Finding a Class

To find a class in the Class Browser:

1. Type all or part of the name of the class in the Class lookup bar. Matches will be found for classes whose names begin with the entered text. Matching is case-insensitive.

   

   Class lookup bar

2. Press Enter/Return or click the Search for Class () button. If there is one match, the class will be highlighted. Otherwise, you will get a dialog box of all the matches, and you will be able to select one.

   

   search results dialog box

If a matching class is not currently visible in the Class Browser,

automatically scrolls to the correct location

and expands the hierarchy to make the class visible.

Note: If you are unable to find the class you are looking for, the class may be hidden. To verify that hidden classes are displayed, choose Project | Configure, go to the Options tab, and make sure the Display Hidden Classes option is checked. Hidden classes are shown with a gray icon (e.g., ).

Hiding a Class

You can hide a class, using the Class menu. Hidden classes are still part of your project, but are not visible. You can use this, for example, if you want to restrict the user's view to a part of your knowledge base, but want to retain the structure of the larger project. All subclasses of a hidden class are also hidden.

You can choose whether or not hidden classes are displayed in the Class Browser by choosing Project | Configure, going to the Options tab, and toggling the Display Hidden Classes option. See Configuring a Project for more information.

Hiding a Class

To hide a class:

1. Select the class in the Class Browser.

2. Click the right mouse button to display the Class menu.

3. Select Hide Class and click the left mouse button.

   

   Class menu, "Hide Class" selected

4. If hidden classes are visible in your project, you will see a gray icon (e.g., ), indicating that the class is hidden. If hidden classes are not visible in your project, you will no longer see the class or any of its subclasses.

Making a Hidden Class Visible

To make a hidden class visible:

1. If you cannot see your class because hidden classes are not currently displayed, make hidden classes visible. To do this, choose Project | Configure, select Options, and make sure that Display Hidden Classes is selected.

2. Select the class you wish to make visible.

3. Click the right mouse button to display the Class menu.

4. Select Make Hidden Class Visible and click the left mouse button.

   

   Class menu, "Make Hidden Class Visible" selected

   Note: If your class has a superclass which is hidden, it will still not display.

5. The gray icon will be removed from your class.

Replacing a Superclass

You can move a class to a different superclass, using drag-and-drop in the Class Browser. This will remove the class from one superclass and make it a subclass of another superclass. Note that when you replace the superclass of a class, the class will often lose and gain inherited slots.

Moving a Class

To move a class:

1. Select the class you want to move. If the class has more than one superclass, select the view of the class that appears under the superclass you want to replace.

2. Hold down the mouse button and drag the class on top of the new superclass.

3. Release the mouse. The subclass will no longer be under the original superclass, but will now be located under the new superclass. Note that the slots of the moved class will automatically change to reflect the inheritance from its new superclass.

You can also add a superclass by holding down the Ctrl (Cmd) key while you drag.

Example

The following example shows how to make Columnist inherit from Employee, rather than the class Person.

1. Highlight Columnist in the Class Browser. Because Columnist has more than one superclass, you must make sure to select the copy of Columnist that is under Employee. (When a class has more than one superclass, you can use the Superclasses pane to select the copy that you want. See Jumping to a Different Superclass for more information.) Note that the Template Slots pane for Columnist includes slots it inherits from Employee.

   

   Class Browser, "Columnist" selected

2. Hold down the mouse button and drag Columnist on top of the new superclass Person.

3. Release the mouse button to drop the class. Person is outlined and the Class Browser redisplays to show the new hierarchy. The dragged class and all of its subclasses, if any, will be moved from the original superclass to the new superclass.

   

   Class Browser, "Person" outlined, "Columnist" selected

If you highlight Columnist after it has been repositioned, you will see that some of the slots it had before are now missing. These were the slots it inherited from Employee.

Class Browser, "Columnist" selected, some slots missing

Adding a Superclass

Classes in can have more than one superclass. Classes inherit the properties of every one of their superclasses, so by adding a superclass to a class, you are adding all of its slots as well.

Note: If you cannot see the Superclasses pane, your window may be too small. You can see the pane by enlarging your window or by dragging the slider bar at the bottom of the Class Browser. See Working With a Small Window for more information.

Adding a Superclass in the Superclasses Pane

To add a superclass using the Superclasses pane:

1. Select the subclass in the Class Browser.

2. Click the Add Superclass () button in the Superclasses pane (located at the bottom left of the Classes tab, below the Class Browser). A Select Classes window will appear.

   

   Superclasses pane, "Employee" selected

3. Choose the additional superclass(es) you want from the Select Classes window. To highlight multiple classes, hold down the Ctrl (Cmd) key while clicking each class. To highlight a range of classes, click the first class, then hold down the Shift key and click the last class in the range.

   

   Select Classes window, ":THING" selected

Note: If nothing happens when the class is dropped over a new superclass, the target class is not allowed to be a superclass of the dragged class. For example, descendants of the dragged class are excluded.

Adding a Superclass Using Drag-and-Drop

To add a superclass, using drag-and-drop in the Class Browser:

1. Select the subclass in the Class Browser.

2. Hold down the mouse button and drag the subclass over the additional superclass.

3. Hold down the Ctrl (Cmd) key and release the mouse button to drop the subclass. The system will add the new superclass to the subclass.

Note: If you do not hold down the Ctrl (Cmd) key when releasing the mouse, the operation is interpreted as Moving a Class.

Multiple Superclasses and Inheritance

Adding a superclass results in more than one superclass for a class, which then inherits the slots and facets of all of its superclasses. For example, the Columnist class in the Newspaper example has two occurrences in the Class Browser: one with the superclass Author, and one with the superclass Person; it inherits slots from both superclasses.

Jumping to a Superclass

If a class has more than one superclass, you can use the Superclasses pane to jump from one superclass to another in the Class Browser.

Note: If you cannot see the Superclasses pane, your window may be too small. You can see the pane by enlarging your window or by dragging the slider bar at the bottom of the Class Browser. See Working With a Small Window for more information.

To jump to another superclass:

1. Highlight any occurrence of the class in the Class Browser. The superclasses of the class are displayed in the Superclasses pane, located at the lower left of the Classes tab, below the Class Browser.

2. Click on any superclass in the Superclasses pane. The highlight in the Class Browser automatically moves to the occurrence of the class which is directly under the chosen superclass. If the copy is not currently visible in the Class Browser, automatically scrolls to the correct location and expands the hierarchy to make the class visible.

In the illustration below, if you clicked on Employee in the Superclasses pane, the highlight in the Class Browser would jump to the copy of Columnist under Employee. If the Employee hierarchy was not currently expanded, it would expand to display the Columnist class.

Class Browser, "Editor" and "Author" selected

Removing a Superclass

If a class has more than one superclass, you can remove one or more of its superclasses. You must leave at least one superclass. The subclass still appears in the knowledge base as a subclass of its other superclass(es).

Note: If the class has only one superclass, the Remove Superclass () button is disabled.

Removing a Superclass

To remove a superclass from a class:

1. Highlight the class that you want to work with in the Class Browser. The superclasses of the selected class will be shown in the Superclasses pane immediately below the Class Browser.

2. Highlight the superclass you want to remove in the Superclasses pane.

3. Click the Remove Superclass () button at the top right of the Superclasses pane. The superclass will remain in the knowledge base, but the superclass/subclass link will be broken.

Example

For example, to remove Employee as a superclass of Columnist in the newspaper project:

1. Highlight Columnist in the Class Browser.

   

   Class Browser, "Columnist" highlighted

2. Highlight Employee in the Superclasses pane.

   

   Superclasses pane, "Employee" highlighted

3. Click the Remove Superclass () button at the top right of the Superclasses pane.

Columnist remains a subclass of Author.

To delete a class from the knowledge base, highlight the class and click the Delete Class () class button. See Deleting a Class.

Viewing Class Relations

If Class_A has a direct slot of type Class or an Instance that includes Class_B in the allowed class(es) of the slot, we say that Class_B is related to Class_A. The Relations menu, available by clicking on the arrow to the right of the class buttons, allows you to choose which relation between classes to show in the Class Browser. This help topic describes the choices on the Relations menu.

Class Relations icon

Example

For example, the responsible_for slot at the Editor class is a class of type Instance that has Employee as an allowed class; this means that Employee is related to Editor.

Relations Menu for Editor

The picture below shows the Class Relationship menu for the class Editor in the Newspaper example. Editor has two Instance slots, responsible_for and sections.

Class Relationship menu, "Show Relation responsible_for" selected

Note: If the highlighted class does not have any related classes, the menu only displays Show Class Hierarchy and Show all Relations.

Selecting Show Relations responsible_for changes the Class Hierarchy window to display only the classes that are related to Editor through the responsible_for slot.

Class Browser, "Editor" selected

The Relations Menu

Show Class Hierarchy

The default Show Class Hierarchy displays the subclass-superclass hierarchy of your knowledge base. All the classes in the knowledge base appear in the displayed tree. (Some classes may be hidden. You can choose whether or not hidden classes are displayed in the Class Browser by choosing Configure from the Project menu, going to the Display tab, and toggling the Display Hidden Classes option.)

Show All Relations

Show All Relations displays a hierarchy of classes that are related to the selected class via its slots, as follows:

• The root is the class (Class_A) that was highlighted when Show All Relations was selected.

• The next level (direct children) consists of any classes (Class_B1, Class_B2, etc.) that are related to Class_A through one or more of its slots.

• The next level consists of any classes (Class_C1, Class_C2, etc.) that are related to one of the classes on the previous level (Class_B1, Class_B2, etc.), through one of the slots of Class_A. Note the following:

  • A class Class_C1 is shown as a child of the class it is related to.

  • If a class is related to more than one class on the previous level, it is shown everywhere it occurs (multiple superclasses).

  • Only classes related through the slots of Class_A are shown; if Class_X is related to Class_B through a slot that is not attached to Class_A, it will not appear.

• Subsequent levels continue the tree of classes that are related to the higher classes via the slots of Class_A.

It is possible (and sometimes useful) to have a recursive relation: Class_A appears somewhere subordinate to Class_A on the tree. This can happen, for example, if Class_B is related to Class_A, which in turn is related to Class_B through a different slot. In this case, all the levels are shown from Class_A to Class_A and the second instance is labeled (recursive).

Show Relation slot

Selecting a slot from the menu will show the hierarchy of classes, starting at the selected class, that are related to each other only through the slot selected on the menu. The slot-specific view can be read as "parent-relation-child", where "relation" is the slot selected on the Relations menu. For example, in the responsible_for view, Editor - is responsible for - Employee.

This view is not necessarily a subset of the Show All Relations view. If Show All Relations has recursion, the view restricted to a single slot can be quite different and possibly more extensive. Consider the following situation:

• Class_A and Class_B both have slot_a and slot_b.

• Class_B is related to Class_A through slot_a.

• Class_A is related to Class_B through slot_b.

• There are a number of additional classes that are related to Class_B through slot_a.

In this case:

• Show All Relations will display Class_A and Class_B in a two-level recursion; the class relations from slot_a at Class_B are not shown.

• Show Relation slot_a will show the classes that are related to Class_B through slot_a and any children of those classes.

It is also possible to view a list of all the frames that reference a highlighted class, using the References Class () button. See Viewing References for more information.

The Classes & Instances Tab

The Classes & Instances tab is an optional tab that combines the functionality of the Classes tab and the Instances tab in a single window. In this window, you may view, create, and edit classes and instances.

To display the Classes & Instances tab, use the Configure Project dialog box.

Classes & Instances tab, "Editor" and "Author" selected

The Classes & Instances tab includes the following components:

• A Class Browser at the left shows and allows you to work with the class hierarchy (e.g., creating and deleting classes).

• An Instance Browser allows you to create and delete instances.

• An Editor window on the right displays the information for the current selection. When a single class is selected, the Editor window contains the Class Editor for the selected class. When a single instance is selected, the Form pane contains the Instance Editor for the selected instance.

For information about the Classes tab user interface and accomplishing class-related tasks, see the Classes Table of Contents. For information about the Instances tab user interface and accomplishing instances-related tasks, see the Instances Table of Contents.

Viewing References

In a complex project, it is possible to have many different relationships between classes, instances, and slots. The References window allows you to view a list of all the frames that reference a value.

Note: For classes, it is also possible to view those classes that are related through one or more slots. See Viewing Class Relations for more information.

"References to ..." dialog, "name" selected

Viewing the References Window

To open the References window:

1. Highlight the item for which you wish to see a list of references. Make sure to go to the correct location:

   • For a class:

     1. Go to the Classes tab.

     2. Highlight the item in the Class Browser.

     3. Click the View References to Class () button.

   • For an instance:

     1. Go to the Instances tab.

     2. Highlight the class where the instance appears in the Class Browser.

     3. Highlight the instance in the Instance Browser

     4. Click the View References to Instance () button.

Viewing the Editor for a Reference

To open the Editor for any of the frames shown in the References window:

1. Click on the frame to highlight it.

2. Click the View Reference () button.

Viewing References to a Value

To view the references for any of the frames shown in the References window:

1. Click on the frame to highlight it.

2. Click the View References to Value () button.

For example, clicking on Content in the above window and then clicking View References to Value () would show the references for Content. This allows you to view references to a slot.

Slots

This section of the User's Guide covers the concepts of understanding, creating, and using slots.

Note: Before you create and use slots, you should be confident with the basic interface. You should also be comfortable with projects, project types, windows, and classes.

To return to the main table of contents, click the User's Guide link (located at the top of the table of contents on the right-hand side of this page).

The Slots Tab

The Slots tab provides a single window in which you may view, create, and edit slots. Slots usually represent properties of classes or relationships between classes. For example, the name slot represents the property of having a name. Once you have created a slot, you can attach it to a class. When name is attached to the Person class, it represents the name of the person.

Although slots are usually thought of in terms of classes, they can be defined and manipulated independently, and can exist without any relationship to classes.

The tab consists of two panes:

1. The Slot Browser, on the left, shows all the slots in the project. It allows you to edit existing slots, create new slots, and delete slots, as well as work with superslots.

2. When a single slot is selected, the Slot Editor for the selected slot is shown at the right. The Slot Editor allows you to name the slot, choose its cardinality and value type, define constraints, defaults, and maximum and minimum values, as well as provide a brief description. The Slot Editor can be displayed as a separate window by clicking the View Slot () button in the Slots pane. The Slot Editor can also be accessed from the Templates Slots pane in the Classes tab.

Click on an area in the picture to jump to it:

Slots tab

For information about the Slots tab user interface and about accomplishing specific tasks, see the Slots Table of Contents.

The Slot Browser

The Slot Browser, on the left of the Slots tab, displays the all the slots in your project. The Slot Browser includes the following:

1. Slot buttons allow you to create (), view/edit (), and delete () classes in your knowledge base.

2. The Slot Hierarchy window: displays your slot hierarchy. Icons give additional information about your slots. In this window you can:

   • rearrange the slot hierarchy, using "drag-and-drop".

   • select a slot and see its information displayed in the Slot Editor to the right.

   • right-click a slot to use the Slot menu, which allows you to create and delete slots as well as work with slot metaclasses.

3. Slot search bar: allows you to find a slot in the Slot Hierarchy window by typing all or part of the slot name and clicking the Search for Slot () button.

4. Superslots pane: allows you to add and remove superslots for a slot as well as jump to a different superslot in the hierarchy view.

Slot Browser

For information about the Slots tab user interface and about accomplishing specific tasks, see the Slots Table of Contents.

The Slot Buttons

The slot buttons, located at the top right of the Slot Browser in the Slots tab, allow you to view/edit, create, or delete a slot. You can also perform these commands by right-clicking on a slot and selecting a command from the Slot menu.

The buttons have the following actions:

You can also view, create, and edit slots from the Template Slots pane. See the Template Slot buttons for more information.

The Slot Menu

Whenever you have a slot selected in the Slot Editor, you can access the cascading slot menu by clicking the right mouse button. This menu allows you to perform a number of slot-related tasks.

To access the slot menu:

1. Select a slot in the Slot Editor.

2. Click the right mouse button. The cascading slot menu will be displayed.

   

   cascading slot menu

3. Make your selection and click the left mouse button.

The slot menu allows you to perform the following tasks. Not all tasks are available at all times; tasks that cannot be performed are grayed out. Note that metaclasses and metaslots are advanced features; you should have a good understanding of before you use metaclasses:

• Create slot: Creates a new slot. This operation is identical to clicking the Create Slot () button.

• Create Subslot: Creates a subslot subordinate to the highlighted slot.

• Create subslot using slot metaclass...: (advanced) If you have added slot metaclasses to your project, allows you to create a new subslot, using a slot metaclass as a template.

• Delete Slot: Deletes the highlighted slot and all of its subslots, removing it from the current project. This operation is identical to the Delete Slot () button.

• Change slot metaclass: (advanced) Changes the slot metaclass of the highlighted slot. See Changing the Slot Metaclass of a Slot for more information.

• Change slot metaclass of subslots: (advanced) Changes the slot metaclass of all subordinate slots to the slot metaclass of the highlighted slot.

• Expand: Shows all slots subordinate to the highlighted slot. This is a multi-level display operation that is more extensive than clicking the "collapsed" () icon, which only shows the next level of direct subslots.

• Collapse: Hides all slots subordinate to the highlighted slot. This is a multi-level display operation that is more extensive than clicking the "expanded" () icon to the left of the slot.

The Slot Editor

The Slot Editor can be used to define and edit the attributes, or facets, of a slot. The Slot Editor for the selected slot is displayed at the right of the Slots tab. The Slot Editor can also be displayed as a free-standing window, as follows:

• When you highlight a slot in the Slots tab and then click the View Slot () button.

• When you create a new slot for a highlighted class by clicking the Create Slot () button in the Template Slots pane of the Classes tab.

• When you highlight a slot in the Template Slots pane and then click the View Top-level Slot () or the View Slot Overrides () button.

In the example below, the slot urgent for the class Article was double-clicked in the Template Slots pane. The Slot Editor displays a Boolean Type, with Single Cardinality, and a text documentation pane of the urgent slot.

urgent dialog

A slot can be attached to more than one class. Each slot has a top-level (system) description; the system description can be specialized, or overridden, for a specific class. The scope of your edits depends on how you access the Slot Editor:

• Editing a Top-Level Slot: When you access the Slot Editor via the Slots tab or via the View Top-level Slot () button in the Template Slots pane of the Classes tab, you can view and edit the top-level description; these modifications affect the slot for any class where it occurs.

• Overriding Slot Properties at a Class: When you access the Slot Editor via the View Slot Overrides () button in the Template Slots pane of the Classes tab, you can view and edit the slot properties for the currently highlighted class. Class-level modifications, called overrides, only affect the slot at the current class and its subclasses.

The Slot Editor displays the following information for a slot:

1. Note icons, which allow you to add notes.

2. Name of the slot.

3. Value Type of the slot.

4. Cardinality of the slot.

5. (optional) Minimum and Maximum values for the slot (slots of type Integer or Float only).

6. (optional) Any Documentation that has been entered for the slot.

7. (optional) An Inverse Slot for the slot (slots of type Class or Instance).

8. (optional) Any Template Values that have been defined for the slot.

9. (optional) Any Defaults that have been defined for the slot.

10. Domain of the slot.

For certain value types, an additional pane appears below the Value Type pane:

1. For type Class, the Allowed Superclasses pane appears.

2. For type Instance, the Allowed Classes pane appears.

3. For type Symbol, the Allowed Symbols pane appears.

Note Icons

The note icons (, , ), at the upper right of the Editor, allow you to add and remove yellow sticky notes to your slot. These notes, which are not part of your ontology, are displayed when the slot is selected at the Slots tab. For information on how to add notes to any frame (class, instance, or slot), see Working with Notes.

Slot Name

You can edit the slot name directly in the Name field. Slot names are case-sensitive. A recommended convention is to make slot names lowercase, separating adjacent words with an underscore (_).

Value Type Menu

The Value Type menu allows you to select the slot value type, which determines the kind of values that the slot may hold. When you are creating instances for a slot, the slot type also determines how the slot is displayed in the Instance Editor. See the Standard Widgets for more information about instances and type.

Value Type menu

The following table summarizes the value types. For a full description, click on the type name:

When a value type of Class, Instance, or Symbol is selected, an additional pane appears below the Value Type menu. This pane allows you to select or create the values for the slot.

Allowed Superclasses pane

Cardinality

The Cardinality field allows you to specify the number of values allowed or required for the slot. This supplies the following options:

Cardinality field options

The default configuration allows the slot to have at most one value; that is, it can have one value or no value. You can change the default by entering a positive whole number in the at least and/or at most options, or by selecting the multiple option:

• required/at least: Sets the minimum number of values for the slot. To use, enter a positive whole number in the at least entry bar:

  • If you enter a value for at least, required is automatically selected.

  • Setting at least equal to one (1) means a value is required for the slot.

  • Setting at least greater than one automatically selects multiple as well.

  • Setting at least equal to 1 and at most equal to 1 specifies that the slot must have exactly one value.

• at most: Sets the maximum number of values for the slot. To use, enter a positive whole number in the at most entry bar:

  • Setting at most equal to one (1) means that the slot can have at most one value; this is called a single slot.

  • Setting at most greater than one automatically selects multiple. The slot can contain multiple values, but there is a limit to the number of values.

• multiple: Allows the slot to have more than one value; multiple values are stored and displayed as a list:

  • As above, to set a minimum number of values, set the at least value.

  • As above, to set a maximum number of values, set the at most value.

  • The lack of an at most value indicates that there is no limit to the number of items the slot may contain.

  • Duplicate values are allowed, although their use is uncommon

Minimum (optional)

This field is applicable only to slots of type Integer or Float.

Minimum allows you to specify a minimum value for your slot. When present, the Minimum value is displayed in the Other Facets column of the Template Slots pane.

When an instance is created for a class with this slot, the value of the slot must be greater than or equal to the minimum. For example, a minimum of zero means instances cannot have negative values.

Together, Minimum and Maximum can be used to define an allowable range.

Maximum (optional)

This field is applicable only to slots of type Integer or Float.

Maximum allows you to specify a maximum value for your slot. When present, the Maximum value is displayed in the Other Facets column of the Template Slots pane.

When an instance is created for a class with this slot, the value of the slot must be less than or equal to the maximum. Together, Minimum and Maximum can be used to define an allowable range.

Documentation (optional)

The Documentation field allows you to enter a text description of the slot. Filling in this field is optional, but is recommended to make maintaining the knowledge base easier. This documentation is part of your knowledge base.

Inverse Slot (optional)

Only available for slots of type Class or Instance.

Allows you to create a reciprocal relationship between two slots. If this relationship is set up correctly, assigning a value (i.e., a specific class or instance) to the slot for one instance automatically assigns the instance as a value to the appropriate inverse slot. For example, the "direct superclass/direct subclass" relationship is actually an inverse slot relationship. See Understanding Inverse Slots and Creating an Inverse Slot Relationship for more information.

If a slot has an inverse slot, the name of the inverse slot is shown after the slot name at the Slots tab.

Template Values (optional)

Allows you to specify the value(s) for a slot at the class level:

• The template value is a required, uneditable value that is filled in for all classes and instances that use or inherit the slot.

• The template value can not be changed or overridden at the instance level.

• The number of Template Values should not exceed the at most value for the Cardinality of the slot.

For a value that can be overridden, use Defaults instead.

When present, any Template Values are displayed in the Other Facets column of the Template Slots pane in the Classes tab.

Defaults (optional)

Allows you to specify default value(s) for a slot:

• When an instance is created for a class that has this slot, the default is automatically entered as the value of the slot.

• The default value can be changed or overwritten.

• The number of defaults should not exceed the at most value for the Cardinality of the slot.

When present, any Defaults are displayed in the Other Facets column of the Template Slots pane in the Classes tab.

Domain

The set of classes where the slot is attached is called the domain of the slot. For example, the slot urgent is attached to a single class, Content, while the slot name is attached to a number of classes:

Domain field for "urgent"

Domain field for "name"

See Adding a Slot to a Class for more information about editing the domain of a slot.

Viewing Several Slots

To view the information for several slots at once, select the slots at the Slots tab and click the View () slot button to open the Slot Editor for each slot. To highlight multiple slots, hold down the Ctrl (Cmd) key while clicking each slot. To highlight a range of slots, click the first slot, then hold down the Shift key and click the last slot in the range.

You can also view multiple slots using the View Top-level Slot () or View Slot Overrides () template slots buttons in the Template Slots pane.

Opening a new Slot Editor does not close the previous Editor. This allows you to compare the attributes for two or more slots. Edits can be made directly in any open Editor.

If you have multiple forms open, you can manage them as follows:

• Cascade multiple forms by clicking the Cascade () button below the main menu bar, or by selecting Cascade Windows from the Windows menu.

• Close all open forms by clicking the CloseAllWindows () button below the main menu bar, or by selecting Close All Windows from the Windows menu.

The Value Type Menu

The Value Type menu in the Slot Editor allows you to select the slot value type, which determines the kind of values that the slot may hold. When a value type of Class, Instance, or Symbol is selected, an additional pane appears below the Value Type menu.

Value Type menu

When you are creating instances for a slot, the slot type also determines how the slot is displayed in the Instance Editor. See the Standard Widgets for more information about instances and type.

The following value types are available:

• Any: the slot can take any of the values on the menu.

• Boolean: a logical, Boolean value; i.e., a value that is either true or false

• Class: the slot takes one or more classes as values

• Float: the slot has a floating-point number as a value

• Instance: the slot takes one or more instances as values

• Integer: the slot takes an integer as a value

• String: the slot takes ASCII text strings as values

• Symbol: the slot takes values from a list of strings you define

The Any Value Type

A value type of Any means the slot can take any one of the other values: Boolean, Class, Float, Instance, Integer, String, or Symbol. Any allows you to create a generic slot for a high-level class and then determine the actual value type at a lower level.

If a class inherits a slot of type Any, then the slot may be modified by restricting it to one of the other types. This is the only case where the actual value type of an inherited slot can be changed.

For example, suppose you are modeling a taxonomy for all the vertebrates in an ecosystem, with specific species as the instances. You could create the slot Diet at the Vertebrate class level. Then:

• for the subclass Carnivore, you could restrict the Diet slot to type Instance, so that you could select specific species already in your taxonomy as the diet

• for the subclass Herbivore, you could restrict the Diet slot to type Symbol and list possible food plants by name

A class that has a slot of type Any cannot have instances.

The Boolean Value Type

A Boolean slot holds a logical Boolean value; that is, a value that is either true or false. To set the value type of a slot to Boolean:

1. Create the slot, or view the Slot Editor for an existing slot.

2. Select Boolean from the Value Type menu.

3. The Name of the slot will be used as a label for the checkbox; make sure this is what you want.

When an instance is created for a class with a Boolean slot, the instance entry field corresponding to the slot is a Boolean field and is displayed as a checkbox:

For example, the Personals_Ad class contains the Boolean slot Urgent; the Silly instance of Personals_Ad is not Urgent, while the M137 instance is.

The Class Value Type

A slot of type Class has classes as values. Specifically, when Class is selected as the value type, you specify one or more allowed superclasses. An instance of this class then has a class entry field that takes one of these classes or any of their subclasses as the value(s) of the slot.

Setting the Value Type to Class

To set the value type of a slot to Class:

1. Create the slot, or view the Slot Editor for an existing slot.

2. Select Class from the Value Type menu. The Allowed Superclasses pane will be displayed.

   

   Allowed Superclasses pane

3. To add one or more allowed superclasses, click the Add Class () button.

4. Select the classes you want as allowed superclasses in the Select Classes dialog box. To select multiple classes, use the Ctrl (Cmd) key; to select a range, use the Shift key. When an instance is created, the only values that can appear in the entry field corresponding to this slot will be the listed classes and their subclasses.

   

   Select Classes dialog

5. Click OK.

Removing an Allowed Superclass

To remove a class from the list of allowed superclasses for a slot of type Class:

1. Select the classes to remove in the Allowed Superclasses pane. To highlight multiple classes, use the Ctrl (Cmd) key. To highlight a range of classes, use the Shift key.

2. Click the Remove Class () button at the top of the Allowed Superclasses pane.

Example

For example, the Wines project is a knowledge base which includes, among other information:

• the class Winery, which has wineries as instances

• the class Wine region, which has a subclass hierarchy of regions. For example, Wine region has the subclass French region, which in turn has subclasses such as Bordeaux region and Loire region.

• The slot location, which is of type Class, with Wine Region as the Allowed Superclasses. location is attached to the Winery class.

Slot Editor

When a user creates an instance for Winery, the entry field corresponding to the location slot is a Class Entry field. A user can choose the region from the list of classes subordinate to and including Wine region.

Select Class dialog, "Wine region" selected

Instance Editor

The Float Value Type

A slot of type Float has numbers as values; these numbers may include a decimal point. Values of type Float are stored on your system as floating-point values, and are only as accurate as the representation used by your system.

Setting the Value Type to Float

To set the value type of a slot to Float:

1. Create the slot, or view the Slot Editor for an existing slot.

2. Select Float from the Value Type menu.

3. Fill in the other facets of the slot as desired.

Minimum and Maximum Values

For slots of type Float, you can enter a Minimum and/or Maximum value. See The Slot Editor for more information:

• Minimum allows you to specify a minimum value for your slot. When an instance is created for a class with this slot, the value of the slot must be greater than or equal to the minimum. For example, a minimum of zero means instances cannot have negative values.

• Maximum allows you to specify a maximum value for your slot. When an instance is created for a class with this slot, the value of the slot must be less than or equal to the maximum.

• Together, Minimum and Maximum can be used to define an allowable range.

When present, the Minimum and/or Maximum values are displayed in the last column of the Template Slots pane.

Entering Floating-Point Numbers for an Instance

When entering a Float value for an instance, you can use decimal point or exponential representation. You can enter positive and negative values. For example:

The Instance Value Type

A slot of type Instance has instances as values. More specifically, when Instance is selected as the value type, you specify one or more allowed classes. An instance of the class with this slot then takes instances of the allowed classes or of their subclasses as the value(s) of the slot.

Setting the Value Type to Instance

To set the value type of a slot to Instance:

1. Create the slot, or view the Slot Editor for an existing slot.

2. Select Instance from the Value Type menu. The Allowed Classes pane will be displayed.

   

   Slot Editor, "Instance" selected

3. To add one or more allowed classes, click the Add Class () button.

4. Select the classes you want as allowed classes in the Select Classes dialog box. To select multiple classes, use the Ctrl (Cmd) key; to select a range, use the Shift key.

   

   Select Classes dialog

5. Click OK.

Removing an Allowed Class

To remove a class from the list of allowed classes for a slot of type Integer:

1. Select the classes to remove. To highlight multiple classes, use the Ctrl (Cmd) key. To highlight a range of classes, use the Shift key.

2. Click the Remove Class () button at the top of the Allowed Classes pane.

Example

In the Newspaper example, the slot responsible_for in the class Editor takes instances of the class Employee as values.

Slot Editor, "Instance" selected

The instance Chief_Honcho is responsible for two instances which are descended from Employee: Sports Nut and Ms Gardiner.

Responsible For pane

The Integer Value Type

An Integer slot holds an integer number value. (Recall that integer numbers are whole numbers that are positive, negative, or zero; they cannot include a decimal point. Values of type Integer are stored programmatically on your system as integer values.)

To set the value type of a slot to Integer:

1. Create the slot, or view the Slot Editor for an existing slot.

2. Select Integer from the Value Type menu.

3. Fill in the other facets of the slot as desired.

For slots of type Integer, you can enter a Minimum and/or Maximum value.

• Minimum allows you to specify a minimum value for your slot. When an instance is created for a class with this slot, the value of the slot must be greater than or equal to the minimum. For example, a minimum of zero means instances cannot have negative values.

• Maximum allows you to specify a maximum value for your slot. When an instance is created for a class with this slot, the value of the slot must be less than or equal to the maximum.

• Together, Minimum and Maximum can be used to define an allowable range.

When present, the Minimum and/or Maximum values are displayed in the last column of the Template Slots pane.

The String Value Type

A slot of type String has text strings as values. You can enter ASCII characters for an instance, including upper and lowercase letters, numbers, and the basic symbols on the keyboard, such as !, _, and %. String values can also include spaces.

To set the value type of a slot to String:

1. Create the slot, or view the Slot Editor for an existing slot.

2. Select String from the Value Type menu.

3. Fill in the other fields as desired.

The Symbol Value Type

A slot of type Symbol allows you to create a predefined list of strings; an instance of a class chooses from among these strings. When Symbol is selected as the value type, the Allowed Values pane is displayed. An instance then takes string(s) from among the allowed values as the value(s) of the slot.

To set the value type of a slot to Symbol:

1. Create the slot, or view the Slot Editor for an existing slot.

2. Select Symbol from the Value Type menu. The Allowed Values pane will be displayed.

3. Create the values you want as the list of available values for a slot. To create a value:

   • Click the Create Value () button at the top of the Allowed Values pane.

   • Type the string you want in the Create Symbol window. You can enter ASCII characters, including upper and lowercase letters, numbers, and other common characters, such as !, _, and %.

   • Click OK.

4. When you have created all the values you want for this symbol, fill in the other fields as desired.

To edit a pre-existing value:

1. Click the View Value () button at the top of the Allowed Values pane.

2. Edit the string in the Edit Symbol window.

3. Click OK.

To remove a value from the list of values:

1. Select the values to remove. To highlight multiple values, hold down the Ctrl (Cmd) key while clicking each value. To highlight a range of values, click the first value, then hold down the Shift key and click the last value in the range.

2. Click the Remove Value () button at the top of the Allowed Values pane.

Example

For example, the weekday slot at the class Prototype_Newspaper allows you to choose from among the seven days of the week: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday.

"weekday" slot

An instance has a pop-up menu that allows a user to choose one of the symbol values for the slot:

Instance dialog, showing pop-up menu

Creating a New Slot

A new slot is created with a generic name, such as newspaper_Slot_1. There are three ways to create a slot:

• By clicking the Create Slot () Slot button in the Slot pane of the Slots tab. This creates a slot, but does not assign it to any class. The slot can later be attached to one or more classes.

• By right-clicking in the Slot Browser in the Slots tab and selecting Create slot from the Slot menu. This is identical to the previous operation.

  

  Slot menu, "Create Slot" selected

• By selecting a class in the Classes tab and then clicking the Create Slot () button in the Template Slots pane. This creates a slot and attaches it to the selected class.

You can use the Slot Editor to edit the properties of the slot.

Viewing a Slot

You can view and edit a slot at two levels:

• View/edit the top-level properties of a slot. This changes the fundamental definition of the slot all across the project, including the Slots tab and all classes that reference the slot.

• View/override the slot at a class. This creates "overrides" that appear at the class and any subclasses. The slot remains unchanged at the Slots tab, any superclasses, and any unrelated classes. A slot with overrides is shown with an override () icon in the Template Slots pane.

In either case, you can edit the properties of the slot directly in the Slot Editor. See Editing Slot Properties for more information. Any changes you enter into the Slot Editor take effect immediately. To make the changes permanent, save the project by selecting Save from the Project menu.

Editing a Top-Level Slot

Editing at the top-level changes the definition of the slot. The changes appear everywhere the slot occurs, including the Slots tab and all the classes that reference the slot.

You can edit the top-level properties of a slot in two locations:

• directly from the Slots tab

• by using the View Top-level Slot () button in the Template Slots pane.

From the Slots Tab

To edit the properties of a slot from the Slots tab:

1. Select the slot you wish to edit in the Slot pane of the Slots tab.

2. Click the View Slot () button or press Enter/Return. This will open the Slot Editor for the selected slot.

From the Template Slots Pane

To edit the top-level properties of a slot from the Template Slots pane in the Classes tab:

1. Select a class in the Class Browser in the Classes tab.

2. Select the slot you wish to edit in the Template Slots pane.

3. Open the Slot Editor in one of the following ways:

   • Click the View Top-level Slot () Template Slot button at the upper right of the template Template Slots pane

   • or Double-click the slot and select View top-level slot in the Select Slot View dialog box, then click OK.

     

     Select Slot View dialog

You can also override the slot properties at a class and all of its subclasses without changing the top-level slot. See Overriding Slot Properties at a Class for more information.

Overriding Slot Properties at a Class

You can override slot properties by editing the slot at the class level. This allows you to be more restrictive about the slot facets relative to that class. A slot with overrides is shown with an override () icon in the Template Slots pane.

You can also edit the properties of a slot directly, instead of just overriding them at a class. See Editing a Top-level Slot for more information.

Overriding a Slot

To edit the slot properties for a specific class:

1. Select a class in the Classes tab of the Class Browser.

2. Select the slot you wish to edit in the Template Slots pane.

3. Open the Slot Editor in one of the following ways:

   • Click the View Slot Overrides () Slot button at the upper right of the Template Slots pane.

   • Double-click the slot and select View slot at class in the Select Slot View dialog box, then click OK.

     

     Select Slot View dialog

4. Change the desired properties in the Slot Editor. See Editing Slot Properties for more information.

After you have edited a slot at the class level, the slot will be displayed with an override () icon.

Scope

Overrides appear:

• at the selected class

• at all of its subclasses

Overrides do not appear:

• at the Slots tab

• at any superclasses

• at any unrelated classes

Examples

1. The slot employee_list is a slot of type Instance that takes the value Employee at the top level. By default, whenever you attach this slot to a class, it will range over the instances of Employee. Suppose, however, that for this class, you want to restrict the possible employees to salespeople. By overriding the slot, you can restrict the value range to the Salesperson subclass of Employee for the current class and its subclasses, without affecting the slot value range for any other class.

2. Suppose you had a class of articles which appeared only on work days, not Saturday or Sunday. You could override the slot weekday at that class to remove Saturday and Sunday from the Symbol list for that class only, restricting the possibilities to working days. Once again, the top-level slot and its range at other classes will remain unchanged.

Restrictions

When you override a slot at a class, you can edit slot facets in the same way as you can at the top level. The override will not remove any existing restrictions, however, and may in fact tighten one or more of them:

• The Name of an inherited slot cannot be changed.

• For Cardinality, the slot may be changed from Multiple to Single, but not vice versa. The at least value may be increased; the at most value may be decreased.

• For certain value types, some restrictions apply:

  • For a slot of type Any, the slot may be restricted to one of the other types (Boolean, Class, Float, Instance, Integer, String, or Symbol). You cannot change the type of slots other than type Any.

  • For a slot of type Class, the allowed superclasses can only be changed to subclasses of the allowed superclasses in the superclass.

  • For a slot of type Instance, the allowed classes can only be changed to subclasses of the allowed classes in the superclass.

• A Minimum value (on types Integer or Float) may be created or increased.

• A Maximum value (on types Integer or Float) may be created or decreased.

• Default values cannot be removed.

Note: Currently, when you override a slot, Protege-Frames does not enforce the restrictive property. That is, you could theoretically expand or change the facets of a slot, rather than restricting them. However, it is not recommended that you do this, both because it is not good practice and because Protege-Frames may enforce restriction in the future.

Editing Slot Properties

You can edit the properties of a newly created or existing slot using the Slot Editor.

Slot Name

To change the name of a slot, edit the text in the Name field. Slot names are case sensitive. To distinguish slot names from class names, a recommended convention is to make slot names lowercase.

Value Type

To change the value type of the slot, select a different type from the Value Type menu. The available types are summarized in the following table:

Note: If you are editing the slot from a specific class, and the slot is inherited, the following restrictions apply:

• For an inherited slot of type Any, you can select any one of the other types.

• For an inherited slot of a value type other than Any, you cannot change the type of the slot. However, for slots of type Class, Instance, or Symbol, you can change the choices in the associated Allowed menu.

When a value type of Class, Instance, or Symbol is selected, an additional pane appears below the Value Type menu, as follows:

     Setting the Value Type to Class

     Setting the Value Type

Cardinality

To change whether or not a slot can be composed of more than one item, select a different option for the Cardinality.

Cardinality options

The default configuration allows the slot to have at most one value; that is, it can have one value or no value. You can change the default by entering a positive whole number in the at least and/or at most options, or by selecting the multiple option with no at most value.

• To require a minimum number of values for the slot, enter a positive whole number in the at least entry bar. Setting at least equal to one requires a value for the slot. Setting at least equal to 1 and at most equal to 1 means that the slot must have exactly one value. If you enter a value for at least, required is automatically selected. If you set at least greater than one, multiple is automatically selected.

• To allow the slot to have multiple values, select multiple.

• To allow the slot to have multiple values, but to limit the number of values allowed, enter the maximum number of values in the at most entry var. If you set at most greater than one, multiple is automatically selected.

Note: If you are editing the slot for a specific class, and the slot is inherited, you cannot change the cardinality from single to multiple. The at least field must be greater than or equal to any inherited at least. The at most field must be less than or equal to any inherited at most.

Minimum (optional)

For a slot of type Integer or Float, you can change the minimum value by typing the new value in the Minimum field. If you are editing the slot for a specific class, and the slot is inherited, the new minimum value must be greater than or equal to the inherited minimum.

Maximum (optional)

For a slot of type Integer or Float, you can change the maximum value by typing the new value in the Maximum field. If you are editing the slot for a specific class, and the slot is inherited, the new maximum value must be less than or equal to the inherited maximum.

Defaults (optional)

Allows you to specify the default value(s) for a slot. When an instance is created for a class that has a slot with a defined default, the default value is automatically entered as the value of the slot. The default value can then be changed or overwritten.

For a slot with Single cardinality, Defaults must be a single value or no value; for a slot with Multiple cardinality, Defaults can be more than one item.

When present, any Defaults are displayed in the second-to-last column of the Template Slots pane in the Classes tab.

Documentation (optional)

You can change the text description of the slot directly in the documentation field.

Removing a Slot from a Class

You can remove a slot from a class without deleting it from the knowledge base. You can remove the association between a slot and a class in one of two ways:

• removing the slot from the template slots of the class

• removing the class from the domain of the slot

You can only remove a direct slot from a class; you may not remove an inherited slot. Removing a slot cannot be undone; you may wish to save or archive the project before removing slots.

Removing a Slot at a Class

To remove a slot from the list of template slots for a class:

1. Display the Class Editor for the class which has the slot you want to remove. The slots for the class will be displayed in the Template Slots pane.

2. Highlight the slot(s) you wish to remove in the Template Slots pane. To highlight multiple slots, hold down the Ctrl (Cmd) key while clicking each slot. To highlight a range of slots, click the first slot, then hold down the Shift key and click the last slot in the range.

3. Click the Remove Slot () Template Slot button. Any slots you removed no longer appear among the slots for the class. They are also removed from any subclasses of the class.

Removing a Class from the Domain of a Slot

To remove a class from the classes listed in the domain of a slot:

1. Display the Slot Editor for the desired slot. The Domain is located at the bottom right of the Slot Editor.

2. Select the class(es) you wish to remove from your slot. To remove more than one class, hold down Ctrl (Cmd) while clicking, or use the Shift key to select a range of classes.

3. Click the Remove Class () button at the top right of the Domain facet.

You can also delete a slot from the entire knowledge base, using the Slots tab. See Deleting a Slot for more information.

Deleting a Slot from the Project

You can delete a slot so that it is no longer part of the knowledge base. Deleting a slot cannot be undone. You may wish to save or archive your project before deleting slots.

Deleting a Single Slot

To delete a single slot:

1. In the Slots tab, highlight the slot which you want to remove.

2. Click the Delete Slot () button or click the right mouse button and select Delete selected slots from the Slot menu.

   

   Slot menu, "Delete Slot" selected

   The slot will no longer appear in the list of slots. It will also be removed from any classes where it appears.

Deleting Multiple Slots

To delete several slots at once:

1. In the Slots tab, highlight the slots you wish to remove. To highlight multiple slots, hold down the Ctrl (Cmd) key while clicking each slot. To highlight a range of slots, click the first slot, then hold down the Shift key and click the last slot in the range.

2. Click the Delete Slot () button. The slots will no longer appear in the list of slots and will be deleted from any classes where they appear.

You can also remove a slot from a class where it appears without deleting it from the project. See Removing a Slot for more information.

Adding a Slot to a Class

You can attach a slot to one or more classes. For example, the Prototype_Newspaper class has a Weekday slot, which can be used to choose among the days of the week. If you were creating a new type of employee who wrote a weekly feature, you might want to reuse this slot. You can create an association between a slot and a class in one of two ways: attaching the slot to a class or adding a class to the domain of the slot.

Attaching a Slot to a Class

To attach a slot to a class:

1. Display the Class Editor for the desired class.

2. Click the Add Slot () button at the top right of the Template Slots pane. The Select Slots form will display all of the slots you can add to the class.

   

   Select Template Slots dialog

3. Select the slot(s) you wish to add to your class. To add more than one slot, hold down Ctrl (Cmd) while clicking, or use the Shift key to select a range of slots.

4. Click OK. The selected slot(s) are added to the Template Slots pane as directly attached slot(s), displayed with a blue rectangle () icon.

If you wish to edit or override a slot after adding it, double-click it or click the View Top-Level Slot () or the View Slot at Class () button to display the Slot Editor. See Viewing a Slot and Editing Slot Properties for more information.

Adding a Class to the Domain of a Slot

The domain of a slot (i.e., the list of the classes to which the slot is attached) is shown in the Domain facet of the Slot Editor. You can associate a slot to a class by adding the class to the domain of the slot:

1. Display the Slot Editor for the desired slot. The Domain is located at the bottom right of the Slot Editor.

2. Click the Add Class () button at the top right of the Domain facet.

3. Select the class(es) you wish to add to your slot. To add more than one class, hold down Ctrl (Cmd) while clicking, or use the Shift key to select a range of classes.

   

   Select Classes dialog

4. Click OK. The selected class(es) are added to the Domain for the slot. If you view the Class Editor for the class(es), you will see the slot in the Template Slots pane.

Removing Overrides From a Slot

You can remove any class-level overrides from a slot, using the Remove Slot Overrides () Template Slot button in the Template Slots pane.

To remove the slot overrides at a class:

1. Select the class where you want to remove the overrides in the Class Browser.

2. Select the slot whose overrides you wish to remove in the Template Slots pane. Overrides are indicated by the override () icon.

3. Click the Remove Slot Overrides () button at the upper right of the Template Slots pane. The overrides will be cleared from the slot at this class and all of its subclasses. The slot will now match the top-level definition. Any overrides created at an unrelated class will still exist.

Understanding Inverse Slots

This topic gives an overview of how to analyze a project and design inverse slots in Protege-Frames. An inverse slot relationship is a reciprocal relationship between two slots. Whenever one slot is filled in at one instance, its inverse slot is automatically filled in at another instance, according to the relationship you specified.

This topic describes the most common relationship - an inverse slot relationship between two instances, including the following steps: identifying an inverse relationship, analyzing the Protege-Frames components of the relationship, implementing the relationship in Protege-Frames.

You create inverse slots using the Inverse Slot widget in the Slot Editor. For more information on how to use the user interface, see Creating an Inverse Slot Relationship. Note that if you create an inverse slot relationship after one or more instances have been created, existing instances will not display the inverse slot information.

Example

For example, suppose you want to keep track at the section level of which editor(s) edit which section(s). There is already a slot named sections at the class Editor; it takes instances in the class Section as values:

sections slot

You could create an inverse slot named editor at the class Section which takes instances in the class Editor as values:

editor (inverse) slot

Now, when you edit the instance Mr. Science to assign the value Science to the slot sections, the inverse relationship is tracked by Protege-Frames. At the instance Science, Mr. Science automatically appears as a value for the slot editor.

Identifying the Relationship

First, you must determine if an inverse slot will appropriately represent the structure of your knowledge base. An inverse slot represents a reciprocal relationship that always occurs. For example, if Mr. Science edits the Science section, the Science section is edited by Mr. Science. Protege-Frames supports several different types of inverse relationships:

1. The relationship must be reciprocal.

2. The relationship can be a one-to-one correspondence, or one or both of the slots can have multiple values. For example, Chief Honcho edits a number of sections.

3. The relationship can be between instances in different classes or instances in the same class. For example, likes and is_liked_by would be a relationship where the slot and its inverse slot are both attached to Person.

4. A slot can be its own inverse. shares_ an_ office_ with would be a candidate for an inverse relationship where the inverse slot was identical with the original slot. This is a stronger tie than simply having instances in the same class.

Analyzing the Relationship for Protege-Frames

Once you have identified the relationship in your ontology, you need to analyze it in terms of your Protege-Frames project. For an inverse slot relationship between Instance slots, determine the following:

• What Protege-Frames class(es) do you want for the first set of instances? We will call this first list of classes Class_List_A.

  • Make sure to choose a class or classes that are appropriate for the project.

  • It is most important to choose a class list that is not too small; that is, you need to select a list of classes such that every possible instance is in one of those classes.

  • At the same time, for simplicity, you want the class list to be focused on the instances and not be too broad.

  • This list may consist of a single class. For example, in the newspaper project, one of the reporters, Larry Tennis-Nut, is an eager beaver and sometimes edits the Sports section. It would make sense to expand the list of classes to Editor and Reporter. However, no salesmen or columnists are allowed to edit a section. Therefore, while it would be possible to simply use the class Employee, it is cleaner not to.

• If the second set of instances is different from the first, perform the same analysis for the second set of instances. Call this second list of classes Class_List_B.

  • As before. this list may be a single class.

  • This list may be identical to Class_List_A.

Steps Required for Implementing the Relationship

In this example, we will restrict ourselves to instances in the class Section.

The following steps are necessary to create an inverse slot relationship in a Protege-Frames project:

1. Create a slot of type Instance whose allowed classes are Class_List_A. We'll call this the original_slot.

2. Create another slot of type Instance whose allowed classes are Class_List_B. We'll call this the inverse_slot. If the information is important in your ontology, it is likely that one or both of these slots already exist in the project.

3. Attach your Protege-Frames slots to the appropriate classes.

   • First, add original_slot to every class in Class_List_B. Recall that the target values of original_slot are in Class_List_A. Assigning the slot to Class_List_B is what creates the cross-connection between the classes.

   • Similarly, assign inverse_slot to every class in Class_List_A.

4. Create the inverse relationship between inverse_slot and original_slot. (You can actually do this as soon as both slots are created.)

If you already have a slot original_slot of type Instance in your project and it already has the desired allowed classes and domain, you can create a new slot specifically as the inverse of original_slot. In this case, the inverse_slot has the following properties; you can edit them after creation if necessary:

• inverse_slot is automatically attached to all classes in the list of allowed classes for original_slot.

• its allowed classes automatically includes the list of all the classes where original_slot is attached.

For information on how to use the Protege-Frames interface to make an inverse slot, see Creating an Inverse Slot Relationship.

Creating an Inverse Slot Relationship

The Inverse Slots widget on the Slot Editor allows you to create an inverse relationship between two slots of type Class or Instance.

• You can create an inverse slot relationship in one of two ways: linking two existing slots and creating a new slot as the inverse of an existing slot

• You can also modify inverse slot relationships, removing the inverse slot link between two slots or replacing an inverse slot with another slot.

For an inverse relationship to work correctly, your two slots and the classes where they appear must be designed appropriately. For slots of type Instance, the following situation provides optimal results:

• All classes where the first slot is attached (i.e., the domain of the slot) appear in the Allowed Classes pane for the second slot.

• All classes where the second slot is attached appear in the Allowed Classes pane for the first slot.

However, depending on the structure of your knowledge base, this may not be appropriate or feasible. Other situations are also valid. For example, suppose slots A and B are inverse slots. If one of the allowed classes for slot A does not have B as one of its attached slots, all that happens is that inverse slot value does not get created for those instances. The inverse relationship will still work normally for those allowed classes that do have slot B attached.

A slot can have at most one inverse slot. For more information on designing an inverse slot relationship, see Understanding Inverse Slots.

Note that if you create an inverse slot relationship after instances have been created, existing instances will not display the inverse slot information.

Linking Two Existing Slots

To create an inverse slot relationship between two existing slots, the slots you choose must be of value type Class or Instance. To create the relationship:

1. Open the Slot Editor for one of the two slots; it does not matter which one you choose. You can open the Slot Editor from the Classes tab or the Slots tab.

2. Click the Add Slot () button at the right of the Inverse Slot field.

   

   Inverse Slot field

   Note: If the button is grayed out, you cannot create an inverse slot for the selected slot. Make sure that the slot is of type Class or Instance.

3. Select the slot you want to use from the Select Slot dialog box. Only slots of type Class or Instance will appear.

   

   Select Slot dialog

4. Click OK. The two slots will now be inverses of each other.

You can view the Slot Editor of the second slot by double-clicking on its name in the Inverse Slot field or by using the View Slot () button. You will see that it automatically has the first slot as its inverse slot. You may also wish to check that the Allowed Classes of each slot contains all the possible classes where the other slot will appear.

Creating a New Inverse Slot

To create a new slot and make it the inverse of a slot:

1. Open the Slot Editor for the slot you want to create an inverse for. You can do this from either the Class tab or the Slots tab:

   • On the Slots tab, select the slot from the list of slots in the Slot Browser pane.

   • On the Classes tab, double-click the slot in the list of Template Slots (or select the slot in the list of Template Slots and click the "View Top-Level Slot" button).

2. Click the Create Slot () button at the right of the Inverse Slot Editor.

   

   Inverse Slot bar

   Note: If the button is grayed out, you cannot create an inverse slot for the selected slot. Make sure it is of type Class or Instance.

3. A new class of type Instance is created. The Slot Editor for the new slot opens automatically.

   

   inverse-of-sections dialog

4. Name the slot.

5. The classes where your original slot appears will be automatically entered in the Allowed Classes field. Modify this list if necessary.

6. The classes in the Allowed Classes field of the original slot will be added to the Domain field. Modify this list if necessary. Remember that attaching a slot to a class also attaches it to all subclasses of the class.

7. Make any other changes you wish to the slot definition.

Removing an Inverse Slot Relationship

Removing the inverse slot relationship removes the link between the two classes. Note that, if you remove an inverse slot relationship after instances have been created, existing values that were created by the inverse slot relationship are not removed. Removing an inverse slot only affects the values of new instances. To remove the inverse slot relationship between two slots:

1. Highlight the Inverse Slot field in the Slot Editor for either one of the two slots.

2. Click the Remove () button at the right of the Inverse Slot field. The slot relationship will be removed.

Replacing an Inverse Slot

Replacing the inverse slot relationship at a slot removes the link to the original inverse slot and makes a link with a different, existing, slot. Note that, if you replace an inverse slot relationship after instances have been created, existing values that reflect the original (replaced) inverse slot relationship are retained. Replacing an inverse slot only affects the values of new instance. To replace an inverse relationship:

1. Select the slot you want to have a different inverse.

2. Click the Add Slot () button at the right of the Inverse Slot field.

3. Select the slot you want from the Select Slot dialog box.

4. Click OK. The new slot becomes the inverse slot of the current slot. The original inverse slot is now unlinked from the slot where you made the change and no longer has an inverse slot.

Working with Subslots

Normally, whenever you create a new slot, it is a top-level slot. However, you can also create a subslot of an existing slot.

Understanding Subslots

Subslots have the following characteristics:

• When you first create a subslot, the subslot inherits the properties of the superslot. Only the name is different.

• You can only modify a subslot to make it more restrictive than its superslot. You cannot make it less restrictive.

• When you attach a superslot to a class, all of its subslots are attached.

Subslots allow you to do the following:

• You can create two (or more) slots which share information, but where one slot (the subslot) is more restrictive.

• You can attach multiple related properties, using a single slot. To do this, create a single superslot and then create subslots that define characteristics of the superslot. By attaching the superslot to a class, you automatically attach all of its subslots.

Creating a Subslot

To create a subslot of a slot:

1. In the Slot tab, select the slot that you want as the superslot of your subslot.

2. Click the right mouse button.

3. Select Create Subslot from the Slot menu.

   

   Slot menu, "Create Subslot" selected

4. The new slot is created as a subslot of the selected slot. Except for the name, when created, it has the same properties as its parent slot.

5. You can use the Slot Editor to edit the properties of the new slot.

Restrictions on Edits

When you create a subslot, there are restrictions on the possible edits:

• For Cardinality, the slot may be changed from Multiple to Single, but not vice versa. The at least value may be increased; the at most value may be decreased.

• For certain value types, some restrictions apply:

  • For a slot of type Any, the slot may be restricted to one of the other types (Boolean, Class, Float, Instance, Integer, String, or Symbol). You cannot change the type of slots other than type Any.

  • For a slot of type Class or Instance, you cannot change the allowed classes.

• A Minimum value (for types Integer or Float) may be created or increased.

• A Maximum value (for types Integer or Float) may be created or decreased.

• Default values cannot be removed.

These restrictions are similar to the restrictions on slot overrides, except that you can change the name of a subslot, and you cannot make any changes to the allowed classes of a subslot.

Finding a Slot

To find a slot by name in the Slot Browser:

1. Type all or part of the name of the slot in the Slot lookup bar at the bottom of the Slot Browser.

   

   Slot lookup bar

2. Press Enter/Return or click the Search for Slot () button. If there is one match, the slot will be highlighted. Otherwise, you will get a dialog box of all the matches, and you will be able to select one.

   

   Select from search results dialog

The Slot Hierarchy Window

The Slot Hierarchy window in the Slot Browser displays the slots for the project and allows you to rearrange your hierarchy using "drag-and-drop". By default, the Slot window displays the slot structure of your knowledge base, with all slots shown as descending, directly or indirectly, from the system slot :THING.

Slot Hierarchy window

Description

This window shows the following:

• Subslots appear below their superslots and indented to the right.

• Hierarchy icons indicate how much or how little of the hierarchy is displayed. An "expanded" () icon means all direct subslots of the slot are displayed. A "collapsed" () icon means the slot has direct subslots which are not currently displayed. Clicking on either icon toggles it to the other. If no icon is displayed, the slot has no direct subslots.

  Tip: You can also display all slots below a slot by right-clicking the slot and selecting Expand from the cascading Slot menu.

• The currently selected slot is shown with a highlight.

• Slots with more than one superslot appear more than once in the tree.

• Slot icons show information about your slot.

• If a slot has an inverse slot, the name of the inverse slot is shown after the slot name:

  

  slot entry with inverse slot

Tasks

The Slot Hierarchy window allows you to perform the following tasks:

• You can select a slot by clicking on it.

• You can edit the attributes of a slot in the Slot Editor. When a slot is selected, the Slot Editor appears to the right. You can also open the Slot Editor for one or more selected slots by clicking the View Slot () button.

• You can create a new slot by clicking the Create Slot () button, then creating and editing its attributes in the Slot Editor.

• You can delete a slot by clicking the Delete Slot () button.

• You can search for a slot by typing all or part of the slot name in the Slot lookup bar, then clicking the Search for Slot () button.

• You can work with slot metaclasses, using the right mouse button. See the Slot menu for more information.

You can also rearrange the superslot/subslot relationships:

• You can move a slot to another superslot by selecting the slot, dragging it directly over the new superslot, and then dropping it.

• You can add an additional superslot to a slot by selecting the slot, dragging it over the additional superslot, and holding down the Ctrl (Cmd) key while you drop it.

For additional superslot tasks you can perform, see the Superslots pane.

The Slot Icons

The icons in the Slot Browser and the Template Slots pane give information about the slots. There are two types of icons: slot icons and hierarchy icons.

Slot Icons

These icons give information about a slot. When a class inherits a class from a superclass, icons in the Template Slots pane give information related to the inheritance and overrides; these icons are not shown anywhere else.

Hierarchy Icons

(Slot Browser only) If you have created any subslots, the following icons in the Slot Browser give information about the display of the slot hierarchy:

The Superslots Pane

The Superslots pane, at the bottom of the Slot Browser, displays all the superslots of the slot that is currently selected. This pane provides the interface for adding, locating, removing, or viewing superslots.

Slot Browser, including Superslots pane

Note: If you cannot see the Superslots pane, your window may be too small. You can see the pane by enlarging your window or by dragging the slider bar at the bottom of the Slot Browser. See Working With a Small Window for more information.

Viewing the List of Superslots

To see a list of all superslots of a given slot, highlight any occurrence of the slot in the Slot Browser. The Superslots pane automatically displays a list of all of the superslots of the selected slot.

Adding a Superslot

To add a superslot to the selected slot, click the Add Superslot () button, highlight the slot you want as an additional superslot in the Select Slot window, and then click OK.

Removing a Superslot

To remove a superslot from the list of superslots for the selected slot, highlight the superslot you want to remove, and click the Remove Superslot () button. The superslot/subslot relationship is broken, but the superslot is not deleted from the knowledge base.

Locating Another Superslot

To jump to a different superslot in the Slot Browser, click on any superslot in the Superslots pane. The highlight in the Slot Browser automatically moves to the occurrence of the slot which is directly under the chosen superslot. If the occurrence is not currently visible in the Slot Browser, Protege-Frames automatically scrolls to the correct location and expands the hierarchy to make the slot visible.

Forms

This section of the User's Guide covers the concepts of understanding, creating, and using Protege-Frames forms.

Note: Before you create and use classes, you should be confident with the basic Protege-Frames interface. You should also be comfortable with Protege-Frames projects, project types, windows, classes, and slots.

To return to the main table of contents, click the Protege-Frames User's Guide link (located at the top of the table of contents on the right-hand side of this page).

Understanding Forms

Once you have built the classes and slots of your ontology, you will want to begin to create instances. This is done by filling out forms. The Forms tab allows you to customize the user interface that will be used for entering instances. In Protege-Frames, the expectation is that ontology creation and instance entry could be done by different groups of people:

• The Classes and Slots tabs are used by domain experts and knowledge engineers to create ontologies - that is, to design a set of classes that describe the domain. For example, a team of medical specialists could design an ontology dealing with blood diseases.

• The Instances tab is used to acquire instances. It is typically used by people who are neither domain experts nor knowledge engineers. For example, nurses at a hospital could use the ontology above to enter instances to describe each patient.

The Forms tab generates the basic user interface for instance entry:

• A class has template slots, each of which has a value type.

• The form for a class is composed of widgets, each one of which corresponds to a template slot. The appearance of the widget is based on the slot value type.

• When a user enters an instance, each widget becomes an entry field in the Instance Editor.

Every class, concrete or abstract, has an associated form. For a concrete class, a user defines an instance of the class by filling out the class's form. For an abstract class, the form is used to define layout information which can then be inherited by other classes.

Using the Forms tab, you can customize the appearance of forms. Protege-Frames generates a default form for every class you create, based on the slots that are attached to the class and their slot value types. On the default form, there is a widget for every slot that is attached to the class.

The default form is intended as an initial, useful set of forms; however, these default interfaces are not always user-friendly. For example, if a class has a slot such as name or title, you might want the form to display this field first. The default form probably will not do this for you.

Different slot value types use different widgets: for example, a string slot uses a text entry bar widget, while a Boolean slot uses a checkbox. You can customize the form by moving and resizing widgets and deleting widgets; for some slot value types, you can also select another widget that is different from the default. For example, you can set up a widget which displays Symbol values as icons and allows the user to select those.

The Forms tab also allows you to create several user interfaces for the same ontology - forms for knowledge acquisition can be customized for different groups of users.

The Forms Tab

The Forms tab provides a single window in which you may view and edit prototype forms. The forms you design and create at the Forms tab can be viewed in their final format at the Instances tab. End users will use the finished forms to enter instances into the knowledge base.

The Forms tab consists of two panes:

1. The Form Browser pane, at the left, shows the hierarchy of all the classes and allows you to clear all customizations from your form. You can also create a form with one of the following preset layouts: the default, a form that has been created for a superclass, or a form for another class.

2. The Form Editor pane, at the right, shows the layout of the form associated with the selected class. Each slot in the class is associated with a user-interface widget on the form. If you have not modified the form, Protege-Frames uses a default layout based on the slot type and cardinality.

Forms tab, "Editor" selected

As mentioned above, the forms you design will appear at the Instances tab. Click to see this example as it appears at the Instances tab.

The Form Browser

The Form Browser, at the left of the Forms tab, displays all the classes in your project. To ensure that the selected class is the same one that was selected at the Classes tab or the Instances tab, you can synchronize class trees.

The Form Browser has three components:

1. The Forms window displays the hierarchy of the classes in your project. Icons give more information about the form associated with the class. You cannot change the hierarchy in this window. To edit the hierarchy, use the Classes tab.

2. The Form buttons, at the top right of the pane, allow you to clear all customizations from your form as well as to create a form with a preset layout.

3. The Forms lookup bar, at the bottom of the pane, allows you to locate a form in the Forms window by typing all or part of the name and clicking the binoculars.

Form Browser, "Editor" selected

The Forms Window

This displays all the forms in the project, ordered by the names of their associated classes. When a single form is selected in this window, its associated form is displayed in the Form Editor to the right. If you have not created or modified the form, Protege-Frames uses a default layout, based on the slot type and cardinality.

The following icons, shown at the left of each form name, provide information about the form associated with the class:

Hierarchy Icons

The following icons, shown at the beginning of each line, provide information about the display of the class hierarchy:

The Form Buttons

The Form buttons, at the top right of the Form Browser, allow you to change the layout of the selected form.

You can also customize a form in a number of ways, by customizing global properties as well as changing individual widgets on the form. See the Forms Table of Contents for more information.

The Form Editor

The Form Editor shows the layout of the form associated to the selected class and allows you to edit the form's layout.

Components

The Form Editor has the following components:

1. The Display Slot menu, which allows you to choose the display slot for the form.

2. The Widget Type menu, which allows you to choose a widget type for the currently selected widget, if any.

3. A number of user-interface widgets. The currently selected widget, if any, is outlined in blue. Widgets are translated to entry fields in the Instances tab, and control how users will enter information as instances. Each slot in the class is associated with a user-interface widget on the form.

In addition, double-clicking on the Form Editor brings up a dialog box, as follows:

1. Double-clicking on any widget brings up the Widget Configuration dialog for that widget, which allows you to view widget information and edit the widget's configuration, depending on the widget type.

2. Double-clicking on the background of the Form Editor brings up the Form Configuration dialog, which allows you to view the widget type for each widget, redisplay hidden widgets, and select which widget, if any, takes up most of the horizontal and/or vertical space as the form expands.

Form Editor

Default Layout

If you have not created or modified the form, Protege-Frames uses a default layout, as follows:

1. Widgets appear in an order that is based on their size and type.

2. Each widget has a standard type, based on the slot's value type and cardinality.

3. Each widget has a standard size, based on the widget type.

The layout that you create in the Form Editor appears in the Instance Editor. Users fill in the form, entering instances into the knowledge base. You can use the Form Editor to design an interface which allows easy entry of the disparate types of information represented by the different types of slots.

Editing Tools

There are a number of basic editing tools provided on the Form Editor. Some of the actions you can perform with widgets are:

1. Moving widgets to a different location and/or resizing them.

2. Hiding or redisplaying a widget.

3. Selecting a different type of widget from the Select Widget Type menu.

4. For widgets with buttons, choosing which buttons are displayed.

Note: It is also possible to create customized widgets, using the programmer's interface.

Global Edits

You can also make changes to the global properties of the form, including:

1. Selecting a display slot, which is used to identify the different instances when they are displayed in a list.

2. Selecting a single widget that will expand to take up most of the form, rather than having all widgets resize proportionally.

The Display Slot Menu

The Display Slot menu allows you to choose the display slot, used to identify the different instances when they are displayed in the Instance Browser or on a list.

The display slot can also be set at the Instances tab. See Setting the Display Slot for more information.

Display Slot menu (closed)

Display Slot menu (open)

If you do not select a slot to use as a display slot, Protege-Frames uses a default key, <instance name>, such as newspaper_0017. It is usually helpful to set a display slot.

If you set a display slot for a class, the slot is inherited by any subclasses.

The Selected Widget Type Menu

The Selected Widget Type menu allows you to choose the widget type, that is, the way the information for that slot is formatted for the currently selected widget. The choices for widget type depend on the value type of the slot. Each value type has a default widget for the slot, as well as a preset list of possible widget types, based on the slot's value type.

Clicking on the menu displays a list of possible options for the currently selected widget. Making a new selection will change the appearance of the widget on the form.

Selected Widget Type menu, TextFieldWidget selected

For example, for a String field of Single Cardinality, you can select a number of widgets, including a TextAreaWidget, TextAreaWidget, a UniqueStringWidget, or a YellowStickyWidget.

Various String Widgets

If you select <none> from the Widget Type menu, the widget is removed from the Form Editor and is not displayed in the Instance Editor for that class. To redisplay a widget that has been removed, open the Form Configuration dialog (by double-clicking on the background of the Form Editor) and choose a different display type for the widget.

The Widget Configuration Dialog

The Widget Configuration dialog box allows you to customize the label, buttons, and other properties of a selected widget. This dialog has a number of tabs, depending on the widget type.

Note: To select a different widget type, use the Form Configuration dialog or the Selected Widget Type menu.

The General Tab

The General tab displays the names of the class and slot with which the widget is associated. For simple widgets, the General tab is the only tab that is available.

You can customize the following at the General tab:

• Edit the Label that is used for the widget on the form.

• Create a Tool Tip that displays when the user hovers the cursor over the widget label.

The example below shows the General tab for the Name widget in the Editor form.

Widget Configuration dialog, General tab

The Buttons Tab

The Buttons tab is available for widgets with buttons, such as Class and Instance widgets, as well as all widgets with multiple Cardinality. For example, the dialog box for a standard InstanceListWidget also has a Buttons tab. This tab allows you to choose which buttons to display on the form.

Widget Configuration dialog, Buttons tab

Additional Tabs

The InstanceRowWidget, InstanceTableWidget, and ContainsWidget show additional widget-specific tabs. See the topics for these widgets for more information.

The Form Configuration Dialog Box

The Form Configuration dialog box allows you to:

1. View the list of available widgets for the currently selected form.

2. Change the widget type for any widget, including redisplaying currently hidden widgets.

3. Select a single widget that takes up extra horizontal and/or vertical space as the form expands.

The Widgets Tab

The Widgets tab displays all of the widget information for the form. For example, the Widgets tab in the Form Configuration dialog box for Editor lists all the slots for Editor with the currently selected widget type.

Form Configuration dialog, Widgets tab

If a widget has been hidden by choosing <none> from the Widget Type menu, you can redisplay the widget by selecting a different widget type (under the Widgets tab in the Form Configuration dialog box).

The Layout Tab

The Layout tab displays the current layout information. You can use the Layout tab to choose a widget that will expand when the form expands as the Protege-Frames window is resized. This can be useful, for example, when you have a complex table widget that you wish to have take up most of the form. You can choose a widget that expands vertically and a widget that expands horizontally. If you wish, these can be the same widget.

Selecting <<none>> from the menu means that the widgets do not expand even if the form does. Selecting <<all>> from the menu means that each widget is resized an equal amount. The default is to have all widgets expand horizontally and none expand vertically.

Form Configuration dialog, Layout tab

Default Widget Types

The Form Editor displays a widget for each slot in the class. In the Instance Editor, these widgets are displayed as fields where users can enter the information for that slot. The possible display and options for the widget depend on the type of information that is included in the slot. For more information on the different types of slots and fields, see the Instances Table of Contents.

When Protege-Frames generates a default layout, it creates a default widget for each slot. These widgets are described below. Protege-Frames provides widgets for both Single and Multiple cardinality. For simplicity, only the Single cardinality is shown. For a description of the Multiple cardinality widget, see the topic for the corresponding field.

Note: These topics describe the default widgets only. You can select different formats for the widgets using the Widget Type menu.

In addition to these widgets, Protege-Frames also provides a graph widget, which allows you to display relational information in the form of a diagram or graph.

Additional String Widgets

There are a number of additional widget types available for String widgets.

Single Cardinality String Widgets

The following widgets are available for a String field of Single cardinality. These widgets can be chosen by selecting a String widget at the Forms tab and then selecting the desired widget from the Widget Type menu:

YellowStickyWidget

Displays the string entry field as a yellow sticky note.

YellowStickyWidget

TextAreaWidget

Displays the entry field as a text area - useful for extensive strings.

TextAreaWidget

UniqueStringWidget

Identical in appearance to the default TextStringWidget, but verifies that the entered string is a unique value, i.e., it is not the same value at any other instance.

UniqueStringWidget

URLWidget

Allows the user to enter and display a URL. Entering a URL and pressing Enter/Return or clicking Home () loads the URL into the field. Clicking View in Browser () opens the URL in the default browser.

URLWidget

ImageWidget

Allows the user to enter the path to an image. Pressing Enter/Return loads the image.

ImageWidget

Multiple Cardinality String Widgets

The following widget is available for a String field of Multiple cardinality.

ResourceListWidget

Allows the user to enter a list of URLs; checks to see that the syntax of the entered string is a valid URL, but does not verify that the URL is available. See Using a ResourceListWidget for more information.

ResourceListWidget

InstanceRowWidget and InstanceTableWidget

InstanceRowWidget is an optional widget for slots of type Instance with single cardinality (at most equal to 1). It shows all slot values for the instance. (The default widget, InstanceFieldWidget, only shows the name of the instance that is selected as the value of the slot.)

InstanceRowWidget

InstanceTableWidget is very similar to InstanceRowWidget, except that it is available for Instance slots with multiple cardinality (at most not specified or greater than 1). So, it can display multiple rows of information.

InstanceTableWidget

For information on how to customize the display of this widget, see Customizing an InstanceRow- or InstanceTableWidget.

ContainsWidget

ContainsWidget is an optional widget for slots of type Instance. The default widget, InstanceFieldWidget or InstanceListWidget, lists Instance(s) that are selected as the value of the slot. ContainsWidget actually contains a version of the form for each instance that is a value of the slot.

ContainsWidget is useful primarily for Class or Instance slots where the Class Editor for the Allowed Classes is fairly simple, and where the cardinality is single or small. For a widget that provides a summary of selected fields, see InstanceRowWidget or InstanceTableWidget.

ContainsWidget

For information on how to customize the display of a ContainsWidget, see Customizing a ContainsWidget.

DirectInstancesWidget

DirectInstancesWidget is an optional widget for slots of type Instance. Similar in appearance and operation to the default InstanceFieldWidget or InstanceListWidget, this widget only permits direct instances of the Allowed Classes as slot values.

DirectInstancesWidget

Changing Global Characteristics

You can change global properties of a form, including the display slot and the layout.

Setting the Display Slot

The display slot identifies the different instances when they are displayed in a list. For example, the form for Prototype_Newspaper has the display slot set to weekday. This means that, in the Instance Browser, the different instances are listed by the value in the weekday field.

If you do not select a slot to use as a display slot, Protege-Frames uses a default key, <instance name>, such as newspaper_0017. It is usually helpful to set a display slot.

To set a display slot for a class:

1. In the Form Browser, at the left of the Forms tab, select the name of the class whose form you wish to edit.

2. Click the Display Slot menu. A list of slots will be displayed.

3. Select the slot you wish to use as a display slot.

You can also set multiple display slots and/or set the display slot at the Instances tab. See Setting the Display Slot for more information.

Selecting a Widget that Expands with the Form

You can choose a widget that will expand as the form expands whenever the Protege-Frames window is resized. This can be useful, for example, when you have a complex table widget that you wish to have take up most of the form. To do this:

1. Double-click anywhere on the background of the form, that is, on an area that does not contain a widget. The Form Configuration dialog box will be displayed.

2. Click on the Layout tab.

   

   Form Configuration dialog, Layout tab

3. To select a widget that will take up most of the vertical room when the form expands, select the widget name from the Fill Vertical Space With: menu. Selecting <<all>> means each widget will expand equally.

4. To select a widget that will take up most of the horizontal room when the form expands, select the widget name from the Fill Horizontal Space With: menu. You can select the same widget or a different one. Selecting <<all>> means each widget will expand equally.

To reset the form so that no widget expands more than the others, make sure that <<all>> is selected in both menus.

Note: For additional tasks that change a form's appearance, such as resizing, moving, changing, or hiding a widget, see the Forms Table of Contents.

Moving or Resizing a Widget

Moving a Widget to a New Location

To move a widget on the form:

1. Click on the widget to select it. A blue boundary will appear around the border of the widget.

2. Click in the interior of the widget and hold down the mouse button.

3. Drag the widget to the desired location.

Resizing a Widget

You can easily make a widget smaller or larger by resizing it. To do this:

1. Click on the widget to select it. A border will appear around the selected widget.

2. Click and drag anywhere on the border to resize the widget. Many widgets can only be resized horizontally (narrower or wider). You can resize Multiple Cardinality widgets both horizontally and vertically.

Note: You can select a single widget that will take up most of the form when the Instance Editor is resized on the screen by end users. See Changing a Form's Layout for more information.

Note: To hide a widget so that it won't be displayed on the form, use the Widget Type menu. See Selecting a Widget Display for more information.

Changing Widget Configuration Properties

The Widget Configuration dialog box allows you to customize the label, buttons, and other properties of a selected widget. This dialog has a number of tabs, depending on the widget type. For some widgets, you can customize additional properties. See the specific topic for the widget for more information.

Changing General Properties

You can change the following properties at the General tab of the Configuration dialog box:

• the widget label: Each widget has a label - a string of text displayed in the left-hand corner of the widget. The default layout uses a version of the slot name for the widget label, where underscores are replaced by blanks and the first letters of the resulting words are capitalized. When end users actually enter instances, they use the label to determine the type of information they should enter.

• the widget tool tip: This is displayed as a pop-up when the user holds the cursor over the widget label.

To change the General properties of a widget:

1. Double-click directly on the widget. The Widget Configuration dialog box will be displayed. (Note: If the Form Configuration dialog box is displayed, you have accidentally double-clicked somewhere on the background of the form. Close the dialog box and double-click on the widget.)

   

   Widget Configuration dialog

2. Enter the label you want in the Label field of the Widget Configuration dialog box. You can use a multi-word phrase.

3. To create a tool tip, type the text you want in the Default Tool Tip field.

4. To implement your changes, click OK.

Choosing a Widget's Buttons

Some widgets (e.g., Class and Instance widgets, Multiple Cardinality widgets) have buttons displayed on their upper right corners. You can turn the display of these buttons on and off individually. To choose which buttons are displayed for a widget:

1. Double-click directly on the widget. The Widget Configuration dialog box will be displayed. (Note: If the Form Configuration dialog box is displayed, you have accidentally double-clicked somewhere on the background of the form. Close the dialog box and double-click on the widget.)

   

   Widget Configuration dialog, Buttons tab

2. If the widget has buttons, there will be a Buttons tab in the Widget Configuration dialog box. Click this tab.

3. Select the buttons you want to display by making sure there is a check in the appropriate boxes.

4. Click OK.

Selecting a Widget Display

Some slot types have multiple widget configurations that can be selected from the Widget Type menu. For example, a String slot can have a number of different widgets, such as a TextFieldWidget, TextAreaWidget, a UniqueStringWidget, or a YellowStickyWidget. By experimenting with these widgets, you can learn how to use them to get the desired display.

Various String Widgets

You can also remove a widget from the form by hiding it completely.

Using the Selected Widget Type Menu

To select a different display for your widget from one of the available configurations:

1. In the Form Browser at the left of the Forms tab, select the name of the class whose form you wish to edit.

2. Click the widget you wish to edit in the Form Editor. The widget will be outlined.

3. Click the Selected Widget Type menu. A list of possible widget types will be displayed.

4. Select the type of widget that you wish to use.

If you do not select a widget type, Protege-Frames uses a default type, based on the value type of the slot.

Using the Configure Form Dialog Box

You can also select different widgets, using the Configure Form dialog box.

Configure Form dialog, Widgets tab

To change the widget type for the slot:

1. Double-click on an empty part of the form to display the Form Configuration dialog box.

2. Click on the widget name in the widget column. A menu will show the list of standard widget types for the slot.

   Note: If the menu does not display, click on the down arrow at the right.

   

   Configure Form dialog, with menu

3. Select the widget you want.

4. Click OK.

Hiding a Widget

In addition to selecting a different widget type, you can hide a widget completely, or redisplay a hidden widget.

Using the Selected Widget Type Menu

The Selected Widget Type menu, at the top right of the Form Editor, allows you to hide a widget:

1. Select the widget you wish to hide by clicking it once. The widget will be outlined.

2. Select <none> from the Selected Widget Type menu. The selected widget will be removed from the form.

Using the Configure Form Dialog Box

1. Double-click on an empty part of the form to display the Form Configuration dialog box.

2. Click on the widget name in the widget column. A menu will show the list of standard widget types for the slot.

   Note: If the menu does not display, click on the down arrow at the right.

   

   Configure Form dialog, widget menu

3. Select <none>.

4. Click OK.

Redisplaying a Hidden Widget

To redisplay a widget which is no longer visible on the form:

1. Double-click on an empty part of the form to display the Form Configuration dialog box.

2. Select the widget you want to redisplay by clicking on its name at the Widget tab.

3. Click on the text <none> under the Widget column.

4. Select a different display type for the widget.

5. Click OK.