GlossBase is a freely-available application that you can use to create, define, edit, and manage glossary terms and definitions for FrameMaker books. GlossBase allows you to create definitions that contain an unlimited number of paragraphs, tables, equations, and referenced graphics. GlossBase encodes each definition in XML and stores terms and definitions in a database.

When you are ready to generate a glossary for a book, GlossBase scans all of your FrameMaker chapters and automatically generates a glossary containing all relevant terms and definitions.

GlossBase is designed to complement the features of WebWorks ePublisher Pro. GlossBase can insert all of the markup necessary for glossary definitions to appear in a pop-up window in on-line help systems generated by ePublisher.

GlossBase can generate glossaries for unstructured and structured FrameMaker books. However, FrameMaker must be running in structured mode to use GlossBase. GlossBase uses a structured template to represent glossary terms and definitions.

Creating a New Term

To create a new term, do the following:

1. Select GlossBase -> Glossary Toolbar from the GolehTek menu in FrameMaker.

The GlossBase Toolbar will open.

2. Type the name of a term in the Define New Terms field.
3. Click the New Term button.

GlossBase will open a new structured template that you can use to enter the definition. Begin typing the new definition at the ParaGl element, which is the first child of the TermDefinition element.

4. When you are finished writing the definition, click Save to check the term into the database.

Generating a Glossary

To generate a glossary, do the following.

1. Open a FrameMaker book.
2. Select GlossBase -> Generate Glossary from the GolehTek menu.

A dialog box will open.

3. Click Generate to generate the glossary.

GlossBase will add a glossary to your FrameMaker book. The generated glossary will contain all relevant terms and definitions.

Enabling WebWorks Processing

To enable WebWorks processing, do the following:

1. Select GlossBase -> Preferences from the GolehTek menu.
2. Check the Apply WebWorks Formatting box.
3. Enter the name of the character style that GlossBase should apply to each term in your FrameMaker source files.

GlossBase will create this character format if it doesn't already exist. By default, all formatting settings are defined as "As Is". The purpose of the character formatting is to prevent the entire paragraph from becoming one large hyperlink in the resulting help file.

4. Check one of the radio buttons that determines how WebWorks should format the hyperlink.

The next time you generate the Glossary, GlossBase will apply the necessary formatting for WebWorks.

Opening the Glossary Toolbar

Glossary Toolbar

Generating a Glossary