Creating Glossaries – Step 2

Once you have your glossaries in place, you now need to include them in your output. This blog post covers how to include glossary content in your print and online output.
Enable Glossaries in you Skin file
  1. From the Project Organizer open you skin file.
  2. On the General tab, click the Glossary check box.
  3. Save your work.
Set Print output
In our case, we create a Glossary topic and add it to our Print TOC. Let’s cover this process first.
  1. Create a “Glossary” topic in Flare.
  2. Open your new topic.
  3. In your <h1> tag, enter the word “Glossary.” Hit enter.
  4. On the new line, select Insert > Proxy > Insert glossary proxy. You should see a gray bar with the text “output glossary proxy.”
  5. Add this new topic to the end of your output TOC.
  6. Save your work.
Next, let’s set up our print target.
  1. For Print output, open your print target.
  2. Go to the Glossary tab.
  3. Your options are:
    1. Do not convert termnone of the glossary terms convert to hyperlinks, popups, expanding text, or footnotes in the output.
    2. Convert only marked terms: only glossary terms that were inserted into topics as glossary term links convert to hyperlinks, popups, expanding text, or footnotes in the output. Glossary terms that happen to exist in topics as normal text will not be converted.
    3. Convert first occurrence of termonly the first occurrence of a glossary term in a topic converts to a hyperlink, popup, expanding text, or footnote in the output. This includes terms inserted as glossary term links, as well as glossary terms that happen to exist in topics as normal text.
    4. Convert all occurrence of termevery occurrence of a glossary term in a topic converts to a hyperlink, popup, expanding text, or footnote in the output. This includes terms inserted as glossary term links, as well as glossary terms that happen to exist in topics as normal text.
  4. Because we want our terms to display in only the Glossary topic we created, we select the Do no convert term option. NOTE: If you convert terms, all linked terms will be added as footnotes to each page housing a glossary term.
  5. In the Glossary file box, make sure the glossary you want used for this output is selected.
  6. Save your work.

Generate output WebHelp/HTML5

We will use the Popup style for our help links. This is the default option in Flare, so you do not need to assign a style option when creating the glossary links. If you are interested in a different style, see the Step 1 blog post.

  1. Open your help target.
  2. Go to the Glossary tab.
  3. Select Convert all occurrences of term. NOTE: This does not mean Flare makes all occurrences glossary entries. You still must complete the Identify/Link glossary terms procedure for each term you want linked in your output.
  4. Save your work.

Tips

  1. If you need to include a variable in your glossary term:
    1. Add the glossary link to the term without the variable inserted.
    2. Once the glossary term is in place, insert the variable where required.
    3. Open the glossary term and add the variable form to the term list.
  2. The glossary is an exact match for the term. Make sure to include all forms of the glossary term in the terms list to include the other iterations of the term.
    1. For example, if the term is “database,” make sure to also include “databases,” “Databases,” and “Database” in the term list.
Advertisements

Leave a comment

Filed under MadCap Flare

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s