About Library Item Tag Elements
You can tag library items in the Symbol Library XML file with different categories of tags, such as resource or message tags. To tag a library item, do the following:
1. Add a <tags> element to a <symbol> or <shape> element.
2. Add one or more <tag> elements to the <tags> element. The tag type is defined by the type attribute value of the <tag> element. Valid type attribute values are listed below.
3. (Optional) Add <description> and <quantity> elements to each <tag> element.
<tag> Elements for Resources
In addition to the tag icon, these tag types appear in the Step Editor Resources tab for the step.
|
type Attribute
|
Description
|
|
consumable
|
Item has variable consumption, such as 3 liters of oil. Its child element, <quantity>, includes a unit attribute.
|
<tag> Elements for Messaging
In addition to the tag icon, these tag types display a message in the Step Editor Description tab for the step.
|
type Attribute
|
Description
|
|
safety
|
Displays a warning tag icon and message for this step.
|
|
quality
|
Displays a quality tag icon and message for this step.
|
|
skill
|
Displays a skill tag icon and message for this step.
|
|
environmental
|
Displays an environmental tag icon and message for this step.
|
|
procedure
|
Displays a procedure tag icon and message, such as inspection instructions, for this step.
|
Syntax for Tagged 2D <symbol> Elements
Use the syntax below to create tags for 2D <symbol> elements.
<symbol id="[n]" categoryId="[n]" billboard="[true|false]">
<name>[Item Name]</name>
<description>[item description]</description>
<tooltip>[tooltip text]</tooltip>
<gallery_thumbnail url="[path/filename.64x64.jpg]"/>
<image url="[path/filename.jpg]"/>
<scale>[0-100]</scale>
<flip horizontal="[true|false]" vertical="[true|false]"/>
<rotate right="[0-360]" left="[0-360]"/>
<tags>
<tag type="[type_name]" category=”[category_name]”>
<description>[description text]</description>
<quantity unit="[unit_symbol">[value]</quantity>
</tag>
<tag>[]</tag>
…
<tag>[]</tag>
</tags>
</symbol>
Syntax for Tagged 3D <shape> Elements
Use the syntax below to create tags for 3D symbol <shape> elements.
<shape id="[n]" categoryId="[n]">
<name>[Item Name]</name>
<description>[item description]</description>
<tooltip>[tooltip text]</tooltip>
<gallery_thumbnail url="[path/filename.64x64.jpg]"/>
<graphic url="[path/filename.ol]"/>
<scale>[0-100]</scale>
<orientation>[0-10]</orientation>
<tags>
<tag type="[type_name]" category=”[category_name]”>
<description>[description text]</description>
<quantity unit="[unit_symbol">[value]</quantity>
</tag>
<tag>[]</tag>
…
<tag>[]</tag>
</tags>
</shape>
Example
The following markup in the Symbol Library XML file creates a library item named Glue Tube, a 3D symbol <shape> element representing a metal bonding adhesive container.
consumable tag—Indicates that the item symbolized (glue) is consumed in this sequence. It contains two child elements, <description>, for glue application instructions, and <quantity>, to specify the container volume, 177 milliliters (unit="ml").
<shape id="2" categoryId="4">
<name>Glue Tube</name>
<description>Metal bonding adhesive</description>
<gallery_thumbnail url="SymbolsLibrary\Shape\Glue_tube64x64.jpg"/>
<graphic url="SymbolsLibrary/Shape/Glue_tube.ol"/>
<tags>
<tag type="consumable" category=”resource”>
<description>Apply generous coating to both joining surfaces</description>
<quantity unit="ml">177</quantity>
</tag>
</tags>
</shape>