Add-on Taxo: Documentation
Get information about how to use and integrate Taxo in Sophora and inform yourself about the benefits of the add-on.
Table of Contents
With Taxo a new input field type can be created that allows administrators to associate an input field with a selected taxonomy document. As a result of using Taxo, contents can be classified easier and more uniformly.
By entering tags to the input field, editors get proposals of already existing tags. Tags which are not included in the proposal list, will be added automatically after saving.
Working with Taxo
The input field is used for entering and displaying tags, which classify the content of a document under certain categories. Taxonomies can be created by editors or individual ones in the administration area of Sophora’s DeskClient.
If you enter a tag to the input field, the new tag will be added automatically to the proposal list and can be used for the next entry again.
- Click in the input field and enter a new tag. The tag can be composed of single words or a number of words.
- By pressing Enter the tag will be created and highlighted.
- Save the document.
Editors who enter tags in the input field receive suggestions while typing. The taxonomy document contains a list of already entered and used tags.
- Start entering one or more letters into the input field. The list of tags will be displayed automatically.
- Click on the suitable suggestion and by double clicking or pressing Enter, the tag will be added to the input field.
- At the end save the document.
Tags can be edited in order to correct spelling mistakes, separate matching tags or connect a number of tags.
- Click on one or several tags until they are not highlighted anymore.
- Now add or delete letters (or entire tags) and press Enter. You can also connect side by side standing tags with pressing Enter.
- After editing save your changes.
Tags can be deleted from the proposal list or just removed within the input field.
- Enter a tag or select an already existing tag from the proposal list to the input field.
- Choose Delete from proposal list. The tag will be removed from the input field.
- By saving the tag will be deleted from the proposal list as well.
- Move the mouse cursor onto the tag which is meant to be removed.
- Press the right mouse button and choose Remove.
- The tag has been removed. Save your changes.
It is possible to set suggested tags on a blacklist in order to exclude special terms.
- Enter a new tag or select an already existing tag to the input field.
- Click on the tag with your right mouse button and choose Forbid.
- The tag will be disappear out of the field and marked as Not allowed within the proposal list.
- Save your changes. If you close the document without saving, an indication will appear to remind editors: Field 'Tags' contains invalid values.
- Editors can still select forbidden tags, but they will be shown crossed out.
Entering multiple values
This input field can be used to enter multiple values which can be reused (tags). The values can be any text (words or phrases). This input field needs a backing system document in which all entered values are stored. Stored values are proposed when text is entered.
Additionally each backing document stores a list of words that should not be used. This blacklist prohibits phrases from being entered in the text field. To move a tag to the blacklist you can use the context menu. The context menu of each tag also allows the removal of that tag from the backing document.
- Property type: String multiple
|Parameter||Description||Range of values|
|Taxonomy Document||The document in which entered phrases will be stored for proposals or blacklisting.||All existing taxonomy documents (system documents of the typ sophora-nt:enhancedTag)|
Exporting & Importing Taxonomy-Documents
Taxonomy-documents can be exported and imported to base the tag list on an external source. Within the administration area editors with the required permission can select "Import..." or "Export..." to transfer lists.
Rebuilding A Taxonomy Document
A taxonomy document holds all used phrases entered in any document using this field. When this field is configured for the first time, you may already have values in stored documents for the configured property. But only when a document is saved the values will be stored in the corresponding taxonomy document. To fill the taxonomy document upfront with the values in existing documents you can trigger a rebuild of that document. A rebuild searches all documents which use the given taxonomy document and copies all values of the corresponding field into the taxonomy document.
A taxonomy document rebuild is trigger by a MBean via JMX. The MBean is located beyond com.subshell.sophora.RebuildTaxonomy. The MBean has two attributes and one operation. The operation rebuildDocument(externalId) starts a rebuild job for the given system document. If you don't know the external ID, you can look it up in the attribute Taxonomies. This attribute maps each external ID of a taxonomy document to its label.
The attribute RunningJobs shows all running rebuild jobs and their status. The rebuild has three steps: First find all documents which use the given taxonomy document, then extract existing values of these documents and afterwards adding all found values to the taxonomy document. The first and last step are relatively fast, but reading each document takes some time. Therefore the progress of processing the documents will be listed in the status text, for example:
RebuildJob of 65d180f3-e9bd-4ec8-956e-b4bc0b8e3ba0: processing documents 450 of 1534
For more information refer to Existing Input Field Types.