Glossary

Sandcastle MAML

Collapse image Expand Image Copy image CopyHover image

This document type is used to create a glossary.

Glossary File Format

Below is an example of a Glossary topic file.

Glossary Topic  Copy imageCopy
<?xml version="1.0" encoding="utf-8"?>
<topic id="00000000-0000-0000-0000-000000000000" revisionNumber="1">
  <developerGlossaryDocument
    xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5"
    xmlns:xlink="http://www.w3.org/1999/xlink">

    <glossary>
      <!-- <title>Optional title</title> -->

      <!-- Glossary division.  You can use these to group entries.  If you only
           have one group, you can omit it and list the glossaryEntry elements
           directly.

           If used, be sure to give each glossaryDiv a unique address attribute
           and a title element.  These will be used to create an index at the
           top of the glossary page.

           Glossary divisions will appear in the order defined in the topic.
           Glossary entries will be sorted by the first term for the entry.
           Terms are sorted by their value. -->
      <glossaryDiv address="Group1">
        <title>Group #1</title>

        <glossaryEntry>
          <terms>
            <!-- One or more terms associated with the definition.  Add a termId
               attribute if you need to link to it from a relatedEntry element.
               Otherwise, it can be omitted.  Terms appear as a comma-separated
               list above the definition. -->
            <term termId="xyz">1st term</term>
            <term>Other term (if any)</term>
          </terms>

          <definition>
            <para>The definition of the term(s)</para>
          </definition>

          <!-- One or more optional related entries.  Creates a "See Also"
               line after the definition with links to each related term. -->
          <!-- <relatedEntry termId="xyz" /> -->
        </glossaryEntry>

      </glossaryDiv>

    </glossary>
  </developerGlossaryDocument>
</topic>

See Also

Other Resources