Skip to main content
H
heathers51575093
Participant
February 12, 2021
Answered

XML for Glossary Widget

  • February 12, 2021
  • 2 replies
  • 737 views

Captivate 2019 version 11.5.1.499: I want to use the Glossary widget for my project, but will be creating many additional projects that will use the same glossary. The widget allows for you to upload and XML file, but the only help I can find on how to start the widget XML writing process is from the captivate versions 8 and 9. I have been able to understand what to write in the XML file, but have yet to figure out how to start it in terms of the Root and the Child being that the Glossary widget hides all the words under the corresponding letter to make the glossary organized and searchable. I am using XML notepad to write my XML file. Any assistance on how to start the root/child relationship would be greatly appreciated. This will allow one glossary file to be created and uploaded into several trainings vice having to populate numerous glossary widgets.  

    This topic has been closed for replies.
    Correct answer RodWard

    The XML is actually very simple.  If you go into the glossary interaction's properties and click the Show Example button it shows you the structure of a typical valid XML file.

    When I have a new project to work on where there will be multiple modules that all need to have the same Glossary terms and definitions I set up an Excel spreadsheet that has several columns.  The second column contains the Terms, the fourth column contains the Definitions and the first, third and fifth columns just contain the XML tags that need to be present to make the valid XML file. 

     

    The first line of the spreadsheet just has the opening <XMLBit> tag and nothing else on other columns.  The linne AFTER the last term and definition contains the closing </XMLBit> tag.

     

    Here's what the Excel file structure looks like:

    So you just enter in all your terms and definitions to their relevant columns, then enter the XML tags for the second line.  Use Excel's features to drag/copy all of the tags down through all of the rows in their columns.

     

    Then the final steps to create the XML file from this is to just save your Excel spreadsheet out as a Unicode TXT file.  You change the TXT file ending to XML and that's your file to upload into the Glossary Widget interaction.

     

    One caveat here is that you will often find that after you import a new XML file (or even the first time you do it) the Glossary widget does not appear when you preview your HTML5 in a web browser.  The reason is usually that you have some text characters in your Glossary terms or definitions that the widget is mistaking for HTML or JavaScript code and that's the reason it is not working.  One thing to watch out for is having any parentheses ( or ) in the Terms column.  Other text characters that stop it from working are things like ampersands (&) and chevrons < >.  These are all characters used in programming code.  So you need to take these out of your terms and definitions. 

     

    Debugging your XML file sometimes turns out to be the longest part of this process.  However, once you have a nice clean XML uploading it into each of your Captivate modules takes only seconds.

    2 replies

    D
    dominiqueb99741485
    Participant
    October 14, 2022

    Are you able to add in an image with the definition if you use XML to upload? I found some old instructions from CPGURU that explains how but I am not certian if that will really work. Especially in Captivate 2019.

    If not, is there any way to add an image with the definition?

    RodWard
    Community Expert
    RodWardCommunity Expert
    Community Expert
    October 14, 2022

    Not that I am aware of.

    D
    dominiqueb99741485
    Participant
    October 17, 2022

    Thank you for getting back to me. 

    I actually found out HOW to get an image in the glossary. Turns out it is so easy it's emabarassing. 

    In the widget, once you have added the term and definition, click on on the definition and you get a little option to add audio nd an image. 

    RodWard
    Community Expert
    RodWardCommunity ExpertCorrect answer
    Community Expert
    February 13, 2021

    The XML is actually very simple.  If you go into the glossary interaction's properties and click the Show Example button it shows you the structure of a typical valid XML file.

    When I have a new project to work on where there will be multiple modules that all need to have the same Glossary terms and definitions I set up an Excel spreadsheet that has several columns.  The second column contains the Terms, the fourth column contains the Definitions and the first, third and fifth columns just contain the XML tags that need to be present to make the valid XML file. 

     

    The first line of the spreadsheet just has the opening <XMLBit> tag and nothing else on other columns.  The linne AFTER the last term and definition contains the closing </XMLBit> tag.

     

    Here's what the Excel file structure looks like:

    So you just enter in all your terms and definitions to their relevant columns, then enter the XML tags for the second line.  Use Excel's features to drag/copy all of the tags down through all of the rows in their columns.

     

    Then the final steps to create the XML file from this is to just save your Excel spreadsheet out as a Unicode TXT file.  You change the TXT file ending to XML and that's your file to upload into the Glossary Widget interaction.

     

    One caveat here is that you will often find that after you import a new XML file (or even the first time you do it) the Glossary widget does not appear when you preview your HTML5 in a web browser.  The reason is usually that you have some text characters in your Glossary terms or definitions that the widget is mistaking for HTML or JavaScript code and that's the reason it is not working.  One thing to watch out for is having any parentheses ( or ) in the Terms column.  Other text characters that stop it from working are things like ampersands (&) and chevrons < >.  These are all characters used in programming code.  So you need to take these out of your terms and definitions. 

     

    Debugging your XML file sometimes turns out to be the longest part of this process.  However, once you have a nice clean XML uploading it into each of your Captivate modules takes only seconds.

      Terms & ConditionsAccessibility statement
      Using the community Terms of use Privacy Cookie preferences Do not sell or share my personal information ad choicesAdChoices