PrF UG meta metaclass example - Revision history

RichMorin at 01:27, November 14, 2008

2008-11-14T01:27:10Z

RichMorin at 23:48, October 24, 2008

2008-10-24T23:48:30Z

RichMorin at 18:54, October 16, 2008

2008-10-16T18:54:44Z

RichMorin: Automated import of articles

2008-10-09T09:03:27Z

Automated import of articles

New page

__NOTOC__
== Example: Creating and Using a Metaclass ==

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

This example gives an overview of how to create and use a metaclass.

Suppose you are creating a knowledge base of wines and wineries.
In this knowledge base,
a type of wine,
such as Chardonnay,
is a class,
while a specific label is an instance of that class.
Suppose that,
for each class of wine,
you wanted to be able to enter the wineries that are,
in your opinion,
the best producers of that type of wine.
You could do this using metaclasses,
as described below.

=== Creating a Metaclass ===

First,
set up your metaclass:

<ol class='a'>
<li>
[[PrF_UG_meta_metaclass_create|Create a metaclass]],
Wine Template, to use for wines.
You create this subordinate to :STANDARD-CLASS,
so that it inherits all the structure of a typical class.

 <div>[[Image:PrF_UG_meta_metaclass_hierarchy.png|metaclasses_metaclass_hierarchy]]</div>


<li>
[[PrF_UG_slots_create_slot|Create]]
an additional template slot,
best wineries,
that allows you to enter a list of wineries.


<li>
Configure best wineries as follows:


<ul>
<li>
Set the
[[PrF_UG_slots_value_type_menu|Value Type]]
to
[[PrF_UG_slots_value_type_instance|Instance]],
so that the values of this slot can be instances in the knowledge base.


<li>
Set the Allowed Classes to Winery,
so that,
specifically,
these instances are wineries.


<li>
Set the
[[PrF_UG_slots_slot_editor#Cardinality|Cardinality]]
to Multiple to allow more than one winery on the list for each class.
 <div>[[Image:PrF_UG_meta_best_wineries_slot.png|metaclasses_best_wineries_slot]]</div>

</ul>

<li>
[[PrF_UG_slots_attach_slot|Attach]]
Best Wineries to Wine template as a template slot,
if you have not already done so.

 <div>[[Image:PrF_UG_meta_wine_template.png|metaclasses_wine_template]]</div>

</ol>

=== Using the Metaclass ===

Once you have created the metaclass,
you can use it as follows:

<ol class='a'>
<li>
[[PrF_UG_meta_create_class_use_meta|Create]]
a class,
such as Chardonnay,
using Wine template as the metaclass.
Or,
if you have already created the classes for your wines,
[[PrF_UG_meta_change_meta_sub|change the metaclass]]
to Wine template.
When you do this,
the best wineries slot that you attached to the template shows up as a new field (located at the lower left) in the Class Editor for your class.
 <div>[[Image:PrF_UG_meta_chardonnay.png|metaclasses_chardonnay]]</div>


<li>
You can now use the Best Wineries field to select one or more wineries from your instances.

</ol>

</div>

@@ Line 2: / Line 2: @@
 == Example: Creating and Using a Metaclass ==
-{{PrF_UG_TOC_meta}}<div id='prf_ug'>
+<noinclude>{{PrF_UG_TOC_meta}}<div id='prf_ug'></noinclude>
 This example gives an overview of how to create and use a metaclass.
@@ Line 89: / Line 89: @@
-</div>
+<noinclude></div></noinclude>

@@ Line 25: / Line 25: @@
      so that it inherits all the structure of a typical class.
      </p>
-     <div>[[Image:PrF_UG_meta_metaclass_hierarchy.png|
+     <div>[[Image:PrF_UG_meta_metaclass_hierarchy.png|frame|none|
-            metaclasses_metaclass_hierarchy]]</div>
+            Class Browser, "Wine template" selected]]</div>
    <li><p>
@@ Line 53: / Line 53: @@
        to <b>Multiple</b> to allow more than one winery on the list for each class.
        </p>
-       <div>[[Image:PrF_UG_meta_best_wineries_slot.png|
+       <div>[[Image:PrF_UG_meta_best_wineries_slot.png|frame|none|
-             metaclasses_best_wineries_slot]]</div>
+           Template Slots, configured]]</div>
    </ul>
@@ Line 62: / Line 62: @@
      if you have not already done so.
      </p>
-     <div>[[Image:PrF_UG_meta_wine_template.png|
+     <div>[[Image:PrF_UG_meta_wine_template.png|frame|none|
-            metaclasses_wine_template]]</div>
+            Wine template instance dialog]]</div>
 </ol>
@@ Line 79: / Line 79: @@
      shows up as a new field (located at the lower left) in the Class Editor for your class.
      </p>
-     <div>[[Image:PrF_UG_meta_chardonnay.png|metaclasses_chardonnay]]</div>
+     <div>[[Image:PrF_UG_meta_chardonnay.png|frame|none|
    <li><p>

@@ Line 7: / Line 7: @@
 Suppose you are creating a knowledge base of wines and wineries.
-In this knowledge base,
+In this knowledge base, a type of wine, such as Chardonnay, is a class,
 while a specific label is an instance of that class.
-Suppose that,
+Suppose that, for each class of wine,
-for each class of wine,
+you wanted to be able to enter the wineries that are, in your opinion,
 the best producers of that type of wine.
-You could do this using metaclasses,
+You could do this using metaclasses, as described below.
 === Creating a Metaclass ===
-First,
+First, set up your metaclass:
 <ol class='a'>
    <li><p>
      [[PrF_UG_meta_metaclass_create|Create a metaclass]],
-     <b>Wine Template,</b> to use for wines.
+     <b>Wine Template</b>, to use for wines.
      You create this subordinate to <b>:STANDARD-CLASS</b>,
      so that it inherits all the structure of a typical class.
      </p>
    <li><p>
-     [[PrF_UG_slots_create_slot|Create]]
+     [[PrF_UG_slots_create_slot|Create]] an additional template slot,
-    an additional template slot,
+     <i>best wineries</i>, that allows you to enter a list of wineries.
      </p>
@@ Line 48: / Line 39: @@
    <ul>
      <li><p>
-       Set the
+       Set the [[PrF_UG_slots_value_type_menu|Value Type]]
-      [[PrF_UG_slots_value_type_menu|Value Type]]
+       to [[PrF_UG_slots_value_type_instance|Instance]],
        so that the values of this slot can be instances in the knowledge base.
        </p>
@@ Line 57: / Line 46: @@
      <li><p>
        Set the <b>Allowed Classes</b> to <b>Winery</b>,
-       so that,
+       so that, specifically, these instances are wineries.
        </p>
      <li><p>
-       Set the
+       Set the [[PrF_UG_slots_slot_editor#Cardinality|Cardinality]]
        to <b>Multiple</b> to allow more than one winery on the list for each class.
        </p>
    </ul>
    <li><p>
-     [[PrF_UG_slots_attach_slot|Attach]]
+     [[PrF_UG_slots_attach_slot|Attach]] <i>Best Wineries</i>
-    <i>Best Wineries</i> to <b>Wine template</b> as a <b>template slot</b>,
+    to <b>Wine template</b> as a <b>template slot</b>,
      if you have not already done so.
      </p>
 </ol>
 === Using the Metaclass ===
-Once you have created the metaclass,
+Once you have created the metaclass, you can use it as follows:
 <ol class='a'>
    <li><p>
-     [[PrF_UG_meta_create_class_use_meta|Create]]
+     [[PrF_UG_meta_create_class_use_meta|Create]] a class, such as <b>Chardonnay</b>,
      using <b>Wine template</b> as the metaclass.
-     Or,
+     Or, if you have already created the classes for your wines,
-    if you have already created the classes for your wines,
+     [[PrF_UG_meta_change_meta_sub|change the metaclass]] to <b>Wine template</b>.
-     [[PrF_UG_meta_change_meta_sub|change the metaclass]]
+     When you do this, the <i>best wineries</i> slot that you attached to the template
-    to <b>Wine template</b>.
+    shows up as a new field (located at the lower left) in the Class Editor for your class.
      </p>
    <li><p>
-     You can now use the <b>Best Wineries</b> field to select one or more wineries from your instances.
+     You can now use the <b>Best Wineries</b> field
      </p>
 </ol>