showhyphens (22sep15)

git-svn-id: svn://tug.org/texlive/trunk@38441 c570f23f-e606-0410-a88d-b1316a301751

4 files changed, 67 insertions, 12 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
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}
diff --git a/Master/texmf-dist/tex/lualatex/showhyphens/showhyphens.sty b/Master/texmf-dist/tex/lualatex/showhyphens/showhyphens.sty
index 849164d8b10..2d6f35bc0c8 100644
--- a/Master/texmf-dist/tex/lualatex/showhyphens/showhyphens.sty
+++ b/Master/texmf-dist/tex/lualatex/showhyphens/showhyphens.sty
@@ -1,32 +1,42 @@
-\ProvidesPackage{showhyphens}[2011/09/12 v0.1 Show hyphenation points (PGU)]
+\ProvidesPackage{showhyphens}[2015/09/22 v0.4 Show hyphenation points (PGU)]
 \RequirePackage{ifluatex,luatexbase}
 % License: MIT style license
 
-% Copyright (c) 2011 Patrick Gundlach patrick@gundla.ch
+% Copyright (c) 2011-2015 Patrick Gundlach patrick@gundla.ch
 
 % Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the
 % "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge,
 % publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do
 % so, subject to the following conditions:
-% 
+%
 % The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-% 
+%
 % THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 % MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
 % FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 % WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+\def\lua@SHcolor{1 0 0}% red
+\DeclareOption{blue}{\def\lua@SHcolor{0 0 1 }}% must be a rgb color
+\ProcessOptions
+
 \ifluatex
 \directlua{
+local show_hyph
+local hlist_node = node.id("hlist")
+local vlist_node = node.id("vlist")
+local disc_node = node.id("disc")
+
 show_hyph = function(head)
   while head do
-    if head.id == 0 or head.id == 1 then % hlist, vlist
+    if head.id == hlist_node or head.id == vlist_node then
       show_hyph(head.head)
-    elseif head.id == 7 then             % disc
+    elseif head.id == disc_node then
       local n = node.new("whatsit","pdf_literal")
       n.mode = 0
-      n.data = "q 1 0 0 RG  0.3 w 0 2 m 0 7 l S Q"
+      n.data = "q \lua@SHcolor RG 0.3 w 0 2 m 0 7 l S Q"
       n.next = head.next
+      head.next.prev = n
       n.prev = head
       head.next = n
       head = n