Debian Codegraph @

texmf-dist/doc/latex/tools/tools-overview.tex

raw
1 \NeedsTeXFormat{LaTeX2e}
2 \ProvidesFile{tools-overview.tex}[2015/03/31 v1.0 Tools overview]
3
4 % Copyright (C) 2006-2025
5 %
6 % The LaTeX Project and any individual authors listed elsewhere
7 % in this file.
8 %
9 % Copyright (c) 2006-2014 Heiko Oberdiek
10 % (c) 2015-2019 The LaTeX Project
11 %
12 % This file is part of the Standard LaTeX `Tools Bundle'.
13 % -------------------------------------------------------
14 %
15 % It may be distributed and/or modified under the
16 % conditions of the LaTeX Project Public License, either version 1.3c
17 % of this license or (at your option) any later version.
18 % The latest version of this license is in
19 % https://www.latex-project.org/lppl.txt
20 % and version 1.3c or later is part of all distributions of LaTeX
21 % version 2005/12/01 or later.
22 %
23 % The list of all files belonging to the LaTeX `Tools Bundle' is
24 % given in the file `manifest.txt'.
25 %
26 % This file is derived from `tools.tex' and `tools-overview.cls'
27 % from the `latex-tds' bundle maintained by Heiko Oberdiek.
28 %
29 \documentclass[a4paper,12pt]{article}
30
31 % page layout
32 \usepackage[
33 ignoreall,
34 hmargin=1in,
35 vmargin={.75in,1in},
36 ]{geometry}
37
38 \pagestyle{empty}
39
40 \usepackage{calc}[2005/08/06]
41
42 \usepackage{hyperref}
43 \hypersetup{
44 colorlinks,
45 filecolor=blue,
46 pdftitle={LaTeX's Tools Bundle},
47 pdfsubject={Overview},
48 pdfauthor={Heiko Oberdiek},
49 pdfcreator={Project `latex-tds'},
50 }
51 \title{Contents of \LaTeX's Tools Bundle}
52
53 \makeatletter
54
55 \let\TO@document\document
56 \let\TO@enddocument\enddocument
57
58 \def\document{%
59 \TO@document
60 \maketitle
61 \toks@={}%
62 \setlength{\maxlen}{0pt}%
63 }
64 \newlength{\maxlen}
65 \def\enddocument{%
66 \begin{list}{}{%
67 \setlength{\leftmargin}{\maxlen + \labelsep}%
68 \setlength{\labelwidth}{\maxlen}%
69 \setlength{\partopsep}{0pt}%
70 }%
71 \the\toks@
72 \end{list}%
73 \TO@enddocument
74 }
75 \newcommand{\entry}[2]{%
76 \outline{#1}%
77 \toks@\expandafter{%
78 \the\toks@
79 \item[%
80 \href{file:#1.pdf}{\printpackage{#1}}%
81 \hfill
82 ]%
83 #2%
84 }%
85 \setlength{\maxlen}{%
86 \maxof{\maxlen}{\widthof{\printpackage{#1}}}%
87 }%
88 \global\maxlen\maxlen
89 }
90 \newcommand*{\printpackage}[1]{%
91 \textbf{\large #1:}%
92 }
93 \newcommand*{\outline}[1]{%
94 \pdfoutline
95 attr {/C[0 0 1]}
96 user {%
97 <<%
98 /S/GoToR%
99 /F(#1.pdf)%
100 /NewWindow true%
101 /D[0/XYZ null null null]%
102 >>%
103 }%
104 {[#1]}\relax
105 }
106 \renewcommand*{\maketitle}{%
107 \begingroup
108 \par
109 \centering
110 \bfseries
111 \LARGE
112 \@title
113 \par
114 \endgroup
115 \vspace{2em}%
116 }
117
118 \providecommand*{\cs}[1]{%
119 \texttt{\textbackslash#1}%
120 }
121
122 \makeatother
123
124 \begin{document}
125 \entry{afterpage}{%
126 Place text after the current page.
127 }%
128 \entry{array}{%
129 Extended versions of the environments array, tabular and tabular*.
130 }%
131 \entry{bm}{%
132 Access bold math symbols.
133 }%
134 \entry{calc}{%
135 Infix arithmetic expressions. Contributed to the distribution by
136 Kresten Krab Thorup and Frank Jensen.
137 }%
138 \entry{dcolumn}{%
139 Alignment on \emph{decimal points} in tabular entries. Requires array.
140 }%
141 \entry{delarray}{%
142 Adds \emph{large delimiters} around arrays. Requires array.
143 }%
144 \entry{enumerate}{%
145 Extended version of the enumerate environment; historical, use
146 \textsf{enumitem} instead.
147 }%
148 \entry{fileerr}{%
149 Suite of small files which may be used to control \TeX{}'s
150 missing file error loop.
151 }%
152 \entry{fontsmpl}{%
153 Package and test file for producing \emph{font samples}.
154 }%
155 \entry{ftnright}{%
156 Place footnotes in the right hand column in two-column mode.
157 }%
158 \entry{hhline}{%
159 Finer control over horizontal rules in tables. Requires array.
160 }%
161 \entry{indentfirst}{%
162 Indent the first paragraph of sections etc.
163 }%
164 \entry{layout}{%
165 Produces an overview of the layout of the current document.
166 }%
167 \entry{longtable}{%
168 Multipage tables. (Does not require array, but uses the extended
169 features if both are loaded.)
170 }%
171 \entry{multicol}{%
172 Typeset text in columns, with the length of the final columns
173 \emph{balanced}.
174 }%
175 \entry{rawfonts}{%
176 Preload fonts under the old internal font names of \LaTeX{}2.09.
177 Not useful today.
178 }%
179 \entry{shellesc}{%
180 Unified interface to ``shell escape'' i.e., access to system commands
181 based on \texttt{\string\write18} or \texttt{os.execute} depending
182 on the system in use.
183 }%
184 \entry{showkeys}{%
185 Draft mode showing the \emph{keys} used by \cs{label}, \cs{ref}, \cs{cite} etc.
186 }%
187 \entry{somedefs}{%
188 Selective handling of package options. (Used in rawfonts.sty.)
189 Not useful today.
190 }%
191 \entry{tabularx}{%
192 Defines tabularx environment (similar to tabular*) but modifies
193 column widths, not inter-column space, to achieve a desired
194 table width.
195 }%
196 \entry{theorem}{%
197 Flexible definition of \emph{theorem-like} environments; historical, use
198 \textsf{amsthm} instead.
199 }%
200 \entry{trace}{%
201 The package helps to suppress and to control the amount of tracing
202 output (\cs{tracingall}) by taming calc and making NFSS less noisy.
203 }%
204 \entry{varioref}{%
205 \emph{Smart} handling of page references.
206 }%
207 \entry{verbatim}{%
208 Flexible version of verbatim environment; historical, use
209 \textsf{fancyvrb} instead.
210 }%
211 \entry{xr}{%
212 eXternal References. Extend \cs{ref} to access \cs{label} commands in
213 other documents.
214 }%
215 \entry{xspace}{%
216 Smart space command that avoids the common mistake of missing
217 spaces after command names.
218 }%
219
220 \end{document}