diff options
author | Karl Berry <karl@freefriends.org> | 2012-04-09 16:27:33 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2012-04-09 16:27:33 +0000 |
commit | e4976202b9bfa904eca1c143c81ffb54fb0bba55 (patch) | |
tree | b196ac917e1f4c9576586fda882035eee5351396 /Master/texmf-dist/doc/luatex/lua-visual-debug/lvdebug-doc.tex | |
parent | d9deba85170b8994f73e7e799dba4f3bda9f18a7 (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/lua-visual-debug/lvdebug-doc.tex')
-rw-r--r-- | Master/texmf-dist/doc/luatex/lua-visual-debug/lvdebug-doc.tex | 28 |
1 files changed, 25 insertions, 3 deletions
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} |