From 29987447c7006b1437decf63c0d8bd59ebe41f90 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Mon, 26 Apr 2010 00:11:23 +0000 Subject: mdframed 0.3a (24apr10) git-svn-id: svn://tug.org/texlive/trunk@17993 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/mdframed/README | 6 +- .../texmf-dist/doc/latex/mdframed/mdframed-doc.pdf | Bin 526516 -> 612384 bytes .../texmf-dist/doc/latex/mdframed/mdframed-doc.tex | 90 ++++++++++++++++----- 3 files changed, 75 insertions(+), 21 deletions(-) (limited to 'Master/texmf-dist/doc') diff --git a/Master/texmf-dist/doc/latex/mdframed/README b/Master/texmf-dist/doc/latex/mdframed/README index 95ffcb58d34..94dd6a525b9 100644 --- a/Master/texmf-dist/doc/latex/mdframed/README +++ b/Master/texmf-dist/doc/latex/mdframed/README @@ -3,4 +3,8 @@ handle page breaks by hand. The present package defines the environment mdframed which automatically deals with page breaks. Author's name: Marco Daniel -License type: lppl \ No newline at end of file +License type: lppl + +changes in version 0.3a: +- Added new options: leftmargin and rightmargin +- fixes some Bugs diff --git a/Master/texmf-dist/doc/latex/mdframed/mdframed-doc.pdf b/Master/texmf-dist/doc/latex/mdframed/mdframed-doc.pdf index 99208c55a69..2ef66b56905 100644 Binary files a/Master/texmf-dist/doc/latex/mdframed/mdframed-doc.pdf and b/Master/texmf-dist/doc/latex/mdframed/mdframed-doc.pdf differ diff --git a/Master/texmf-dist/doc/latex/mdframed/mdframed-doc.tex b/Master/texmf-dist/doc/latex/mdframed/mdframed-doc.tex index 515a577c2dd..0adc00e3b63 100644 --- a/Master/texmf-dist/doc/latex/mdframed/mdframed-doc.tex +++ b/Master/texmf-dist/doc/latex/mdframed/mdframed-doc.tex @@ -1,5 +1,5 @@ %% Documentation of the package mdframed.sty -\def\mdversion{version 0.3} +\def\mdversion{version 0.3a} \documentclass[american,11pt]{article} \usepackage{geometry} \geometry{left=3cm,right=3cm,top=2cm,bottom=2cm} @@ -22,16 +22,27 @@ \usepackage[babel]{microtype} \usepackage{array,tabularx} %%Load the the package itselfs -\usepackage{mdframed} -\usepackage{amsmath,amsthm} +\usepackage[leftmargin=20pt,rightmargin=40pt]{mdframed} + +\usepackage{amsmath} +\usepackage[amsmath,amsthm,hyperref]{ntheorem} \newtheorem{mdtheorem}{Theorem}[section] \newenvironment{theorem}{% - \begin{mdframed}[linewidth=2,margin=40,backgroundcolor=yellow,linecolor=blue]% + \begin{mdframed}[leftmargin=20pt,rightmargin=40pt,linewidth=2,margin=40,backgroundcolor=yellow,linecolor=blue]% \begin{mdtheorem}% }{% \end{mdtheorem}% \end{mdframed}% } + +\newtheorem{mdlemma}{Lemma}[section] +\newenvironment{ntheorem}{% + \begin{mdframed}[ntheorem=true,leftmargin=20pt,rightmargin=40pt,linewidth=2,margin=40,backgroundcolor=yellow,linecolor=blue]% + \begin{mdlemma}% + }{% + \end{mdlemma}% + \end{mdframed}% +} \definecolor{titleblue}{rgb}{0,0,0.9} \usepackage{listings} @@ -57,6 +68,7 @@ urlcolor=titleblue, pdfauthor=Marco Daniel, pdftitle=Documentation of mdframed, +plainpages=false } \usepackage{xspace} \usepackage{multicol} @@ -80,6 +92,7 @@ \newcommand*\mdsetting[1]{\textsf{#1}\xspace} \newcommand*\mdcommand[1]{\texttt{\textbackslash #1}\xspace} +\setcounter{tocdepth}{1} \begin{document} \vspace*{\baselineskip} @@ -91,7 +104,7 @@ \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 and Herbert Voss.} \qquad \mdversion\ \qquad \today + \href{mailto:marco.daniel@mada-nada.de}{Marco Daniel}\footnote{With thanks to Heiko Oberdiek, Rolf Niepraschk, Martin Scharrer and Herbert Voss.} \qquad \mdversion\ \qquad \today \end{center} \begin{abstract} Working with the command \mdcommand{fbox} or \mdcommand{fcolorbox}, one has to handle page breaks by hand, @@ -141,13 +154,39 @@ Load the package as usual: The package defines only one environment with the following syntax \begin{mdexample} - \begin{mdframed}[] - + \begin{mdframed}[< LOCAL OPTIONS >] + < CONTENT > \end{mdframed} \end{mdexample} \section{Options} The package allows to set global and local options which are explained below. + +\subsection{Global Options} +The following options are only global options. + +\begin{center} +\renewcommand{\arraystretch}{1.5} +\begin{tabularx}{\linewidth}{@{}lXl@{}} + \mdoption{skipabove}=& Sets an additional skip above the frame. + & default=\mdsetting{0pt} \\ + \mdoption{skipbelow}=& Sets an additional skip below the frame. + & default=\mdsetting{0pt} \\ + \mdoption{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. + & default=\mdsetting{none} \\ +\end{tabularx} +\end{center} + + By setting one of these options locally, you get a warning like +\begin{mdexample} + Option `...' is already consumed(mdframed) and has no effect on input line ... +\end{mdexample} + +\clearpage +\subsection{Global and Local Options} +The listed options below allows to set global and local. \begin{center} \renewcommand{\arraystretch}{1.5} \begin{tabularx}{\linewidth}{@{}lXl@{}} @@ -161,23 +200,34 @@ The package allows to set global and local options which are explained below. The basic unit of the length is pt. So it is possible to set length to 6 which is equal to 6pt. & default=\mdsetting{2pt} \\ + \mdoption{leftmargin}= & Sets the length of the left margin of the environment. + The basic unit of the length is pt. So it is possible to set + length to 6 which is equal to 6pt. + & default=\mdsetting{2pt} \\ + \mdoption{rightmargin}= & Sets the length of the right margin of the environment. + The basic unit of the length is pt. So it is possible to set + length to 6 which is equal to 6pt. + & default=\mdsetting{2pt} \\ \mdoption{linewidth}=& Sets the width of the line around the environment. The basic unit of the length is pt. So it is possible to set length to 6 which is equal to 6pt. & default=\mdsetting{20pt} \\ - \mdoption{skipabove}=& Sets an additional skip above the frame. This is - \bfseries only a global option. - & default=\mdsetting{0pt} \\ - \mdoption{skipbelow}=& Sets an additional skip below the frame. This is - \bfseries only a global option. - & default=\mdsetting{0pt} \\ - \mdoption{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. This is - \bfseries only a global option. - & default=\mdsetting{none} \\ + \mdoption{ntheorem}=& Befor setting this key you have to load the package \mdpack{ntheorem}. + With this option you set the values \mdcommand{theorempreskipamount} + and \mdcommand{theorempostskipamount} to 0pt. + & default=\mdsetting{false} \\ \end{tabularx} \end{center} + +\subsubsection{The Option \mdoption{ntheorem}} + +\begin{theorem} + This environment is created with \mdoption{ntheorem=false}. +\end{theorem} + +\begin{ntheorem} + This environment is created with \mdoption{ntheorem=true}. +\end{ntheorem} \clearpage \section{Example} @@ -219,7 +269,7 @@ The package allows to set global and local options which are explained below. \end{lemma} \end{document}\end{mdexample} -\section{Known problems} +\section{Known Problems} In this section I will collect known problems. In case you encouter any further problems, please drop me an email, \href{mailto:marco.daniel@mada-nada.de}{marco.daniel@mada-nada.de}. @@ -227,7 +277,7 @@ The package allows to set global and local options which are explained below. \begin{enumerate} \item So far it is not possible to extend a frame to more than two pages - \item So far there is no implementation that allows to set the left or right margin + \item So far there is no implementation for choosing different styles of the frame. But I am workind on that. \end{enumerate} \end{document} -- cgit v1.2.3