Oracle UPK - Creating a Glossary

To create a Glossary in UPK, follow these steps:

1. From the main Library screen, click on the folder within which you want to create the Glossary. You can create the Glossary in any folder, but it makes sense to have a single folder that contains the Glossary file itself, and all of the Web Pages used for the terms.

2. Select menu option File|New|Glossary.

The Glossary Editor is opened in a new tab within the UPK Developer window, as shown in the following screenshot:

To create glossary entries from within the Glossary, follow these steps:

1. Enter the glossary term in the fi rst free Glossary Term field.

2. Click in the Defi nition Link field on the same line. An ellipsis (...) is displayed on the rightmost side of the field.

3. Click on the ellipsis. The Edit Defi nition Link dialog box is displayed.

4. Click on the Create New Web Page field.

5. The Save As dialog box is displayed.

6. Navigate to the directory in which you want to save the Glossary definition.
Again, it makes sense to save these in the same folder as the Glossary itself.

7. The Name field will default to the glossary term specified in the Glossary Term field. It is recommended that you keep this default, and use the definition term as the Web Page name. You could use any other name, if you wanted to (UPK does not use this name to locate the definition; it uses its own, internal identifier) but using the same name will allow you to easily locate the term Web Page if you need to.

8. Click on the Save button. A new tab is opened for the Web Page.

9. Enter the Glossary description into this page.

10. The Web Page will use the default font and colors. You can override these defaults, if required.

11. Close the Web Page by clicking on the x on the rightmost side of the open tab list. You are passed back to the Glossary Editor.

12. Enter a suitable ToolTip text for the glossary entry in the Tooltip field. This text will be displayed when the user hovers the mouse over the hyperlinked glossary term.

13. If only whole instances of the glossary term should be turned into hyperlinks (for example, if the term is Order then "Orders" and "Ordering" will not be hyperlinked), then select the Match Whole Word option. Otherwise, make sure that this option is not selected.

14. If only text that matches the case of the term should be turned into hyperlinks (for example, if the term is Order then "order" will not be hyperlinked), then select the Match Case field. Otherwise, make sure that this option is not selected.

15. Repeat Steps 1 to 14 for all additional terms that you want to add to the Glossary.

To create a glossary entry that uses an existing Web Page for the glossary term, follow these steps:

1. Enter the glossary term in the fi rst free Glossary Term field.

2. Click in the Defi nition Link field on the same line. An ellipsis (...) is displayed on the rightmost side of the field.

3. Click on the ellipsis. The Edit Defi nition Link dialog box is displayed.

4. Click on the Create Link button. The Insert Hyperlink dialog box is displayed.

5. Navigate to, and select, the Web Page that contains the glossary description.

6. Click on OK. The Edit Defi nition Link dialog box is redisplayed.

You can edit the Web Page directly from this dialog box, by clicking on the Edit Web Page icon. Editing Web Pages is explained in more detail earlier in this chapter.

7. Click on OK. You are returned to the Glossary tabbed page.

Once you have defined all required Glossary entries, save and close the Glossary, by following the steps shown below:

1. Click the Save button to save your changes to the Glossary. The Save As dialog box is displayed.

2. Navigate to the directory in which you want to save the Glossary.

3. Enter a suitable name for the Glossary in the Name field.

4. Close the Glossary Editor by clicking on the x on the rightmost side of the open tab list.

An example of a partially-populated Glossary is shown in the next screenshot:

You can see from the Defi nition Link column above that all of the Glossary definition files are stored in the same, single folder, called Glossary. This is the same folder that the Glossary object itself is stored in. Personally, I find it useful to keep all of the content objects for the Glossary in the same single folder. This is not strictly necessary, but it does keep things organized.

You will also note that the Tooltip is the same in every case. I tend to always use the tooltip Glossary so that the user knows that the hyperlink links to the Glossary, and not to another form of Web Page.