summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/lualatex/lualatex-truncate/lualatex-truncate.dtx
blob: 69ad4b8088586669812a9fa07bca0807fbdbf933 (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
%\iffalse
%<*package>
%% \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         \~}
%</package>
%\fi
%\iffalse
% Doc-Source file to use with LaTeX2e
% Copyright (C) 2018 Sebastian Friedl
%
% This work is subject to the LaTeX Project Public License, Version 1.3c or -- at
% your option -- any later version of this license.
% The work consists of the files lualatex-truncate.dtx, lualatex-truncate.ins,
% lualatex-truncate-doc.dtx and the derived file lualatex-truncate.sty
%
% This work has the LPPL maintenance status 'maintained'.
% Current maintainer of the work is Sebastian Friedl.
%\fi
%
%
%
% \subsubsection*{Initialization}
% Identify the package and require \LaTeXe:
%    \begin{macrocode}
\ProvidesPackage{lualatex-truncate}%
    [2018/06/03 v1.0 LuaLaTeX wrapper for the truncate package]
\NeedsTeXFormat{LaTeX2e}
%    \end{macrocode}
%
%
%
% \subsubsection*{Internal variables}
% This internal variable is used to remember whether \enquote{hacking} the hyphenation character (i.e.~"\prehyphenchar") is required:
%    \begin{macrocode}
\newif\if@lualtxtruncate@hackhyphen
\@lualtxtruncate@hackhyphenfalse
%    \end{macrocode}
%
%
%
% \subsubsection*{Package options}
% The \opt{breakwords} and \opt{breakall} options require the hyphanation character to be hidden.
% Therefore, we remember to \enquote{hack} the hyphen character before passing these options
% to the original \sty{truncate} package:
%    \begin{macrocode}
\DeclareOption{breakwords}{%
    \@lualtxtruncate@hackhyphentrue
    \PassOptionsToPackage{breakwords}{truncate}}
\DeclareOption{breakall}{%
    \@lualtxtruncate@hackhyphentrue
    \PassOptionsToPackage{breakall}{truncate}}
%    \end{macrocode}
%
% \smallskip
% Pass all other options (\opt{hyphenate} and \opt{fit}) directly to the \sty{truncate} package:
%    \begin{macrocode}
\DeclareOption*{\PassOptionsToPackage{\CurrentOption}{truncate}}
%    \end{macrocode}
%
% \smallskip
% Process all options passed to \sty{lualatex-truncate}:
%    \begin{macrocode}
\ProcessOptions
%    \end{macrocode}
%
%
%
% \subsubsection*{Loading the \sty{truncate} package}
% Load the \sty{truncate} package. Required package options have already been passed on.
%    \begin{macrocode}
\RequirePackage{truncate}
%    \end{macrocode}
%
%
%
% \subsubsection*{If the document is not compiled via \hologo{LuaLaTeX}\dots}
% Don't wrap anything if the document isn't compiled by \hologo{LuaLaTeX}:
%    \begin{macrocode}
\RequirePackage{iftex}
\ifLuaTeX\else%
    \PackageWarningNoLine{lualatex-truncate}%
        {Whoops! You don't want to use LuaLaTeX?}%
    \endinput%
\fi%
%    \end{macrocode}
%
%
%
% \subsubsection*{Constructing the wrapper}
% \begin{macro}{\lualtxtruncate@truncate}
% Remember the original "\truncate" command's definition.
% Since "\truncate" provides an optional argument, "\LetLtxMacro" has to be used
% instead of the primitive "\let" command:
%    \begin{macrocode}
\RequirePackage{letltxmacro}
\LetLtxMacro\lualtxtruncate@truncate\truncate
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\truncate}
% Construct the wrapper by redefining the "\truncate" command
% and -- if necessary -- modifying "\prehyphenchar":
%    \begin{macrocode}
\renewcommand{\truncate}[3][\TruncateMarker]{%
    \if@lualtxtruncate@hackhyphen%
        \prehyphenchar=0%
    \fi%
    \lualtxtruncate@truncate[#1]{#2}{#3}%
    \if@lualtxtruncate@hackhyphen%
        \prehyphenchar=`\-%
    \fi%
}
%    \end{macrocode}
% \end{macro}
%
%
%
% \subsubsection*{Famous last words}
% Enough code for this package. "\endinput".
%    \begin{macrocode}
\endinput
%    \end{macrocode}