File indexing completed on 2024-11-24 04:34:43
0001 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 0002 <html> 0003 <!-- This document is an unofficial reference manual for LaTeX, a 0004 document preparation system, version of November 2018. 0005 0006 This manual was originally translated from LATEX.HLP v1.0a in the 0007 VMS Help Library. The pre-translation version was written by 0008 George D. Greenwade of Sam Houston State University. The 0009 LaTeX 2.09 version was written by Stephen Gilmore. The 0010 LaTeX2e version was adapted from this by Torsten Martinsen. Karl 0011 Berry made further updates and additions, and gratefully acknowledges 0012 using Hypertext Help with LaTeX, by Sheldon Green, and 0013 LaTeX Command Summary (for LaTeX 2.09) by 0014 L. Botway and C. Biemesderfer (published by the TeX Users 0015 Group as TeXniques number 10), as reference material. We also 0016 gratefully acknowledge additional material appearing in 0017 latex2e-reference by Martin Herbert Dietze. (From these references no 0018 text was directly copied.) 0019 0020 Copyright 2007, 2008, 2009, 2010, 2011, 2012, 2013, 0021 2014, 2015, 2016, 2017, 2018 Karl Berry. 0022 0023 Copyright 1988, 1994, 2007 Stephen Gilmore. 0024 0025 Copyright 1994, 1995, 1996 Torsten Martinsen. 0026 0027 Permission is granted to make and distribute verbatim copies of 0028 this manual provided the copyright notice and this permission notice 0029 are preserved on all copies. 0030 0031 0032 Permission is granted to copy and distribute modified versions of this 0033 manual under the conditions for verbatim copying, provided that the entire 0034 resulting derived work is distributed under the terms of a permission 0035 notice identical to this one. 0036 0037 Permission is granted to copy and distribute translations of this manual 0038 into another language, under the above conditions for modified versions. --> 0039 <!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ --> 0040 <head> 0041 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> 0042 <title>Glossaries (LaTeX2e unofficial reference manual (November 2018))</title> 0043 0044 <meta name="description" content="Glossaries (LaTeX2e unofficial reference manual (November 2018))"> 0045 <meta name="keywords" content="Glossaries (LaTeX2e unofficial reference manual (November 2018))"> 0046 <meta name="resource-type" content="document"> 0047 <meta name="distribution" content="global"> 0048 <meta name="Generator" content="makeinfo"> 0049 <link href="index.html#Top" rel="start" title="Top"> 0050 <link href="IndexDocument.html#Index" rel="index" title="Index"> 0051 <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> 0052 <link href="Front_002fback-matter.html#Front_002fback-matter" rel="up" title="Front/back matter"> 0053 <link href="_005cnewglossaryentry.html#g_t_005cnewglossaryentry" rel="next" title="\newglossaryentry"> 0054 <link href="_005cprintindex.html#g_t_005cprintindex" rel="prev" title="\printindex"> 0055 <style type="text/css"> 0056 <!-- 0057 /* $Id: latex2e.css 690 2018-09-15 15:20:19Z jimhefferon $ 0058 Minor css for latexrefman. Public domain. 0059 Originally written by Jim Hefferon and Karl Berry, 2018. */ 0060 0061 /* So you can style for yourself */ 0062 @import url("/css/latexreflocal.css"); 0063 0064 0065 0066 a.summary-letter {text-decoration: none} 0067 blockquote.indentedblock {margin-right: 0em} 0068 blockquote.smallindentedblock {margin-right: 0em; font-size: smaller} 0069 blockquote.smallquotation {font-size: smaller} 0070 div.display {margin-left: 3.2em} 0071 div.example {margin-left: 3.2em} 0072 div.lisp {margin-left: 3.2em} 0073 div.smalldisplay {margin-left: 3.2em} 0074 div.smallexample {margin-left: 3.2em} 0075 div.smalllisp {margin-left: 3.2em} 0076 kbd {font-style: oblique} 0077 pre.display {font-family: inherit} 0078 pre.format {font-family: inherit} 0079 pre.menu-comment {font-family: serif} 0080 pre.menu-preformatted {font-family: serif} 0081 pre.smalldisplay {font-family: inherit; font-size: smaller} 0082 pre.smallexample {font-size: smaller} 0083 pre.smallformat {font-family: inherit; font-size: smaller} 0084 pre.smalllisp {font-size: smaller} 0085 span.nolinebreak {white-space: nowrap} 0086 span.roman {font-family: initial; font-weight: normal} 0087 span.sansserif {font-family: sans-serif; font-weight: normal} 0088 ul.no-bullet {list-style: none} 0089 BODY { 0090 margin-top: 1em; 0091 margin-left: 1em; /* auto results in two-digit <ol> lost off left */ 0092 margin-right: 1em; 0093 margin-bottom: 1em; 0094 /* the idea is to use the whole window, unless it is ridiculously 0095 wide, probably with too-small fonts, too. */ 0096 max-width: 64em; 0097 } 0098 0099 /* Because we want @math{... @code ...} to be upright, not slanted, 0100 and Texinfo won't fix it. */ 0101 code {font-style:normal; font-family:monospace; } 0102 0103 /* We put a link to our own home page at the bottom. */ 0104 div.referenceinfo {font-size:small;} 0105 0106 --> 0107 </style> 0108 0109 0110 </head> 0111 0112 <body lang="en"> 0113 <a name="Glossaries"></a> 0114 <div class="header"> 0115 <p> 0116 Previous: <a href="Indexes.html#Indexes" accesskey="p" rel="prev">Indexes</a>, Up: <a href="Front_002fback-matter.html#Front_002fback-matter" accesskey="u" rel="up">Front/back matter</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="IndexDocument.html#Index" title="Index" rel="index">Index</a>]</p> 0117 </div> 0118 <hr> 0119 <a name="Glossaries-1"></a> 0120 <h3 class="section">25.3 Glossaries</h3> 0121 0122 <a name="index-glossary"></a> 0123 <a name="index-glossaries"></a> 0124 <a name="index-acronyms_002c-list-of"></a> 0125 <a name="index-_005cmakeglossary"></a> 0126 <a name="index-_005cprintglossaries"></a> 0127 0128 <p>Synopsis: 0129 </p> 0130 <div class="example"> 0131 <pre class="example">\usepackage{glossaries} \makeglossaries 0132 ... 0133 \newglossaryentry{<var>label</var>}{<var>settings</var>} 0134 ... 0135 \gls{<var>label</var>}. 0136 ... 0137 \printglossaries 0138 </pre></div> 0139 0140 <p>The <samp>glossaries</samp> package allows you to make glossaries, including 0141 multiple glossaries, as well as lists of acronyms. 0142 </p> 0143 <p>To get the output from this example, compile the document (for instance 0144 with <code>pdflatex filename</code>), then run the command line command 0145 <code>makeglossaries filename</code>, and then compile the document again. 0146 </p> 0147 <div class="example"> 0148 <pre class="example">\documentclass{...} 0149 \usepackage{glossaries} \makeglossaries 0150 \newglossaryentry{tm}{% 0151 name={Turing machine}, 0152 description={A model of a machine that computes. The model is simple 0153 but can compute anything any existing device can compute. 0154 It is the standard model used in Computer Science.}, 0155 } 0156 \begin{document} 0157 Everything begins with the definition of a \gls{tm}. 0158 ... 0159 \printglossaries 0160 \end{document} 0161 </pre></div> 0162 0163 <p>That gives two things. In the main text it outputs ‘<samp>... definition 0164 of a Turing machine</samp>’. In addition, in a separate sectional unit headed 0165 ‘<samp>Glossary</samp>’ there appears a description list. In boldface it says 0166 ‘<samp>Turing machine</samp>’ and the rest of the item says in normal type 0167 ‘<samp>A model of a machine … Computer Science</samp>’. 0168 </p> 0169 <a name="index-_005cmakeglossary-1"></a> 0170 <a name="index-_005cprintglossaries-1"></a> 0171 <a name="index-_002eglo-file"></a> 0172 <p>The command <code>\makeglossary</code> opens the file that will contain the 0173 entry information, <samp><var>root-file</var>.glo</samp>. Put the 0174 <code>\printglossaries</code> command where you want the glossaries to appear 0175 in your document. 0176 </p> 0177 <p>The <samp>glossaries</samp> package is very powerful. For instance, besides 0178 the commands <code>\newglossaryentry</code> and <code>\gls</code>, there are similar 0179 commands for a list of acronyms. See the package documentations on 0180 CTAN. 0181 </p> 0182 <table class="menu" border="0" cellspacing="0"> 0183 <tr><td align="left" valign="top">• <a href="_005cnewglossaryentry.html#g_t_005cnewglossaryentry" accesskey="1">\newglossaryentry</a>:</td><td> </td><td align="left" valign="top">Declare the content of a glossary entry. 0184 </td></tr> 0185 <tr><td align="left" valign="top">• <a href="_005cgls.html#g_t_005cgls" accesskey="2">\gls</a>:</td><td> </td><td align="left" valign="top">Give a page reference for a glossary entry. 0186 </td></tr> 0187 </table> 0188 0189 0190 0191 0192 <hr/><div class='referenceinfo'> <a href='https://latexref.xyz/'> <i>Unofficial LaTeX2e reference manual</i></a></div> 0193 </body> 0194 </html>