summaryrefslogtreecommitdiff
path: root/macros/xetex/latex/fontbook/fontbook.dtx
blob: c792e35fa12443f9348c26ba0a82e8412c2961fe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
% \iffalse meta-comment
%
% Copyright (C) 2011 by Raphaël Pinson <raphink@gmail.com>
% ---------------------------------------------------------------------------
% This work may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either version 1.3
% of this license or (at your option) any later version.
% The latest version of this license is in
%   http://www.latex-project.org/lppl.txt
% and version 1.3 or later is part of all distributions of LaTeX
% version 2005/12/01 or later.
%
% This work has the LPPL maintenance status `maintained'.
%
% The Current Maintainer of this work is Raphaël Pinson.
%
% This work consists of the files fontbook.dtx and fontbook.ins
% and the derived filebase fontbook.sty.
%
% \fi
%
% \iffalse
%<*driver>
\ProvidesFile{fontbook.dtx}
%</driver>
%<package>\NeedsTeXFormat{LaTeX2e}[1999/12/01]
%<package>\ProvidesPackage{fontbook}
%<*package>
    [2011/08/17 0.2 Generate a font book]
%</package>
%
%<*driver>
\documentclass[a4paper]{ltxdoc}
\usepackage{fontbook}[2011/07/05]
\usepackage{xltxtra}
\EnableCrossrefs
\CodelineIndex
\RecordChanges
\begin{document}
  \DocInput{fontbook.dtx}
  \PrintChanges
  \PrintIndex
\end{document}
%</driver>
% \fi
%
% \CheckSum{69}
%
% \CharacterTable
%  {Upper-case    \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
%   Lower-case    \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
%   Digits        \0\1\2\3\4\5\6\7\8\9
%   Exclamation   \!     Double quote  \"     Hash (number) \#
%   Dollar        \$     Percent       \%     Ampersand     \&
%   Acute accent  \'     Left paren    \(     Right paren   \)
%   Asterisk      \*     Plus          \+     Comma         \,
%   Minus         \-     Point         \.     Solidus       \/
%   Colon         \:     Semicolon     \;     Less than     \<
%   Equals        \=     Greater than  \>     Question mark \?
%   Commercial at \@     Left bracket  \[     Backslash     \\
%   Right bracket \]     Circumflex    \^     Underscore    \_
%   Grave accent  \`     Left brace    \{     Vertical bar  \|
%   Right brace   \}     Tilde         \~}
%
%
% \changes{0.2}{2011/08/17}{Fix some licenses and name}
% \changes{0.1}{2011/07/05}{Converted to DTX file}
%
% \DoNotIndex{\newcommand,\newenvironment}
%
% \providecommand*{\url}{\texttt}
% \GetFileInfo{fontbook.dtx}
% \title{The \textsf{fontbook} package}
% \author{Raphaël Pinson \\ \url{raphink@gmail.com}}
% \date{\fileversion~from \filedate}
%
% \maketitle
%
% \section{Introduction}
%
% \XeTeX{} allows us to make use of pretty much all possible fonts.
% With all the possible fonts that can be used and the many features provided
% by OpenType fonts, it can be useful to compile a font book of your favorite
% fonts, so you can find the one you need more easily. This is what the 
% \textsf{fontbook} package is about.
% 
%
% \section{Usage}
%
% To use this package, simply include it:
%
% \begin{verbatim}
% \usepackage{fontbook}
% \end{verbatim}
%
% \subsection{Package Options}
%
% This package provides several options to fine-tune the way its commands react.
%
% \subsubsection{The \textsf{sizes} option}
%
%   The \textsf{sizes} option lets you define which sizes
%   are to be printed for each font.
%   By default, all sizes from \textsf{huge} to \textsf{tiny} downward
%   are used:
%   \makeatletter\textsf{\fontbook@allsizes}\makeatother.
%   This option can take a single value or a list
%   of comma-separated values:
%
% \begin{verbatim}
% \usepackage[sizes={large,huge}]{fontbook}
% \end{verbatim}
%
% \subsubsection{The \textsf{features} option}
% 
%   Similarly to the \textsf{sizes} option, the \textsf{features} option
%   lets you define which features you wish to print for each font.
%   By default, the following features are used:
%   \makeatletter\textsf{\fontbook@allfeatures}\makeatother.
%   This option can take a single value or a list
%   of comma-separated values:
%
% \begin{verbatim}
% \usepackage[features=scshape]{fontbook}
% \end{verbatim}
%
% \subsubsection{The \textsf{featuresize} option}
%
%   By default, features are typeset in size
%   \makeatletter\textsf{\fontbook@defaultfeaturesize}\makeatother.
%   This can be changed by passing the desired size name
%   as the \textsf{featuresize} option:
%
% \begin{verbatim}
% \usepackage[featuresize=huge]{fontbook}
% \end{verbatim}
%
% \subsection{Package commands}
%
% \DescribeMacro{\setsampletext}
%
%   Set the sample text used in the font demo.
%
% \DescribeMacro{\printfont}
%
%   This is the main command of this package
%   It takes 2 mandatory arguments and 1 optional argument.
%   The 2 mandatory arguments are the font name, as passed to
%   \textsf{fontspec}, and the license.
%   The optional argument is the fontspec option that allow
%   to set OpenType features for example:
%
% \begin{verbatim}
% \printfont[Ligatures=Rare]{Linux Libertine O}{Public Domain}
% \end{verbatim}
%
% \StopEventually{}
%
% \section{Implementation}
%
% \iffalse
%<*package>
% \fi
%
%    \begin{macrocode}
\ProvidesPackage{fontbook}
\RequirePackage{fontspec}
\RequirePackage{xunicode}
\RequirePackage{kvoptions}
\RequirePackage{etoolbox}
\SetupKeyvalOptions{
   family=fontbook,
   prefix=fontbook@,
}
%    \end{macrocode}
%% Options
%
%
% \begin{macro}{\fontbook@allsizes}
% Sizes
%    \begin{macrocode}
\def\fontbook@allsizes{%
 huge, LARGE, Large, large, normalsize,
 small, footnotesize, scriptsize, tiny}
\expandafter\DeclareStringOption\expandafter[\fontbook@allsizes]{sizes}
%    \end{macrocode}
% \end{macro}
%
%
% \begin{macro}{\fontbook@allfeatures}
% Features
%    \begin{macrocode}
\def\fontbook@allfeatures{%
 scshape, itshape, bfseries}
\expandafter\DeclareStringOption\expandafter[\fontbook@allfeatures]{features}
\def\fontbook@defaultfeaturesize{large}
\expandafter\DeclareStringOption\expandafter[\fontbook@defaultfeaturesize]{featuresize}
\ProcessKeyvalOptions*
%    \end{macrocode}
% \end{macro}
%
%
% \begin{macro}{\fontbook@sampletext}
%    \begin{macrocode}
\def\fontbook@sampletext{%
 Dans l'affliction éphémère qui m'accable, je teste
 la police d'affichage qui est utilisée sur cette page 1 2 3 4 5.
}
%    \end{macrocode}
% \end{macro}
%
%
% \begin{macro}{\sampletext}
%    \begin{macrocode}
\newcommand{\sampletext}[2][]{%
 {\par\csname#2\endcsname \csname#1\endcsname
 #2 #1\\ \fontbook@sampletext}}
%    \end{macrocode}
% \end{macro}
%
%
% \begin{macro}{\setsampletext}
%    \begin{macrocode}
\newcommand{\setsampletext}[1]{%
 \def\fontbook@sampletext{#1}}
%    \end{macrocode}
% \end{macro}
%
%
% \begin{macro}{\samplefeature}
%    \begin{macrocode}
\newcommand{\samplefeature}[1]{%
 \sampletext[#1]{\fontbook@featuresize}}
%% TODO: call font once
%%%% print all variants
%
%    \end{macrocode}
% \end{macro}
%
%
% \begin{macro}{\printfont}
%    \begin{macrocode}
\newcommand{\printfont}[3][\empty]{%
   \fontspec[#1]{#2}
   \section*{#2 #1 --- Licence: #3}
   \ifx#1\empty
     \addcontentsline{toc}{section}{#2}
   \else
     \addcontentsline{toc}{subsection}{#1}
   \fi
   \expandafter\forcsvlist\expandafter\sampletext\expandafter{\fontbook@sizes}
   \expandafter\forcsvlist\expandafter\samplefeature\expandafter{\fontbook@features}
   \pagebreak
}
%    \end{macrocode}
% \end{macro}
%
%
% \iffalse
%</package>
% \fi
%
% \Finale
\endinput