summaryrefslogtreecommitdiff
path: root/macros/luatex/latex/showhyphens/showhyphens-doc.tex
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/luatex/latex/showhyphens/showhyphens-doc.tex
Initial commit
Diffstat (limited to 'macros/luatex/latex/showhyphens/showhyphens-doc.tex')
-rw-r--r--macros/luatex/latex/showhyphens/showhyphens-doc.tex102
1 files changed, 102 insertions, 0 deletions
diff --git a/macros/luatex/latex/showhyphens/showhyphens-doc.tex b/macros/luatex/latex/showhyphens/showhyphens-doc.tex
new file mode 100644
index 0000000000..0ec2875290
--- /dev/null
+++ b/macros/luatex/latex/showhyphens/showhyphens-doc.tex
@@ -0,0 +1,102 @@
+\documentclass{ltxdockit}
+\usepackage{dtklogos,csquotes,graphicx}
+
+\newcommand\pkgversion{0.5c}
+
+\titlepage{%
+ title={The showhyphens package},
+ subtitle={Show all possible hyphenation points},
+ url={(none yet)},
+ author={Patrick Gundlach},
+ email={patrick@gundla.ch},
+ revision={\pkgversion},
+ date={\today}}
+
+\begin{document}
+\printtitlepage
+\tableofcontents
+
+\section{Documentation}
+
+When you load the package \texttt{showhyphens} in your Lua\LaTeX\ document, \LaTeX\ will show all possible hyphenation points. This
+package requires you to process the document with Lua\LaTeX.
+
+\begin{verbatim}
+\documentclass{article}
+\usepackage{showhyphens}
+
+\begin{document}
+A wonderful serenity has taken
+possession of my entire soul, like these
+sweet mornings of spring which I enjoy
+with my whole heart. I am alone, and
+feel the charm of existence in this
+spot, which was created for the bliss of
+souls like mine. I am so happy, my dear
+friend, so absorbed in the exquisite
+sense of mere tranquil existence, that I
+neglect my talents. I should be
+incapable of drawing a single stroke at
+the present moment; and yet I feel that
+I never was a greater artist than now.
+\end{document}
+\end{verbatim}
+
+yields \vspace{5mm}
+
+\noindent \includegraphics{showhyphens-sample}
+
+\section{Bugs and limitations}
+
+% see http://tex.stackexchange.com/q/268884
+Hyphenation points within ligatures cannot be shown correctly. The package marks the ligature with a horizontal bar on top. The hyphenation point is somewhere within the ligature.
+For example \enquote{office} gives the word \enquote{office} with a horizontal bar on top of \enquote{ffi} but should show of'fice instead.
+While it is possible to look inside
+the ffi ligature and find out where the original hyphen character was placed
+(between the first f and the following component fi), it is very hard to draw
+the line indicating the hyphenation point correctly. The ffi ligature is one
+opaque rectangle to the package. Drawing a line at the correct position is
+pure luck, and therefore out of the scope of the package.
+
+\section{Options}
+
+\begin{optionlist}
+\legitem{blue}{Shows hyphenation marker in blue, instead of red.}
+\end{optionlist}
+
+
+\section{Changes}
+
+\begin{changelog}
+\begin{release}{0.5c}{2016-02-19}
+ \item Remove viz-nodelist
+\end{release}
+\begin{release}{0.5b}{2016-02-05}
+ \item Fix version number
+\end{release}
+\begin{release}{0.5a}{2016-02-05}
+ \item Remove debug message
+\end{release}
+\begin{release}{0.5}{2016-02-05}
+ \item Mark ligatures
+\end{release}
+\begin{release}{0.4a}{2015-09-23}
+ \item Documentation update.
+\end{release}
+\begin{release}{0.4}{2015-09-22}
+ \item Document limitation on ligatures.
+\end{release}
+\begin{release}{0.3}{2014-07-30}
+ \item Internal changes (node structure corrected, node ids not hard coded)
+\end{release}
+\begin{release}{0.2}{2012-10-25}
+ \item New option \enquote{blue}, thanks go to Herbert Vo\ss.
+\end{release}
+\end{changelog}
+
+\section{Copying}
+
+Copyright 2011-2016 Patrick Gundlach (patrick@gundla.ch), licensed under the MIT license. See the style for details.
+
+
+\end{document}