+++ /dev/null
-<refentry xmlns="http://docbook.org/ns/docbook"\r
- xmlns:xlink="http://www.w3.org/1999/xlink"\r
- xmlns:xi="http://www.w3.org/2001/XInclude"\r
- xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"\r
- xmlns:xsl="http://www.w3.org/1999/XSL/Transform"\r
- version="5.0" xml:id="glossary.collection">\r
-<refmeta>\r
-<refentrytitle>glossary.collection</refentrytitle>\r
-<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>\r
-</refmeta>\r
-<refnamediv>\r
-<refname>glossary.collection</refname>\r
-<refpurpose>Name of the glossary collection file</refpurpose>\r
-</refnamediv>\r
-\r
-<refsynopsisdiv>\r
-<src:fragment xml:id="glossary.collection.frag">\r
-<xsl:param name="glossary.collection"></xsl:param>\r
-</src:fragment>\r
-</refsynopsisdiv>\r
-\r
-<refsection><info><title>Description</title></info>\r
-\r
-<para>Glossaries maintained independently across a set of documents\r
-are likely to become inconsistent unless considerable effort is\r
-expended to keep them in sync. It makes much more sense, usually, to\r
-store all of the glossary entries in a single place and simply\r
-<quote>extract</quote> the ones you need in each document.</para>\r
-\r
-<para>That's the purpose of the\r
-<parameter>glossary.collection</parameter> parameter. To setup a global\r
-glossary <quote>database</quote>, follow these steps:</para>\r
-\r
-<refsection><info><title>Setting Up the Glossary Database</title></info>\r
-\r
-<para>First, create a stand-alone glossary document that contains all of\r
-the entries that you wish to reference. Make sure that each glossary\r
-entry has an ID.</para>\r
-\r
-<para>Here's an example glossary:</para>\r
-\r
-<informalexample>\r
-<programlisting>\r
-<?xml version="1.0" encoding="utf-8"?>\r
-<!DOCTYPE glossary\r
- PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"\r
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">\r
-<glossary>\r
-<glossaryinfo>\r
-<editor><firstname>Eric</firstname><surname>Raymond</surname></editor>\r
-<title>Jargon File 4.2.3 (abridged)</title>\r
-<releaseinfo>Just some test data</releaseinfo>\r
-</glossaryinfo>\r
-\r
-<glossdiv><title>0</title>\r
-\r
-<glossentry>\r
-<glossterm>0</glossterm>\r
-<glossdef>\r
-<para>Numeric zero, as opposed to the letter `O' (the 15th letter of\r
-the English alphabet). In their unmodified forms they look a lot\r
-alike, and various kluges invented to make them visually distinct have\r
-compounded the confusion. If your zero is center-dotted and letter-O\r
-is not, or if letter-O looks almost rectangular but zero looks more\r
-like an American football stood on end (or the reverse), you're\r
-probably looking at a modern character display (though the dotted zero\r
-seems to have originated as an option on IBM 3270 controllers). If\r
-your zero is slashed but letter-O is not, you're probably looking at\r
-an old-style ASCII graphic set descended from the default typewheel on\r
-the venerable ASR-33 Teletype (Scandinavians, for whom /O is a letter,\r
-curse this arrangement). (Interestingly, the slashed zero long\r
-predates computers; Florian Cajori's monumental "A History of\r
-Mathematical Notations" notes that it was used in the twelfth and\r
-thirteenth centuries.) If letter-O has a slash across it and the zero\r
-does not, your display is tuned for a very old convention used at IBM\r
-and a few other early mainframe makers (Scandinavians curse <emphasis>this</emphasis>\r
-arrangement even more, because it means two of their letters collide).\r
-Some Burroughs/Unisys equipment displays a zero with a <emphasis>reversed</emphasis>\r
-slash. Old CDC computers rendered letter O as an unbroken oval and 0\r
-as an oval broken at upper right and lower left. And yet another\r
-convention common on early line printers left zero unornamented but\r
-added a tail or hook to the letter-O so that it resembled an inverted\r
-Q or cursive capital letter-O (this was endorsed by a draft ANSI\r
-standard for how to draw ASCII characters, but the final standard\r
-changed the distinguisher to a tick-mark in the upper-left corner).\r
-Are we sufficiently confused yet?</para>\r
-</glossdef>\r
-</glossentry>\r
-\r
-<glossentry>\r
-<glossterm>1TBS</glossterm>\r
-<glossdef>\r
-<para role="accidence">\r
-<phrase role="pronounce"></phrase>\r
-<phrase role="partsofspeach">n</phrase>\r
-</para>\r
-<para>The "One True Brace Style"</para>\r
-<glossseealso>indent style</glossseealso>\r
-</glossdef>\r
-</glossentry>\r
-\r
-<!-- ... -->\r
-\r
-</glossdiv>\r
-\r
-<!-- ... -->\r
-\r
-</glossary></programlisting>\r
-</informalexample>\r
-\r
-</refsection>\r
-\r
-<refsection><info><title>Marking Up Glossary Terms</title></info>\r
-\r
-<para>That takes care of the glossary database, now you have to get the entries\r
-into your document. Unlike bibliography entries, which can be empty, creating\r
-<quote>placeholder</quote> glossary entries would be very tedious. So instead,\r
-support for <parameter>glossary.collection</parameter> relies on implicit linking.</para>\r
-\r
-<para>In your source document, simply use <tag>firstterm</tag> and\r
-<tag>glossterm</tag> to identify the terms you wish to have included\r
-in the glossary. The stylesheets assume that you will either set the\r
-<tag class="attribute">baseform</tag> attribute correctly, or that the\r
-content of the element exactly matches a term in your glossary.</para>\r
-\r
-<para>If you're using a <parameter>glossary.collection</parameter>, don't\r
-make explicit links on the terms in your document.</para>\r
-\r
-<para>So, in your document, you might write things like this:</para>\r
-\r
-<informalexample>\r
-<programlisting><para>This is dummy text, without any real meaning.\r
-The point is simply to reference glossary terms like <glossterm>0</glossterm>\r
-and the <firstterm baseform="1TBS">One True Brace Style (1TBS)</firstterm>.\r
-The <glossterm>1TBS</glossterm>, as you can probably imagine, is a nearly\r
-religious issue.</para></programlisting>\r
-</informalexample>\r
-\r
-<para>If you set the <parameter>firstterm.only.link</parameter> parameter,\r
-only the terms marked with <tag>firstterm</tag> will be links.\r
-Otherwise, all the terms will be linked.</para>\r
-\r
-</refsection>\r
-\r
-<refsection><info><title>Marking Up the Glossary</title></info>\r
-\r
-<para>The glossary itself has to be identified for the stylesheets. For lack\r
-of a better choice, the <tag class="attribute">role</tag> is used.\r
-To identify the glossary as the target for automatic processing, set\r
-the role to <quote><literal>auto</literal></quote>. The title of this\r
-glossary (and any other information from the <tag>glossaryinfo</tag>\r
-that's rendered by your stylesheet) will be displayed, but the entries will\r
-come from the database.\r
-</para>\r
-\r
-<para>Unfortunately, the glossary can't be empty, so you must put in\r
-at least one <tag>glossentry</tag>. The content of this entry\r
-is irrelevant, it will not be rendered:</para>\r
-\r
-<informalexample>\r
-<programlisting><glossary role="auto">\r
-<glossentry>\r
-<glossterm>Irrelevant</glossterm>\r
-<glossdef>\r
-<para>If you can see this, the document was processed incorrectly. Use\r
-the <parameter>glossary.collection</parameter> parameter.</para>\r
-</glossdef>\r
-</glossentry>\r
-</glossary></programlisting>\r
-</informalexample>\r
-\r
-<para>What about glossary divisions? If your glossary database has glossary\r
-divisions <emphasis>and</emphasis> your automatic glossary contains at least\r
-one <tag>glossdiv</tag>, the automic glossary will have divisions.\r
-If the <tag>glossdiv</tag> is missing from either location, no divisions\r
-will be rendered.</para>\r
-\r
-<para>Glossary entries (and divisions, if appropriate) in the glossary will\r
-occur in precisely the order they occur in your database.</para>\r
-\r
-</refsection>\r
-\r
-<refsection><info><title>Formatting the Document</title></info>\r
-\r
-<para>Finally, when you are ready to format your document, simply set the\r
-<parameter>glossary.collection</parameter> parameter (in either a\r
-customization layer or directly through your processor's interface) to\r
-point to your global glossary.</para>\r
-\r
-<para>The stylesheets will format the glossary in your document as if\r
-all of the entries implicilty referenced appeared there literally.</para>\r
-</refsection>\r
-\r
-<refsection><info><title>Limitations</title></info>\r
-\r
-<para>Glossary cross-references <emphasis>within the glossary</emphasis> are\r
-not supported. For example, this <emphasis>will not</emphasis> work:</para>\r
-\r
-<informalexample>\r
-<programlisting><glossentry>\r
-<glossterm>gloss-1</glossterm>\r
-<glossdef><para>A description that references <glossterm>gloss-2</glossterm>.</para>\r
-<glossseealso>gloss-2</glossseealso>\r
-</glossdef>\r
-</glossentry></programlisting>\r
-</informalexample>\r
-\r
-<para>If you put glossary cross-references in your glossary that way,\r
-you'll get the cryptic error: <computeroutput>Warning:\r
-glossary.collection specified, but there are 0 automatic\r
-glossaries</computeroutput>.</para>\r
-\r
-<para>Instead, you must do two things:</para>\r
-\r
-<orderedlist>\r
-<listitem>\r
-<para>Markup your glossary using <tag>glossseealso</tag>:</para>\r
-\r
-<informalexample>\r
-<programlisting><glossentry>\r
-<glossterm>gloss-1</glossterm>\r
-<glossdef><para>A description that references <glossterm>gloss-2</glossterm>.</para>\r
-<glossseealso>gloss-2</glossseealso>\r
-</glossdef>\r
-</glossentry></programlisting>\r
-</informalexample>\r
-</listitem>\r
-\r
-<listitem>\r
-<para>Make sure there is at least one <tag>glossterm</tag> reference to\r
-<glossterm>gloss-2</glossterm> <emphasis>in your document</emphasis>. The\r
-easiest way to do that is probably within a <tag>remark</tag> in your\r
-automatic glossary:</para>\r
-\r
-<informalexample>\r
-<programlisting><glossary role="auto">\r
-<remark>Make sure there's a reference to <glossterm>gloss-2</glossterm>.</remark>\r
-<glossentry>\r
-<glossterm>Irrelevant</glossterm>\r
-<glossdef>\r
-<para>If you can see this, the document was processed incorrectly. Use\r
-the <parameter>glossary.collection</parameter> parameter.</para>\r
-</glossdef>\r
-</glossentry>\r
-</glossary></programlisting>\r
-</informalexample>\r
-</listitem>\r
-</orderedlist>\r
-</refsection>\r
-\r
-</refsection>\r
-</refentry>\r
projects / Evergreen-DocBook.git / blobdiff