Glossary Terms

Salesforce documentation must have only one glossary definition for each term in Salesforce, regardless of where that definition appears. All definitions for Salesforce are in ../help/glossary/glossary_master.xml. Having all the terms in a single file helps prevent one term getting more than one definition. The glossary_master.xml functions like the ../help/reusable.xml file in that it is never included in a build. Never use an <xref> to glossary_master.xml.

A glossary belongs in a book or ditamap if the book is more than 25 pages. This is a judgment call for the writer, as there are exceptions. For example, a book with a list of 100 sample formulas that is more than 25 pages does not really need a glossary.

Writing glossary terms

For reuse and clarity, restate the term within the definition. For example:

Instead of:

This allows you to use a <ph> tag around the definition an use it in your “About” or “Introduction” files.

Acronyms and synonyms

For acronyms, define the term where you expand the acronym fully and provide a glossary entry for the acronym, using a See reference to the expanded term. For example:

For synonyms, write the definition once and use a “See” reference in other terms with the same definition.