Glossary

Populate the glossary

You can populate your glossary under Knowledge Base > Glossary. There are two ways to add terms:

  1. One at a time:
    Click Add Term to manually add a glossary term and its definition.
  2. In Bulk:
    Click Import Terms to add glossary terms in bulk from a csv file.  There is an example csv file here you can use as a template.

Glossary terms will automatically be displayed in alphabetical order. When your glossary gets larger, you can use the search feature to quickly find a term.

View the glossary

The glossary is a default page in every knowledge base. Its permalink is always "glossary", so you can get to the glossary by going to "/help/glossary" in your knowledge base (or "/home/glossary" or "/docs/glossary" if you are using a different root path).

For example, here is the glossary page for our help and documentation (we haven't set ours up yet so you'll only see some test terms):
https://support.knowledgeowl.com/help/glossary 

If you are ready to share your glossary with your readers, you can add it to the table of contents under Settings > Basic > Website Settings  > Table of Contents > "Add a glossary link to the top of the table of contents".  You can also manually link to it from your top navigation, home page, or articles using the link "/help/glossary".


Provide definitions in articles automatically

Once you have set up glossary terms, you can automatically provide hover-over definitions for these terms in your articles. You can turn on this option under Settings > Basic > Website Settings > Glossary Terms > "Automatically highlight the first glossary terms that appear in an article".

You can choose how many glossary terms should be automatically highlighted.  To prevent readers from being overwhelmed by tons of underlines, we limit you to 10 automatically highlighted terms per article. We will only highlight the first instance of each terms, so if you choose to highlight the first 3 terms, only the first instance of each of first 3 glossary terms will be highlighted.

For automatic highlighting to work, the terms in the articles must exactly match the terms in the glossary. If your article contains variations of a term, you can manually create a link to the glossary definition.

Add glossary definitions in articles manually

In addition to automatically highlighting up to 10 glossary terms per article, you can also manually set up glossary definitions.  Manually setting up the glossary definitions give you the most control as you can specify when and where you want to define terms. It also allows you to provide definitions for variations of a words whereas the automatic highlighting must be an exact match.

To provide a definition for a term in an article,

  1. Make sure the glossary term and definition exist in the glossary. New terms can be added under Knowledge Base > Glossary.
  2. Highlight the word or phrase you want to provide a definition for, and click on the Add Glossary Term icon in the editor.
  3. Search for and select the glossary term, and optionally customize the text to be displayed. Once you insert the glossary term, you will see a double underline in the editor and the hover-over definitions can be viewed in preview or using the live link.

Customize how glossary terms look

The default highlighting of a glossary term looks like this: test

You can customize the look and feel of your glossary terms using css. Here's the code for the default double underline which you can customize and add under Settings> Style > Custom CSS:

.ko-glossary-term {
border-bottom: 3px #bbb double;
}

The hover-over definition can also be customized.  Here's the default styles:

span.ko-glossary-term+.popover{
font-size:14px;
font-weight:normal;
line-height:1.2
}

The popover is done using Bootstrap. See their popover documentation for more options.

Keep glossary header visible when scrolling

Here is some code to keep your glossary header visible when scrolling.


Copy and paste this script into the bottom of Settings > Style > Custom HTML > Body. This script will keep the Glossary header and letters visible as you scroll.

<script>
$(function(){

//only on glossary
if(window.location.pathname == '/help/glossary') {
if($('.ko-content-cntr').length > 0)
var articleCont = $('.ko-content-cntr');
else 
var articleCont = $('.documentation-article');
var articleWidth = articleCont.width();
var navTop = $('.hg-header').outerHeight(true);
  var topDiv = $('<div/>', {class: "ko-glossary-topdiv"});
articleCont.prepend(topDiv);
topDiv.append($('h1.page-header')).append($('div.glossary-jump-to'));
var topOfJumpto = topDiv.offset().top;
var jumptoHeight = topDiv.outerHeight(true);
topDiv.affix({
offset: {
top: topOfJumpto - navTop,
}
});
//add dynamic reusable styles
$('<style>.ko-glossary-topdiv.affix{top:'+navTop+'px;width:'+articleWidth+'px;background:#fff;}.ko-glossary-topdiv.affix + .glossary-terms-wrapper{margin-top:'+jumptoHeight+'px}</style>').appendTo('head');
}
});
</script>

Copy and paste this CSS into Settings > Style > Custom CSS to make sure the sections are visible when you click are the links to jump to a section. Without this CSS the letter you jump to might get covered by the header.

.hg-glossary-page a:not([href]) {
display: block;
height: 200px;
margin-top: -200px;
visibility: hidden;
}

Add search to the glossary page

You can add a search box to your glossary page with a little html, css, and javascript. As you type, this script will highlighting matching words in your glossary terms and definitions, hiding the terms without matches.

Copy and paste this JavaScript to the bottom of Settings> Style > HTML Body.

<script>
$(function(){

//Glossary
if($('.hg-glossary-page') && $('.hg-glossary-page').length >= 1){
$('.page-header').append('<input type="text" id="glossary-search" placeholder="Search glossary">');
$('input[id=glossary-search]').keyup(function()
{
$('.glossary-term').removeHighlight();
var term = $(this).val().toLowerCase();
$('.glossary-term').each(function()
{
if ($(this).text().toLowerCase().indexOf(term) > -1)
{
$(this).show().highlight(term);
}
else
{
$(this).hide();
}
});
});
}
});
</script>
<script src="//dyzz9obi78pm5.cloudfront.net/app/image/id/56fa0cfd91121cd0337b6d9d/n/jquery.highlight-5"></script>

Copy and paste this CSS into Settings > Style > Custom CSS:

#glossary-search {
height: 28px;
font-size: 14px;
float: right;
width: 300px;
padding: 2px;
}

.highlight { 
background-color: yellow 
}

Glossary FAQs

Can you add links to articles in glossary definitions?

Yes, you can add links in your glossary definitions using plain html. 

Here's an example of what it might look like: 

This is the definition. For more information, see <a href="/help/amazing-article"> this amazing article</a>.

Do glossary items show up in search?

Not right now but we do have a feature requests to add the glossary to search results.   Contact us if you are interested in this feature and we can add you to the list!

Can you add synonyms for glossary terms?

You can add synonyms as part of a definition or add synonyms as separate terms with text like "See xyz". We recommend definition the most commonly used term and listing synonyms in the definition. You can always manually provide definitions for the synonyms in articles using the Add Glossary Term option.

Example:

This is a definition. Synonyms: this, that, the other thing

 We do have a feature request to add a synonyms feature.   Contact us if you are interested in this feature and we can add you to the list!

Can you link from one glossary term to another?

Not currently. You can alternative use text like "See also: this, that, this other thing" or link to an article.   Contact us if you are interested in this feature and we can add you to the list!

Can you have more than one glossary?

Each knowledge base has a single glossary that is used for the glossary page as well as providing contextual definitions. If you need multiple glossaries, you can alternatively create separate articles for the separate glossaries. We can make the page look and function like the glossary. Contact us and we can help you get it set up!

Can you share a glossary between multiple knowledge bases?

We don't currently have a way to share a single glossary across multiple knowledge base. However, you can create a glossary in one, export the terms, and import them into other kb. You will need to manage the kb in multiple places. 

Can you insert the full definition into an article as plain text rather than a popover?

Not currently but we do have a feature request to create a merge code or snippet for glossary terms.   Contact us if you are interested in this feature and we can add you to the list!