Thesaurus

Last Updated: 17 Dec 2015

The Thesaurus asset allows you to create a database of related terms that can be used in conjunction with other assets. For more information on the functionalities of the Thesaurus, refer to the examples in this manual.

Bookmarks to the headings on this page:  

  1. Details Screen

Once you have added a Thesaurus, you can configure its settings on its associated asset screens. The majority of these screens are the same or similar to those for a Standard Page and are described in the Asset Screens manual. In this chapter, we will describe the Details screen, which is different for a Thesaurus.  

Details Screen

The Details screen allows you to configure the relation, reflection and hierarchy settings for the Thesaurus as well as import and export the Thesaurus'  XML file.

For more information about the Status, Future Status, Thumbnail and Details sections, refer to the Details Screen chapter in the Asset Screens manual.

Import XML

This section allows you to upload an Extensible Markup Language (XML) file to determine the structure of the Thesaurus. The Import XML section is shown in the figure below.

5-0-0_import-xml-section.png
The Import XML section of the Details screen

The fields available in this section are as follows:

  • Upload File: select which file to use for the Thesaurus. To do this, click on the Browse button – the File Upload pop up will appear. Locate the file that you want to use, left click on it and click on the Open button. The path of the file that you have selected will appear in the Upload File field. You can only upload files of type XML.
  • Example File: a sample XML file is available here as a demonstration of the expected structure of the imported file.

For more information on the Thesaurus XML file setup and structure, refer to the Formatting the Thesaurus XML File chapter in this manual.

Export XML

This section allows you to generate and download the Thesaurus as an XML file. The Export XML section is shown in the figure below.

5-0-0_export-xml-section.png
The Export XML section of the Details screen

To use this section, the Thesaurus must have terms associated with it through either the Import XML section or manually adding the Thesaurus Term assets. If it does not, the error message The thesaurus currently has no terms will appear. The fields available in this section are as follows:

  • Generate XML file: click this button to generate an XML file from the current Thesaurus Terms. Generating an XML file overwrites any previously generated files for this section.
  • Download File: click this button to download the XML file. This button is only available once an XML file has been generated using the Generate XML file button.
Hierarchy Mode

This section allows you to configure how the ThesaurusTerms are displayed in the Asset Map. The Hierarchy Mode section is shown in the figure below.

5-0-0_hierarchy-mode-section.png
The Hierarchy Mode section of the Details screen

The fields available in this section are as follows:

  • 5-0-0_thesaurus-hierarchy-mode.png
    A Thesaurus in Hierarchy Mode  

    Hierarchy Mode: select whether or not to use the Hierarchy Mode. If this field is set to Enabled, the terms that are shown for the Thesaurus will be based on the value that is selected in the Hierarchy Relation field. For example, if this field was Enabled and the Hierarchy Relation field was set to eats, the terms gazelle, lion and monkey will appear, as shown in the figure to the right. A Hierarchy Relation needs to be selected for the terms to display correctly. If this field is set to Disabled, all terms will be listed on the same level in the Asset Map. By default, this field is set to Enabled.
  • Hierarchy Relation: select which relation to use to determine which Thesaurus Terms will be displayed as the top-level terms in the Asset Map. When a relation is selected, terms with children of that relation will appear under the Thesaurus in the Asset Map. For example, in the figure shown to the right, the Hierarchy Relation is set as eats, with gazelle, lion and monkey shown as top-level terms. If the relation were set as lives, only gazelle and monkey would be shown. Lion would not be a top-level term as it does not have any lives related terms. Hierarchy Mode must be set to Enabled for this setting to work. By default, this field is set to -- Nothing Selected --.

Tip: To display Thesaurus Terms in the Asset Map, the Hierarchy Mode needs to be configured or disabled.

Built-in Relations

This section allows you to choose the relations for synonyms and abbreviations in the Thesaurus for use on a Search Page and in the WYSIWYG Editor. The Built-in Relations section is shown in the figure below.

5-0-0_built-in-relations-section.png
The Built-in Relations section of the Details screen

The fields available in this section are as follows:

  • Synonym Relation: select the relation to use for synonym searching on a Search Page. This means that if a search page has Synonym Search enabled, only terms linked with this relation will be regarded as synonyms, rather than all related terms. For example, a Thesaurus is created with the term disappear connected to the term vanish by the relation similar and to the term appear by the relation different. If no Synonym Relation is selected, when entering the word disappear into a search field, both vanish and appear will be suggested terms. However, if similar is selected in the Synonym Relation field, when entering the word disappear into a search field, only vanish will be suggested.
  • Abbreviation Relation: select the relation to use for abbreviation expansion in the WYSIWYG Editor. The WYSIWYG Editor will expand abbreviated terms based on the relation selected in this field. For example, a Thesaurus is created with the terms Aus and Australia connected by the relation abbrev. If abbrev is selected in the Abbreviation Relation field, when entering Aus in the WYSIWYG Editor, Australia will be suggested to use instead. For abbreviation expansion to work, the Matrix Expand Keywords Plugin must be enabled and a Thesaurus must be selected in either the Global Preferences or User Group Preferences. For more information, refer to the System Configuration manual.

By default, both Synonym and Abbreviation Relations are set at -- Nothing Selected -- For more information on how to set up Built-in Relations, refer to the Abbreviation Expansion in the WYSIWYG Editor and Synonym Searching examples in this manual.

Relations

This section allows you to configure the settings of relations in the Thesaurus. The Relations section is shown in the figure below.

5-0-0_relations-section.png
The Relations section of the Details screen

The fields available in this section are as follows:

  • Default Relation: select the relation to be used when linking terms to each other in the Asset Map. For example, if this field was set to a relation named habitat and a term titled bush was linked to a term titled koala, the default relation of bush and koala would be habitat. When a term is linked to the Thesaurus no relation is assigned, as the term becomes a top-level term.
  • Add New Relation: this field allows you to add a new relation for use in the Thesaurus. A name for the relation can be entered, however this field is not mandatory. A relation with no name will be listed as NULL in various fields on the Details screen.
  • Rename Relation: this field allows you to rename an existing relation by selecting the relation from the dropdown list and entering a new name.
  • Delete Relation: select a relation to delete. If a relation is deleted, terms associated with that relation will no longer be linked. If all relations are deleted, the Thesaurus will contain no linked terms.
Reflections

This section allows you to enable reflections between different relations. The Reflections section is shown in the figure below.

5-0-0_reflections-section.png
The Reflections section of the Details screen

Reflections allow relation links to be created automatically based upon sets of reflection pairings. Once a term is linked to another with a relation, that term will reflect a relation back, specific to the original linked relation. For example, the relation settings are configured so the relation habitat is reflected with the relation lives. If the term bush was linked to the term koala with the habitat relation, koala would reflect back and link to bush with the relation lives.

The fields available in this section are as follows:

  • Enforce Reflections: select whether or not to enable reflections. If this setting is set to Disabled, reflections will not be enforced when linking or unlinking terms.
  • Relation Map: this field allows you to set up the reflection pairs. Relations can be reflected with themselves or another relation. A relation can only be used in one reflection pairing.
  • ANSI Integrity Check: this field will check whether all relations are reflected, in accordance with ANSI standards, when Reflections are enabled on the Thesaurus. If not all relations are configured in the Relation Map, a warning message will appear and a list of unpaired relations will be displayed. For more information on the ANSI standards being checked, view the Guidelines for the Construction, Format, and Management of Monolingual Controlled Vocabularies (ANSI/NISO Z39.19).

Next Chapter

The Latest

Let Us Know What You Think

Let us know if you spot any errors or if you have any ideas on how we can improve the Matrix Community Website.

Contact Squiz for Demo

Let us show you the true power of Squiz Matrix by giving you a personalised demonstration.