draftinputlines-man.tex

\documentclass{scrartcl}
\usepackage[
headfootpackage=scrpage,
hijackboth=true,
dilinputfiles=true,
inputfilesrule=false,
]{draftinputlines}
\usepackage{listings}
\lstloadlanguages{[LaTeX]TeX} 
\lstset{% 
    basicstyle=\ttfamily, 
    commentstyle=\itshape\ttfamily\small, 
    showspaces=false, 
    showstringspaces=false, 
    breaklines=true, 
    breakautoindent=true, 
    captionpos=t,
    frame=single,
    escapeinside={(*}{*)},
} 
\lstMakeShortInline{|}
\usepackage{enumitem}
\setdescription{font=\ttfamily,leftmargin=4em}

\begin{document}
%\def\dilfont{\sffamily}

\section{Introduction}


This package adds the input lines of various parts of your LaTeX
document as marginpars.
It can also add the first and last input lines read to the header and
footer respectively.

The marginpars float, and I can't guarantee they'll be entirely
accurate if lots are bunched together.
Also, the begin and end page numbers might not be totally accurate.
But they're still useful (I hope).

The numbers that float with tables and the like do not float, so they
will overlap other numbers in some circumstances.
This should be rare since floats should have their own space.

\section{Examples}
\input{inputfile}

\section{Options}
Here are the options that are currently defined and a description of
what they do.

\paragraph{\lstinline+headfootpackage+}
This sets what package is used to do the headers and footers.

Set it to whatever is setting the headers and footers in your
document.
The options are:
\begin{description}[labelindent=1cm]
\item[scrpage] Uses KOMA script's |scrpage2|
\item[fancyhdr] Uses |fancyhdr|
  % These options don't currently work.
  % Genuinely not sure I can be bothered writing them.
% \item[memoir] Uses |memoir|. 
%   Coming soon.
% \item[plain] Use the plain TeX macros. 
%   Coming soon.
\end{description}

\paragraph{\lstinline+inputlineshead,inputlinesfoot,filenamehead,filenamefoot+}

These options print the line number and file name at the start of the
page at the top and the end of the page at the bottom. 
The options available are the same for both, though they can be set separately. 
They are:
\begin{description}[labelindent=1cm]
\item[inside] Print number on the inside (same as |left| for onesided
  documents)
\item[outside] Print number on the outside (same as |right| for
  onesided documents)
\item[center] Print number on in the center
\item[left] Print number on the left
\item[right] Print number on the right
\item[off] Don't print the numbers
\end{description}

They aren't necessarily 100\% accurate given the asynchronous way that
the page builder works, but they are probably good enough for most purposes.

\paragraph{\lstinline+dilfont+}

All the input line numbers and file names are formatted with |\dilfont|.
The default is |\ttfamily\small|.
It can be redefined as normal:
|\def\dilfont{\small\sffamily}| for example would make the numbers
appear sans serif.

\paragraph{\lstinline+environmentline+}

This option takes a list of environment names.
Those environments listed will then print the line number where they
start.
This is only necessary in |safemode| (see below).

\paragraph{Switches}

The following is a list of Boolean (true/false) options and what they
control.
\begin{description}
\item[dilinputfiles] Prints the name and input line number of files
  included with |\input| and |\include|.
\item[dilinputfilesrule] Prints rules above the start and below the
  end of an included file, so it's obvious where in the page it starts
  and ends.
  If |dilinputfiles| is false, this doesn't do anything.
\item[graphicsfilename] Prints the name of files added with
  |\includegraphics| in the opposite margin to the page numbers.
  Load |graphicx| \emph{before} |draftinputlines| for this to work.
\item[hijackheaders,hijackfooters,hijackboth] These are just a quick
  way to set the headers and footers to output input line information.
\item[safemode] The way this package works is to hook into the
  paragraph mechanism with the |everyhook| package.
  This isn't always a good idea since paragraphs are used for all
  sorts of random stuff.
  So if the package breaks, try safe mode. 
  Fewer line numbers, but it should be more robust.
\item[sectionline] Determines whether each section will print the line
  it is printed on.
\end{description}




\end{document}

%%% Local Variables: 
%%% mode: latex
%%% TeX-master: t
%%% End: