Document! X and HelpStudio 2019
Authoring Content / Glossary Editing
In This Topic
    Glossary Editing
    In This Topic

    The Document! X and HelpStudio Project Glossary is a list of terms and definitions specific to your Help System. From the Glossary terms you define, Document! X and HelpStudio automatically creates an indexed Glossary topic as part of the Build process.

    By simply wrapping uses of defined Glossary terms in Topic Content with double dollar symbols, Document! X and HelpStudio will replace the term with a clickable link which will display the definition of the term in a popup window in the generated Help System.

    If the text you want to appear in the generated Topic is different from the glossary term (e.g. you want to have the text 'dictionaries' show a popup glossary definition for the term 'dictionary') you can include a custom caption before the glossary term, separated by a ":", e.g. $ $dictionaries:dictionary$ $.

    Examples

    $ $Page Menu$ $ = Page Menu

    $ $Build Profiles:Build Profile$ $ = Build Profiles

    Benefits

    Creating a Glossary makes it easy for users to discover what a term means, just by clicking on it in the Topic text. Because you define the term and definition only once and leave Document! X and HelpStudio to generate the Glossary topic and popup links, you avoid unnecessary effort and duplication.

    Movies

    Glossary Editing Fundamentals

    Open the Glossary Editor

    Click on the Glossary Editor button on the Tools Ribbon Tab. The Glossary Editor will be opened.

     

    Create a new Glossary Term and Definition

    1. Open the Glossary Editor;
    2. Click the  New toolbar button;
    3. A new Glossary Item will be added to the list and selected for edit;
    4. Edit the Term and Definition using the fields on the right hand side of the Glossary Editor.

    It is also possible to create a new Glossary Term directly from a Content Editor:

    1. Select the text in the Content Editor that you would like to define as a new Glossary Term;
    2. Right Click to show the Context Menu;
    3. Select Create Glossary Reference;
    4. The selected text will be created as a new Glossary Item, and the Glossary Editor will be opened for edit, and a reference to the new Glossary Item inserted into the Content Editor.

     

    Reference a Glossary Term in Content

    1. Open a Content Editor;
    2. Type the desired Glossary Term, surrounded with $ symbols - e.g. /MyGlossaryTerm/;

      - or -

      Right click on existing text that you have previously defined as a Glossary Term, Right Click and select Insert Glossary Reference - that will surround the term with $ $ symbols for you.
    3. Switch to Preview to examine how the Glossary Term is automatically converted to a clickable popup definition of the term in the generated output. Example: Build Flag.
    Sometimes you might want the reference to a Glossary term to have different text than the term itself (e.g. a plural version of the word). To do that, include both the desired caption for the Glossary Term reference and the term itself, separated with a ":", e.g. $ $MyGlossaryTermCaption:MyGlossaryTerm$ $.

     

    Movies

     

     

    © 2019 Innovasys. All Rights Reserved.

    Send Feedback