PrF UG inst entry field instance - Revision history

RichMorin at 01:07, November 14, 2008

2008-11-14T01:07:22Z

RichMorin: /* Adding an Instance */

2008-10-23T10:37:55Z

‎Adding an Instance

RichMorin: /* Creating an Instance */

2008-10-23T10:37:31Z

‎Creating an Instance

RichMorin at 23:21, October 22, 2008

2008-10-22T23:21:14Z

RichMorin at 23:19, October 15, 2008

2008-10-15T23:19:17Z

RichMorin at 22:49, October 14, 2008

2008-10-14T22:49:54Z

RichMorin: Automated import of articles

2008-10-09T08:55:44Z

Automated import of articles

New page

__NOTOC__
== The Instance Fields ==

{{PrF_UG_TOC_inst}}<div id='prf_ug'>

When an instance is created for a class with a slot of
[[PrF_UG_slots_value_type_instance|Value Type Instance]],
the entry field corresponding to the slot is an Instance entry field.
It contains values which are direct or indirect instances of the classes specified as allowed classes for the slot. (Direct instances are instances of the class;
indirect instances are instances of a class subordinate to the class,
e.g.,
a subclass.)

<ul class='a'>
<li>
[[#Single_Cardinality|single cardinality]]


<li>
[[#Multiple_Cardinality|multiple cardinality]]


<li>
[[#Editing_an_Instance|editing an instance]]


<li>
[[#Creating_an_Instance|creating an instance]]


<li>
[[#Adding_an_Instance|adding an instance]]


<li>
[[#Removing_an_Instance|removing an instance]]

</ul>

=== Single Cardinality ===

An instance with an Instance/Single slot shows a display field and four buttons that let you edit,
create,
add,
and remove instances.
The value of this slot is a single instance:

<div>[[Image:PrF_UG_inst_filled_entry_instance.png|instances_filled_entry_instance]]</div>

=== Multiple Cardinality ===

An instance with an Instance/Multiple slot shows a display list.
The value of this slot is a list of instances:

<div>[[Image:PrF_UG_inst_filled_instance_multiple.png|instances_filled_instance_multiple]]</div>

Note the following for fields of multiple cardinality:

<ul class='a'>
<li>
To select multiple instances to view or remove,
use Ctrl (Cmd);
use Shift to select a range.


<li>
Adding an instance does not replace a previous one.


<li>
If the at most value is set in the
[[PrF_UG_slots_slot_editor#Cardinality|Cardinality]]
field for the slot,
there is a limit on the number of instances you can enter.

</ul>

=== Editing an Instance ===

To edit an existing instance:

<ol class='a'>
<li>
Click the View Instance
[[Image:PrF_UG_inst_instance.view.gif|instances_instance.view]]
button to open the
[[PrF_UG_inst_instance_editor|Instance Editor]]
for the instance that is displayed or selected.
If no instance is currently displayed,
the View Instance button will be grayed out.


<li>
Enter the updated information directly in the
[[PrF_UG_inst_instance_editor|Instance Editor]].

</ol>

Note that any edits you make to this instance will appear in all locations where this instance occurs. You should be sure that you want the change to be global before editing an existing instance.
In some cases,
it may be more appropriate to create a new instance,
instead.

=== Creating an Instance ===

To create a new instance:

<ol class='a'>
<li>
Click the Create Instance
[[Image:PrF_UG_inst_instance.create.gif|instances_instance.create]]
button.


<li>
If there is more than one allowed class,
or if the allowed class has subclasses,
a dialog box will appear,
asking you to select a Concrete class,
displayed with a solid icon
[[Image:PrF_UG_classes_class.gif|classes_class]].
Select a class and click OK.

 <div>[[Image:PrF_UG_inst_select_concrete_cls.png|instances_select_concrete_cls]]</div>


<li>
A direct instance of the selected class will be created and a blank
[[PrF_UG_inst_instance_editor|Instance Editor]]
will be displayed.
Fill in the editor for the new instance,
as desired.

</ol>

=== Adding an Instance ===

To add an existing instance to the value of the field:

<ol class='a'>
<li>
Click the Add Instance
[[Image:PrF_UG_inst_instance.add.gif|instances_instance.add]]
button.
A Select Instance dialog box will be displayed.

 <div>[[Image:PrF_UG_inst_select_instance.png|instances_select_instance]]</div>


<li>
In the Allowed Classes pane,
select the class where the instance you want is located.


<li>
If the class has subclasses,
use the menu at the top of the Instances pane to choose the instances you want to see:


<ul>
<li>
Direct Instances limits the display to direct instances of the class


<li>
All Instances displays the instances of the class and all of its descendants (subclasses,
subsubclasses,
etc.)

</ul>

<li>
Select a single instance.


<li>
Click OK.
The instance you selected will be displayed.
If another instance was displayed previously,
it will now be gone.

</ol>

This selects a pre-existing instance as the value of the field.
This instance can also be viewed in the
[[PrF_UG_inst_instance_browser|Instance Browser]]
and may also appear as a value for other instances.
Note that any edits you make to this instance will appear in all locations where this instance occurs. You should be sure that you want the change to be global before editing an existing instance.
In some cases,
it may be more appropriate to create a new instance instead.

=== Removing an Instance ===

To remove an instance:

<ol class='a'>
<li>
Click the Remove Instance
[[Image:PrF_UG_inst_instance.remove.gif|instances_instance.remove]]
button.
The instance will be removed.

</ol>

This removes the instance as a value of the current field,
but does not remove it from the project.
The instance can still be viewed via the
[[PrF_UG_inst_instance_browser|Instance Browser]]
for the correct class,
and still appears in any other field where it has been selected.
To
[[PrF_UG_inst_deleting_an_instance|delete]]
an instance from the knowledge base,
use the Delete Instance
<div>[[Image:PrF_UG_inst_instance.delete.gif|instances_instance.delete]]</div>
button in the
[[PrF_UG_inst_instance_browser|Instance Browser]].

</div>

@@ Line 116: / Line 116: @@
      </p>
      <div>[[Image:PrF_UG_inst_select_instance.png|frame|none|
-            Select Instance dialog]]</div>
+            Select Instance dialog, "Section" selected]]</div>
    <li><p>

@@ Line 96: / Line 96: @@
      </p>
      <div>[[Image:PrF_UG_inst_select_concrete_cls.png|frame|none|
-            Select Concrete Cls dialog]]</div>
+            Select Concrete Cls dialog, "Content" selected]]</div>
    <li><p>

@@ Line 19: / Line 19: @@
 The value of this slot is a single instance:
-<div>[[Image:PrF_UG_inst_filled_entry_instance.png|
+<div>[[Image:PrF_UG_inst_filled_entry_instance.png|frame|none|
-        instances_filled_entry_instance]]</div>
+        Single Cardinality display field]]</div>
 === Multiple Cardinality ===
@@ Line 27: / Line 27: @@
 The value of this slot is a list of instances:
-<div>[[Image:PrF_UG_inst_filled_instance_multiple.png|
+<div>[[Image:PrF_UG_inst_filled_instance_multiple.png|frame|none|
-        instances_filled_instance_multiple]]</div>
+        Multiple Cardinality display list]]</div>
 Note the following for fields of multiple cardinality:
@@ Line 58: / Line 58: @@
    <li><p>
      Click the <b>View Instance</b>
-     [[Image:PrF_UG_inst_instance.view.gif|instances_instance.view]]
+     ([[Image:PrF_UG_inst_instance.view.gif|instances_instance.view]]) button
-     button to open the
+     to open the [[PrF_UG_inst_instance_editor|Instance Editor]]
      for the instance that is displayed or selected.
      If no instance is currently displayed,
@@ Line 84: / Line 83: @@
    <li><p>
      Click the <b>Create Instance</b>
-     [[Image:PrF_UG_inst_instance.create.gif|instances_instance.create]] button.
+     ([[Image:PrF_UG_inst_instance.create.gif|instances_instance.create]]) button.
      </p>
@@ Line 93: / Line 92: @@
      asking you to select a <b>Concrete</b> class,
      displayed with a solid icon
-     [[Image:PrF_UG_classes_class.gif|classes_class]].
+     ([[Image:PrF_UG_classes_class.gif|classes_class]]).
      Select a class and click <b>OK</b>.
      </p>
-     <div>[[Image:PrF_UG_inst_select_concrete_cls.png|instances_select_concrete_cls]]</div>
+     <div>[[Image:PrF_UG_inst_select_concrete_cls.png|frame|none|
    <li><p>
@@ Line 112: / Line 112: @@
    <li><p>
      Click the <b>Add Instance</b>
-     [[Image:PrF_UG_inst_instance.add.gif|instances_instance.add]] button.
+     ([[Image:PrF_UG_inst_instance.add.gif|instances_instance.add]]) button.
      A <b>Select Instance</b> dialog box will be displayed.
      </p>
-     <div>[[Image:PrF_UG_inst_select_instance.png|instances_select_instance]]</div>
+     <div>[[Image:PrF_UG_inst_select_instance.png|frame|none|
    <li><p>
@@ Line 168: / Line 169: @@
    <li><p>
      Click the <b>Remove Instance</b>
-     [[Image:PrF_UG_inst_instance.remove.gif|instances_instance.remove]] button.
+     ([[Image:PrF_UG_inst_instance.remove.gif|instances_instance.remove]]) button.
      The instance will be removed.
      </p>
@@ Line 182: / Line 183: @@
 an instance from the knowledge base,
 use the <b>Delete Instance</b>
-[[Image:PrF_UG_inst_instance.delete.gif|instances_instance.delete]] button
+([[Image:PrF_UG_inst_instance.delete.gif|instances_instance.delete]]) button
 in the [[PrF_UG_inst_instance_browser|Instance Browser]].
 </div>

@@ Line 2: / Line 2: @@
 == The Instance Fields ==
-{{PrF_UG_TOC_inst}}<div id='prf_ug'>
+<noinclude>{{PrF_UG_TOC_inst}}<div id='prf_ug'></noinclude>
 When an instance is created for a class with a slot
@@ Line 186: / Line 186: @@
 in the [[PrF_UG_inst_instance_browser|Instance Browser]].
-</div>
+<noinclude></div></noinclude>

@@ Line 4: / Line 4: @@
 {{PrF_UG_TOC_inst}}<div id='prf_ug'>
-When an instance is created for a class with a slot of
+When an instance is created for a class with a slot
-[[PrF_UG_slots_value_type_instance|Value Type Instance]],
+of [[PrF_UG_slots_value_type_instance|Value Type Instance]],
 the entry field corresponding to the slot is an Instance entry field.
 It contains values which are direct or indirect instances of the classes specified
@@ Line 19: / Line 19: @@
 The value of this slot is a single instance:
-<div>[[Image:PrF_UG_inst_filled_entry_instance.png|instances_filled_entry_instance]]</div>
+<div>[[Image:PrF_UG_inst_filled_entry_instance.png|
 === Multiple Cardinality ===
@@ Line 26: / Line 27: @@
 The value of this slot is a list of instances:
-<div>[[Image:PrF_UG_inst_filled_instance_multiple.png|instances_filled_instance_multiple]]</div>
+<div>[[Image:PrF_UG_inst_filled_instance_multiple.png|
 Note the following for fields of multiple cardinality:
@@ Line 42: / Line 44: @@
    <li><p>
-     If the <b>at most</b> value is set in the
+     If the <b>at most</b> value is set
-    [[PrF_UG_slots_slot_editor#Cardinality|Cardinality]]
+    in the [[PrF_UG_slots_slot_editor#Cardinality|Cardinality]] field
-     field for the slot,
+     for the slot,
      there is a limit on the number of instances you can enter.
      </p>
@@ Line 65: / Line 67: @@
    <li><p>
-     Enter the updated information directly in the
+     Enter the updated information directly
-    [[PrF_UG_inst_instance_editor|Instance Editor]].
+    in the [[PrF_UG_inst_instance_editor|Instance Editor]].
      </p>
 </ol>
-Note that <i>any edits you make to this instance will appear in all locations where this instance occurs.</i> You should be sure that you want the change to be global before editing an existing instance.
+Note that <i>any edits you make to this instance will appear in all locations
-In some cases,
+where this instance occurs.</i>
-it may be more appropriate to create a new instance,
+You should be sure that you want the change to be global before editing an existing instance.
-instead.
+In some cases, it may be more appropriate to create a new instance, instead.
 === Creating an Instance ===
@@ Line 82: / Line 84: @@
    <li><p>
      Click the <b>Create Instance</b>
-     [[Image:PrF_UG_inst_instance.create.gif|instances_instance.create]]
+     [[Image:PrF_UG_inst_instance.create.gif|instances_instance.create]] button.
      </p>
@@ Line 94: / Line 95: @@
      [[Image:PrF_UG_classes_class.gif|classes_class]].
      Select a class and click <b>OK</b>.
      </p>
    <li><p>
-     A direct instance of the selected class will be created and a blank
+     A direct instance of the selected class will be created
-    [[PrF_UG_inst_instance_editor|Instance Editor]]
+    and a blank [[PrF_UG_inst_instance_editor|Instance Editor]] will be displayed.
-    will be displayed.
+     Fill in the editor for the new instance, as desired.
      </p>
 </ol>
@@ Line 114: / Line 112: @@
    <li><p>
      Click the <b>Add Instance</b>
-     [[Image:PrF_UG_inst_instance.add.gif|instances_instance.add]]
+     [[Image:PrF_UG_inst_instance.add.gif|instances_instance.add]] button.
      A <b>Select Instance</b> dialog box will be displayed.
      </p>
    <li><p>
@@ Line 128: / Line 124: @@
    <li><p>
      If the class has subclasses,
-     use the menu at the top of the Instances pane to choose the instances you want to see:
+     use the menu at the top of the Instances pane
      </p>
@@ Line 137: / Line 134: @@
      <li><p>
-       <b>All Instances</b> displays the instances of the class <i>and</i> all of its descendants (subclasses,
+       <b>All Instances</b> displays the instances of the class
-      subsubclasses,
+      <i>and</i> all of its descendants (subclasses, subsubclasses, etc.)
        </p>
    </ul>
@@ Line 156: / Line 152: @@
 This selects a pre-existing instance as the value of the field.
-This instance can also be viewed in the
+This instance can also be viewed
-[[PrF_UG_inst_instance_browser|Instance Browser]]
+in the [[PrF_UG_inst_instance_browser|Instance Browser]]
 and may also appear as a value for other instances.
-Note that <i>any edits you make to this instance will appear in all locations where this instance occurs.</i> You should be sure that you want the change to be global before editing an existing instance.
+Note that <i>any edits you make to this instance will appear in all locations
-In some cases,
+where this instance occurs.</i>
-it may be more appropriate to create a new instance instead.
+You should be sure that you want the change to be global
 === Removing an Instance ===
@@ Line 170: / Line 168: @@
    <li><p>
      Click the <b>Remove Instance</b>
-     [[Image:PrF_UG_inst_instance.remove.gif|instances_instance.remove]]
+     [[Image:PrF_UG_inst_instance.remove.gif|instances_instance.remove]] button.
      The instance will be removed.
      </p>
@@ Line 178: / Line 175: @@
 This removes the instance as a value of the current field,
 but does not remove it from the project.
-The instance can still be viewed via the
+The instance can still be viewed
-[[PrF_UG_inst_instance_browser|Instance Browser]]
+via the [[PrF_UG_inst_instance_browser|Instance Browser]]
 for the correct class,
 and still appears in any other field where it has been selected.
-To
+To [[PrF_UG_inst_deleting_an_instance|delete]]
 an instance from the knowledge base,
 use the <b>Delete Instance</b>
-<div>[[Image:PrF_UG_inst_instance.delete.gif|instances_instance.delete]]</div>
+[[Image:PrF_UG_inst_instance.delete.gif|instances_instance.delete]] button
-button in the
+in the [[PrF_UG_inst_instance_browser|Instance Browser]].
 </div>

@@ Line 7: / Line 7: @@
 [[PrF_UG_slots_value_type_instance|Value Type Instance]],
 the entry field corresponding to the slot is an Instance entry field.
-It contains values which are direct or indirect instances of the classes specified as allowed classes for the slot. (Direct instances are instances of the class;
+It contains values which are direct or indirect instances of the classes specified
 indirect instances are instances of a class subordinate to the class,
-e.g.,
+e.g., a subclass.)
 === Single Cardinality ===
-An instance with <b>an Instance/Single</b> slot shows a display field and four buttons that let you edit,
+An instance with <b>an Instance/Single</b> slot shows a display field
-create,
+and four buttons that let you edit, create, add, and remove instances.
 The value of this slot is a single instance: