Creating a stand-alone Glossary

From UPK wiki
Jump to: navigation, search



UPK allows you to create a Glossary that contains terms and their definitions. This is used to 'automatically' hyperlink instances of the terms to their definitions, throughout your content.

However, the Glossary does not really exist as a separate entity, and cannot displayed in its entirety (by users). Sometimes, clients like to see a separate Glossary document (either in UPK or external to UPK). There are a few ways of doing this. as outlined below.

Creating a 'Glossary' within the Player

If you want a Glossary within the Player (for example, as an entry in the Outline) then you can do this as follows:

  1. Create a new Module or Section called Glossary, and link it into your Outline.
  2. Attach a Web Page to this as the Concept Page.
  3. Copy all of your Glossary Terms into this Web Page.
  4. Run 'Update Glossary Links' for this Web Page.

This will create an entry in the Outline that, when clicked on, displays all of the Glossary Terms (in the Concept Pane, and all of these are hyperlinks to the relevant definitions.

Creating an external document

Option 1: Use existing glossary links

Assuming that you have ALL of your content linked into a single Outline Element, select this element and then publish as a Training Guide (I think Instructor Guide would work as well). This will generate a single Word document, the last section of which will be a Glossary of all terms used in all of the content. Delete everything but this, and you have a stand-alone glossary. Of course this assumes that al of your Glossary terms are included in your content SOMEWHERE, and that you have generated glossary links. It may also take a while to run, because it is sucking in all of your content.

Option 2: Create a separate Web Page

First, create a Web Page and attach it to a Module or Section. COPY all of your Glossary Terms from your Glossary (you can just select the column and then copy). Paste this into the Web Page you created. Then generate glossary links for this Web Page. Publish the Module or Topic that this Web page is attached to as a Training Guide (as mentioned above) and again, you'll get a Glossary out of it. The advantage of this approach is that it includes ALL terms, and will generate faster, but the downside is you need to do extra work to set it up.

Option 3: Build a custom output document

The 'cleanest' option is to create a custom document type that you can then publish to as often as you need. The easiest way to do this is to take a copy of an existing Output Document type that includes a Glossary, and strip out all of the content apart from the Glossary itself (be very careful doing this - the documents are very sensitive to change). See Defining a new output style and Customizing Word-based output documents for details of how to do this. You can then publish your document from either Option 1 or Option 2 above, to create this separate document. (More details to follow on this when I get time to flesh it out - else see the UPK 3.5 book).

Personal tools