trunk/base/lthyphen.dtx

   1 % \iffalse meta-comment
   2 %
   3 % Copyright 1993-2016
   4 % The LaTeX3 Project and any individual authors listed elsewhere
   5 % in this file.
   6 %
   7 % This file is part of the LaTeX base system.
   8 % -------------------------------------------
   9 %
  10 % It may be distributed and/or modified under the
  11 % conditions of the LaTeX Project Public License, either version 1.3c
  12 % of this license or (at your option) any later version.
  13 % The latest version of this license is in
  14 %    http://www.latex-project.org/lppl.txt
  15 % and version 1.3c or later is part of all distributions of LaTeX
  16 % version 2005/12/01 or later.
  17 %
  18 % This file has the LPPL maintenance status "maintained".
  19 %
  20 % The list of all files belonging to the LaTeX base distribution is
  21 % given in the file `manifest.txt'. See also `legal.txt' for additional
  22 % information.
  23 %
  24 % The list of derived (unpacked) files belonging to the distribution
  25 % and covered by LPPL is defined by the unpacking scripts (with
  26 % extension .ins) which are part of the distribution.
  27 %
  28 % \fi
  29 % \iffalse
  30 %<*driver>
  31 \ProvidesFile{lthyphen.dtx}
  32 %</driver>
  33 %<default>\ProvidesFile{hyphen.ltx}
  34 % \fi
  35 %         \ProvidesFile{lthyphen.dtx}
  36           [1994/12/04 v1.0h LaTeX Kernel (hyphenation interface)]
  37 %
  38 %
  39 %
  40 %\iffalse        This is a META comment
  41 %
  42 % File `lthyphen.dtx'.
  43 % Copyright (C) 1994-94 LaTeX3 project, Frank Mittelbach and
  44 % Rainer Sch\"opf, all rights reserved.
  45 %
  46 %\fi
  47 % \GetFileInfo{lthyphen.dtx}
  48 % \title{The \texttt{lthyphen.dtx} file\thanks
  49 %     {This file has version number \fileversion, dated \filedate.}\\
  50 %       for use with \LaTeXe}
  51 % \author{Frank Mittelbach, Chris Rowley \and Rainer Sch\"opf}
  52 %
  53 % \def\dst{{\normalfont\scshape docstrip}}
  54 % \setcounter{StandardModuleDepth}{1}
  55 %
  56 %
  57 % \MaintainedByLaTeXTeam{latex}
  58 % \maketitle
  59 %
  60 % This file contains the code for loading hyphenation patterns into
  61 % \LaTeX. Most of this will end up in a file called
  62 % \texttt{hyphen.ltx}. If you wish to customize your \LaTeX{} system
  63 % in respect of hyphenation patterns, write a file
  64 % \texttt{hyphen.cfg}. If this file exists, it will be loaded instead
  65 % of \texttt{hyphen.ltx}.  See the comments below for additional
  66 % information.
  67 %
  68 % \StopEventually{}
  69 %
  70 % To produce the printed version of this file the following code
  71 % is used. It can be extracted with the \dst{} program, or one can run
  72 % this file directly through \LaTeXe{}.
  73 %    \begin{macrocode}
  74 %<*driver>
  75 \documentclass{ltxdoc}
  76 \begin{document}
  77 \DocInput{lthyphen.dtx}
  78 \end{document}
  79 %</driver>
  80 %    \end{macrocode}
  81 %
  82 % \changes{v0.1c}{1994/03/07}{move the 2ekernel code to ltfinal.dtx}
  83 % \changes{v1.0g}{1994/12/01}{Rename lthyphen.ltx/cfg to hyphen.ltx/cfg}
  84 % \changes{v1.0h}{1994/12/04}{Documentation edits for /1989}
  85 %
  86 % The default file |hyphen.ltx| loads hyphenation patterns for US
  87 % english.  If you want to load additional or other hyphenation
  88 % patterns, you should create a file |hyphen.cfg|. This is best done
  89 % by starting from |hyphen.ltx|.
  90 %
  91 % For backward compatibility, the default file, |hyphen.ltx|,
  92 % first tries to load
  93 % the file |hyphen.tex|. If this file exists, an information
  94 % message is issued and the appropriate defaults for \TeX's internal
  95 % parameters are set: |\language| is initialized to $0$, and
  96 % |\lefthyphenmin| and |\righthyphenmin| to $2$ and $3$, respectively,
  97 % to disallow x- or -xx breaks.
  98 %    \begin{macrocode}
  99 %<*default>
 100 \InputIfFileExists{hyphen.tex}%
 101    {\message{Loading hyphenation patterns for US english.}%
 102     \language=0
 103     \lefthyphenmin=2 \righthyphenmin=3 }%
 104 %    \end{macrocode}
 105 % Otherwise, since we cannot do anything without any hyphenation
 106 % patterns, an error message is printed and the Ini\TeX{} run
 107 % is terminated by invoking |\@@end| (which is the \LaTeXe{} name
 108 % for \TeX's |\end| primitive).
 109 %    \begin{macrocode}
 110    {\errhelp{The configuration for hyphenation is incorrectly
 111              installed.^^J%
 112              If you don't understand this error message you need
 113              to seek^^Jexpert advice.}%
 114     \errmessage{OOPS! I can't find any hyphenation patterns for
 115                 US english.^^J \space Think of getting some or the
 116                 latex2e setup will never succeed}\@@end}
 117 %</default>
 118 %    \end{macrocode}
 119 % The following example describes the possible contents of a file
 120 % |hyphen.cfg| that will load both US English and German hyphenation
 121 % patterns, making the former the default.
 122 % It sets |\language| to $0$ for the US patterns and to $1$ for the
 123 % German patterns.
 124 % Then |\language| is set to $0$ to make this the default and the
 125 % default values of |\lefthyphenmin| and |\righthyphenmin| are set.
 126 % \begin{verbatim}
 127 %\language=0
 128 %\input hyphen % (or \input ushyphen1 if the file has been renamed)
 129 %\language=1
 130 %\input ghyph31
 131 %\language=0
 132 %\lefthyphenmin=2
 133 %\righthyphenmin=3
 134 %\endinput
 135 %\end{verbatim}
 136 %
 137 % Another possibility is to use the package |babel|, by Johannes Braams.
 138 % That package is distributed with a suitable |hyphen.cfg| file.
 139 %
 140 %
 141 % \Finale
 142 %
 143 \endinput