/ [gentium] / trunk / gentium / doc / fonts / gentium-tug / gentium.tex
To checkout: svn checkout http://svn.gnu.org.ua/sources/gentium/trunk/gentium/doc/fonts/gentium-tug/gentium.tex
Puszcza

Annotation of /trunk/gentium/doc/fonts/gentium-tug/gentium.tex

Parent Directory Parent Directory | Revision Log Revision Log


Revision 4 - (hide annotations)
Mon Jun 3 17:24:14 2013 UTC (8 years, 3 months ago) by karl
File MIME type: application/x-tex
File size: 21364 byte(s)
first version of gentium-tug approved by SIL for release
1 karl 4 % !TEX TS-program = pdflatex
2     % !TEX encoding = UTF-8 Unicode
3    
4     % This file is part of the Gentium package for TeX.
5     % It is licensed under the Expat License, see doc//README for details.
6    
7     \documentclass[11pt, welsh, british]{article}
8     \usepackage{babel}
9     \usepackage[utf8x]{inputenc}
10     \usepackage[T1]{fontenc}
11     \usepackage{gentium}
12     \renewcommand{\ttdefault}{lmvtt}
13     \usepackage{fancyhdr,lastpage,fancyref}
14     \usepackage{array,longtable,verbatim}
15     \usepackage{booktabs}
16     \usepackage{multirow}
17     \usepackage{url}
18     \urlstyle{tt}
19     \usepackage[breaklinks,colorlinks,
20     linkcolor=black,citecolor=black,urlcolor=black]
21     {hyperref}
22     %\usepackage{microtype}
23     \usepackage[a4paper,headheight=14pt,scale=0.8]{geometry}
24     % use 14pt for 11pt text, 15pt for 12pt text
25    
26     \title{Gentium for \TeX}
27     \author{Mojca Miklavec \and Pavel Farář \and Thomas A. Schmitz}
28     \newcommand*{\dyddiad}{\today}
29     \newcommand*{\ofname}{of}
30     \date{\dyddiad}
31     \pagestyle{fancy}
32     \fancyhf[lh]{\itshape gentium}
33     \fancyhf[rh]{\itshape\dyddiad}
34     \fancyhf[ch]{}
35     \fancyhf[lf]{}
36     \fancyhf[rf]{}
37     \fancyhf[cf]{\itshape --- \thepage~\ofname~\pageref{LastPage} ---}
38    
39     \usepackage{textcomp}
40    
41     \def\ConTeXt{Con{\TeX}t}
42     \def\ConTeXtMKII{Con{\TeX}t {\sc MkII}}
43     \def\ConTeXtMKIV{Con{\TeX}t {\sc MkIV}}
44     \def\XeTeX{Xe{\TeX}} % TODO: improve the first "e"--reversed and lowered
45     \def\pdfTeX{pdf{\TeX}}
46     \def\pdfLaTeX{pdf{\LaTeX}}
47     \def\TeXLive{\TeX~Live}
48     \def\MiKTeX{MiK\TeX}
49     \def\MacTeX{Mac\TeX}
50    
51     \begin{document}
52     \maketitle
53     \thispagestyle{empty}
54     \pdfinfo{%
55     /Creator (TeX)
56     /Producer (pdfTeX)
57     /Author (Pavel Farář, Mojca Miklavec, Clea F.\ Rees)
58     /Title (Gentium for TeX)
59     /Subject (TeX)
60     /Keywords (TeX,LaTeX,font,fonts,tex,latex,gentium,GentiumPlus,GentiumBasic,Gentium,SIL,sil)}
61     \pdfcatalog{%
62     /URL ()
63     /PageMode /UseOutlines}
64     % other values: /UseNone, /UseOutlines, /UseThumbs, /FullScreen
65     %[openaction <actionspec>]
66     % \pagestyle{empty}
67     % if you want this, you probably want to comment out \maketitle as well...?
68     \setlength{\parindent}{0pt}
69     \setlength{\parskip}{0.5em}
70    
71    
72     \newcommand*{\sil}{\textsc{sil}}
73     \newcommand*{\pkgname}[1]{\textsf{#1}}
74     \newcommand*{\fname}[1]{\textsf{#1}}
75    
76     \begin{abstract}
77     \hspace*{-\parindent}This document outlines the
78     \TeX/\LaTeX/\ConTeXt\ support provided by this
79     package for the Gentium font collection released by \sil.
80     \end{abstract}
81    
82     \tableofcontents
83    
84    
85     \section{Introduction}
86    
87     This document explains how to use the \TeX/\LaTeX/\ConTeXt\ support in
88     the present package for the Gentium font collection developed by \sil.
89     This package includes fonts in PostScript Type~1 format converted from
90     the original TrueType files released by \sil\ (using the FontForge
91     routines found in this package). These Type~1 fonts use the name
92     `Gentium' by permission of \sil\ to the \TeX\ Users Group. Therefore
93     the name of this \TeX\ package, by request of \sil, is
94     \pkgname{gentium-tug}. Its home page is \url{http://tug.org/gentium}.
95    
96     Further information about the fonts themselves can be found in the
97     included documentation and at \url{http://scripts.sil.org/gentium}. The
98     fonts are released under the \textsc{sil} Open Font License. For
99     details, see \url{ofl.txt} and \url{ofl-faq.txt}. (In the event of
100     releasing modified versions of the fonts, either TrueType or Type~1,
101     it's required to use a name that doesn't include ``Gentium'', per the
102     \textsc{ofl}.)
103    
104     This \TeX/\LaTeX/\ConTeXt\ support package consists of metrics, map
105     files, style files, documentation, and so on. These files are released
106     under the Expat license. The text for both licenses is included at the
107     end of this document, and in files in the distribution.
108    
109     If you have the package installed and just want to know how to use
110     Gentium in your \TeX\ documents, feel free to skip to
111     section~\ref{sec:latex-package} (\LaTeX\ usage) or
112     section~\ref{sec:context-package} (\ConTeXt\ usage).
113    
114     Please report any problems (contact info on the web page). If you can
115     also send a fix, so much the better.
116    
117    
118     \section{Gentium collection background}
119    
120     This package uses the original fonts GentiumPlus to make the regular and
121     italic styles and GentiumBasic to make the bold and bold italic styles,
122     and combines them into one \TeX-world family.
123    
124     GentiumPlus is a serif family designed to support a wide range of Latin,
125     Greek and Cyrillic characters. It currently includes just the regular
126     and italic style, as well as smallcaps.
127    
128     GentiumBasic has just the Latin characters and it even lacks some Latin
129     characters found in GentiumPlus. Therefore, the bold and bold italic
130     styles of this package support fewer languages than the regular and
131     italic styles (e.g.\ Czech and Slovak are not fully
132     supported). Moreover, GentiumBasic has no smallcaps and no kerning
133     pairs. When and if \sil\ releases bold and bold italic GentiumPlus
134     fonts, we will switch to those, of course.
135    
136     This package does not use the Berry fontname scheme, but longer names
137     similar to those of Latin Modern, etc. One disadvantage of this choice
138     is that you cannot use the additional font selection commands provided
139     by the package \pkgname{nfssext-cfr}.
140    
141    
142     \section{Installation}
143    
144     If you are using a reasonably recent \MiKTeX\ or \TeXLive\ or distro
145     installation it should be enough to install the \pkgname{gentium-tug}
146     package (if it's not already present).
147    
148     Otherwise, or if you want to install the font manually, you will in
149     general need to perform these steps:
150     \begin{enumerate}
151     \item choose whether to install the font system-wide or in a personal
152     directory;
153     \item move or copy the package files to the appropriate location;
154     \item refresh the \TeX\ database;
155     \item incorporate the included map file fragments for the different
156     engines.
157     \end{enumerate}
158    
159     However, that's all that it make sense to say here. It's beyond the
160     scope of this Gentium documentation to explain all the myriad ways in
161     which \TeX-world map files can be installed and used; there are
162     differences between \TeXLive\ and \MiKTeX, too.
163    
164     Instead, we refer you to an explanation of the system-wide installation,
165     with information for both \MiKTeX\ and \TeXLive, at
166     \url{http://tug.org/fonts/fontinstall.html}. A corresponding
167     explanation for personal installation is at
168     \url{http://tug.org/fonts/fontinstall-personal.html}.
169    
170     Those pages describe using \path{testfont.tex} for a basic test of the
171     font; a tfm file name to use with that is \url{ec-gentiumplus-regular}.
172    
173     To further test your installation and that the package works on your
174     system, run \LaTeX\ on this \path{gentium.tex} source file. (You'll
175     need some commonly-available \LaTeX\ packages too, or comment them at.)
176     The console output and/or log should tell you whether any fonts were not
177     found. You can also compare your output with the original
178     \path{gentium.pdf}.
179    
180    
181     \section{Gentium \TeX\ support packages}\label{sec:support}
182    
183     In short, for \LaTeX\ it suffices to include \verb|\usepackage{gentium}|
184     in your document preamble, and for \ConTeXtMKIV,
185     \verb|\setupbodyfont[gentium]|. Details follow.
186    
187     The only prerequisite is that the \LaTeX\ package (\path{gentium.sty})
188     requires \pkgname{xkeyval}, which you almost certainly already have.
189    
190    
191     \subsection{Encodings}\label{sec:encs}
192    
193     The package supports not only the most common Latin encodings such as
194     \textsc{ot1}, TeXnANSI/\textsc{ly1}, Cork/\textsc{ec}/\textsc{t1} and
195     Text Companion/\textsc{ts1} encodings, but also (in regular and italic)
196     other Latin, Greek and Cyrillic encodings. Most characters in the text
197     encodings and some of those in the Text Companion encoding are
198     available, including the~\texteuro. You can see the available encodings
199     in table~\ref{encodings}. The Greek encoding LGR is supported only in
200     \LaTeX, AGR only in \ConTeXt.
201    
202     \begin{table}[h]
203     \centering
204     \begin{tabular}{lll}
205     \toprule
206     script & available encodings & styles \\
207     \midrule
208     Latin & OT1, T1, LY1, L7x, QX, T5, TS1 & regular, italic, bold,
209     bold italic \\
210     Cyrillic & T2A, T2B, T2C, X2 & regular, italic\\
211     Greek & LGR (\LaTeX), AGR (\ConTeXt) & regular, italic \\
212     \bottomrule
213     \end{tabular}
214     \caption{Available encodings in \pkgname{gentium-tug}.}
215     \label{encodings}
216     \end{table}
217    
218     The regular and italic styles support all these Latin, Greek and Cyrillic
219     encodings. They support also small caps for the Latin and Cyrillic encodings,
220     but there are no small caps for Greek.
221    
222     The bold and bold italic styles support only the Latin encodings and they
223     have no small caps.
224    
225     Cork/T1 encoding lacks visible space, cwm (compound work mark),
226     SS and the character for composing permille sign.
227    
228     Missing characters in bold styles for Latin encodings:
229    
230     T1: Aogonek / aogonek, Eogonek / eogonek, Lcaron / lcaron,
231     Scedilla / scedilla, uni021A (Tcommaaccent) / uni021B (tcommaaccent),
232     dcaron, tcaron
233    
234     L7x: Rcommaaccent, Gcommaaccent, Kcommaaccent, Lcommaaccent, Ncommaaccent,
235     Aogonek, Eogonek, Iogonek, Uogonek
236    
237     QX: Aogonek, Eogonek, Iogonek, uni021A (Tcommaaccent)
238    
239    
240     \subsection{\LaTeX}
241     \label{sec:latex-package}
242    
243     To use Gentium fonts in a \LaTeX\ document, add
244     \verb|\usepackage{gentium}| to your document preamble. This will set
245     the default serif/roman family to \fname{gentium}.
246    
247     If you want to use Gentium together with another font (sans or
248     typewriter) with a different x-height, you should consider using the
249     option \verb|scaled|. This scales Gentium font and if you choose the
250     right scaling factor, you will get the same x-height of both fonts.
251     Here is an example of this option:
252     \begin{verbatim}
253     \usepackage[scaled=0.9]{gentium}
254     \end{verbatim}
255    
256    
257     \subsection{\ConTeXt}
258     \label{sec:context-package}
259    
260     In \ConTeXtMKIV, to switch to the Gentium typeface you only need:
261     \begin{verbatim}
262     \setupbodyfont[gentium]
263     \end{verbatim}
264    
265     In \ConTeXtMKII, before doing that you need either (for \pdfTeX):
266     \begin{verbatim}
267     \usetypescriptfile[type-gentium]
268     \usetypescript[gentium][ec] % or whatever encoding
269     \end{verbatim}
270     or (for \XeTeX):
271     \begin{verbatim}
272     \usetypescriptfile[type-gentium]
273     \usetypescript[gentium]
274     \end{verbatim}
275    
276    
277     \subsection{Changes in the Type~1 fonts vs.\ the TrueType originals}
278    
279     The shapes of all characters in the Type~1 fonts are the same as in the
280     original TrueType fonts, except for the unavoidable changes are induced
281     by the format conversion (that is, the spline representations are
282     necessarily different).
283    
284     However, a few small changes---hopefully improvements---were made to the
285     metrics of the GentiumPlus family (that is, regular and italic; bold and
286     bold italic are untouched). The Type~1 fonts are used to generate the
287     \TeX\ font metric files (tfm), so these changes propagate to the 8-bit
288     engines like \pdfTeX.
289    
290     The first change concerns Greek. 8-bit Greek encodings (LGR and AGR) do
291     not use precomposed accented capital letters. These letters are composed
292     as a sequence of two glyphs: accent + capital letter. The problem is
293     that this sequence does not look like the precomposed letter---there is
294     often big space between the accent and the letter. Therefore, there are
295     some extra kerning pairs between accents and capital Greek
296     letters. These kerning pairs are created automatically (the script is
297     included in the sources) and the goal is to have the same relative
298     position between the accent and the letter as in the precomposed
299     letter. Thanks to these extra kerning pairs you should get better
300     results for 8-bit engines. These changes are irrelevant for Unicode
301     engines---they use the precomposed letters.
302    
303     The second change is in the letters dcaron (ď) and lcaron
304     (ľ) that are used in the Czech and Slovak languages. (There was
305     no need to change tcaron (ť) and Lcaron (Ľ) with the same
306     accent.) There is no change of their shapes, and their advance widths
307     are also untouched---the change is to add several kerning pairs with
308     quite big negative values. Without these changes there was often a large
309     space between dcaron or lcaron and the following letter, so the changes
310     make the words containing these letters much more compact. You get these
311     changes automatically if you use 8-bit engines. If you use Unicode
312     engines with the original TrueType fonts, you get the original
313     metrics. However, you can tell the Unicode engines to use the Type~1
314     fonts (which append \verb|PS| to the family name) like this:
315     \begin{verbatim}
316     \usepackage{fontspec}
317     \setmainfont{GentiumPlusPS}
318     \end{verbatim}
319     Then you get the additional kern pairs for dcaron and lcaron. The
320     unfortunately disadvantage is that you cannot use small caps.
321    
322     The last (similar) change is that additional kerning pairs were added to
323     the Type~1 fonts for accented Latin letters and small caps. The original
324     TrueType fonts have no such kerning pairs. As with the Czech/Slovak
325     changes, you get these changes automatically if you use 8-bit
326     engines. If you use Unicode engines with the original TrueType fonts,
327     you get the original metrics, but you can override as above (but since
328     you cannot use small caps with that method, the kerning pairs for small
329     caps become irrelevant).
330    
331    
332     \section{Known bugs}
333    
334     There are problems in older versions of \pdfTeX\ with small caps when
335     using TrueType fonts. Especially the Latin encoding \textsc{t5} and all
336     Cyrillic encodings are unusable. You can use the Type~1 version of the
337     fonts or at least \pdfTeX\ version 1.40.13 to avoid these problems.
338    
339     The Gentium fonts are a work in progress and as such they still miss
340     some features like kerning pairs for some letters. Currently, there are
341     no kerning pairs in the GentiumBasic family at all and the GentiumPlus
342     family has kerning pairs just for Latin letters without accents and for
343     Greek letters; there are no kerning pairs for small caps, accented Latin
344     letters or Cyrillic letters. The Type~1 fonts in this package have some
345     additional kerning pairs for accented Latin letters and for small
346     caps. Kerning pairs for Cyrillic are under consideration.
347    
348    
349     \section{License}
350    
351     The fonts in this page, both the \sil\ originals and the derived Type~1
352     versions, are released under \textsc{ofl}. The \TeX\ support files
353     are licensed under the Expat License. Here are the full license texts.
354    
355    
356     \subsection{SIL Open Font License}
357    
358     Copyright (c) 2003-2011 SIL International (http://www.sil.org/),
359     with Reserved Font Names ``Gentium'' and ``SIL''.
360    
361     This Font Software is licensed under the SIL Open Font License, Version 1.1.
362     This license is copied below, and is also available with a FAQ at:
363     http://scripts.sil.org/OFL
364    
365    
366     % TODO: Try to have the similar look as the text version
367     %-----------------------------------------------------------
368     SIL OPEN FONT LICENSE Version 1.1 --- 26 February 2007
369     %-----------------------------------------------------------
370    
371    
372     PREAMBLE
373    
374     The goals of the Open Font License (OFL) are to stimulate worldwide
375     development of collaborative font projects, to support the font creation
376     efforts of academic and linguistic communities, and to provide a free and
377     open framework in which fonts may be shared and improved in partnership
378     with others.
379    
380     The OFL allows the licensed fonts to be used, studied, modified and
381     redistributed freely as long as they are not sold by themselves. The
382     fonts, including any derivative works, can be bundled, embedded,
383     redistributed and/or sold with any software provided that any reserved
384     names are not used by derivative works. The fonts and derivatives,
385     however, cannot be released under any other type of license. The
386     requirement for fonts to remain under this license does not apply
387     to any document created using the fonts or their derivatives.
388    
389    
390     DEFINITIONS
391    
392     ``Font Software'' refers to the set of files released by the Copyright
393     Holder(s) under this license and clearly marked as such. This may
394     include source files, build scripts and documentation.
395    
396     ``Reserved Font Name'' refers to any names specified as such after the
397     copyright statement(s).
398    
399     ``Original Version'' refers to the collection of Font Software components as
400     distributed by the Copyright Holder(s).
401    
402     ``Modified Version'' refers to any derivative made by adding to, deleting,
403     or substituting---in part or in whole---any of the components of the
404     Original Version, by changing formats or by porting the Font Software to a
405     new environment.
406    
407     ``Author'' refers to any designer, engineer, programmer, technical
408     writer or other person who contributed to the Font Software.
409    
410    
411     PERMISSION \& CONDITIONS
412    
413     Permission is hereby granted, free of charge, to any person obtaining
414     a copy of the Font Software, to use, study, copy, merge, embed, modify,
415     redistribute, and sell modified and unmodified copies of the Font
416     Software, subject to the following conditions:
417    
418     1) Neither the Font Software nor any of its individual components,
419     in Original or Modified Versions, may be sold by itself.
420    
421     2) Original or Modified Versions of the Font Software may be bundled,
422     redistributed and/or sold with any software, provided that each copy
423     contains the above copyright notice and this license. These can be
424     included either as stand-alone text files, human-readable headers or
425     in the appropriate machine-readable metadata fields within text or
426     binary files as long as those fields can be easily viewed by the user.
427    
428     3) No Modified Version of the Font Software may use the Reserved Font
429     Name(s) unless explicit written permission is granted by the corresponding
430     Copyright Holder. This restriction only applies to the primary font name as
431     presented to the users.
432    
433     4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
434     Software shall not be used to promote, endorse or advertise any
435     Modified Version, except to acknowledge the contribution(s) of the
436     Copyright Holder(s) and the Author(s) or with their explicit written
437     permission.
438    
439     5) The Font Software, modified or unmodified, in part or in whole,
440     must be distributed entirely under this license, and must not be
441     distributed under any other license. The requirement for fonts to
442     remain under this license does not apply to any document created
443     using the Font Software.
444    
445    
446     TERMINATION
447    
448     This license becomes null and void if any of the above conditions are
449     not met.
450    
451    
452     DISCLAIMER
453    
454     \textsc{The font software is provided ``as is'', without warranty of any kind,
455     express or implied, including but not limited to any warranties of
456     merchantability, fitness for a particular purpose and noninfringement
457     of copyright, patent, trademark, or other right. In no event shall the
458     copyright holder be liable for any claim, damages or other liability,
459     including any general, special, indirect, incidental, or consequential
460     damages, whether in an action of contract, tort or otherwise, arising
461     from, out of the use or inability to use the font software or from
462     other dealings in the font software.}
463    
464    
465     \subsection{Expat License}
466    
467     Copyright (c) 2008-2013 TeX Users Group
468    
469     Permission is hereby granted, free of charge, to any person obtaining
470     a copy of this software and associated documentation files (the
471     ``Software''), to deal in the Software without restriction, including
472     without limitation the rights to use, copy, modify, merge, publish,
473     distribute, sublicense, and/or sell copies of the Software, and to
474     permit persons to whom the Software is furnished to do so, subject to
475     the following conditions:
476    
477     The above copyright notice and this permission notice shall be included
478     in all copies or substantial portions of the Software.
479    
480     \textsc{The software is provided ``as is'', without warranty of any kind,
481     express or implied, including but not limited to the warranties of
482     merchantability, fitness for a particular purpose and noninfringement.
483     In no event shall the authors or copyright holders be liable for any
484     claim, damages or other liability, whether in an action of contract,
485     tort or otherwise, arising from, out of or in connection with the
486     software or the use or other dealings in the software.}
487    
488    
489    
490     % OT1 is the same for regular and italic style (like TeX Gyre, unlike
491     % Computer Modern)---this might go to the bugs section.
492    
493     % Cyrillic encodings use some letters with tail instead of with descender.
494    
495    
496     % TODO
497    
498     % Show the available encodings in a better way (probably something
499     % similar to README), probably use small caps. Look at Clea's tables
500     % if they are better than what I wrote.
501    
502     % Improve the LaTeX logo in Gentium (not so much related to this
503     % documentation).
504    
505     % Search for gentiumplus and vgx---the latter shouldn't be present.
506    
507     % Scale the monospaced font to match the x-height.
508    
509     % Change the license and other information in the header.
510    
511    
512     % NOTES TO CLEA
513    
514     % Current (unlike Clea's) LY1 doesn't contain Wcircumflex and others.
515     % Look at it!
516     % \textsc{ly1} is
517     % necessary for access to Wcircumflex (Ŵ), wcircumflex (ŵ),
518     % Ycircumflex (Ŷ) and ycircumflex (ŷ) as pre-composed
519     % glyphs.
520    
521     % Look what's different from Clea's package.
522    
523    
524     % Some Clea's texts that might be used:
525    
526     % The final option controls whether Latin Modern is used for sans and
527     % typewriter text. Because Computer Modern does not support the
528     % TeXnANSI/\textsc{ly1} encoding, you will likely get strange results
529     % unless you redefine \path{\sfdefault} and \path{\ttdefault}. Latin
530     % Modern is used because it is close to the default Computer Modern fonts
531     % and is widely available. If you would prefer that the package not
532     % redefine the default sans and typewriter families, use \verb|lm=false|
533     % when loading \pkgname{gentiumplus}. To explicitly request the default
534     % behaviour, which does redefine these families, use \verb|lm| or
535     % \verb|lm=true|.
536    
537     % Loading \path{gentium.sty} does not affect the setup for
538     % mathematics.
539    
540     \end{document}

Properties

Name Value
svn:eol-style native

Send suggestions and bug reports to Sergey Poznyakoff
ViewVC Help
Powered by ViewVC 1.1.20