Skip to content

Term sidebar

Clicking on a term in the graph opens the term sidebar which provides all details of the term.

Main

Basic information

alt text

  1. Name: View and change the name of the term. It is a simple text field
  2. Description: View and change the description of the term. It is a simple text field
  3. Related: Terms appearing in the description AND those directly connected by relations to this term
  4. Parent: The direct superordinate term(s). These are identified as the target(s) of relations where the type is "Generalisation" originating from this term
  5. Sibling: The children of the parent (see 4)
  6. Children: The direct subordinate term(s). These are identified as the source(s) of relations where the type is "Generalisation" pointing to this term

For points 4 to 6, it's essential to have the relation types properly defined. Specifically, one or more relation names must be mapped to the type "Generalisation".

Buttons

alt text

  • A Collapse/Resize: Resize the sidebar or collapse the sidebar
  • B Search and AI prompts: Opens a menu allowing you to search for this term online or generate prompts for AI chatbots.
    • AI prompt to paste: Copy chatbot response and paste into the Definition or ADD INFO tab field.
    • AI for Bulk add: Copy chatbot response and paste into the Bulk add input field located in the right sidebar.
  • C Copy definition to clipboard
  • D Navigate to taxonomy view: Shows the term in the hierarchy view in the right sidebar. The icon is only visible if at least one "Generalisation" relation type is defined
  • E Popout description: Shows a popup with the definition. Handy for comparing multiple definitions. Press the ESC button to close all popups.
  • F Collapse related view

Tabs

Add Info

alt text

Here you can add additional information for your term. You can elaborate on the description, add examples, explanations etc. It supports rich text format.

Details

alt text

In this tab, you can modify the term's category, alter its ID, and add or edit any custom fields you have defined

  • Type: Sets the type of term
    • Term: A normal term
    • Property: Set it to a property. Functions like a standard term but can be hidden in the graph: Settings > Document > Hide properties
    • Group: A container used to organise terms. This container acts as a regular term and can have its own relations, etc
    • Label: Allows the addition of brief text elements directly onto the graph
  • Change id: Clicking the icon allows you to modify the term's identifier
  • Extra fields: This section enables you to manage custom Fields for both terms and relations. You can add or remove Fields and set their corresponding values. Fields are usefull to store extra information, like categories or hyperlinks. They can also be used for filtering the graph.
  • Weight: Only visible if enabled in the Document Settings. Type or select a number representing the term weight.

Relations

Gives an overview of the relations and related terms, supporting inheritance. alt text

Explanations:

  1. Source term
  2. Relation: The relation name. If colors for relation types are enabled it will show the color associated with that relation type. If it is not enabled, it will show the color which is set by hand in the graph for that relation
  3. Cardinality: See for explanation the cardinality
  4. Target term
  5. Inherited from: The parent term from which this relation is inherited. The inheritance must be enabled via A. More explanation here
  6. Reverse Cardinality: The cardinality of this relation when viewed from the target term back to the source term (reading from right to left)

Buttons:

  • A Toggle Inheritance: Turn on or off the inheritance feature. This will show the relations from the parents as well. This button is only visible if there is at least one relation type "Generalisation".
  • B Highlight relations: Blurs the graph and keeps only the relations of this term highlighted
  • C Add relation: Opens dialog to add a new relation. The left-right arrow button in that dialog switches the direction

Relation Inheritance

Termboard offers a powerful feature called Relation Inheritance, which allows terms to automatically inherit relations from their parent terms. This can significantly simplify your model, reduce redundancy, and improve maintainability and understanding. To utilize this feature, you need to:

  • Define "Generalization" Relations: Establish hierarchical relationships between terms using a relation type specifically designated as "Generalization." You can learn how to create and designate relation types here. The "Generalization" relation should point from the more specific term (the child) to the more general term (the parent).

  • Enable Inheritance: Activate the inheritance feature in the application settings by navigating to Settings > Document > Inherit relations , as explained here.

Once these steps are completed, the RELATIONS tab in the term sidebar for any term will display not only its directly connected relations but also all applicable relations of its parent(s), and their parent(s) recursively. It's as if these inherited relations directly belong to the current term. Importantly, all relation types except "Generalization" relations themselves will be inherited.

Benefits of Relation Inheritance:

  • Reduced Redundancy: Avoid repeatedly defining the same relations for multiple similar terms. Define them once on a general parent term, and let its more specific children inherit them.
  • Improved Maintainability: When a common relation needs to be updated, you only need to modify it on the parent term, and the changes will automatically propagate to all inheriting child terms.
  • Enhanced Understanding: Makes the underlying structure and commonalities within your model clearer by explicitly showing inherited relationships.

Duplicate Relation Detection:

Termboard includes a built-in mechanism to detect and highlight potential duplicate relations arising from inheritance.

alt text

Example:

As shown in the image above, both the parent term "vehicle" and the child term "motor vehicle" have a "requires Maintenance" relation. Since "motor vehicle" is a child of "vehicle" (via a "Generalization" relation), it inherits the "requires Maintenance" relation. Termboard will identify the directly defined "requires Maintenance" relation on "motor vehicle" as a "Duplicate" in the relation overview.

Visual Indication:

In the relation list, inherited duplicate relations will be clearly marked with a "Duplicate" label, as illustrated in the screenshot.

Check for Duplicates:

Termboard also provides a dedicated Semantic Check feature that can scan your entire graph for all instances of duplicate inherited relations. You can find and utilize this check as described here. This helps ensure the consistency and clarity of your model by identifying and allowing you to address any redundant relation definitions.

Properties

This tab will only show when for this term there are relations with other terms of type property. For more specific information see Relations

Verbalisations

Verbalisations make it easier to see how things in your data model are connected and how many of each thing can be related (the cardinality). They do this by explaining the connections in plain language, which helps you check if the relationships make sense and understand them better.

alt text

For each relation associated with the selected term, a sentence will be generated, including the relation's cardinality where relevant.

Explanations:

  1. Source term
  2. Relation
  3. Cardinality
  4. Target term
  5. A missing reverse relation: This is caused by a missing reverse name. Add it via B
  6. Reverse relation: This is automatically generated

Buttons:

  • A Toggle Inheritance: Turn on or off the inheritance feature. Enabling this will also generate verbalisations based on the parent terms of this concept. This button is only visible if there is at least one relation of the type "Generalisation", which can be set using B
  • B Configure Relation Types: Set the relation type and the names for the reverse relations.