| 1 |
%% $Id: xevlna-inc.tex 535 2017-03-25 16:38:58Z zw $ |
| 2 |
|
| 3 |
\ifeng |
| 4 |
|
| 5 |
\section{English manual} |
| 6 |
This is a manual for “vlna” implemented in \XeTeX. It can be used in plain \XeTeX\ as well as in |
| 7 |
\XeLaTeX. |
| 8 |
|
| 9 |
\else |
| 10 |
|
| 11 |
\section{\texorpdfstring{Český manuál}{Cesky manual}} |
| 12 |
Toto je manuál balíčku „vlna“ implementovaného pomocí \XeTeX u. Lze jej použít jak pro plain |
| 13 |
\XeTeX, tak pro \XeLaTeX. |
| 14 |
|
| 15 |
\fi |
| 16 |
|
| 17 |
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 18 |
|
| 19 |
\ifeng |
| 20 |
|
| 21 |
\subsection{Purpose} |
| 22 |
The purpose of the package is to insert nonbreakable spaces (\verb:~:, in Czech \textit{vlna} or |
| 23 |
\textit{vlnka}) after nonsyllabic prepositions and single letter conjuctions directly while \TeX |
| 24 |
ing the document. The macros recognise math and verbatim by \TeX\ means. Inserting nonbreakable |
| 25 |
spaces by a preprocessor may never be fully reliable because user defined macros and environments |
| 26 |
cannot be recognised. |
| 27 |
|
| 28 |
\else |
| 29 |
|
| 30 |
\subsection{Účel} |
| 31 |
Tento balíček slouží ke vkládání nezlomitelných mezer (vlnek) za neslabičné předložky a |
| 32 |
jednopísmenné spojky přímo při \TeX ování dokumentu. Makra rozeznávají matematiku a verbatim \TeX |
| 33 |
ovými prostředky. Vkládání nezlomitelných mezer preprocesorem nikdy nemůže být naprosto |
| 34 |
spolehlivé, protože uživatelsky definovaná makra a prostředí nelze rozpoznat. |
| 35 |
|
| 36 |
\fi |
| 37 |
|
| 38 |
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 39 |
|
| 40 |
\ifeng |
| 41 |
|
| 42 |
\subsection{Installation} |
| 43 |
The package consists of the following files: |
| 44 |
\begin{itemize} |
| 45 |
\item \texttt{xevlna.sty} – put it to the directory where both \texttt{xetex} and \texttt{xelatex} |
| 46 |
expect included files, preferably \verb;texmf-dist/tex/xelatex/xevlna/; |
| 47 |
\item \texttt{xevlna.pdf} – compiled manual, put it to a directory where \texttt{texdoc} looks for |
| 48 |
documentation, preferably \verb;texmf-dist/doc/xevlna/; |
| 49 |
\item \texttt{xevlna.tex}, \texttt{xevlna-inc.tex} – source files of the manual |
| 50 |
\end{itemize} |
| 51 |
|
| 52 |
\else |
| 53 |
|
| 54 |
\subsection{Instalace} |
| 55 |
Balíček se skládá z následujících souborů: |
| 56 |
\begin{itemize} |
| 57 |
\item \texttt{xevlna.sty} – uložte jej do adresáře, kde \texttt{xetex} i \texttt{xelatex} |
| 58 |
očekávají vkládané soubory, nejlépe \verb;texmf-dist/tex/xelatex/xevlna/; |
| 59 |
\item \texttt{xevlna.pdf} – zkompilovaný návod, vložte jej do adresáře, odkud \texttt{texdoc} čte |
| 60 |
dokumentaci, nejlépe \verb;texmf-dist/doc/xevlna/; |
| 61 |
\item \texttt{xevlna.tex}, \texttt{xevlna-inc.tex} – zdrojové soubory návodu |
| 62 |
\end{itemize} |
| 63 |
|
| 64 |
\fi |
| 65 |
|
| 66 |
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 67 |
|
| 68 |
\ifeng |
| 69 |
|
| 70 |
\subsection{Usage in \texorpdfstring{\XeLaTeX}{XeLaTeX}} |
| 71 |
The package is used in \XeLaTeX\ by: |
| 72 |
|
| 73 |
\else |
| 74 |
|
| 75 |
\subsection{Použití v \texorpdfstring{\XeLaTeX u}{XeLaTeXu}} |
| 76 |
Balíček se použije v \XeLaTeX u: |
| 77 |
|
| 78 |
\fi |
| 79 |
|
| 80 |
\medskip |
| 81 |
\begin{verbatim} |
| 82 |
\usepackage{xevlna} |
| 83 |
\end{verbatim} |
| 84 |
|
| 85 |
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 86 |
|
| 87 |
\ifeng |
| 88 |
|
| 89 |
\subsection{Usage in plain \texorpdfstring{\XeTeX}{XeTeX}} |
| 90 |
The package is used in plain \XeTeX\ by: |
| 91 |
|
| 92 |
\else |
| 93 |
|
| 94 |
\subsection{Použití v plain \texorpdfstring{\XeTeX u}{XeTeXu}} |
| 95 |
V plain \XeTeX u se balíček použije takto: |
| 96 |
|
| 97 |
\fi |
| 98 |
|
| 99 |
\medskip |
| 100 |
\begin{verbatim} |
| 101 |
\input xevlna.sty |
| 102 |
\end{verbatim} |
| 103 |
|
| 104 |
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 105 |
|
| 106 |
\ifeng |
| 107 |
|
| 108 |
\subsection{Enabling and disabling} |
| 109 |
Insertion of nonbreakable spaces may be undesirable in some parts of a multilingual document. It |
| 110 |
may therefore be disabled by \cmd{xevlnaDisable} and enabled \cmd{xevlnaEnable}. Insertion is |
| 111 |
enabled by default. |
| 112 |
|
| 113 |
\else |
| 114 |
|
| 115 |
\subsection{Zapnutí a vypnutí vlnek} |
| 116 |
Vkládání vlnek může být nežádoucí v některých částech vícejazyčného dokumentu. Lze jej vypnout |
| 117 |
makrem \cmd{xevlnaDisable} a znovu zapnout makrem \cmd{xevlnaEnable}. Po načtení balíčku je |
| 118 |
vkládání vlnek zapnuto. |
| 119 |
|
| 120 |
\fi |
| 121 |
|
| 122 |
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 123 |
|
| 124 |
\ifeng |
| 125 |
|
| 126 |
\subsection{Implementation details} |
| 127 |
The package makes use of the \cmd{XeTeXinterchartoks} mechanism. New classes for prepositions and |
| 128 |
opening punctuation are allocated by \cmd{newXeTeXintercharclass}. The nonbreakable space is |
| 129 |
inserted whenever a single character belonging to the preposition class is followed by a space. It |
| 130 |
will therefore be inserted in expression \verb;o lišce; but not in expression \verb;po lišce;. The |
| 131 |
preposition itself cannot be typeset in a different font because the space is not recognised in |
| 132 |
such a case. If \verb;\textit{i} v \textbf{lese}; is |
| 133 |
entered, the nonbreakable space will be inserted after \textit{v} but not after italic \textit{i}. |
| 134 |
The text following the preposition may be in a different script. The nonbreakable space will be |
| 135 |
inserted after Czech preposition \textit{v} in: |
| 136 |
\else |
| 137 |
|
| 138 |
\subsection{Implementační detaily} |
| 139 |
V balíčku je využíván mechanismus \cmd{XeTeXinterchartoks} specifický pro \XeTeX. Pomocí příkazu \cmd{newXeTeXintercharclass} |
| 140 |
jsou alokovány nové třídy pro předložky a otevírací interpunkci. Nezlomitelná mezera (vlnka) je |
| 141 |
vložena, pokud za samostatným znakem z třídy předložek následuje mezera. Bude tedy vložena do |
| 142 |
výrazu \verb;o lišce;, ne však do výrazu \verb;po lišce;. Předložka nesmí být sázena jiným fontem. |
| 143 |
Ve výrazu \verb;\textit{i} v \textbf{lese}; bude vlnka vložena za předložku \textit{v}, ale nebude |
| 144 |
vložena za spojku \textit{i} v kurzívě. Text po předložce může býd psán i jiným písmem. Vlnka bude |
| 145 |
vložena za předložkou \textit{v}~i ve výraze: |
| 146 |
\fi |
| 147 |
v दिल्ली. |
| 148 |
|
| 149 |
\ifeng |
| 150 |
|
| 151 |
The package does not use “@” in the macro names\footnote{Usage of “@” is now needed for |
| 152 |
recognitnion of \XeTeX\ version and hence setting the correct boundary class.} in order to make it easily usable in plain \XeTeX. |
| 153 |
This brings a danger of redefining internal macros by a user. The packages defines and immediatelly |
| 154 |
consumes \cmd{next} and makes use of these internal macros: |
| 155 |
|
| 156 |
\else |
| 157 |
|
| 158 |
Balíček nepoužívá „@“ ve jménech maker\footnote{Znak „@“ je nyní nutný pro rozpoznání verze |
| 159 |
\XeTeX{}u a tudíž správnému nastavení hodnoty \emph{boundary class}.}, aby bylo usnadněno použití v plain \XeTeX u. To však |
| 160 |
přináší nebezpečí, že bude interní makro předefinováno uživatelem. Balíček definuje a okamžitě |
| 161 |
použije \cmd{next} a používá tato interní makra: |
| 162 |
|
| 163 |
\fi |
| 164 |
|
| 165 |
\begin{itemize} |
| 166 |
\item \cmd{CSopenpunctuation} |
| 167 |
\item \cmd{CSnonsyllabicpreposition} |
| 168 |
\item \cmd{CSinterchartoks} |
| 169 |
\item \cmd{CSnointerchartoks} |
| 170 |
\item \cmd{PreCSpreposition} |
| 171 |
\item \cmd{ExamineCSpreposition} |
| 172 |
\item \cmd{ProcessCSpreposition} |
| 173 |
\item \cmd{xevlnaXeTeXspace} |
| 174 |
\end{itemize} |
| 175 |
|
| 176 |
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 177 |
|
| 178 |
\ifeng |
| 179 |
\subsection{Changes} |
| 180 |
Version 1.1 reflects increased number of character classes and is backward compatible with older |
| 181 |
versions of \XeTeX. |
| 182 |
\else |
| 183 |
|
| 184 |
\subsection{Změny} |
| 185 |
Verze 1.1 bere ohled na zvýšený počet znakových tříd a je zpětně kompatibilní s předchozími verzemi |
| 186 |
\XeTeX u. |
| 187 |
\fi |
| 188 |
|
| 189 |
\ifeng |
| 190 |
\subsection{License} |
| 191 |
The package can be used and distributed according to the LaTeX Project Public License version~1.3 or later the |
| 192 |
text of which can be found at the \texttt{License.txt} or at |
| 193 |
\else |
| 194 |
|
| 195 |
\subsection{Licence} |
| 196 |
Balíček může být používán a šířen podle LaTeX Project Public License verze~1.3 nebo novější, jejíž text najdete |
| 197 |
v souboru \texttt{License.txt} nebo na |
| 198 |
\fi |
| 199 |
\url{http://www.latex-project.org/lppl.txt} |