Debian Codegraph @

texmf-dist/source/latex/dingbat/dingbat.dtx

raw
1 % \iffalse meta-comment
2 %
3 % Copyright (C) 2001 Scott Pakin <[email protected]>
4 % -------------------------------------------------------
5 %
6 % This package may be distributed and/or modified under the
7 % conditions of the LaTeX Project Public License, either version 1.2
8 % of this license or (at your option) any later version.
9 % The latest version of this license is in
10 % http://www.latex-project.org/lppl.txt
11 % and version 1.2 or later is part of all distributions of LaTeX
12 % version 1999/12/01 or later.
13 %
14 % \fi
15 % \iffalse
16 %% File: dingbat.dtx Copyright (C) 2001 Scott Pakin <[email protected]>
17 %
18 %<package>\NeedsTeXFormat{LaTeX2e}
19 %<package>\ProvidesPackage{dingbat}
20 %<package> [2001/04/27 v1.00 Hands and other dingbats]
21 %<uarkfd>\ProvidesFile{uark.fd}
22 %<uarkfd> [2001/04/27 v1.00 Font definitions for the ark10 font]
23 %<udingbatfd>\ProvidesFile{udingbat.fd}
24 %<udingbatfd> [2001/04/27 v1.00 Font definitions for the dingbat font]
25 %
26 %<*driver>
27 \documentclass{ltxdoc}
28 \usepackage{dingbat}
29 \usepackage{tabularx}
30 \EnableCrossrefs
31 \CodelineIndex
32
33 % Uncomment the following line if you don't want to include a
34 % source-code listing.
35 %\OnlyDescription
36
37 \begin{document}
38 \DocInput{dingbat.dtx}
39 \end{document}
40 %</driver>
41 % \fi
42 %
43 % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
44 %
45 % \CheckSum{76}
46 % \GetFileInfo{dingbat.sty}
47 %
48 % \title{The \textsf{dingbat} package\thanks{This file
49 % has version number \fileversion, last
50 % revised \filedate.}}
51 % \author{Scott Pakin\\[email protected]}
52 % \date{\filedate}
53 % \maketitle
54 %
55 % \changes{v1.00}{2001/04/27}{Initial version}
56 %
57 % \DoNotIndex{\newcommand,\selectfont}
58 %
59 % \StopEventually{^^A
60 % \section{Credits}
61 %
62 % Just so it's clear who did what, here are the various components of
63 % the \textsf{dingbat} package and the associated copyright information:
64 %
65 % \begin{center}
66 % \begin{tabularx}{0.9\textwidth}{lX}
67 % \texttt{ark10.mf} & Copyright (c) 1988 by Arthur M. Keller \\
68 % & The ARK font was initially done in MF79
69 % by Scott Kim. It was converted to (new) MF by N.N. Billawala
70 % of Metamarks. \\
71 % \texttt{dingbat.dtx} & Copyright (C) 2001 Scott Pakin \\
72 % \texttt{dingbat.ins} & Copyright (C) 2001 Scott Pakin \\
73 % \texttt{dingbat.mf} & Created 3-3-89 by Doug Henderson \\
74 % \texttt{uark.fd} & Copyright (C) 2001 Scott Pakin
75 % \end{tabularx}
76 % \end{center}
77 %
78 % \PrintIndex
79 % }
80 %
81 % \begin{abstract}
82 % The \textsf{dingbat} package provides a \LaTeXe\ interface to the
83 % |ark10.mf| and |dingbat.mf| fonts.
84 % \end{abstract}
85 %
86 %
87 % \section{Usage}
88 %
89 % ^^A Typeset a symbol in one column and its name in the next.
90 % \def\tblsym#1{#1 & \texttt{\string#1}}
91 %
92 % \DescribeMacro{\rightpointright}
93 % \DescribeMacro{\leftpointright}
94 % \DescribeMacro{\leftthumbsdown}
95 % \DescribeMacro{\leftthumbsup}
96 % \DescribeMacro{\rightpointleft}
97 % \DescribeMacro{\rightthumbsdown}
98 % \DescribeMacro{\rightthumbsup}
99 % The \textsf{dingbat} package defines the following hand gestures:
100 %
101 % \begin{center}
102 % \renewcommand{\arraystretch}{1.2}
103 % \begin{tabular}{lll}
104 % \tblsym{\rightpointright} & Right hand pointing to the right \\
105 % \tblsym{\leftpointright} & Left hand pointing to the right \\
106 % \tblsym{\leftthumbsdown} & Left hand, thumbs down \\
107 % \tblsym{\leftthumbsup} & Left hand, thumbs up \\
108 % \tblsym{\rightpointleft} & Right hand pointing to the left \\
109 % \tblsym{\rightthumbsdown} & Right hand, thumbs down \\
110 % \tblsym{\rightthumbsup} & Right hand, thumbs up \\
111 % \end{tabular}
112 % \end{center}
113 %
114 % \noindent
115 % (|\rightpointright| comes from |dingbat.mf|, while the rest come from
116 % |ark10.mf|, hence, the discrepency in style.)
117 %
118 % \DescribeMacro{\squarewithdots}
119 % \DescribeMacro{\filledsquarewithdots}
120 % \DescribeMacro{\Sborder}
121 % \DescribeMacro{\Zborder}
122 % The following symbols are intended to be used to create fancy borders
123 % around a box or the entire page.
124 %
125 % \begin{center}
126 % \renewcommand{\arraystretch}{1.2}
127 % \begin{tabular}{lll}
128 % \tblsym{\squarewithdots} & Unfilled square with dots \\
129 % \tblsym{\filledsquarewithdots} & Filled square with dots \\
130 % \tblsym{\Sborder} & \textit{S}-like border design \\
131 % \tblsym{\Zborder} & \textit{Z}-like border design \\
132 % \end{tabular}
133 % \end{center}
134 %
135 % \noindent
136 % Note that if you \emph{are} going to create fancy borders, I recommend
137 % using the \textsf{niceframe} package. \textsf{niceframe} is geared
138 % to drawing fancy borders and knows specifically about the border
139 % characters in |dingbat.mf|. The symbols defined by the
140 % \textsf{dingbat} package, |\squarewithdots|, |\filledsquarewithdots|,
141 % |\Sborder|, and |\Zborder|, are the only border characters that might
142 % be useful outside of a border (e.g., in a straight line or as a bullet
143 % in a fancy itemized list); the other, unnamed, characters defined in
144 % |dingbat.mf| represent a frame's corners and sides.
145 %
146 % \DescribeMacro{\largepencil}
147 % \DescribeMacro{\anchor}
148 % \DescribeMacro{\carriagereturn}
149 % \DescribeMacro{\checkmark}
150 % \DescribeMacro{\eye}
151 % \DescribeMacro{\satellitedish}
152 % \DescribeMacro{\smallpencil}
153 % The following \textsf{dingbat} symbols don't fit into either of the
154 % previous categories:
155 %
156 % \begin{center}
157 % \renewcommand{\arraystretch}{1.2}
158 % \begin{tabular}{lll}
159 % \tblsym{\largepencil} & Large pencil \\
160 % \tblsym{\anchor} & Anchor \\
161 % \tblsym{\carriagereturn} & Carriage return \\
162 % \tblsym{\checkmark} & Check mark \\
163 % \tblsym{\eye} & Eye \\
164 % \tblsym{\satellitedish} & DLA satellite dish \\
165 % \tblsym{\smallpencil} & Small pencil \\
166 % \end{tabular}
167 % \end{center}
168 %
169 % For some of these symbols, most notably |\largepencil|, the font
170 % metrics seem to be a bit off. As a result, the symbols tend to jut
171 % into previous or subsequent lines.
172 %
173 %
174 % \section{Implementation}
175 %
176 % There's nothing particularly interesting about the implementation.
177 % Section~\ref{sec:symbol-commands} defines the symbol commands that
178 % make up |dingbat.sty|, and Section~\ref{sec:font-definitions} creates
179 % the |uark.fd| and |udingbat.fd| font definition files, which \LaTeX\
180 % loads when |dingbat.sty| selects font encoding~|U| and font family
181 % |ark| or |dingbat|.
182 %
183 % \subsection{Symbol commands}
184 % \label{sec:symbol-commands}
185 %
186 % \begin{macrocode}
187 %<*package>
188 % \end{macrocode}
189 %
190 % \begin{macro}{\arkfamily}
191 % \begin{macro}{\ark@sym}
192 % Define a macro, |\arkfamily|, which switches the font to |ark| and
193 % another macro, |\ark@sym| which typesets a symbol in the |ark| font.
194 % \begin{macrocode}
195 \newcommand{\arkfamily}{\fontencoding{U}\fontfamily{ark}\selectfont}
196 \newcommand{\ark@sym}[1]{{\arkfamily\symbol{#1}}}
197 % \end{macrocode}
198 % \end{macro}
199 % \end{macro}
200 %
201 % \begin{macro}{\carriagereturn}
202 % \begin{macro}{\leftthumbsdown}
203 % \begin{macro}{\eye}
204 % \begin{macro}{\rightpointleft}
205 % \begin{macro}{\smallpencil}
206 % \begin{macro}{\leftpointright}
207 % \begin{macro}{\leftthumbsup}
208 % \begin{macro}{\largepencil}
209 % \begin{macro}{\rightthumbsdown}
210 % \begin{macro}{\rightthumbsup}
211 % There are only ten symbols in the |ark| font. We define names
212 % individually for each of them. Note that |\largepencil|'s bounding box
213 % is a little too short, so |\largepencil| may jut into the previous line
214 % of text. I think some of the other bounding boxes may be the wrong
215 % size, as well, but I haven't yet tested that carefully.
216 % \begin{macrocode}
217 \newcommand{\carriagereturn}{\ark@sym{'103}}
218 \newcommand{\leftthumbsdown}{\ark@sym{'104}}
219 \newcommand{\eye}{\ark@sym{'105}}
220 \newcommand{\rightpointleft}{\ark@sym{'114}}
221 \newcommand{\smallpencil}{\ark@sym{'120}}
222 \newcommand{\leftpointright}{\ark@sym{'122}}
223 \newcommand{\leftthumbsup}{\ark@sym{'125}}
224 \newcommand{\largepencil}{\ark@sym{'127}}
225 \newcommand{\rightthumbsdown}{\ark@sym{'144}}
226 \newcommand{\rightthumbsup}{\ark@sym{'165}}
227 % \end{macrocode}
228 % \end{macro}
229 % \end{macro}
230 % \end{macro}
231 % \end{macro}
232 % \end{macro}
233 % \end{macro}
234 % \end{macro}
235 % \end{macro}
236 % \end{macro}
237 % \end{macro}
238 %
239 % \begin{macro}{\dingbatfamily}
240 % \begin{macro}{\dingbat@sym}
241 % Define a macro, |\dingbatfamily|, which switches the font to |dingbat|
242 % and another macro, |\dingbat@sym| which typesets a symbol in the
243 % |dingbat| font.
244 % \begin{macrocode}
245 \newcommand{\dingbatfamily}{\fontencoding{U}\fontfamily{dingbat}\selectfont}
246 \newcommand{\dingbat@sym}[1]{{\dingbatfamily\symbol{#1}}}
247 % \end{macrocode}
248 % \end{macro}
249 % \end{macro}
250 %
251 % \begin{macro}{\checkmark}
252 % \begin{macro}{\satellitedish}
253 % \begin{macro}{\rightpointright}
254 % \begin{macro}{\anchor}
255 % The following are definitions for all the non-border characters in
256 % |dingbat.mf|.
257 % \begin{macrocode}
258 \newcommand{\checkmark}{\dingbat@sym{'104}}
259 \newcommand{\satellitedish}{\dingbat@sym{'111}}
260 \newcommand{\rightpointright}{\dingbat@sym{'116}}
261 \newcommand{\anchor}{\dingbat@sym{'117}}
262 % \end{macrocode}
263 % \end{macro}
264 % \end{macro}
265 % \end{macro}
266 % \end{macro}
267 %
268 % \begin{macro}{\squarewithdots}
269 % \begin{macro}{\filledsquarewithdots}
270 % \begin{macro}{\Sborder}
271 % \begin{macro}{\Zborder}
272 % The following are the border characters. There are many more, but I
273 % haven't yet made up \LaTeX\ names for them.
274 % \begin{macrocode}
275 \newcommand{\squarewithdots}{\dingbat@sym{'102}}
276 \newcommand{\filledsquarewithdots}{\dingbat@sym{'103}}
277 \newcommand{\Sborder}{\dingbat@sym{'123}}
278 \newcommand{\Zborder}{\dingbat@sym{'132}}
279 % \end{macrocode}
280 % \end{macro}
281 % \end{macro}
282 % \end{macro}
283 % \end{macro}
284 %
285 % \begin{macrocode}
286 %</package>
287 % \end{macrocode}
288 %
289 % \subsection{Font definition files}
290 % \label{sec:font-definitions}
291 %
292 % \subsubsection{\ttfamily uark.fd}
293 %
294 % All we do here is define |ark| as a symbol font (|U|~encoding) and tell
295 % \LaTeX\ to scale |ark10.mf| to whatever font size is requested.
296 %
297 % \begin{macrocode}
298 %<*uarkfd>
299 % \end{macrocode}
300 %
301 % \begin{macrocode}
302 \DeclareFontFamily{U}{ark}{}
303 \DeclareFontShape{U}{ark}{m}{n}{<-> ark10}{}
304 % \end{macrocode}
305 %
306 % \begin{macrocode}
307 %</uarkfd>
308 % \end{macrocode}
309 %
310 % \subsubsection{\ttfamily udingbat.fd}
311 %
312 % Similarly, we define |dingbat| as another, |U|-encoded symbol font and
313 % instruct \LaTeX\ to scale |dingbat.mf| to whatever font size is requested.
314 %
315 % \begin{macrocode}
316 %<*udingbatfd>
317 % \end{macrocode}
318 %
319 % \begin{macrocode}
320 \DeclareFontFamily{U}{dingbat}{}
321 \DeclareFontShape{U}{dingbat}{m}{n}{<-> dingbat}{}
322 % \end{macrocode}
323 %
324 % \begin{macrocode}
325 %</udingbatfd>
326 % \end{macrocode}
327 %
328 % \Finale
329 %