Difference between revisions of "PrF UG slots editing slot properties"
(Automated import of articles) |
|||
| (6 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
== Editing Slot Properties == | == Editing Slot Properties == | ||
| − | {{PrF_UG_TOC_slots}}<div id='prf_ug'> | + | <noinclude>{{PrF_UG_TOC_slots}}<div id='prf_ug'></noinclude> |
| − | You can edit the properties of a newly created or existing slot using the | + | You can edit the properties of a newly created or existing slot |
| − | [[PrF_UG_slots_slot_editor|Slot Editor]]. | + | using the [[PrF_UG_slots_slot_editor|Slot Editor]]. |
=== Slot Name === | === Slot Name === | ||
| − | To change the name of a slot, | + | To change the name of a slot, edit the text in the <b>Name</b> field. |
| − | edit the text in the <b>Name</b> field. | ||
Slot names are case sensitive. | Slot names are case sensitive. | ||
To distinguish slot names from class names, | To distinguish slot names from class names, | ||
| Line 17: | Line 16: | ||
=== Value Type === | === Value Type === | ||
| − | To change the value type of the slot, | + | To change the value type of the slot, select a different type |
| − | select a different type from | + | from [[PrF_UG_slots_value_type_menu|the Value Type menu]]. |
| − | [[PrF_UG_slots_value_type_menu|the Value Type menu]]. | ||
The available types are summarized in the following table: | The available types are summarized in the following table: | ||
| + | <div class='b'> | ||
{| summary="available value types" | {| summary="available value types" | ||
! width="75" | Type | ! width="75" | Type | ||
| Line 33: | Line 32: | ||
| Boolean | | Boolean | ||
| Logical Value | | Logical Value | ||
| − | | True, | + | | True, False |
| − | False | ||
|- | |- | ||
| Class | | Class | ||
| Line 42: | Line 40: | ||
| Float | | Float | ||
| Number with a decimal point | | Number with a decimal point | ||
| − | | 1.0, | + | | 1.0, 3.4e10, -0.3e-3 |
| − | 3.4e10, -0.3e-3 | ||
|- | |- | ||
| Instance | | Instance | ||
| Line 51: | Line 48: | ||
| Integer | | Integer | ||
| Whole number | | Whole number | ||
| − | | 1, | + | | 1, 2, -4 |
| − | 2, -4 | ||
|- | |- | ||
| String | | String | ||
| − | | List of alphanumeric characters, | + | | List of alphanumeric characters, possibly including spaces |
| − | possibly including spaces | ||
| "John Doe" | | "John Doe" | ||
|- | |- | ||
| Symbol | | Symbol | ||
| − | | Enumerated list of values, | + | | Enumerated list of values, which may not include spaces |
| − | which may not include spaces | + | | red, blue, and green |
| − | | red, | ||
| − | blue, | ||
| − | and green | ||
|} | |} | ||
| + | </div> | ||
| − | <b> | + | <b>Note</b>: |
If you are editing the slot from a specific class, | If you are editing the slot from a specific class, | ||
and the slot is inherited, | and the slot is inherited, | ||
| Line 81: | Line 74: | ||
For an inherited slot of a value type other than <b>Any</b>, | For an inherited slot of a value type other than <b>Any</b>, | ||
you <i>cannot</i> change the type of the slot. | you <i>cannot</i> change the type of the slot. | ||
| − | However, | + | However, for slots of type <b>Class</b>, <b>Instance</b>, or <b>Symbol</b>, |
| − | |||
| − | |||
| − | |||
you can change the choices in the associated <b>Allowed</b> menu. | you can change the choices in the associated <b>Allowed</b> menu. | ||
</p> | </p> | ||
</ul> | </ul> | ||
| − | When a value type of | + | When a value type |
| − | + | of [[PrF_UG_slots_value_type_class|Class]], | |
| − | + | [[PrF_UG_slots_value_type_instance|Instance]], | |
| − | or | + | or [[PrF_UG_slots_value_type_symbol|Symbol]] is selected, |
| − | + | an additional pane appears | |
| − | is selected, | + | below the [[PrF_UG_slots_value_type_menu|Value Type menu]], |
| − | an additional pane appears below the | ||
| − | [[PrF_UG_slots_value_type_menu|Value Type menu]], | ||
as follows: | as follows: | ||
| + | <div class='b'> | ||
{| summary="value types and panes" | {| summary="value types and panes" | ||
! width="75" | Value Type | ! width="75" | Value Type | ||
| Line 107: | Line 96: | ||
| | | | ||
The <b>Allowed Superclasses</b> pane. | The <b>Allowed Superclasses</b> pane. | ||
| − | See | + | See [[PrF_UG_slots_value_type_class#Setting_the_Value_Type_to_Class| |
| − | [[PrF_UG_slots_value_type_class#Setting_the_Value_Type_to_Class|Setting the Value Type to Class]] | + | Setting the Value Type to Class]] |
| − | in the | + | in the [[PrF_UG_slots_value_type_class|Value Type Class]] |
| − | [[PrF_UG_slots_value_type_class|Value Type Class]] | ||
for information on how to add and remove allowed superclasses. | for information on how to add and remove allowed superclasses. | ||
|- | |- | ||
| Line 117: | Line 105: | ||
| | | | ||
The <b>Allowed Classes</b> pane. | The <b>Allowed Classes</b> pane. | ||
| − | See | + | See [[PrF_UG_slots_value_type_instance#Setting_the_Value_Type_to_Instance| |
| − | [[PrF_UG_slots_value_type_instance#Setting_the_Value_Type_to_Instance|Setting the Value Type]] | + | Setting the Value Type]] |
for information on how to add and remove allowed classes. | for information on how to add and remove allowed classes. | ||
|- | |- | ||
| Line 125: | Line 113: | ||
| | | | ||
The <b>Allowed Values</b> pane. | The <b>Allowed Values</b> pane. | ||
| − | See | + | See [[PrF_UG_slots_value_type_symbol|The Symbol Value Type]] |
| − | [[PrF_UG_slots_value_type_symbol|The Symbol Value Type]] | ||
for information on how to add and remove allowed values. | for information on how to add and remove allowed values. | ||
|} | |} | ||
| + | </div> | ||
=== Cardinality === | === Cardinality === | ||
| Line 135: | Line 123: | ||
select a different option for the <b>Cardinality</b>. | select a different option for the <b>Cardinality</b>. | ||
| − | <div>[[Image:PrF_UG_slots_cardinality.png| | + | <div>[[Image:PrF_UG_slots_cardinality.png|frame|none| |
| + | Cardinality options]]</div> | ||
The default configuration allows the slot to have at most one value; | The default configuration allows the slot to have at most one value; | ||
| − | that is, | + | that is, it can have one value or no value. |
| − | it can have one value or no value. | + | You can change the default by entering a positive whole number |
| − | You can change the default by entering a positive whole number in the <b>at least</b> and/or <b>at most</b> options, | + | in the <b>at least</b> and/or <b>at most</b> options, |
or by selecting the <b>multiple</b> option with no <b>at most</b> value. | or by selecting the <b>multiple</b> option with no <b>at most</b> value. | ||
| Line 148: | Line 137: | ||
enter a positive whole number in the <b>at least</b> entry bar. | enter a positive whole number in the <b>at least</b> entry bar. | ||
Setting <b>at least</b> equal to one requires a value for the slot. | Setting <b>at least</b> equal to one requires a value for the slot. | ||
| − | Setting <b>at least</b> equal to 1 <i>and</i> <b>at most</b> equal to 1 means that the slot must have exactly one value. | + | Setting <b>at least</b> equal to 1 <i>and</i> <b>at most</b> equal to 1 |
| + | means that the slot must have exactly one value. | ||
If you enter a value for <b>at least</b>, | If you enter a value for <b>at least</b>, | ||
<b>required</b> is automatically selected. | <b>required</b> is automatically selected. | ||
| Line 169: | Line 159: | ||
</ul> | </ul> | ||
| − | <b> | + | <b>Note</b>: |
If you are editing the slot for a specific class, | If you are editing the slot for a specific class, | ||
and the slot is inherited, | and the slot is inherited, | ||
| Line 205: | Line 195: | ||
When present, | When present, | ||
| − | any <b>Defaults</b> are displayed in the second-to-last column of the | + | any <b>Defaults</b> are displayed in the second-to-last column |
| − | [[PrF_UG_classes_template_slot_pane|Template Slots pane]] | + | of the [[PrF_UG_classes_template_slot_pane|Template Slots pane]] |
| − | in the | + | in the [[PrF_UG_classes_classes_tab|Classes tab]]. |
| − | [[PrF_UG_classes_classes_tab|Classes tab]]. | ||
=== Documentation (optional) === | === Documentation (optional) === | ||
| Line 214: | Line 203: | ||
You can change the text description of the slot directly in the documentation field. | You can change the text description of the slot directly in the documentation field. | ||
| − | </div> | + | |
| + | <noinclude></div></noinclude> | ||
Latest revision as of 17:47, November 13, 2008
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:
| Type | Description | Examples |
|---|---|---|
| Any | Any of the types below (logical Union) | |
| Boolean | Logical Value | True, False |
| Class | Class in the knowledge base | Organization |
| Float | Number with a decimal point | 1.0, 3.4e10, -0.3e-3 |
| Instance | Instance of a class in the knowledge base | instance_00010 |
| Integer | Whole number | 1, 2, -4 |
| String | List of alphanumeric characters, possibly including spaces | "John Doe" |
| Symbol | Enumerated list of values, which may not include spaces | red, blue, and green |
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:
| Value Type | Associated Pane |
|---|---|
|
The Allowed Superclasses pane. See Setting the Value Type to Class in the Value Type Class for information on how to add and remove allowed superclasses. | |
|
The Allowed Classes pane. See Setting the Value Type for information on how to add and remove allowed classes. | |
|
The Allowed Values pane. See The Symbol Value Type for information on how to add and remove allowed values. |
Cardinality
To change whether or not a slot can be composed of more than one item, select a different option for the Cardinality.
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.
