[Tex/LaTex] mdframed with tikz method: putting line numbers outside of frame

line-numberingmdframedtikz-pgf

I want to number the lines in a mdframed environment with the line numbers appearing on the left of the frame, outside of it.

\documentclass{article}
\usepackage[framemethod=latex]{mdframed}

\newdimen\linenumbersep

\newcommand{\linenumber}[1]{%
  \linenumbersep 4pt%
  \advance\linenumbersep\mdflength{innerleftmargin}%
  \advance\linenumbersep\mdflength{innerlinewidth}%
  \advance\linenumbersep\mdflength{middlelinewidth}%
  \advance\linenumbersep\mdflength{outerlinewidth}%
  \advance\linenumbersep\mdflength{linewidth}%
  \makebox[0pt][r]{{\rmfamily\tiny#1}\hspace*{\linenumbersep}}}

\begin{document}

\ttfamily

\begin{mdframed}
\linenumber{1}(define fact\\
\linenumber{2}  (lambda (n)\\
\linenumber{3}  (if (= n 0)\\
\linenumber{4}  1\\
\linenumber{5}  (* n (fact (- n 1))))))
\end{mdframed}

\end{document}

After typesetting this document, I get

enter image description here

as expected. But when the tikz method is used for drawing the frame by changing the second line of the source document

\usepackage[framemethod=tikz]{mdframed}

the line numbers are not visible anymore, giving

enter image description here

Is it possible to make this example work with the tikz method?

I want to use something like this in a package I am writing to typeset a program listing with the help of Pygments. The line numbers would be generated automatically.

Best Answer

mdframed clips the box at the frame. But I don't know if it intended or a bug.

Edit 2017:

The problem seems to have been resolved. The patch it no longer needed.

\documentclass{article}
\usepackage[framemethod=tikz]{mdframed}


\newdimen\linenumbersep

\newcommand{\linenumber}[1]{%
  \linenumbersep 4pt%
  \advance\linenumbersep\mdflength{innerleftmargin}%
  \advance\linenumbersep\mdflength{innerlinewidth}%
  \advance\linenumbersep\mdflength{middlelinewidth}%
  \advance\linenumbersep\mdflength{outerlinewidth}%
  \advance\linenumbersep\mdflength{linewidth}%
  \makebox[0pt][r]{{\rmfamily\tiny#1}\hspace*{\linenumbersep}}}

\begin{document}

\ttfamily


\begin{mdframed}
\linenumber{1}(define fact\\
\linenumber{2}  (lambda (n)\\
\linenumber{3}  (if (= n 0)\\
\linenumber{4}  1\\
\linenumber{5}  (* n (fact (- n 1))))))
\end{mdframed}

\makeatletter
\renewrobustcmd*\mdf@tikzbox@tfl[1]{%three or four borders
    \path(0,0)rectangle(\mdfboundingboxwidth,\mdfboundingboxheight);% replace \clip by \path
    \begin{scope}[mdfcorners]%
       \clip[preaction=mdfouterline]%
            [postaction=mdfbackground]%
            [postaction=mdfinnerline]#1;%
    \end{scope}%
    \path[mdfmiddleline,mdfcorners]#1;
  }%

\begin{mdframed}
\linenumber{1}(define fact\\
\linenumber{2}  (lambda (n)\\
\linenumber{3}  (if (= n 0)\\
\linenumber{4}  1\\
\linenumber{5}  (* n (fact (- n 1))))))
\end{mdframed}    

\end{document}

code output

Related Solutions

[Tex/LaTex] mdframed with label outside of box

Update on 31st May: Modified solution based on Marco Daniel's. Incorporated his positioning of the label, and have also included a fixed text width for the label, the "right margin" and the "skip below".

My own solution is to add to the style definition of 'testframe' as follows:

enter image description here

\documentclass{article}

\usepackage[framemethod=TikZ]{mdframed}
\usepackage{lipsum}
\usetikzlibrary{calc}
\newcommand{\mdfLABEL}[1]{\node[text width=2em,align=right,anchor=north east,%
               outer sep=0pt,inner sep=0pt] at ($ (O|-P)
                    -(\the\mdflength{innerleftmargin},0)
                    -0.5*(\the\mdflength{middlelinewidth},0)
                   - (0,\the\mdflength{innertopmargin})
                   + (0,0.5pt)
                 $) {#1};}

\mdfdefinestyle{testframe}{topline=false,rightline=false,bottomline=false,%
    innerleftmargin=1em,linecolor=white,rightmargin=2em,skipbelow=1em,%
    tikzsetting={draw=black,line width=.5pt,dashed,dash pattern= on 1pt off 3pt},%
    firstextra={\mdfLABEL{(i)}},%
    singleextra={\mdfLABEL{(i)}},%
    secondextra={\mdfLABEL{$\phantom{.}$}},%
    middleextra={\mdfLABEL{$\phantom{.}$}},%
}

\begin{document}

\begin{mdframed}[style=testframe]
\lipsum[3]
\end{mdframed}

\end{document}

Note that tikz library calc has been loaded to calculate the label's coordinates. Also, a manual adjustment of +(0,0.5pt) has been made.

[Tex/LaTex] mdframed missing half the frame

Analysis

If package color is loaded a white background is drawn. The default framemethod uses the following z-order similar to \fcolorbox:

left line
top line
background
bottom line
right line

Screens have usually a low resolution, thin lines can then have a line width of one pixel only. In the direct neighborhood the white background is drawn. Then it can happen that the white background also colors the pixels of the formerly black line, a part of the black line might contain to the background area (low resolution!, rounding issues, ...).

Printers are using higher resolutions, e.g. 600 dpi. Then a line with thickness of 0.4pt (default value). That are 3.3 pixels, when printed. Then the line will not vanish, if the thickness is one pixel short.

Test file

Test file for playing and analyzing:

It makes a simple page with a frame. Fonts are not needed to keep the PDF file small.
The page layout is simplified via package geometry.
Unit is bp, the default unit for PDF (and PS). This makes it easier to understand and interpret the numbers found in the page description of the PDF file.
PDF compressions are disabled (pdflatex). Then the PDF file can be easily inspected in a text viewer or editor.

\pdfobjcompresslevel=0
\pdfcompresslevel=0

\documentclass{article}
\usepackage[
  margin=0pt,
  hmargin=10bp,
  paperwidth=100bp,
  paperheight=50bp,
]{geometry}
\setlength{\topskip}{0bp}
\pagestyle{empty}

\usepackage{xcolor}
\usepackage{mdframed}

\mdfsetup{
  linewidth=.2bp,
  innerleftmargin=0bp,
  innerrightmargin=0bp,
  innertopmargin=0bp,
  innerbottommargin=0bp,
}

\begin{document}
\vspace*{10bp}
\begin{mdframed}
\rule{0pt}{10bp}
\end{mdframed}
\end{document}

Workaround

Package mdframed provides other framemethods. With

\usepackage[framemethod=tikz]{mdframed}

the frame is drawn after the background and therefore remains visible.

Best Answer

Edit 2017:

Related Solutions

[Tex/LaTex] mdframed with label outside of box

[Tex/LaTex] mdframed missing half the frame

Analysis

Test file

Workaround

Related Question