PrF UG classes references window - Revision history

RichMorin at 00:33, November 14, 2008

2008-11-14T00:33:34Z

RichMorin: /* The View Buttons */

2008-10-30T00:28:05Z

‎The View Buttons

RichMorin: /* The Slot Column */

2008-10-30T00:27:35Z

‎The Slot Column

RichMorin at 23:23, October 26, 2008

2008-10-26T23:23:01Z

RichMorin at 10:01, October 23, 2008

2008-10-23T10:01:50Z

RichMorin at 19:39, October 20, 2008

2008-10-20T19:39:15Z

RichMorin at 07:40, October 16, 2008

2008-10-16T07:40:47Z

RichMorin at 19:46, October 15, 2008

2008-10-15T19:46:59Z

RichMorin at 22:19, October 14, 2008

2008-10-14T22:19:37Z

RichMorin: Automated import of articles

2008-10-09T08:43:03Z

Automated import of articles

New page

__NOTOC__
== The References Window ==

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

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 following information is included in the References window:

<ul class='a'>
<li>
The
[[#The_View_Buttons|View buttons]]:
Allow you to view the highlighted frame.


<li>
The
[[#The_Frame_Column|Frame column]]:
Shows the name of each frame that references the item,
with an icon indicating its type.


<li>
The
[[#The_Slot_Column|Slot column]]:
Shows the slot in which the frame references the item.


<li>
The
[[#The_Facet_Column|Facet column]]:
Shows any facet information for the slot.

</ul>

The References window can be viewed by selecting an item and clicking on the References
([[Image:PrF_UG_classes_class.view_references.gif|classes_class.view_references]]
or
[[Image:PrF_UG_inst_instance.view_references.gif|instances_instance.view_references]])
button.
See
[[PrF_UG_classes_view_references|Viewing References]]
for more information.

<div>[[Image:PrF_UG_classes_references_dialog.png|classes_references_dialog]]</div>

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

=== Examples ===

For example,
references for a class include:

<ul class='a'>
<li>
any superclasses of the class


<li>
any direct subclasses of the class


<li>
any instances of the class


<li>
any direct slots (inherited slots are not considered to be references)


<li>
any notes at the class


<li>
the metaclass of the class

</ul>

For a slot,
references include:

<ul class='a'>
<li>
any superslots or subslots


<li>
:STANDARD-SLOT or other
[[PrF_UG_meta_metaslot_intro|slot metaclass]]


<li>
any classes that have the slot attached as a direct slot

</ul>

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

=== The View Buttons ===

{| summary="view buttons"
| width="50" |
[[Image:PrF_UG_all_object.view.gif|all_object.view]]
|
View Reference: Opens the editor for the highlighted frame and allows you to view the frame's properties.
Depending on the frame,
this could be the
[[PrF_UG_classes_class_editor|Class Editor]],
the
[[PrF_UG_slots_slot_editor|Slot Editor]],
or the
[[PrF_UG_inst_instance_editor|Instance Editor]].
|-
|
[[Image:PrF_UG_all_object.view_references.gif|all_object.view_references]]
| View References to Value: Shows the references for the highlighted frame.
|}

=== The Frame Column ===

This column shows the name of each frame that references the highlighted item.
The type of frame is indicated by a
[[PrF_UG_classes_class_icons|class icon]],
[[PrF_UG_slots_slot_icons|slot icon]],
or instance icon
[[Image:PrF_UG_inst_instance.gif|instances_instance]].

=== The Slot Column ===

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

{| summary="standard slots"
| width="175" | DIRECT-INSTANCES
| The selected item is a direct instance of the frame.
|-
| DIRECT-SUPERCLASSES
| The selected item is a direct superclass of the frame.
|-
| DIRECT-SUBCLASSES
| The selected item is a direct subclass of the frame.
|-
| SLOT-VALUE-TYPE
|
The frame is a slot and the selected item appears as one of its values.
If the selected item is an instance,
it may be a value.
If the selected item is a class,
it may be an Allowed Superclass (for a
[[PrF_UG_slots_value_type_class|slot of type Class]])
or an Allowed Class (for a
[[PrF_UG_slots_value_type_instance|slot of type Instance]]).
|}

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.

</div>

@@ Line 2: / Line 2: @@
 == The References Window ==
-{{PrF_UG_TOC_classes}}<div id='prf_ug'>
+<noinclude>{{PrF_UG_TOC_classes}}<div id='prf_ug'></noinclude>
 In a complex project,
@@ Line 158: / Line 158: @@
-</div>
+<noinclude></div></noinclude>

@@ Line 15: / Line 15: @@
 <div>[[Image:PrF_UG_classes_references_dialog.png|frame|none|
-        Relations to Advertisement dialog box]]</div>
+        References to Advertisement dialog, "name" selected]]</div>
 It is also possible to view those classes that are related through a particular slot,

@@ Line 76: / Line 76: @@
 === The View Buttons ===
 {| summary="view buttons"
 | width="50" |
@@ Line 92: / Line 93: @@
 <b>View References to Value:</b> Shows the references for the highlighted frame.
 |}
 === The Frame Column ===

@@ Line 108: / Line 108: @@
 For example:
 {| summary="standard slots"
 | width="175" | DIRECT-INSTANCES
@@ Line 133: / Line 134: @@
 (for a [[PrF_UG_slots_value_type_instance|slot of type <b>Instance</b>]]).
 |}
 The name of any other slot in the project may also appear in this column.

@@ Line 7: / Line 7: @@
 it is possible to have many different relationships
 between classes, instances, and slots.
-A <i>reference</i> for a frame is any other frame that has a direct relationship to it.
+A <i>reference</i> for a frame is any other frame
 The References window can be viewed by selecting an item
 and clicking on the <b>References</b>
-([[Image:PrF_UG_classes_class.view_references.gif|classes_class.view_references]]
+([[Image:PrF_UG_classes_class.view_references.gif|
-or [[Image:PrF_UG_inst_instance.view_references.gif|instances_instance.view_references]]) button.
+   classes_class.view_references]]
-See [[PrF_UG_classes_view_references|Viewing References]] for more information.
+or [[Image:PrF_UG_inst_instance.view_references.gif|
 <div>[[Image:PrF_UG_classes_references_dialog.png|frame|none|
@@ Line 148: / Line 152: @@
 the facet value column specifies whether the selected item appears
 as an <b>Allowed Class</b> or an <b>Allowed Superclass</b>.
 </div>

@@ Line 14: / Line 14: @@
 See [[PrF_UG_classes_view_references|Viewing References]] for more information.
-<div>[[Image:PrF_UG_classes_references_dialog.png|classes_references_dialog]]</div>
+<div>[[Image:PrF_UG_classes_references_dialog.png|frame|none|
 It is also possible to view those classes that are related through a particular slot,
@@ Line 94: / Line 95: @@
 by a [[PrF_UG_classes_class_icons|class icon]],
 [[PrF_UG_slots_slot_icons|slot icon]], or instance icon
-[[Image:PrF_UG_inst_instance.gif|instances_instance]].
+([[Image:PrF_UG_inst_instance.gif|instances_instance]]).
 === The Slot Column ===

@@ Line 84: / Line 84: @@
+|
 [[Image:PrF_UG_all_object.view_references.gif|all_object.view_references]]
 | <b>View References to Value:</b> Shows the references for the highlighted frame.
 |}
@@ Line 106: / Line 107: @@
 | The selected item is a direct instance of the frame.
 |-
 | DIRECT-SUPERCLASSES
-| The selected item is a direct superclass of the frame.
+DIRECT-SUPERCLASSES
 |-
 | DIRECT-SUBCLASSES
-| The selected item is a direct subclass of the frame.
+DIRECT-SUBCLASSES
 |-
 | SLOT-VALUE-TYPE
+|
 The frame is a slot and the selected item appears as one of its values.
 If the selected item is an instance, it may be a value.
 If the selected item is a class,
-it may be an <b>Allowed Superclass</b> (for a
+it may be an <b>Allowed Superclass</b>
-[[PrF_UG_slots_value_type_class|slot of type <b>Class</b>]])
+(for a [[PrF_UG_slots_value_type_class|slot of type <b>Class</b>]])
 or an <b>Allowed Class</b>
 (for a [[PrF_UG_slots_value_type_instance|slot of type <b>Instance</b>]]).

@@ Line 8: / Line 8: @@
 between classes, instances, and slots.
 A <i>reference</i> 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 <b>References</b>
+The References window can be viewed by selecting an item
-([[Image:PrF_UG_classes_class.view_references.gif|classes_class.view_references]] or
+and clicking on the <b>References</b>
-[[Image:PrF_UG_inst_instance.view_references.gif|instances_instance.view_references]]) button.
+([[Image:PrF_UG_classes_class.view_references.gif|classes_class.view_references]]
 See [[PrF_UG_classes_view_references|Viewing References]] for more information.
@@ Line 36: / Line 37: @@
    <li><p>
-     any <i>direct</i> slots (inherited slots are <i>not</i> considered to be references)
+     any <i>direct</i> slots
      </p>
@@ Line 48: / Line 50: @@
 </ul>
-For a slot,
+For a slot, references include:
 <ul class='a'>
@@ Line 74: / Line 75: @@
 [[Image:PrF_UG_all_object.view.gif|all_object.view]]
+|
-<b>View Reference:</b> Opens the editor for the highlighted frame and allows you to view the frame's properties.
+<b>View Reference:</b>
 Depending on the frame,
-this could be the
+this could be the [[PrF_UG_classes_class_editor|Class Editor]],
-[[PrF_UG_classes_class_editor|Class Editor]],
+the [[PrF_UG_slots_slot_editor|Slot Editor]],
-the
+or the [[PrF_UG_inst_instance_editor|Instance Editor]].
 |-
+|
@@ Line 91: / Line 90: @@
 This column shows the name of each frame that references the highlighted item.
-The type of frame is indicated by a
+The type of frame is indicated
-[[PrF_UG_classes_class_icons|class icon]],
+by a [[PrF_UG_classes_class_icons|class icon]],
-[[PrF_UG_slots_slot_icons|slot icon]],
+[[PrF_UG_slots_slot_icons|slot icon]], or instance icon
 [[Image:PrF_UG_inst_instance.gif|instances_instance]].
@@ Line 100: / Line 98: @@
 This column specifies the slot that actually references the selected item.
-Note that {{#var:PrF}} provides standard slots which indicate the relationship between the selected item and the referencing frame.
+Note that {{#var:PrF}} provides standard slots
 For example:
@@ Line 116: / Line 115: @@
+|
 The frame is a slot and the selected item appears as one of its values.
-If the selected item is an instance,
+If the selected item is an instance, it may be a value.
 If the selected item is a class,
 it may be an <b>Allowed Superclass</b> (for a
 [[PrF_UG_slots_value_type_class|slot of type <b>Class</b>]])
-or an <b>Allowed Class</b> (for a
+or an <b>Allowed Class</b>
-[[PrF_UG_slots_value_type_instance|slot of type <b>Instance</b>]]).
+(for a [[PrF_UG_slots_value_type_instance|slot of type <b>Instance</b>]]).
 |}
@@ Line 129: / Line 127: @@
 === 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.
+This column gives information about the facet value for certain types of references
-For example,
+and gives information about the slot relationships between classes.
-an item may appear as a value for a slot which is called by that frame.
+For example, an item may appear as a value for a slot which is called by that frame.
 In the illustration above,
 the class <b>Author</b> appears as an <b>Allowed Class</b> for the slot <i>author</i>,
 as shown in the second row.
-In addition,
+In addition, the slot <i>author</i> appears as a slot for the class <b>Article</b>.
-the slot <i>author</i> appears as a slot for the class <b>Article</b>.
+Therefore, <b>Article</b> references <b>Author</b>.
 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 <b>Allowed Class</b> or an <b>Allowed Superclass</b>.
+the facet value column specifies whether the selected item appears
 </div>