summaryrefslogtreecommitdiff
path: root/macros/latex-dev/base/lthyphen.dtx
blob: f8321719c72bbe4a93cd2e5baa0464dfdb94f978 (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
% \iffalse meta-comment
%
% Copyright (C) 1993-2021
% The LaTeX3 Project and any individual authors listed elsewhere
% in this file.
%
% This file is part of the LaTeX base system.
% -------------------------------------------
%
% It may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either version 1.3c
% of this license or (at your option) any later version.
% The latest version of this license is in
%    https://www.latex-project.org/lppl.txt
% and version 1.3c or later is part of all distributions of LaTeX
% version 2008 or later.
%
% This file has the LPPL maintenance status "maintained".
%
% The list of all files belonging to the LaTeX base distribution is
% given in the file `manifest.txt'. See also `legal.txt' for additional
% information.
%
% The list of derived (unpacked) files belonging to the distribution
% and covered by LPPL is defined by the unpacking scripts (with
% extension .ins) which are part of the distribution.
%
% \fi
% \iffalse
%<*driver>
\ProvidesFile{lthyphen.dtx}
%</driver>
%<default>\ProvidesFile{hyphen.ltx}
% \fi
%         \ProvidesFile{lthyphen.dtx}
          [1994/12/04 v1.0h LaTeX Kernel (hyphenation interface)]
%
%
%
%\iffalse        This is a META comment
%
% File `lthyphen.dtx'.
% Copyright (C) 1994-94 LaTeX3 project, Frank Mittelbach and
% Rainer Sch\"opf, all rights reserved.
%
%\fi
% \GetFileInfo{lthyphen.dtx}
% \title{The \texttt{lthyphen.dtx} file\thanks
%     {This file has version number \fileversion, dated \filedate.}\\
%       for use with \LaTeXe}
% \author{Frank Mittelbach, Chris Rowley \and Rainer Sch\"opf}
%
% \def\dst{{\normalfont\scshape docstrip}}
% \setcounter{StandardModuleDepth}{1}
%
%
% \MaintainedByLaTeXTeam{latex}
% \maketitle
%
% This file contains the code for loading hyphenation patterns into
% \LaTeX. Most of this will end up in a file called
% \texttt{hyphen.ltx}. If you wish to customize your \LaTeX{} system
% in respect of hyphenation patterns, write a file
% \texttt{hyphen.cfg}. If this file exists, it will be loaded instead
% of \texttt{hyphen.ltx}.  See the comments below for additional
% information.
%
% \StopEventually{}
%
% To produce the printed version of this file the following code
% is used. It can be extracted with the \dst{} program, or one can run
% this file directly through \LaTeXe{}.
%    \begin{macrocode}
%<*driver>
\documentclass{ltxdoc}
\begin{document}
\DocInput{lthyphen.dtx}
\end{document}
%</driver>
%    \end{macrocode}
%
% \changes{v0.1c}{1994/03/07}{move the 2ekernel code to ltfinal.dtx}
% \changes{v1.0g}{1994/12/01}{Rename lthyphen.ltx/cfg to hyphen.ltx/cfg}
% \changes{v1.0h}{1994/12/04}{Documentation edits for /1989}
%
% The default file |hyphen.ltx| loads hyphenation patterns for US
% english.  If you want to load additional or other hyphenation
% patterns, you should create a file |hyphen.cfg|. This is best done
% by starting from |hyphen.ltx|.
%
% For backward compatibility, the default file, |hyphen.ltx|,
% first tries to load
% the file |hyphen.tex|. If this file exists, an information
% message is issued and the appropriate defaults for \TeX's internal
% parameters are set: |\language| is initialized to $0$, and
% |\lefthyphenmin| and |\righthyphenmin| to $2$ and $3$, respectively,
% to disallow x- or -xx breaks.
%    \begin{macrocode}
%<*default>
\InputIfFileExists{hyphen.tex}%
   {\message{Loading hyphenation patterns for US english.}%
    \language=0
    \lefthyphenmin=2 \righthyphenmin=3 }%
%    \end{macrocode}
% Otherwise, since we cannot do anything without any hyphenation
% patterns, an error message is printed and the Ini\TeX{} run
% is terminated by invoking |\@@end| (which is the \LaTeXe{} name
% for \TeX's |\end| primitive).
%    \begin{macrocode}
   {\errhelp{The configuration for hyphenation is incorrectly
             installed.^^J%
             If you don't understand this error message you need
             to seek^^Jexpert advice.}%
    \errmessage{OOPS! I can't find any hyphenation patterns for
                US english.^^J \space Think of getting some or the
                latex2e setup will never succeed}\@@end}
%</default>
%    \end{macrocode}
% The following example describes the possible contents of a file
% |hyphen.cfg| that will load both US English and German hyphenation
% patterns, making the former the default.
% It sets |\language| to $0$ for the US patterns and to $1$ for the
% German patterns.
% Then |\language| is set to $0$ to make this the default and the
% default values of |\lefthyphenmin| and |\righthyphenmin| are set.
% \begin{verbatim}
%\language=0
%\input hyphen % (or \input ushyphen1 if the file has been renamed)
%\language=1
%\input ghyph31
%\language=0
%\lefthyphenmin=2
%\righthyphenmin=3
%\endinput
%\end{verbatim}
%
% Another possibility is to use the package |babel|, by Johannes Braams.
% That package is distributed with a suitable |hyphen.cfg| file.
%
%
% \Finale
%
\endinput