Introduction

The Basic Glossary plugin provides a space blueprint to create a glossary that can be linked to one or more spaces by a shared space category. When text is highlighted on a page, it brings up an option to view a definition in the glossary. Should no definition be found, the option to create or request the definition will be presented depending on the permissions of the user.

Glossary Setup

This plugin allows multiple glossaries to be setup in an instance of Confluence. A simple connection convention allows a glossaries to be connected to multiple spaces and multiple glossaries to be connected to a single space. A glossary is a Confluence space with some special pages and the space category glossary. The Glossary Space Blueprint will create the space appropriately. To connect the glossary to a regular space, they need to share a common Space Category. As an example, in Keysight's instance of Confluence we created the Keysight Glossary using the Glossary Space Blueprint. The Keysight Glossary was given the additional space category of keysight. We also have a Keysight Space Blueprint that is part of the Keysight Theme plugin. When a space is created using the Keysight Space Blueprint, the space category of keysight is added. As both the new space and the Keysight Glossary shared the space category of keysight, they are now linked. So when a user highlights text in the new space and selects the glossary icon, it now searches the Keysight Glossary for terms.

Features at a Glance

Features in Detail

Glossary Space Blueprint

Description

Creates a space with 27 spaces, A-Z and &. The expectation is for glossary terms starting with A to be children of the A page. The space is identified as a glossary by having the space category of glossary.

Usage

Select the create space link from the Spaces dropdown. Then select the Glossary Space Blueprint. Provide the values as requested. To link a regular space to the glossary space, they must share a common space category. For example, if there is a space called Bitbucket, then adding a space category such as atlassian to both the Bitbucket and Glossary spaces will link the two.

When a user requests a term to be defined, the email request will be sent to the administrators of the Glossary space.

Purpose

A space blueprint is simply a convenient container for the glossary terms. It creates a place that can be linked to one or more spaces. Likewise, a space can link to one or more glossaries.

Highlighted Text

Description

When text on a page is highlighted, an icon is shown to request the definition from the glossary. If no glossaries are linked to the space, a message to that extent will be shown to the user. If a space has been linked and the highlighted text matches the title of a page in the glossary, the content of that page will be shown in a popup. If there is no match, the user will be given an option to either define or request the definition.

Presently, the matching algorithm is very simplistic. One an exact case-sensitve match works at present.

Usage

Highlight text on a page, click on the book like icon.

Purpose

The purpose of this functionality is self-evident.

Home