diff options
Diffstat (limited to 'Master/texmf-dist/source/lualatex/lualatex-truncate/lualatex-truncate-doc.dtx')
-rw-r--r-- | Master/texmf-dist/source/lualatex/lualatex-truncate/lualatex-truncate-doc.dtx | 31 |
1 files changed, 15 insertions, 16 deletions
diff --git a/Master/texmf-dist/source/lualatex/lualatex-truncate/lualatex-truncate-doc.dtx b/Master/texmf-dist/source/lualatex/lualatex-truncate/lualatex-truncate-doc.dtx index ee6b8215e82..38fb37afa4c 100644 --- a/Master/texmf-dist/source/lualatex/lualatex-truncate/lualatex-truncate-doc.dtx +++ b/Master/texmf-dist/source/lualatex/lualatex-truncate/lualatex-truncate-doc.dtx @@ -22,6 +22,8 @@ %% ------------------------------------------------------------------------------------------- %\fi +% !TeX spellcheck=en_US + \documentclass[11pt]{ltxdoc} \usepackage{iftex} @@ -46,7 +48,7 @@ \setsansfont[Scale=MatchLowercase]{Source Sans Pro} \setmonofont[Scale=MatchLowercase]{Hack} -\usepackage[left=4.50cm,right=2.75cm,top=3.25cm,bottom=2.75cm,nohead]{geometry} +\usepackage[a4paper,left=4.50cm,right=2.75cm,top=3.25cm,bottom=2.75cm,nohead]{geometry} \hyphenation{mo-dify-ing} @@ -59,7 +61,7 @@ \MakeShortVerb{"} -\CheckSum{38} +\CheckSum{55} \renewcommand*{\usage}[1]{\hyperpage{#1}} \renewcommand*{\main}[1]{\hyperpage{#1}} @@ -77,9 +79,9 @@ -\title{The \sty{lualatex-truncate} package \\ {\large\url{https://github.com/SFr682k/lualatex-truncate}}} +\title{The \sty{lualatex-truncate} package \\ {\large\url{https://gitlab.com/SFr682k/lualatex-truncate}}} \author{Sebastian Friedl \\ \href{mailto:sfr682k@t-online.de}{\ttfamily sfr682k@t-online.de}} -\date{2018/06/03 (v1.0)} +\date{2018/08/22 (v1.1)} \hypersetup{pdftitle={The lualatex-truncate package},pdfauthor={Sebastian Friedl}} @@ -93,8 +95,8 @@ \medskip \begin{abstract}\centering \hspace{-1.5em}% - This package provides a wrapper for using the \sty{truncate} package with \hologo{LuaLaTeX}% - \footnote{The \sty{truncate} package is available at \url{https://ctan.org/pkg/truncate}} + This package provides a wrapper for using the \sty{truncate} package\footnote{available at \url{https://ctan.org/pkg/truncate}}, + thus fixing issues related to \hologo{LuaTeX}'s hyphenation mechanism. \end{abstract} @@ -166,17 +168,15 @@ % DOCUMENTATION PART ---------------------------------------------------------------------- \clearpage \part{The documentation} - \subsection*{Read this section first} - \addcontentsline{toc}{subsection}{Read this section first} \begin{center} \colorbox{red!75!black}{\colorbox{white}{\begin{minipage}{.95\textwidth} \textbf{\color{red!75!black}\large Don't load the \sty{truncate} package in your preamble!!} \medskip - This task is already done for you when loading \sty{lualatex-truncate}! + This task is already done for you by \sty{lualatex-truncate}! \smallskip - Also, all package options stated in this documentation are meant to be passed to \sty{lualatex-truncate}, so they can be processed by the wrapper mechanism. + Also, all package options stated in this documentation are meant to be passed to \sty{lualatex-truncate}; otherwise they can't be processed by the wrapper mechanism. \end{minipage}}} \end{center} @@ -185,6 +185,9 @@ \footnote{This section has been adapted from \sty{truncate}'s documentation: \\ \indent\indent\url{http://mirrors.ctan.org/macros/latex/contrib/truncate/truncate.pdf}}} \addcontentsline{toc}{subsection}{Truncating text to a given width} + + \leavevmode% + \DescribeOption{\truncate}% The package defines a command "\truncate["\param{marker}"]{"\param{width}"}{"\param{text}"}". If the text is too wide to fit in the specified width, then it is truncated, and a continuation marker is shown at the end. @@ -225,12 +228,8 @@ \addcontentsline{toc}{subsection}{Known limitations} \begin{itemize} \item - \sty{lualatex-truncate} provides a \textit{wrapper} to enable using the \sty{truncate} package together with \hologo{LuaLaTeX}. - It doesn't (and won't) fix any bugs or \enquote{undocumented features} introduced by the \sty{truncate} package. - - \item - \sty{lualatex-truncate} applies some \enquote{hacking} to the hyphenation character. \\ - This might cause some problems if the hyphenation character of the currently used language is different from \enquote{\texttt{\textbackslash{}-}}. + \sty{lualatex-truncate} provides a \textit{wrapper} fixing \hologo{LuaTeX}-related \enquote{glitches} in the \sty{truncate} package. + It doesn't (and won't) fix any bugs or \enquote{undocumented features} introduced by the \sty{truncate} package itself. \end{itemize} |