summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/mdframed/mdframed-doc-en.tex
blob: fb041fc1032b217075dac74ddde69aa992afe62f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
%Documenation of the package mdframed
%%$Id: mdframed-doc-en.tex 188 2011-09-07 10:32:16Z marco $
%%$Rev: 188 $
%%$Author: marco $
%%$Dater:$
%% [latex -> ps -> pdf]
\setcounter{errorcontextlines}{999}
\documentclass[english,11pt,]{scrartcl}
%\usepackage{showframe}
\usepackage[nofancy,draft,notoday]{svninfo}
\svnInfo $Id: mdframed-doc-en.tex 188 2011-09-07 10:32:16Z marco $
\usepackage{babel}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage{lipsum}
\usepackage[T1,altbullet]{lucidabr}
\usepackage[scaled=0.82]{beramono}  
%\usepackage{libertine}
\usepackage{microtype}
\usepackage[french=quotes]{csquotes}
%\let\glqq\flqq
%\let\grqq\frqq
\let\grqq\grqq

\usepackage{scrpage2}
\clearscrheadfoot
\pagestyle{scrheadings}
\automark[subsection]{section}
\renewcommand{\sectionmark}[1]{\markboth{\sectionmarkformat #1}{}}%
\renewcommand{\subsectionmark}[1]{\markright{\subsectionmarkformat #1}} %nur Titel ohne Nr.
\ihead{\rightmark}
\ohead{\leftmark}
\ofoot{\pagemark} 
\ifoot{\svnId}


\usepackage[left=5cm,right=3cm,top=3cm,bottom=2cm]{geometry}


\usepackage{xcolor}
\definecolor{titleblue}{rgb}{0,0,0.9}

\usepackage{amsmath}
\usepackage[amsmath]{ntheorem}

\usepackage[]{graphicx}

\usepackage[style=1,]{mdframed}


\usepackage{xspace}
\usepackage{multicol}
\columnseprule0.4pt


\usepackage{listings}
\lstset{keywordstyle=\bfseries}
\lstnewenvironment{mdexample}[1][]
  {\lstset{%
     basicstyle=\small\ttfamily,
     language={[LaTeX]TeX},
     basicstyle=\small,%
     xleftmargin=20pt,%
     xrightmargin=20pt,%
     frame=single,%
     rulecolor=\color{titleblue},%
     framesep=5pt,%
     framerule=1pt,%
     texcsstyle=*\color{red!50!black}\bfseries,
     moretexcs=intertext,
     keywordstyle=\color{blue!60!black}\bfseries,%
     columns=fixed,%
     fontadjust=true,%
     basewidth=0.65em,%
     breakatwhitespace=true,
     morekeywords=[2]{@length},
     keywordstyle=[2]\color{red!50!black}\bfseries,
     morekeywords={outerlinewidth,leftmargin,rightmargin,backgroundcolor,%
                   outerlinecolor,innertopmargin,splittopskip,skipbelow,%
                   skipabove,ntheorem,theorem,lemma,mdframed,linecolor,%
                   frametitle,infobox,innerlinewidth,roundcorner,leftline,topline,%
                   splitbottomskip,middlelinewidth,middlelinecolor,tikzsetting,%
                   rightline,bottomline,innerrightmargin,style,linewidth,lem,section},%
     moretexcs={newmdtheoremenv,newmdenv,theoremstyle,mdfsetup,@length,%
                   md@putbox@single,@tempboxa,mdf@,%
                   mdf@linewidth,mdf@leftmargin@length,interruptlength,%
                   setlength,newrobustcmd,overlaplines,appto,md@frame@leftline@singe,%
                   color,md@frame@leftline@single,mdf@innerbottommargin@length,%
                   mdf@middlelinewidth@length,mdfboundingboxheight,%
                   md@frame@rightline@single,mdfboundingboxwidth,%
                   mdf@innerrightmargin@length},
     #1,
   }%
  }%
%  morekeywords={\usepackage,\end,\begin,\lipsum,\documentclass,\newtheorem,\newenvironment,\section,\label\mbox{ }}%
  {}

\makeatletter
\begingroup
  \text@command\relax
  \global\let\xspace@check@icr\check@icr
\endgroup
\xspaceaddexceptions{\xspace@check@icr}

\renewcommand\tableofcontents{%
\setcounter{tocdepth}{2}%
 \begin{multicols}{2}[\centering\textbf{\sffamily\Large\contentsname}]
        \@starttoc{toc}
 \end{multicols}
}
\makeatother
\newcommand*\mdoption[1]{\textsf{\bfseries\color{titleblue}#1}}
\newcommand*\mdname{\textsf{mdframed}\xspace}
\newcommand*\mdpack[1]{\textsf{#1}\xspace}
\newcommand*\mdsetting[1]{\textsf{#1}\xspace}
\newcommand*\mdcommand[1]{\texttt{\textbackslash #1}\xspace}

\newcommand*\mdDescribeMacro[2][]{\par\kern\baselineskip%
                                   \noindent\llap{%
                                   \textsf{\bfseries\color{titleblue}#2}%
                                   \quad}\mdDefault{#1}\ignorespaces}
\newcommand*{\mdDefault}[1]{%
 \ifx\relax#1\relax\else\marginpar{\small\mdsetting{default=#1}}\fi}

\newcommand*\mdDescribeCmd[2][]{\par\kern\baselineskip%
                                   \noindent\llap{%
                                   \textsf{\bfseries\color{titleblue}\textbackslash #2}%
                                   \quad}{#1}\ignorespaces}

 \usepackage{pst-node}
 \usepackage{pstricks-add}

\usepackage{hyperref}
\hypersetup{%
breaklinks=true,
pdftitle={Documenation of mdframed},%
pdfauthor={Marco Daniel},%
colorlinks=true,%
linkcolor=titleblue,
urlcolor=cyan,
bookmarksdepth=4,
}
%\usepackage{showframe}

\newmdtheoremenv[linecolor=red]{lemma}{Lemma}[section]

\begin{document}
\thispagestyle{empty}
\begin{center}
  \color{titleblue}
   \Large\bfseries \sffamily The \mdname package\footnote{Extending the package \texttt{framed.sty}.}
  
    \vspace*{0.5\baselineskip}
     \normalfont\large\normalcolor auto-split frame environment
     
     \vspace*{.5\baselineskip}
      \href{mailto:marco.daniel@mada-nada.de}{Marco Daniel}%
       \footnote{With thanks to Heiko Oberdiek, Rolf Niepraschk,
                 Martin Scharrer and Herbert Voss.\newline Sorry for bad English.},
     \href{mailto:marco.daniel@mada-nada.de}{Elke Schubert}%
        \qquad \mdversion\ \qquad \today
\end{center}
\begin{abstract}
The standard methods for framing text (\mdcommand{fbox} or \mdcommand{fcolorbox}) require you to handle page breaks by hand, meaning that you have to split the \mdcommand{fbox} into two. The present package defines the environment \mdname which automatically deals with pagebreaks in framed text.\par
By using \mdcommand{newenvironment} the user may choose between several individual designs.
\end{abstract}
\pdfbookmark[1]{\contentsname}{tocbook}
\tableofcontents

\section{Motivation}
Many users wish to (further) emphasize lemmata, definitions, proofs, etc. The package \mdname allows you to create environments with breakable frames. I think an example is the best way to demonstrate its properties.
\begin{mdexample}
\newmdtheoremenv[outerlinewidth=2,leftmargin=40,
    rightmargin=40,backgroundcolor=yellow,%
    outerlinecolor=blue,innertopmargin=0pt,%
    splittopskip=\topskip,skipbelow=\baselineskip,%
    skipabove=\baselineskip,ntheorem]{theorem}%
    {Theorem}[section]
\begin{theorem}[Pythagorean theorem]
...
\end{theorem}
\end{mdexample}

%\newtheorem{mdtheorem}{Theorem}[section]
\newmdtheoremenv[outerlinewidth=2,leftmargin=40,rightmargin=40,%
    backgroundcolor=yellow,outerlinecolor=blue,innertopmargin=0pt,%
    splittopskip=\topskip,skipbelow=\baselineskip,%
    skipabove=\baselineskip,ntheorem]{theorem}{Theorem}[section]

\begin{theorem}[Pythagorean theorem]
 In any right triangle, the area of the square whose side is the hypotenuse
 is equal to the sum of the areas of the squares whose sides are the two legs.
 
\[ a^2+b^2=c^2 \]
\end{theorem}

\section{Syntax}\label{sec:syntax}
The package itself loads the packages \mdpack{kvoptions}, \mdpack{etoolbox}, \mdpack{calc} and \mdpack{color}.
By setting the correct options \mdpack{mdframed} will load \mdpack{xcolor}, \mdpack{tikz} or \mdpack{pstricks}.

Load the package as usual:
\begin{mdexample}
 \usepackage[<GLOBAL OPTIONS>]{mdframed}
\end{mdexample}

The package defines only one environment with the following syntax:
\begin{mdexample}
 \begin{mdframed}[<LOCAL OPTIONS>]
    <CONTENT>
 \end{mdframed}
\end{mdexample}

With version 0.8 you have two commands to create environments with \mdpack{mdframed}.

\par\kern\baselineskip%
\noindent\llap{\textsf{\bfseries\color{titleblue}autodetecting floats}\quad}\ignorespaces
With version 0.9 I added a detection of \mdpack{float} or \mdpack{minipage} environments. If you use \mdname in such an environment \mdname will use the option \mdoption{nobreak} automaticlly. 

\mdDescribeCmd[]{newmdenv} The command has the following syntax:
\begin{mdexample}
\newmdenv[<MDFRAMED OPTIONS>]{Name of the environment}
\end{mdexample}
In this way you can simply use:
\begin{mdexample}
 \newmdenv[linecolor=red,frametitle=Infobox]{infobox}
 ...
 \begin{infobox}[backgroundcolor=yellow]
  foo   foo   foo   foo   foo   foo 
 \end{infobox}
\end{mdexample}
\mdDescribeCmd[]{renewmdenv} By using this command you can redifine environments which are created by \mdcommand{newmdenv}.

\mdDescribeCmd[]{newmdtheoremenv} 
Since the package is often used to highlight theorem environments, I have created a command\footnote{Thanks to Martin Scharrer:\newline \href{http://tex.stackexchange.com/questions/26298/own-command-to-create-new-environment}{Own command to create new environment}} to simplify this process. The command has the following syntax:

\begin{mdexample}[deletekeywords={mdframed}]
\newmdtheoremenv[<mdframed-options>]{<envname>}%
                [<numberedlike>]{<caption>}[<within>]
\end{mdexample}
The last four arguments are equivalent to the command \mdcommand{newtheorem}. Only the first optional argument is able to pass \mdpack{mdframed}-options. A simple example is:
\begin{mdexample}
\theoremstyle{<some style>}
\newmdtheoremenv[linecolor=blue]{lemma}%
                {Lemma}[section]
... 
\begin{lemma}[Some title]
  foo   foo   foo   foo   foo   foo
\end{lemma}
\end{mdexample}
So far there is no \mdcommand{renewmdtheoremenv}!


\section{Options}
The package allows the following global and local options:

\subsection{Global Options}
The following options are only global options.

\mdDescribeMacro[none]{xcolor}
By setting this key, the package \mdpack{xcolor} will
be loaded with the given value(s). Without any value \mbox{\mdname} loads
the package \mdpack{color} without any options.

\mdDescribeMacro[0]{style} 
With this key you can change the way frames are drawn. By using
\mdoption{style=0} the frames are drawn by the \LaTeX-command \mdcommand{rule}.
By setting the key to \mdoption{style=1} the package
\mdpack{tikz} will draw the frames. By setting the key to \mdoption{style=3} the
package \mdpack{pstricks} will draw the frames. The manipulation of the frames
depends on the \mdoption{style}. For further information see below.


\subsection{Global and Local Options}
The options listed below can be set globally or locally.
\mdDescribeMacro{\textbackslash mdfsetup}To set the options globally
you can use the optional argument of \mdcommand{usepackage} or
you can use the command \mdcommand{mdfsetup} which is not limited to the preamble.

\subsubsection{Options with lengths}

In figure \eqref{fig:laengen} you can see the adjustable lengths which will be described below. 
All lengths accept two kinds of input. The first one is a length (e.g. 2pt) and
the second one is a number (e.g. 2) which will be multiplied by \mdoption{1 defaultunit}.
\mdDescribeMacro[pt]{defaultunit} see the sentence above.

\begin{center}
% \includegraphics{laengen}
\psscalebox{0.7}{%
\Large
\begin{pspicture}(-2,-2)(12,8)
        %
 \psframe[fillstyle=vlines,linecolor=green!70!black,hatchcolor=green!70!black](2,2)(8,4)
 \rput*(5,3){Contents}
 \psframe[linecolor=red!70!black,linewidth=10pt](0,0)(10,6)
 \psframe[linecolor=blue!70!black,linewidth=10pt](!0 0.1 3 mul add
                                                  0 3 0.1 mul add )%
                                                 (! 10 0.1 3 mul neg add
                                                    6  0.1 3 mul neg add)
 \psframe[linecolor=yellow!70!black,linewidth=10pt](!0 0.2 3 mul add
                                                     0 3 0.2 mul add )%
                                                   (! 10 0.2 3 mul neg add
                                                      6  0.2 3 mul neg add)
 \psline{<->}(5,6)(5,8)
 \uput[0](5,7){skipabove}
 \psline{<->}(5,0)(5,-2)
 \uput[0](5,-1){skipbelow}
 \psline{<->}(5,4)(5,5.1)
 \uput*[90](5,4){innertopmargin}
 \psline{<->}(5,2)(5,0.9)
 \uput*[90](5,1){innerbottommargin}
 \psline{<->}(10,3)(12,3)
 \uput[0](10,2.8){rightmargin}
 \psline{<->}(0,3)(-2,3)
 \uput[180](0,2.8){leftmargin}
 \psline{<->}(8,3)(9.1,3)
 \uput*[0](8.2,3){\psrotateleft{innerrightmargin}}
 \psline{<->}(0.9,3)(2,3)
 \uput*[0](1.2,3){\psrotateleft{innerleftmargin}}
 \psline(-2,8)(12,8)\uput*[0](-2,8){text above}
 \psline(-2,-2)(12,-2)\uput*[0](-2,-2){text below}
\end{pspicture}
}

 \captionof{figure}{adjustable lengths of \mdpack{mdframed}}
 \label{fig:laengen}
\end{center}

\mdDescribeMacro[0pt]{skipabove} Sets an additional skip above the frame.
\mdDescribeMacro[0pt]{skipbelow} Sets an additional skip below the frame.
\mdDescribeMacro[]{margin} This option is not longer supported. Use \mdoption{leftmargin}
                           and \mdoption{rightmargin} instead.
\mdDescribeMacro[0pt]{leftmargin} Sets the length of the left margin of the environment.
\mdDescribeMacro[0pt]{rightmargin} Sets the length of the right margin of the environment.

\mdDescribeMacro[10pt]{innerleftmargin} Sets the length of the inner left margin of the environment.
\mdDescribeMacro[10pt]{innerrightmargin} Sets the length of the inner right margin of the environment.
\mdDescribeMacro[\newline.4\textbackslash baselineskip]{innertopmargin} Sets the length of the inner top margin of the environment.
\mdDescribeMacro[\newline.4\textbackslash baselineskip]{innerbottommargin} Sets the length of the inner bottom margin of the environment.

\paragraph*{The following lengths are not shown in figure \eqref{fig:laengen}.}

\mbox{}
\mdDescribeMacro[0pt]{splittopskip} Sets the length of the skip above the split part of the environment.
\mdDescribeMacro[0pt]{splitbottomskip} Sets the length of the skip below the splitt part of the environment.
\mdDescribeMacro[0.4pt]{linewidth} Sets the width of the line around the environment.
\mdDescribeMacro[0pt]{roundcorner} Sets the size of the radius of the corners of the frames.
                                    \textbf{This works only with \mdoption{style=1} and \mdoption{style=3}.}
\mdDescribeMacro[0pt]{innerlinewidth} Sets the width of the inner line around the environment.
                                        \textbf{This works only with \mdoption{style=1}.}
\mdDescribeMacro[0pt]{outerlinewidth} Sets the width of the outer line around the environment.
                                        \textbf{This works only with \mdoption{style=1}.}
\mdDescribeMacro[\newline linewidth]{middlelinewidth} Sets the width of the middle line around the environment.
                                        \textbf{This works only with \mdoption{style=1}.}


\subsubsection{Colored Options}
\mdDescribeMacro[black]{linecolor} Sets the color of the line around the environment.
\mdDescribeMacro[\newline linecolor]{innerlinecolor} Sets the color of the inner line around the environment.
                                        \textbf{This works only with \mdoption{style=1}.}
\mdDescribeMacro[\newline linecolor]{middlelinecolor} Sets the color of the middle line around the environment.
                                        \textbf{This works only with \mdoption{style=1}.} 
\mdDescribeMacro[\newline linecolor]{outerlinecolor} Sets the color of the outer line around the environment.
                                        \textbf{This works only with \mdoption{style=1}.}
\mdDescribeMacro[white]{backgroundcolor} Sets the color of the background of the environment.
\mdDescribeMacro[black]{fontcolor} Sets the color of the contents of the environment.

\subsection{Hidden Lines}


\mdDescribeMacro[true]{topline} Draws a line at the top.
\mdDescribeMacro[true]{bottomline} Draws a line at the bottom.
\mdDescribeMacro[true]{leftline} Draws a line on the left.
\mdDescribeMacro[true]{rightline} Draws a line on the right.

\subsection{Frametitle}


\mdDescribeMacro[none]{frametitle} The environment get a title. To set a title use \mdoption{frametitle=\{The Title of the frame\}} as an option of the environment.
\mdDescribeMacro[\mbox{} \mdcommand{bfseries}\mdcommand{large}]{frametitleformat} Sets the format of the frame title.


\subsubsection{General options}




\mdDescribeMacro[false]{ntheorem} Before setting this boolean key, you have to load the package \mdpack{ntheorem}. 

                                 With this option you set the values \mdcommand{theorempreskipamount}
                                 and\newline \mdcommand{theorempostskipamount} to 0pt.
                                 
\mdDescribeMacro[false]{nobreak} Sometimes it is useful to prevent a frame from splitting.  The \mdoption{nobreak} option is used for this purpose.

%%\mdDescribeMacro[none]{settings} With version 0.9 of the package \mdname this option was added. This option allows the user to commit some macros. An example is shown in the appendix.

%\mdDescribeMacro[none]{printheight} This key allows the entries \texttt{none}, \texttt{info} or \texttt{warning}. In relation to the key the vertical space at the beginning of the environment \mdname on the current page will be printed in the \texttt{log} file.


\mdDescribeMacro[none]{pstrickssetting} With this key you can pass several options to \mdcommand{psset}. For example 
                                        if you want all lines dashed you will have to set 
                                        \mdoption{pstrickssetting=\{linestyle=dashed\}}. It is very important
                                        to put the options of \mdoption{pstrickssetting} in brackets.
                                        \textbf{This works only with \mdoption{style=3}.}
\mdDescribeMacro[none]{tikzsetting} With this key you can pass several options to \mdcommand{tikzset}. Some examples are listed in the next section. It is very important
                                        to put the options of \mdoption{tikzsetting} in brackets.
                                        \textbf{This works only with \mdoption{style=1}.}
\section{Examples}
Now I present some examples. Of course I know that some of them are only gimmicks. To create the following examples I am using \mdoption{style=1}.
\mdfsetup{skipabove=\baselineskip,skipbelow=\baselineskip}
\begin{mdexample}
\mdfsetup{outerlinewidth=5pt,innerlinewidth=0pt,
          outerlinecolor=red,roundcorner=5pt}
\end{mdexample} 
\begin{mdframed}[outerlinewidth=5pt,innerlinewidth=0pt,outerlinecolor=red,roundcorner=5pt]
Some Text Some Text Some Text Some Text Some Text Some Text
Some Text Some Text Some Text Some Text Some Text Some Text
Some Text Some Text Some Text Some Text Some Text Some Text
Some Text Some Text Some Text Some Text Some Text Some Text
Some Text Some Text Some Text Some Text Some Text Some Text
\end{mdframed}

Now I will add the next options
\begin{mdexample}
\mdfsetup{topline=false,leftline=false,}
\end{mdexample} 
\begin{mdframed}[topline=false,leftline=false,outerlinewidth=5pt,innerlinewidth=0pt,outerlinecolor=red,roundcorner=5pt]
Some Text Some Text Some Text Some Text Some Text Some Text
Some Text Some Text Some Text Some Text Some Text Some Text
Some Text Some Text Some Text Some Text Some Text Some Text
Some Text Some Text Some Text Some Text Some Text Some Text
Some Text Some Text Some Text Some Text Some Text Some Text
\end{mdframed}

Gimmick:
\begin{mdexample}
\mdfsetup{splitbottomskip=0.8cm,splittopskip=0cm,
          innerrightmargin=2cm,innertopmargin=1cm,%
          innerlinewidth=2pt,outerlinewidth=2pt,
          middlelinewidth=10pt,backgroundcolor=red,
          linecolor=blue,middlelinecolor=gray,
          tikzsetting={draw=yellow,line width=3pt,%
                    dashed,%
                    dash pattern= on 10pt off 3pt},
          rightline=false,bottomline=false}
\end{mdexample} 

\begin{mdframed}[splitbottomskip=0.8cm,splittopskip=0cm,
          innerrightmargin=2cm,innertopmargin=1cm,%
          innerlinewidth=2pt,outerlinewidth=2pt,
          middlelinewidth=10pt,backgroundcolor=red,
          linecolor=blue,middlelinecolor=gray,
          tikzsetting={draw=yellow,line width=3pt,dashed,dash pattern= on 10pt off 3pt},
          rightline=false,
          bottomline=false]
Some Text Some Text Some Text Some Text Some Text Some Text
Some Text Some Text Some Text Some Text Some Text Some Text
Some Text Some Text Some Text Some Text Some Text Some Text
Some Text Some Text Some Text Some Text Some Text Some Text
Some Text Some Text Some Text Some Text Some Text Some Text
\end{mdframed}
\clearpage
\twocolumn[\subsection{Working in twocolumn mode}]
\lipsum[1]
\begin{mdframed}[leftmargin=10pt,rightmargin=10pt,outerlinecolor=blue,outerlinewidth=5pt,backgroundcolor=yellow]
\lipsum[1]
\end{mdframed}
Some Text Some Text Some Text Some Text Some Text Some Text
%Some Text Some Text Some Text Some Text Some Text Some Text
%Some Text Some Text Some Text Some Text Some Text Some Text
\clearpage
\onecolumn
\clearpage
\section{Errors, Warnings and Messages}
The package \mdpack{mdframed} provides different errors, warnings and
messages in the \texttt{log}-file. Some \LaTeX-editors like
\TeX Maker(X) have a special tab for errors and warnings
but not for messages. So you should look in the \texttt{log-File} itself.

The followings errors and warnings are generated by \mdpack{mdframed}.

\begin{mdexample}
  The package ...  does not exist but
  is required by mdframed
\end{mdexample}        
To avoid this problem you should install the required
packages which are listed in section \ref{sec:syntax}.

\begin{mdexample}
 The style number ... does not exist
 mdframed ues instead style=0
\end{mdexample}   
If you set the option \mdoption{style} and a file 
\texttt{md-frame-'number'.mdf} does not exist
you will get this warning. So check the
option \mdoption{style}.

\begin{mdexample}
  You have not loaded ntheorem yet
\end{mdexample}   
To use the option \mdoption{ntheorem} you have to 
load the package \mdpack{ntheorem}.

\begin{mdexample}
 You have only a width of 3cm
\end{mdexample}   
The package \mdpack{mdframed} calculates the width of the contents
based on the given options. If the width of the contents smaller than
3\,cm you will get this warnings. You should change the 
settings to get a greater width.

\begin{mdexample}
 You got a bad break
 you have to change it manually
 by changing the text, the space
 or something else
\end{mdexample} 
Sometimes you have enough vertical space for the rules and the space
between the rules and the contents but not for the contents itself.
In this situation you will get this warning because the contents
of this box is empty. You have the possibility to change the
settings or include a \mdcommand{clearpage} in front of 
the environment \mdpack{mdframed}.
So far I have no idea how to avoid such things.

\begin{mdexample}
 You got a bad break
 because the split box is empty
 You have to change the page settings
 like enlargethispage or something else
 You got a bad break
\end{mdexample} 
See the explanation above.

\begin{mdexample}
 You got a bad break
 because the last split box is empty
 You have to change the settings
\end{mdexample} 
The same reason as above but only in the last box.


\begin{mdexample}
 Option ... is already consumed
 and has no effect on input line ...
\end{mdexample} 
If you set a global option inside the document
body you will get this warning.

\section{Known Problems}
 In this section I will collect known problems. In case you encounter any further problems, please
 drop me an email, \href{mailto:marco.daniel@mada-nada.de}{marco.daniel at mada-nada.de}.

   Do you have any ideas / wishes on further extensions to this package? Please let me know!

\begin{enumerate}
 \item So far the environment isn't compatible with the package \mdpack{gmverb}.
 \item So far it isn't possible to combine the environment \mdcommand{begin\{multicols\}} of the package \mdpack{multicol} with \mdpack{mdframed}.
 \item So far it isn't possible to use footnotes within a frame.
\end{enumerate}


\section{ToDo}
\begin{enumerate}
  \item see \glqq Known Problems\grqq.
  \item Work with \mdoption{twoside}-mode by setting \mdoption{inner} and \mdoption{outer}.
  \item Create new styles.
  \item Improve page breaks.
  \item Section with version history.
\end{enumerate}                

\section{Previous versions}
If you have trouble with the new version of \mdname you can load \texttt{mdframedpre} instead. In this way you load the version v0.6 (see \nameref{rev}).
%With the new version 0.7a I changed the internal commands (I use \mdpack{etoolbox}) and the algorithm of the splitting. So I don't know whether I will get new bugs or not. For the last case and the previous version (v0.6) works well you can load \mdpack{mdframedpre} instead of \mdpack{mdframed}.

\section{Acknowledgements}
Thanks for the bug reports and suggestions

\textsf{Dick Nickalls;\quad Dr. Dietrich Grau;\quad Piazza Luca\quad Jobst Hoffmann}.
\medskip

\noindent Thanks for proofreading 

\textsf{Alan Munn} and \textsf{Nahid Shajari}                                       
\clearpage
\appendix
\section{More information}
\addtocontents{toc}{\protect\setcounter{tocdepth}{-4}}
In the following section I want to present how to create
your own frame.
\subsection{How does \mdpack{mdframed} work?}
With the environment \mdcommand{begin\{mdframed\}} \ldots \mdcommand{end\{mdframed\}}
the whole contents will be saved in a \mdcommand{savebox} called \mdcommand{@tempboxa}.
After the calculation of the width and the height of the \mdcommand{@tempboxa} (done by \mdpack{mdframed.sty}) the box 
will be set sequently (done by \mdpack{md-frame-X.mdf}). The following figure demonstrates this.

\begin{center}
\newcommand{\mybox}[1]{\psframebox[linecolor=gray,shadowcolor=lightgray]{\parbox{3.5cm}{\centering\small #1}}}        
%    \includegraphics{way}
\begin{psmatrix}[mnode=r,colsep=4,rowsep=1.2]
  [name=s1] \mybox{read in and save contents in \textbackslash @tempboxa} &
  [name=f1] \mybox{\textbackslash md@putbox@single} \\
  [name=s2] \mybox{split \textbackslash @tempboxa in \textbackslash tw@ to the free space of the page} &
  [name=f2] \mybox{\textbackslash md@putbox@first} \\
  [name=s3] \mybox{contents of \textbackslash @tempboxa have enough space on the new page} &
  [name=f3] \mybox{\textbackslash md@putbox@second} \\
  [name=s4] \mybox{split \textbackslash @tempboxa in \textbackslash tw@ to the free space of the page} &
  [name=f4] \mybox{\textbackslash md@putbox@middle} \\[.5\baselineskip]
  %
  \psset{arrowinset=0,arrowscale=1.3,nodesep=3pt}
  \ncline{->}{s1}{f1}\naput{enough space on page}    
  \ncline{->}{s1}{s2}\naput{not enough space on page}
  \ncline{->}{s2}{f2}\naput{type out \textbackslash tw@}    
  \ncline[angle=90]{->}{f2}{s3}\ncput*{calculate the height of the new \textbackslash @tempboxa}
  \ncline{->}{s3}{f3}\naput{yes}   
  \ncline{->}{s3}{s4}\naput{no}
  \ncline{->}{s4}{f4}\naput{type out \textbackslash tw@}
  \ncloop[angleA=180,angleB=-90,loopsize=4.5]{<-}{s3}{f4}
  \nbput{calculate the height of the new \textbackslash @tempboxa}
\end{psmatrix}

\captionof{figure}{Setting the contents of \mdpack{mdframed}}\label{fig:way}
\end{center}

The width of the contents is the result of the settings of \mdoption{leftmargin}, \mdoption{rightmargin}, \mdoption{linewidth}, \mdoption{innerleftmargin} and \mdoption{innerrightmargin} (see figure \eqref{fig:laengen}).



\subsection{The Framecommands}
The package \mdpack{mdframed} knows four kinds of \glqq Framecommand\grqq. These commands tell \LaTeX\ how to set the contents of \mdpack{mdframed}. 
\begin{description}
       \item[\mdcommand{md@putbox@single}] This command sets the contents of a single unspliot frame.
       \item[\mdcommand{md@putbox@first}]  This command sets the contents of the first frame of a split frame.
       \item[\mdcommand{md@putbox@middle}] This command sets the contents of the middle frame of a split frame.
       \item[\mdcommand{md@putbox@second}] This command sets the contents of the last frame of a split frame.
\end{description}

Using the explained commands we give an example. The command \mdcommand{box} uses the contents of the savebox and types them out. 

First we want to type out the single box without any settings (but with the calculated width).
\begin{mdexample}
\makeatletter
 \def\md@putbox@single{\box\@tempboxa}
\makeatother
\end{mdexample}
I am using the command \mdcommand{leftline} to start the \glqq Framecommands\grqq\ at the left.
\begin{mdexample}[deletekeywords={leftline},moretexcs={leftline}]
\makeatletter
 \def\md@putbox@single{\leftline{\box\@tempboxa}}
\makeatother
\end{mdexample}

Now you have to know how the lengths are named. Every length which can be modified by the options has the following syntax:
\begin{mdexample}
\mdf@<Name of the Length>@length
\end{mdexample}
For example the leftmargin is:
\begin{mdexample}
\mdf@leftmargin@length
\end{mdexample}

To create only a line at the left with the correct \mdoption{leftmargin} you can set \mdcommand{md@putboxsingle} as follows

\begin{mdexample}[deletekeywords={leftline},moretexcs={leftline}]
\makeatletter
\def\md@putbox@single{%
         \leftline{%
             \hspace*{\mdf@leftmargin@length}%
             \rule[-\dp\@tempboxa]{\mdf@linewidth}%
                  {\ht\@tempboxa+\dp\@tempboxa}%
             \box\@tempboxa
         }%
}
\makeatother
\end{mdexample}

In this way you can do what you want. If you create your own style you
can save the file as \mdpack{md-frame-X.mdf}.
\mdpack{X} must be an integer. 
In this way you can use the option \mdoption{style} to
load the file by setting \mdoption{style=X}.

\subsection{Modify the frame}

The example below is inspired by the following post on StackExchange \href{http://tex.stackexchange.com/questions/24101/theorem-decorations-that-stay-with-theorem-environment}{Theorem decorations that stay with theorem environment}

First I will show the the result. 
\makeatletter
\newlength{\interruptlength}
\setlength{\interruptlength}{2.5ex}
\newrobustcmd\overlaplines{%
   \input{md-frame-0.mdf}%
   \appto\md@frame@leftline@single{%
           \llap{\color{white}%
               \rule[-\dp\@tempboxa-\mdf@innerbottommargin@length%
                     -\mdf@middlelinewidth@length+\interruptlength]%
                    {\mdf@middlelinewidth@length}%
                     {\mdfboundingboxheight%
                      +2\mdf@middlelinewidth@length
                      -2\interruptlength}%
                  }%
   }%
   \appto\md@frame@rightline@single{%
         \rlap{\color{white}%
               \hspace*{\mdfboundingboxwidth}%
               \hspace*{\mdf@innerrightmargin@length}%
               \rule[-\dp\@tempboxa-\mdf@innerbottommargin@length%
                     -\mdf@middlelinewidth@length+\interruptlength]%
                      {\mdf@middlelinewidth@length}
                      {\mdfboundingboxheight%
                       +2\mdf@middlelinewidth@length%
                       -2\interruptlength}%
               }%
   }%
}
\overlaplines
\newmdtheoremenv[style=0,ntheorem,linecolor=blue,linewidth=3pt]{lem}{Lemma}[section]
\makeatother



\begin{lem}
\lipsum[1]
\end{lem}

You can see how the lines on the left and the right are interrupted. Now I will show the code.

I define a command which draws white lines on the left and the right side in the same way as in the style file. For this example I must include the file \texttt{md-frame-1.mdf} because this document used the global style 1.

With the new length \mdcommand{interruptlength} you can manipulate the amount of overlap. 

\begin{mdexample}
\newlength{\interruptlength}
\setlength{\interruptlength}{1.5ex}
\makeatletter
\makeatletter
\newlength{\interruptlength}
\setlength{\interruptlength}{2.5ex}
\newrobustcmd\overlaplines{%
   \input{md-frame-0.mdf}%
   \appto\md@frame@leftline@single{%
           \llap{\color{white}%
               \rule[-\dp\@tempboxa
                     -\mdf@innerbottommargin@length%
                     -\mdf@middlelinewidth@length
                     +\interruptlength]%
                    {\mdf@middlelinewidth@length}%
                     {\mdfboundingboxheight%
                      +2\mdf@middlelinewidth@length
                      -2\interruptlength}%
                  }%
   }%
   \appto\md@frame@rightline@single{%
         \rlap{\color{white}%
               \hspace*{\mdfboundingboxwidth}%
               \hspace*{\mdf@innerrightmargin@length}%
               \rule[-\dp\@tempboxa
                     -\mdf@innerbottommargin@length%
                     -\mdf@middlelinewidth@length
                     +\interruptlength]%
                      {\mdf@middlelinewidth@length}
                      {\mdfboundingboxheight%
                       +2\mdf@middlelinewidth@length%
                       -2\interruptlength}%
               }%
   }%
}
\overlaplines
\newmdtheoremenv[style=0,ntheorem,linecolor=blue,%
                 linewidth=3pt]{lem}{Lemma}[section]
\makeatother
\end{mdexample}
%\clearpage
\subsection{Revision history}\label{rev}
\setkomafont{subsubsection}{\normalfont\bfseries}
\small
\minisec{Version 0.9b submitted 7 Sep 2011}
\begin{itemize}
\item fixes bugs in \mdcommand{newmdtheoremenv} (Thanks to Enrico Gregorio)
\end{itemize}

\minisec{Version 0.9a submitted 5 Sep 2011}
\begin{itemize}
\item fixes bugs (Thanks to Lars Madson)
\item expanded documentation (added revision history)
\end{itemize}


\minisec{Version 0.9 submitted 4 Sep 2011}
\begin{itemize}
\item added option \mdoption{nobreak}
\item detecting float environments to prevent split calculation
\item expand documentation (Thanks to Alan Munn)
\end{itemize}

\minisec{Version 0.8a}
\begin{itemize}
\item fixes bugs
\item fixes documentation
\end{itemize}

\minisec{Version 0.8 submitted 22 Aug 2011}
\begin{itemize}
\item  added commands: \mdcommand{newmdenv}, \mdcommand{renewmdenv}, \mdcommand{newmdtheoremenv}
\item fixes bugs
\item fixes documentation
\end{itemize}

\minisec{Version 0.7a submitted 6 August 2011}
\begin{itemize}
\item added option \mdoption{frametitle}
\item added option \mdoption{frametitlefont}
\item allow twolumn-mode
\item changed the calculation
\item added option \mdoption{tikzsetting}
\item added options for hidden lines for all styles
\item fixes bugs
\end{itemize}

\minisec{Version 0.6a submitted 22 Dec 2010}
\begin{itemize}
\item fixes bugs
\item added \mdcommand{mdfsetup}
\item expanded documentation
\end{itemize}

\minisec{Version 0.6 submitted 18 Dec 2010}
\begin{itemize}
\item added \mdoption{style=3} with \mdpack{pstricks}
\item added option \mdoption{pstrickssetting}
\item added option \mdoption{splitbottomskip}
\item added option \mdoption{splittopskip}
\item added options for hidden lines 
\item changed the calculation
\item fixes bugs
\end{itemize}

\minisec{Version 0.4a submitted 14 May 2010}
\begin{itemize}
\item fixes bug in fontcolor
\end{itemize}

\minisec{Version 0.4 submitted 13 May 2010}
\begin{itemize}
\item Elke Schubert creates style file for \mdpack{tikz}
\item fixes some bugs -- calculation of the page dimen (thanks  Dick Nickalls)
\item using tikz for the frame with different styles
\end{itemize}

\minisec{Version 0.3b submitted 1 May 2010}
\begin{itemize}
\item fixes some bugs -- thanks to Dr. Dietrich Grau
\item added new options: \mdoption{ntheorem}
\end{itemize}

\minisec{Version 0.3a submitted 23 Apr 2010}
\begin{itemize}
\item added new options: \mdoption{leftmargin} and \mdoption{rightmargin}
\item fixes some bugs
\end{itemize}

\minisec{Version 0.3 submitted16 Apr 2010}
\begin{itemize}
\item first upload to \href{http://dante.ctan.org/upload}{CTAN}
\end{itemize}
\end{document}