How to build a Glossary in daisy

Providing a Glossary in daisy

Introduction

This document explains how to setup a glossary. It is based on a real example.

When using daisy as a company documentation system, it may be necessary to have a glossary that explains terminology and give examples. Each term should be a single document that other documents can link to. The Glossary should be ordered alphabetically and should be displayed from A to Z with the beginning initial being a level in the navigation structure. (Just as we know it from books)

Examples could be :

• Abbreviations (what does UNESCO stand for?)
• Named procedures (what is the correct procedure for merchandise intake?)
• Definitions (what is an item with your company and how is the line ID structured?)

An extra bonus would be that the glossary shows only relevant entries within a navigation tree. So some glossary documents should be used in every glossary available, others only within the relevant navigation structure

Example:

The glossary entry "Line Item" (in the sample below in its German translation "Artikel") is valid throughout the company, while "Costums" should only show up in the navigation tree for the Import Department, where the entry "line Item" needs to show up, too. The navigation structure could look like this:

Glossary Example

Overall you only want to write the Glossary document "Line Item" once, but use it at several points in the navigation (perhaps because some users have no access to a certain part of the navigation structure).

How it is done

Step 1 - Add a new documentType 'Glossary'

Log in as a user with admin rights.
Go to the Administrator tab and select > Repository Schema > Manage Document Types.
Create a new document type, named Glossary and add the translations you need for your system.

As a part type choose at least the SimpleDocumentContent.

Step 2 - Add all Glossary Documents to the NavigationTree

Go to the navigation where you want to add the glossary, add a folder named "Glossary" and add a query by choosing the button "Insert New Query node".

Here enter the query:

select Substring(name,1,1), name where documentType = 'Glossary' order by name

If you have a mulitlinugal site, add your languageID (in this case '2'):

select Substring(name,1,1), name where documentType = 'Glossary' and languageId ='2' order by name

Step 3 - Adding specific Glossary Documents to a NavigationTree

If you want a more specified glossary to show up at a different part of the navigation, you may want to add some collection information:

select Substring(name,1,1), name where documentType = 'Glossar' 
and languageId ='2' and InCollection('XYZ') order by name

For this to work, your specific documents need to be added to the collections you want to use them in - in the above example the collection 'XYZ'.

Things get a bit more compicated, if you want to exclude glossary documents. This could be your query (with sample collection names):

select Substring(name,1,1), name where documentType = 'Glossary' 
and languageId ='2' and (collections HAS NONE ('XYZ','ABC','NAME','COMPANY')) order by name