Adding glossary terms

Prev Next

Plans supporting this feature: Professional Business Enterprise

In Document360, you can easily add glossary terms at any time, making it a quick process that takes just a few seconds.


Adding a glossary term

To add a new glossary term,

  1. Navigate to Documentation () in the left navigation bar in the Knowledge base portal.

  2. In the left navigation pane, navigate to Content tools > Content reuse > Glossary.

    Here, you’ll see a list of existing glossary terms (if any have been added).

  3. Click Create to create a new glossary term.

    Alternatively, click the dropdown in the Create button and select Import terms to import terms from a CSV file.

  4. Enter the desired term in the provided field.

    Document360 interface showcasing glossary and translation features for knowledge management.

  5. When adding a glossary term, you will encounter four fields: Name, Language, Term, and Definition.

    1. Name:

      • This field allows you to give a specific name to the glossary term, which will be used for reference.

      • The character limit for the Name is 100 characters.

    2. Language:

      • Choose the appropriate language for the glossary term from the dropdown menu.

      • If you select Global, the term will remain untranslated across all languages. To enable translation, select any specific language instead of Global.

    3. Term:

      • This field is where you enter the actual term or phrase you want to define.

      • The character limit for the Term is also 100 characters, including spaces. Acceptable inputs include letters, numbers, spaces, and special characters such as () - _ & : ; ? / . , [ ] @ # ! *.  

    4. Definition:

      • In this field, you can provide a detailed definition or explanation of the term.

      • The character limit for the definition is 1000 characters.

    NOTE

    When translating a term into another language, the name acts as a placeholder. You can update the term in different languages, but the name remains the same across all languages.

  1. Once completed, click Create to finalize the addition.

    NOTE

    When translating an article into other languages, machine translation credits are consumed based on the number of characters.

Formatting options

You can style your glossary content using the following formatting tools:

Document360 interface showcasing editing tools and content creation features for knowledge base.

  1. Font family (): Change the font-family of the text.

  2. Font size: Adjust the size of the text between 8 to 96.

  3. Headings: You can define the headings, such as Paragraph, Heading 3, and Heading 4.

  4. Bold () Emphasize important words or phrases.

  5. Italic (): Highlight text or indicate terms like glossary or titles.

  6. Underline (): Add a line below the text for emphasis.

  7. Text color: Change the text color using a color picker or HEX code.

  8. Background color: Change the background color behind the text.

  9. Click the More () menu to access additional options:

    1. Inline code (): Format short code snippets or commands within text.

    2. Strikethrough (): Strike out text to indicate removal or revision.

    3. Superscript (): Display text slightly above the line (useful for footnotes or math).

    4. Subscript (): Display text slightly below the line (useful for formulas).

    5. Remove formatting: Clear all applied styles and revert to plain text.

  10. Unordered list (): Create a bulleted list.

  11. Ordered list (): Create a numbered list.

  12. Insert image (): Upload images from a URL, local storage, or Drive.

  13. Insert link (): Add a hyperlink to text. You can link to another article within your project or to an external URL. This works the same way as hyperlinking text in the Advanced WYSIWYG editor.

  14. Checklist (): Add a checklist to your content.

  15. Divider (): Add a divided to your content.

  16. LaTeX (): Add LaTeX expressions for mathematical content.

  17. Emoji (): Insert emojis into the content.

NOTE

  • You can use the /Slash menu in the Glossary editor to access formatting tools such as Heading 3, Heading 4, Numbered list, Bullet list, and Checklist, and you can also insert elements like Image, Link, Divider, LaTeX, and Emoji.

  • If a glossary term is added under "All," it cannot be added at the language-specific level. For example, if you want to define "TXT record" in multiple languages, create a glossary term in English and translate it to other languages. Use the Name field to identify the term across all languages. A term designated as Global cannot be language-specific.

For a better understanding of how a business glossary can help your Knowledge base, read the blog: Importance of business glossary in knowledge management.


Importing glossary terms

You can also effortlessly import multiple glossary terms using the Import glossary option. Before importing, you need to prepare a CSV file with glossary terms and their corresponding definitions.

Import glossary template

You can create a CSV file matching the required template or download a sample to populate your data.

Sample CSV format

Term

Definition

First term

First term definition

Second term

Second term definition

Third term

Third term definition

Download a sample CSV file

You can download one of the following templates for local use:

  • With data - Includes sample terms and definitions.

Import glossary - With data
761 Byte
  • Without data - Contains only row headers.

Import glossary - Without data
20 Byte

NOTE

Use software like Microsoft Excel, OpenOffice Calc, or Google Docs to open and edit the CSV file.

Importing glossary terms using the CSV file

Once your CSV is ready, upload it to the platform and start using the glossary terms in your articles and category pages.

  1. Navigate to Documentation () in the left navigation bar in the Knowledge base portal.

  2. In the left navigation pane, navigate to Content tools > Content reuse > Glossary.

  3. Click Create > Import terms, and the Import terms dialog appears.

  4. Select the desired language from the Language dropdown.

  5. Click Download template to download the sample CSV file that shows the required format for your import file.

  6. Drag and drop the CSV file or use the Upload from my device option to select the file from your device.

    Then, wait a few seconds for validation. The system will display the number of valid and invalid terms.

    If any terms are invalid, click Download () next to the error count to review the errors, such as Already associated term or Definition exceeds 500 characters.

  7. Click Import, and the newly added terms will appear in the Glossary overview.

Import terms feature for uploading CSV files in the glossary section of Document360.

This feature streamlines the glossary management process, saving you time when handling large sets of terms and definitions.


Troubleshooting

CSV upload error

If you encounter an error message like "Please make sure the CSV follows the sample template" when uploading a glossary CSV file, it may be due to the language settings in your Excel application.

Cause: The headers in the template file may have been altered if your Excel language is set to anything other than English. The system cannot detect modified headers, leading to upload failure.

Resolution: Follow these simple steps to fix the problem:

  • Check and change Excel regional settings (Office 365 Web Application)

  1. Open the glossary CSV template in Excel.

  2. If you are using Excel in Office 365 (Web Application):

    1. Go to File > Options > Regional Settings in Excel.

    2. In the Change Regional Format Settings panel, select English (United Kingdom) from the dropdown in the Select your preferred regional format for Excel for the web field.

  • Change regional format in Windows:

  1. Open Settings in Windows.

  2. Navigate to Time & Language > Language & Region.

  3. Change the regional format to English (United Kingdom).

    Once done,

  4. Close and reopen the glossary CSV template in Excel.

  5. Ensure the headers match the sample template exactly.

  6. Save the file again to ensure the correct headers remain intact.

  7. Retry uploading the CSV file.

If the issue persists after following these steps, please contact the Document360 support team for further assistance: Contact Document360 Support


FAQ

Can I add images to the glossary while importing glossary terms from a CSV file?

Only web images can be imported through definitions. Use the tag <img src="Image_URL"/> in your definition cell to add images.

For example, to include an image for "JSON Web Token," add the definition in the CSV as: JSON Web Token <img src="https://jwt.io/img/logo-asset.svg"/>

Imported images are stored in the Glossary folder in My Drive > Images > Glossary.