Using the glossary popup feature
Organizations whose business processes involve the use of difficult or confusing concepts and terms often wish to make the definitions for these terms available online for users to eliminate any possibility of confusion, speed up the process of learning the business process and to save time.
Hyper.Net provides a glossary function that eliminates the need to look up terms in a separate reference. All you need do is define a list of terms and their definitions, explanations or clarifications. While publishing a Rich Hypertext rendition, Hyper.Net will create a popup box on the first occurrence of any term in the list within every topic. The glossary can be created in the schema. This allows you to apply defined glossary lists globally by content type. Here's how to create a glossary:
| |
|
|
|
Step
|
|
1
|
Go to the Hyper.Net Administration console and click on Schema Editor.
|
|
2
|
Click on the Action icon next to an existing schema and select Modify this Schema or create a new schema.
|
|
3
|
Within the Schema Editor, click on Topic Manipulation in the left navigator, then on Glossary Definitions as shown:
The list of currently defined glossary terms is displayed in the list box.
|
|
4
|
Click on Add. The following dialog will appear:
|
|
5
|
For Name, you would usually enter the term. This is simply the name of the definition. The value of Name does not affect behavior. Let's use the name PCE.
|
|
6
|
Identifying Matcher is a descriptor used to define a way of locating text within a topic. You can identify text by searching for paragraph or word styles (Style Matcher), by searching for unique formatting such as "Bold-Italic-12 points" (Formatting Matcher) or by searching for unique text patterns (Pattern Matcher). In most cases, glossary terms are defined with pattern matchers. For example, if you wish to define the glossary term PCE, you would search for the text pattern "PCE". Pattern matchers are useful because they are created by regular expressions. This allows you to use wildcards in your text search. If the document references PCE2, PCE7 and PCE8 for example, and you wish to create a glossary popup on the first occurrence of any PCE reference, you can use the pattern matcher "PCE?" to search for it.
You cannot type directly into the Identifying Matcher box. You must click on one of the matcher creation buttons below it or the Modify button next to it if a matcher has already been defined. Let's define the term PCE:
|
|
7
|
Click on Add Pattern Matcher. The following dialog appears:
|
|
8
|
Enter "PCE" in the Pattern Matcher box and click on Apply.
|
|
9
|
Back at the Add new Glossary Definition dialog, click on the Static Text check box. The following will appear:
|
|
10
|
Enter the definition for the PCE term under the Static Text check box and click on Apply.
|
| |
|
|
Note
|
The following are advanced features that are beyond the scope of this document:
| |
· |
Subtraction matchers: A comma-separated list of pattern matcher strings (each surrounded by double quotes) that match text within the text returned by the main pattern matcher. Before publication, the text that was matched by the subtraction matchers is removed from the originally matched text. This allows you to accomplish small edits to the published content to provide added consistency. For further information about subtraction matchers, refer to the Hyper.Net Support database at www.coextant.com.
|
| |
· |
Search configuration: Parameters that allow you instead to pass the matched text to a database application using a link handler to extract the text to be used in the glossary popup.
|
|