lua-visual-debug (8apr12)

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

10 files changed, 58 insertions, 7 deletions

diff --git a/Master/texmf-dist/doc/luatex/lua-visual-debug/README.doc b/Master/texmf-dist/doc/luatex/lua-visual-debug/README.doc
new file mode 100644
index 00000000000..4562a507726
--- /dev/null
+++ b/Master/texmf-dist/doc/luatex/lua-visual-debug/README.doc
@@ -0,0 +1,26 @@
+The LuaTeX package 'lua-visual-debug' shows boxes, glues, kerns and
+penalties in the PDF output.
+
+Usage:
+
+LaTeX:
+
+\usepackage{lua-visual-debug}
+
+or (plain)
+
+\input lua-visual-debug.sty
+
+
+
+Requirements: The package has only been tested with LuaTeX and
+  the formats plain and LaTeX. Other formats might work as well,
+  but other engines only show a warning message.
+
+
+Copyright 2012 Patrick Gundlach (patrick@gundla.ch)
+Package version: 0.4
+Public repository: https://github.com/pgundlach/lvdebug
+Licensed under the MIT license. See the Lua file for details.
+The idea is heavily inspired by Hans Hagen's http://pragma-ade.com/articles/art-visi.pdf
+
diff --git a/Master/texmf-dist/doc/luatex/lua-visual-debug/lvdebug-doc.pdf b/Master/texmf-dist/doc/luatex/lua-visual-debug/lvdebug-doc.pdf
index cfc68665c85..1e95f49a4b6 100644
--- a/Master/texmf-dist/doc/luatex/lua-visual-debug/lvdebug-doc.pdf
+++ b/Master/texmf-dist/doc/luatex/lua-visual-debug/lvdebug-doc.pdf
diff --git a/Master/texmf-dist/doc/luatex/lua-visual-debug/lvdebug-doc.tex b/Master/texmf-dist/doc/luatex/lua-visual-debug/lvdebug-doc.tex
index 27000645d54..9ed5397d4cd 100644
--- a/Master/texmf-dist/doc/luatex/lua-visual-debug/lvdebug-doc.tex
+++ b/Master/texmf-dist/doc/luatex/lua-visual-debug/lvdebug-doc.tex
@@ -1,5 +1,6 @@
 \documentclass{article}
-\usepackage{graphicx,listings,lmodern,luatextra}
+\usepackage{graphicx,listings,lmodern,luatextra,dtklogos}
+\newcommand\pkgversion{0.4}
 
 \newcommand*\pgsmall{\fontsize{8.5}{8.7}\selectfont\ttfamily}
 \lstset{basicstyle=\pgsmall,
@@ -12,17 +13,19 @@
 }
 
 \begin{document}
-\title{The lua-visual-debug package (V0.3)}
+\title{The lua-visual-debug package (V\pkgversion)}
 \author{Patrick Gundlach}
 % \address{patrick@gundla.ch}
 \maketitle
+
+\tableofcontents
 \section{About}
 
 This package aids debugging your \TeX\ and \LaTeX\ document by drawing rectangles around boxes and rules where glue is inserted. Other items are marked as well: kerns, hyphenation points and penalties.
 
 \section{How to use}
 
-When you load the package \texttt{lua-visual-debug} in your \LuaLaTeX\ document (or use \verb|\input lua-visual-debug.sty| in plain \TeX), Lua\TeX\ will highlight boxes, penalties, glues and kerns in the PDF. This package requires you to process the document with \LaTeX\ (plain and LaTeX formats).
+When you load the package \texttt{lua-visual-debug} in your \LuaLaTeX\ document (or use \verb|\input lua-visual-debug.sty| in plain \TeX), \LuaTeX\ will highlight boxes, penalties, glues and kerns in the PDF. This package requires you to process the document with \LuaTeX\ (plain and \LaTeX formats).
 
 \section{A \LaTeX\ example}
 \lstinputlisting[language=tex]{sample.tex}
@@ -39,6 +42,25 @@ When you load the package \texttt{lua-visual-debug} in your \LuaLaTeX\ document
 
 \noindent \includegraphics{sample-plain-crop.pdf}
 
+\section{How to interpret the markers} % (fold)
+\label{sec:how_to_interpret_the_markers}
+
+\noindent\includegraphics[width=.9\textwidth]{lvdebugdetail1-num}
+\begin{enumerate}
+	\item A vertical glue. Beginning and end are marked with a small tick. At the mark 1, two vertical glues are connected.
+\item A horizontal glue.
+\item A negative kern. Positive kerns are yellow.
+\item A possible hyphenation point.
+\item Horizontal and vertical boxes are drawn with a border.
+\item Penalties are marked with a square. A penalty of 10,000 is marked with a blank square, a penalty less than 10,000 is filled with a gray square (that will improve in the future, currently it is grayness of penalty / 10000).
+\end{enumerate}
+
+A strut box (zero width box) is marked with a red rule:
+
+\noindent\includegraphics[scale=0.8]{strut}
+
+% section how_to_interpret_the_ (end)
+
 
 \section{Copying}
 
diff --git a/Master/texmf-dist/doc/luatex/lua-visual-debug/lvdebugdetail1-num.png b/Master/texmf-dist/doc/luatex/lua-visual-debug/lvdebugdetail1-num.png
new file mode 100644
index 00000000000..4c5fa553f8c
--- /dev/null
+++ b/Master/texmf-dist/doc/luatex/lua-visual-debug/lvdebugdetail1-num.png
diff --git a/Master/texmf-dist/doc/luatex/lua-visual-debug/sample-plain.pdf b/Master/texmf-dist/doc/luatex/lua-visual-debug/sample-plain.pdf
index f3632746021..c5c7afb2943 100644
--- a/Master/texmf-dist/doc/luatex/lua-visual-debug/sample-plain.pdf
+++ b/Master/texmf-dist/doc/luatex/lua-visual-debug/sample-plain.pdf
diff --git a/Master/texmf-dist/doc/luatex/lua-visual-debug/sample.pdf b/Master/texmf-dist/doc/luatex/lua-visual-debug/sample.pdf
index a649aa706d4..19f25382ed9 100644
--- a/Master/texmf-dist/doc/luatex/lua-visual-debug/sample.pdf
+++ b/Master/texmf-dist/doc/luatex/lua-visual-debug/sample.pdf
diff --git a/Master/texmf-dist/doc/luatex/lua-visual-debug/strut.png b/Master/texmf-dist/doc/luatex/lua-visual-debug/strut.png
new file mode 100644
index 00000000000..c7cd0176afa
--- /dev/null
+++ b/Master/texmf-dist/doc/luatex/lua-visual-debug/strut.png
diff --git a/Master/texmf-dist/tex/luatex/lua-visual-debug/lua-visual-debug.lua b/Master/texmf-dist/tex/luatex/lua-visual-debug/lua-visual-debug.lua
index af2f02c93e1..8d600a74bfb 100644
--- a/Master/texmf-dist/tex/luatex/lua-visual-debug/lua-visual-debug.lua
+++ b/Master/texmf-dist/tex/luatex/lua-visual-debug/lua-visual-debug.lua
@@ -1,5 +1,6 @@
 -- Copyright 2012 Patrick Gundlach, patrick@gundla.ch
 -- Public repository: https://github.com/pgundlach/lvdebug (issues/pull requests,...)
+-- Version: 0.4
 
 -- 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,
@@ -18,7 +19,7 @@
 module(...,package.seeall)
 
 -- There are 65782 scaled points in a PDF point
--- Therefore we need to devide all TeX lengths by
+-- Therefore we need to divide all TeX lengths by
 -- this amount to get the PDF points.
 local number_sp_in_a_pdf_point = 65782
 
diff --git a/Master/texmf-dist/tex/luatex/lua-visual-debug/lua-visual-debug.sty b/Master/texmf-dist/tex/luatex/lua-visual-debug/lua-visual-debug.sty
index 7479e0fc6b9..49636ac10c1 100644
--- a/Master/texmf-dist/tex/luatex/lua-visual-debug/lua-visual-debug.sty
+++ b/Master/texmf-dist/tex/luatex/lua-visual-debug/lua-visual-debug.sty
@@ -1,11 +1,13 @@
-% Version: 0.3
 % see lua file for copyright information (MIT License)
 
+\def\lvdebugpkgdate{2012/04/06}
+\def\lvdebugpkgversion{0.4}
+
 \expandafter\ifx\csname ProvidesPackage\endcsname\relax
   \input ifluatex.sty\relax
 \else
   \NeedsTeXFormat{LaTeX2e}
-  \ProvidesPackage{lua-visual-debug}[2012/02/24 v0.3 Visual debugging in LuaLaTeX (PGU)]
+  \ProvidesPackage{lua-visual-debug}[\lvdebugpkgdate\space v\lvdebugpkgversion\space Visual debugging in LuaLaTeX (PGU)]
   \RequirePackage{ifluatex}
 \fi
 
diff --git a/Master/tlpkg/libexec/ctan2tds b/Master/tlpkg/libexec/ctan2tds
index 004062839ec..1f17168536a 100755
--- a/Master/tlpkg/libexec/ctan2tds
+++ b/Master/tlpkg/libexec/ctan2tds
@@ -511,10 +511,10 @@ chomp ($Build = `cd $Master/../Build/source && pwd`);
  'ltablex',		"die 'skipping, unknown license'",
  'ltnews',		"die 'skipping, nonfree doc'",
  'ltt',		"&MAKEltt",
- 'ltxbase',	"&MAKEbase",
  'ltxfileinfo',	"die 'skipping, Ruby, not self-locating'",
  'ltxmisc',	"die 'skipping, too complicated, sorry'",
  'ltxtable',	"die 'skipping, use carlisle'",
+ 'lua-visual-debug',	"&MAKEflatten",
 # 'luaindex',	"die 'skipping, try again when 2011 luatex is in'",
  'luapersian',	"&MAKEflatten",
  'lucida',	"die 'skipping, nonfree font'",