summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/lualatex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2015-09-22 22:28:59 +0000
committerKarl Berry <karl@freefriends.org>2015-09-22 22:28:59 +0000
commit92ce2c7b7e6d80754558123f1023824e3b99ab5a (patch)
treec43481a2fe89b2227722aa2596887d24db8c0c3c /Master/texmf-dist/doc/lualatex
parent8e5c104f9dd76f86ca2ec12abcf854694bb5ed1d (diff)
showhyphens (22sep15)
git-svn-id: svn://tug.org/texlive/trunk@38441 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/lualatex')
-rw-r--r--Master/texmf-dist/doc/lualatex/showhyphens/README2
-rw-r--r--Master/texmf-dist/doc/lualatex/showhyphens/showhyphens-doc.pdfbin67382 -> 81844 bytes
-rw-r--r--Master/texmf-dist/doc/lualatex/showhyphens/showhyphens-doc.tex53
3 files changed, 50 insertions, 5 deletions
diff --git a/Master/texmf-dist/doc/lualatex/showhyphens/README b/Master/texmf-dist/doc/lualatex/showhyphens/README
index 1305b5cdc6f..41d0b060fd3 100644
--- a/Master/texmf-dist/doc/lualatex/showhyphens/README
+++ b/Master/texmf-dist/doc/lualatex/showhyphens/README
@@ -7,5 +7,5 @@ Usage:
Requirements: The package only works with LuaLaTeX.
-Copyright 2011 Patrick Gundlach (patrick@gundla.ch),
+Copyright 2011-2015 Patrick Gundlach (patrick@gundla.ch),
licensed under the MIT license. See the style for details.
diff --git a/Master/texmf-dist/doc/lualatex/showhyphens/showhyphens-doc.pdf b/Master/texmf-dist/doc/lualatex/showhyphens/showhyphens-doc.pdf
index a267772d9e1..f5da2d56113 100644
--- a/Master/texmf-dist/doc/lualatex/showhyphens/showhyphens-doc.pdf
+++ b/Master/texmf-dist/doc/lualatex/showhyphens/showhyphens-doc.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/lualatex/showhyphens/showhyphens-doc.tex b/Master/texmf-dist/doc/lualatex/showhyphens/showhyphens-doc.tex
index 1b85d473d9e..27b3656af71 100644
--- a/Master/texmf-dist/doc/lualatex/showhyphens/showhyphens-doc.tex
+++ b/Master/texmf-dist/doc/lualatex/showhyphens/showhyphens-doc.tex
@@ -1,8 +1,21 @@
-\documentclass{article}
-\usepackage{graphics}
-\newcommand\LuaLaTeX{Lua\LaTeX}
+\documentclass{ltxdockit}
+\usepackage{dtklogos,csquotes,graphicx}
+
+\newcommand\pkgversion{0.4}
+
+\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 \LuaLaTeX\ document, \LaTeX\ will show all possible hyphenation points. This
@@ -33,9 +46,41 @@ yields \vspace{5mm}
\noindent \includegraphics{showhyphens-sample}
+\section{Bugs and limitations}
+
+% see http://tex.stackexchange.com/q/268884
+Ligatures will give incorrect results. For example \enquote{office} gives:
+offi'ce but should show of'ffice 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 rectancgle 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.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 Patrick Gundlach (patrick@gundla.ch), licensed under the MIT license. See the style for details.
+Copyright 2011-2014 Patrick Gundlach (patrick@gundla.ch), licensed under the MIT license. See the style for details.
\end{document}