docs/1.6/styleguide/glossary.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <glossary version="5.0" xmlns="http://docbook.org/ns/docbook"
   3          xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
   4          role="auto" xml:id="glossary">
   5
   6          <para>The recommendation here is to build a glossary database (Chapter 17 of Stayton's
   7                   book) that is writable by any author or editor with commit privileges. Authors can
   8                   populate it with whatever terms they like, using a simple rule for id
   9                   disambiguation (such as gloss.term, where gloss is constant and term is the term
  10                   itself). If we need to disambiguate two forms of the same term, we can add a
  11                   suffix. The build process described in Stayton's book builds a glossary for each
  12                   document based on the terms used in that document.</para>
  13
  14          <para>For authors without commit privileges, this becomes a little more complex. One
  15                   thought would be to have authors submit their glossary entries in a separate file,
  16                   which editor-committers can then upload.</para>
  17
  18 </glossary>