Imported taxonomy definition files must adhere to the CommonSpot taxonomy definition in order to pass import validation. CommonSpot includes a sample taxonomy definition (commonspot\taxonomy\sample.xml).
Below is a summary of each Element and accepted attributes and values.
Element: TAXONOMY |
||
Description |
The Element is the top-level container for the taxonomy definition. All recognized Elements are defined as sub-Elements of this tag. |
|
Attributes |
version |
The version of the taxonomy specification that the XML conforms to. This version number is published by PaperThin. |
Valid Sub-Elements |
name |
Required. The name of the taxonomy. This value displays in the Manage Taxonomy dialog. |
description |
Optional. The description of the taxonomy. This value displays in the Manage Taxonomy dialog. |
|
version |
The version of the taxonomy, as assigned by the author of the taxonomy definition file. This value displays in the Manage Taxonomy dialog. Whenever a new taxonomy is imported, this value should be changed in order to maintain an import history. |
|
term |
See Term Element description |
|
facet |
See Facet Element description |
Element: TERM |
||
Description |
Each term definition will be defined using a term Element. |
|
Valid Sub-Elements |
name |
Required. The name of the term. Each term must have a unique term name. |
npt |
See NPT Element description below. |
|
nt |
See NT Element description |
|
annotation |
See the Annotation Element description |
Element: FACET |
||
Description |
Defines the hierarchical relationship among the terms. |
|
Valid Sub-Elements |
name |
Required. The name of the facet. Each defined facet must have a unique name. |
description |
A description of the facet. |
|
topterm |
Required. The top term in the facet's hierarchy. The topterm identified here must be a term that has been defined elsewhere in the XML using the term element. Multiple top terms are allowed for each facet. |
Element: NT |
||
Description |
Used to identify all Narrower Terms for a given term. |
|
Attributes |
facet |
Required. The facet in which the narrower term designation applied. If the relationship is valid for more than one facet, multiple NT elements can be used. |
Valid Sub-Elements |
facet |
Required. The facet in which the narrower term designation applied. If the relationship is valid for more than one facet, multiple NT elements can be used. |
{value} |
The name of the narrower term. The value identified here must be a term that has been defined elsewhere in the XML using the term element. |
Element: ANNOTATION |
||
Description |
Used to add annotative text to a term. |
|
Attributes |
type |
Any custom type code that indicates an ANNOTATION relationship. Standard annotative codes include, but are not limited to, SN (Scope Note) and HN (History Note). |
Valid Sub-Elements |
{value} |
The annotative text. |
Related Links
You can download PDF versions of the Content Contributor's, Administrator's, and Elements Reference documents from the support section of paperthin.com (requires login).
For technical support: