summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/luatex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2012-04-09 16:27:33 +0000
committerKarl Berry <karl@freefriends.org>2012-04-09 16:27:33 +0000
commite4976202b9bfa904eca1c143c81ffb54fb0bba55 (patch)
treeb196ac917e1f4c9576586fda882035eee5351396 /Master/texmf-dist/doc/luatex
parentd9deba85170b8994f73e7e799dba4f3bda9f18a7 (diff)
lua-visual-debug (8apr12)
git-svn-id: svn://tug.org/texlive/trunk@25881 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/luatex')
-rw-r--r--Master/texmf-dist/doc/luatex/lua-visual-debug/README.doc26
-rw-r--r--Master/texmf-dist/doc/luatex/lua-visual-debug/lvdebug-doc.pdfbin234590 -> 307440 bytes
-rw-r--r--Master/texmf-dist/doc/luatex/lua-visual-debug/lvdebug-doc.tex28
-rw-r--r--Master/texmf-dist/doc/luatex/lua-visual-debug/lvdebugdetail1-num.pngbin0 -> 73328 bytes
-rw-r--r--Master/texmf-dist/doc/luatex/lua-visual-debug/sample-plain.pdfbin49233 -> 49145 bytes
-rw-r--r--Master/texmf-dist/doc/luatex/lua-visual-debug/sample.pdfbin143183 -> 143046 bytes
-rw-r--r--Master/texmf-dist/doc/luatex/lua-visual-debug/strut.pngbin0 -> 11445 bytes
7 files changed, 51 insertions, 3 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
Binary files differ
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
Binary files differ
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
Binary files differ
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
Binary files differ
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
Binary files differ