ubuntu-manual team mailing list archive

[Kevin Godby <godbyk@xxxxxxxxx>]

Hello, all.

I've just added a glossary to the manual.  You'll need to run the
pkgs/install-pkgs.sh script to make sure you have all the required
packages installed.

If you want to add entries to the glossary, add them in the
frontmatter/glossary-entries.tex file.

A glossary entry looks like this:

  \newglossaryentry{label}{name={entry-name}, description={the
definition or description}}

The label should only contain Latin characters---that is, letters a-z
and an occasional hyphen (-).  The name is the head word or the term
being defined.  If the name starts with a non-Latin letter (that is, a
letter with an accent or from another script/language), put it in
braces ({}) by itself:

  \newglossaryentry{elite}{name={é}lite, description={select group of people}}

If you leave out the braces, the glossary program will freak out and
things will break.  (Scary, no?)

The description is the description or definition of the term.

For the translators, you can edit the name and description parts.  If
you edit the label, you'll need to be sure to update it throughout the
document (otherwise the links won't work right).

Now, in the manual itself, when you want to link to a glossary entry,
you have a few commands at your disposal:

  \gls{label} % inserts the name associated with <label> and links it
to the glossary
  \glspl{label} % inserts the plural name associated with the <label>
and links it to the glossary
  \Gls{label} % inserts the capitalized name associated with <label>
and links it to the glossary. useful for the beginning of sentences
  \Glspl{label} % take a wild guess

Examples:

  \gls{elite} % élite
  \glspl{elite} % élites
  \Gls{elite} % Élite
  \Glspl{elite} % Élite

If you have any questions, feel free to contact me.  You can also read
the full docs on the glossary stuff by typing 'texdoc glossaries' at
the prompt.

--Kevin