From afd21711dd0891ff8e4fd6d150940e1c5d76ae11 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Thu, 11 Aug 2011 01:43:52 +0000 Subject: mdframed 0.7a (10aug11) git-svn-id: svn://tug.org/texlive/trunk@23490 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/mdframed/README | 21 +- .../doc/latex/mdframed/mdframed-doc-en.pdf | Bin 86036 -> 109985 bytes .../doc/latex/mdframed/mdframed-doc-en.tex | 224 ++++++++++++++++----- 3 files changed, 194 insertions(+), 51 deletions(-) (limited to 'Master/texmf-dist/doc/latex/mdframed') diff --git a/Master/texmf-dist/doc/latex/mdframed/README b/Master/texmf-dist/doc/latex/mdframed/README index cb686e62de5..bad18c08572 100644 --- a/Master/texmf-dist/doc/latex/mdframed/README +++ b/Master/texmf-dist/doc/latex/mdframed/README @@ -1,7 +1,7 @@ -%%$Id: README 101 2010-12-22 16:26:58Z marco $ -%%$Rev: 101 $ +%%$Id: README 161 2011-08-06 11:28:15Z marco $ +%%$Rev: 161 $ %%$Author: marco $ -%%$Date: 2010-12-22 17:26:58 +0100 (Mi, 22. Dez 2010) $ +%%$Date: 2011-08-06 13:28:15 +0200 (Sa, 06. Aug 2011) $ Working with the command \fbox or \fcolorbox, one has to handle page breaks by hand. The present package defines the @@ -10,13 +10,23 @@ environment mdframed which automatically deals with page breaks. Author's name: Marco Daniel and Elke Schubert (!new) License type: lppl + +------------------------------------------------ +changes in version 0.7a: +- added option frametitle +- added option frametitlefont +- allow twolumn-mode +- changed the calculation +- added option tikzsetting +- added options for hidden lines for all styles +- fixes bugs + +------------------------------------------------ changes in version 0.6a: - fixes bugs - added \mdfsetup to the documentation - expanded documentation - - ------------------------------------------------ changes in version 0.5: - added style=3 with pstricks @@ -37,7 +47,6 @@ changes in version 0.4: - calculation of the page dimen - using tikz for the frame with different styles - ------------------------------------------------ changes in version 0.3b: - fixes some bugs -- thanks to Dr. Dietrich Grau diff --git a/Master/texmf-dist/doc/latex/mdframed/mdframed-doc-en.pdf b/Master/texmf-dist/doc/latex/mdframed/mdframed-doc-en.pdf index 59aa9d723a9..e55a5146ebe 100644 Binary files a/Master/texmf-dist/doc/latex/mdframed/mdframed-doc-en.pdf and b/Master/texmf-dist/doc/latex/mdframed/mdframed-doc-en.pdf differ diff --git a/Master/texmf-dist/doc/latex/mdframed/mdframed-doc-en.tex b/Master/texmf-dist/doc/latex/mdframed/mdframed-doc-en.tex index cafa5aa6879..a94ae0ff3a1 100644 --- a/Master/texmf-dist/doc/latex/mdframed/mdframed-doc-en.tex +++ b/Master/texmf-dist/doc/latex/mdframed/mdframed-doc-en.tex @@ -1,19 +1,19 @@ %Documenation of the package mdframed -%%$Id: mdframed-doc-en.tex 101 2010-12-22 16:26:58Z marco $ -%%$Rev: 101 $ +%%$Id: mdframed-doc-en.tex 160 2011-08-06 10:31:55Z marco $ +%%$Rev: 160 $ %%$Author: marco $ %%$Dater:$ \setcounter{errorcontextlines}{999} -\def\mdversion{0.6a} \documentclass[english,11pt,]{scrartcl} %\usepackage{showframe} -\usepackage[nofancy,draft]{svninfo} -\svnInfo $Id: mdframed-doc-en.tex 101 2010-12-22 16:26:58Z marco $ +\usepackage[nofancy,draft,notoday]{svninfo} +\svnInfo $Id: mdframed-doc-en.tex 160 2011-08-06 10:31:55Z marco $ \usepackage{babel} \usepackage[utf8]{inputenc} \usepackage[T1]{fontenc} - -\usepackage[de,T1,altbullet]{lucidabr} +\usepackage{lipsum} +\usepackage[T1,altbullet]{lucidabr} +%\usepackage{libertine} \usepackage{microtype} \usepackage[french=quotes]{csquotes} %\let\glqq\flqq @@ -38,11 +38,12 @@ \usepackage{xcolor} \definecolor{titleblue}{rgb}{0,0,0.9} -\usepackage{amsmath,amsthm} +\usepackage{amsmath} +\usepackage[amsmath]{ntheorem} \usepackage[]{graphicx} -\usepackage[style=0]{mdframed} +\usepackage[style=1]{mdframed} \usepackage{xspace} @@ -100,6 +101,7 @@ \usepackage{hyperref} \hypersetup{% +breaklinks=true, pdftitle={Documenation of mdframed},% pdfauthor={Marco Daniel},% colorlinks=true,% @@ -129,7 +131,7 @@ Working with the command \mdcommand{fbox} or \mdcommand{fcolorbox}, one has to h By using \mdcommand{newenvironment} the user may choose between several individual designs. \end{abstract} - +\pdfbookmark[1]{\contentsname}{tocbook} \tableofcontents \section{Motivation} @@ -138,35 +140,33 @@ create environments with breakable frames. I think an example is the best way to \begin{mdexample} \newtheorem{mdtheorem}{Theorem}[section] \newenvironment{theorem}{\begin{mdframed}% - [linewidth=2,leftmargin=40,rightmargin=40,% - backgroundcolor=yellow,linecolor=blue,% + [outerlinewidth=2,leftmargin=40,rightmargin=40,% + backgroundcolor=yellow,outerlinecolor=blue,% splittopskip=\topskip,skipbelow=\baselineskip,% - skipabove=\baselineskip]% + skipabove=\baselineskip,ntheorem]% \begin{mdtheorem}}{\end{mdtheorem}\end{mdframed}} \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} \end{mdexample} \newtheorem{mdtheorem}{Theorem}[section] \newenvironment{theorem}{\begin{mdframed}% - [linewidth=2,leftmargin=40,rightmargin=40,% - backgroundcolor=yellow,linecolor=blue,% + [outerlinewidth=2,leftmargin=40,rightmargin=40,% + backgroundcolor=yellow,outerlinecolor=blue,innertopmargin=0pt,% splittopskip=\topskip,skipbelow=\baselineskip,% - skipabove=\baselineskip]% + skipabove=\baselineskip,ntheorem,]% \begin{mdtheorem}}% {\end{mdtheorem}\end{mdframed}} \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} +\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}. @@ -181,7 +181,6 @@ The package defines only one environment with the following syntax: \end{mdframed} \end{mdexample} - \section{Options} The package allows to set global and local options which are explained below. @@ -252,6 +251,7 @@ the second one is a number (e.g. 2) which will be multiplied by \mdoption{1 defa \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} @@ -273,7 +273,6 @@ the second one is a number (e.g. 2) which will be multiplied by \mdoption{1 defa \mbox{} \mdDescribeMacro[0pt]{splittopskip} Sets the length of the skip above the splitted part of the environment. \mdDescribeMacro[0pt]{splitbottomskip} Sets the length of the skip below the splitted part of the environment. - \textbf{This works only with \mdoption{style=0} and \mdoption{style=3}.} \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}.} @@ -297,28 +296,20 @@ the second one is a number (e.g. 2) which will be multiplied by \mdoption{1 defa \mdDescribeMacro[black]{fontcolor} Sets the color of the contents of the environment. \subsection{Hidden Lines} -\textbf{The following options work only with \mdoption{style=0} and \mdoption{style=3}.} + \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. -\subparagraph{Remark:} By setting \mdoption{style=3} only the following combinations are implemented -\begin{itemize} - \item \mdoption{leftline=true, rightline=true, bottomline=true, topline=true} - \item \mdoption{leftline=true, rightline=true, bottomline=false, topline=true} - \item \mdoption{leftline=true, rightline=true, bottomline=true, topline=false} - \item \mdoption{leftline=true, rightline=false, bottomline=true, topline=true} - \item \mdoption{leftline=false, rightline=true, bottomline=true, topline=true} - \item \mdoption{leftline=false, rightline=false, bottomline=false, topline=false} - \item \mdoption{leftline=false, rightline=false, bottomline=true, topline=true} - \item \mdoption{leftline=true, rightline=true, bottomline=false, topline=false} - \item \mdoption{leftline=true, rightline=false, bottomline=false, topline=false} - \item \mdoption{leftline=false, rightline=true, bottomline=false, topline=false} - \item \mdoption{leftline=false, rightline=false, bottomline=true, topline=false} - \item \mdoption{leftline=false, rightline=false, bottomline=false, topline=true} -\end{itemize} +\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{Useful options} @@ -333,8 +324,148 @@ the second one is a number (e.g. 2) which will be multiplied by \mdoption{1 defa \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}.} +\section{Examples} +Now I present some examples. Of course I know that some of them are only gimmick. 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 with twocolumn}] +\lipsum[1]\lipsum[2] +\begin{mdframed}[leftmargin=10pt,rightmargin=10pt,outerlinecolor=blue,outerlinewidth=5pt,backgroundcolor=yellow] +\lipsum[1]\lipsum[2] +\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}. + +The followings errors and warnings are generated by \mdpack{mdframed}. + +\begin{mdexample} + The package ... does not exist but + it is required by mdframed +\end{mdexample} +To avoid this problem you should install the required +package which are named in section \nameref{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} calculate the width of the contents +by given options. If the width of the contents smaller then +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 to avoid such things. + +\begin{mdexample} + You got a bad break + because the splittet 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 splittet 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}. @@ -343,7 +474,7 @@ the second one is a number (e.g. 2) which will be multiplied by \mdoption{1 defa \begin{enumerate} \item So far the environment isn't compatible with the package \mdpack{gmverb}. - \item So far it isn't possible to use the multicolumn environment. + \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. \end{enumerate} @@ -351,11 +482,14 @@ the second one is a number (e.g. 2) which will be multiplied by \mdoption{1 defa \section{ToDo} \begin{enumerate} \item see \glqq Known Problems\grqq. - \item No limitations of any style. + \item Work with \mdoption{twoside}-mode by setting \mdoption{inner} and \mdoption{outer}. \item Create new styles. \item Improve page breaks. \end{enumerate} +\section{Previous versions} +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{Acknowledgement} Thanks for the bug reports and suggestions @@ -375,8 +509,8 @@ 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} the box -will be set sequently. The following figure demonstrates this. +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}}} @@ -389,7 +523,7 @@ will be set sequently. The following figure demonstrates this. [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} \\ + [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} -- cgit v1.2.3