Document! X & HelpStudio Bundle 2022.1
In This Topic
    Glossary Editing
    In This Topic

    The Document! X and HelpStudio Bundle project glossary is a list of terms and definitions which are specific to your project. The Document! X and HelpStudio Bundle automatically creates an indexed glossary topic using the terms you have defined as glossary term when the build is processed.

    By simply wrapping uses of defined glossary terms in topic content with double dollar symbols, Document! X and HelpStudio Bundle 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 Bundle to generate the Glossary topic and popup links, you avoid unnecessary effort and duplication.

    Glossary Editing Fundamentals

    Open the Glossary Editor

    1. On the Tools ribbon menu, select Glossary Editor.

      The Glossary window appears. 

    2. Select the alphabets to edit the desired glossary term and edit the description.

    Create a new Glossary Term and Definition

    1. Open the Glossary Editor.
    2. Click the  Create a new Glossary Item button.
    3. A new Glossary Item will be added to the list and selected for edit.
    4. Enter the glossary term and definition in the Term and definition fields.

    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 and select Create Glossary Reference.

    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. Enter the desired Glossary Term, surrounded with $ symbols. For example, /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.

    The glossary term is automatically converted to a pop-up window that appears on hover. This pop-up window will have definition of the glossary term. For example Build Profile

    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$ $.

     

     

    © 2023 Innovasys. All Rights Reserved.

    Send Feedback