summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/mdframed
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2011-09-07 23:26:19 +0000
committerKarl Berry <karl@freefriends.org>2011-09-07 23:26:19 +0000
commit5508320ba1a6332a67f2e5d2840c6eba080715b8 (patch)
treebd63428b77a6fa683dcf05457ee1ed1bb4e84359 /Master/texmf-dist/doc/latex/mdframed
parentfacd5da6746c2e6834b9020905bc08b4dc708a67 (diff)
mdframed 0.9b (7sep11)
git-svn-id: svn://tug.org/texlive/trunk@23855 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/mdframed')
-rw-r--r--Master/texmf-dist/doc/latex/mdframed/README68
-rw-r--r--Master/texmf-dist/doc/latex/mdframed/mdframed-doc-en.pdfbin130982 -> 136219 bytes
-rw-r--r--Master/texmf-dist/doc/latex/mdframed/mdframed-doc-en.tex158
3 files changed, 142 insertions, 84 deletions
diff --git a/Master/texmf-dist/doc/latex/mdframed/README b/Master/texmf-dist/doc/latex/mdframed/README
index e477349dbbc..cf04fcfaf66 100644
--- a/Master/texmf-dist/doc/latex/mdframed/README
+++ b/Master/texmf-dist/doc/latex/mdframed/README
@@ -1,7 +1,7 @@
-%%$Id: README 173 2011-09-04 16:28:21Z marco $
-%%$Rev: 173 $
+%%$Id: README 190 2011-09-07 10:39:52Z marco $
+%%$Rev: 190 $
%%$Author: marco $
-%%$Date: 2011-09-04 18:28:21 +0200 (So, 04. Sep 2011) $
+%%$Date: 2011-09-07 12:39:52 +0200 (Mi, 07. Sep 2011) $
Working with the command \fbox or \fcolorbox, one has to
handle page breaks by hand. The present package defines the
@@ -10,65 +10,9 @@ environment mdframed which automatically deals with page breaks.
Author's name: Marco Daniel and Elke Schubert (!new)
License type: lppl
-------------------------------------------------
-changes in version 0.9:
-- added option nobreak
-- detecting float environments to prevent split calculation
-- expand documentation (Thanks to Alan Munn)
+----------------------------
+v0.9b
+- fixes bugs in \newmdtheoremenv (Thanks to Enrico Gregorio)
-------------------------------------------------
-changes in version 0.8a:
-- fixes bugs
-- fixes documentation
-------------------------------------------------
-changes in version 0.8:
-- added commands: \newmdenv, \renewmdenv, \newmdtheoremenv
-- fixes bugs
-- fixes documentation
-------------------------------------------------
-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
-- added option pstrickssetting
-- added option splitbottomskip (see documentation)
-- added option splittopskip (see documentation)
-- added options for hidden lines (see documentation)
-- changed the calculation
-- fixes bugs
-
-changes in version 0.4a:
-- fixes bug in fontcolor (Elke Schubert)
-
-------------------------------------------------
-changes in version 0.4:
-- second author Elke Schubert
-- fixes some bugs
- - 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
-- added new options: ntheorem
-
-------------------------------------------------
-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-en.pdf b/Master/texmf-dist/doc/latex/mdframed/mdframed-doc-en.pdf
index f064ed64171..6e4ab46c6d3 100644
--- a/Master/texmf-dist/doc/latex/mdframed/mdframed-doc-en.pdf
+++ b/Master/texmf-dist/doc/latex/mdframed/mdframed-doc-en.pdf
Binary files 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 71ae1a3b89f..fb041fc1032 100644
--- a/Master/texmf-dist/doc/latex/mdframed/mdframed-doc-en.tex
+++ b/Master/texmf-dist/doc/latex/mdframed/mdframed-doc-en.tex
@@ -1,18 +1,20 @@
%Documenation of the package mdframed
-%%$Id: mdframed-doc-en.tex 174 2011-09-04 17:25:41Z marco $
-%%$Rev: 174 $
+%%$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 174 2011-09-04 17:25:41Z marco $
+\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}
@@ -50,9 +52,13 @@
\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,%
@@ -60,11 +66,31 @@
rulecolor=\color{titleblue},%
framesep=5pt,%
framerule=1pt,%
- language=[LaTeX]TeX,#1,%
+ texcsstyle=*\color{red!50!black}\bfseries,
+ moretexcs=intertext,
+ keywordstyle=\color{blue!60!black}\bfseries,%
columns=fixed,%
fontadjust=true,%
basewidth=0.65em,%
- breakatwhitespace=true}%
+ 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{ }}%
{}
@@ -144,26 +170,22 @@ By using \mdcommand{newenvironment} the user may choose between several individu
\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}
-\newtheorem{mdtheorem}{Theorem}[section]
-\newenvironment{theorem}{\begin{mdframed}%
- [outerlinewidth=2,leftmargin=40,rightmargin=40,%
- backgroundcolor=yellow,outerlinecolor=blue,%
+\newmdtheoremenv[outerlinewidth=2,leftmargin=40,
+ rightmargin=40,backgroundcolor=yellow,%
+ outerlinecolor=blue,innertopmargin=0pt,%
splittopskip=\topskip,skipbelow=\baselineskip,%
- skipabove=\baselineskip,ntheorem]%
- \begin{mdtheorem}}{\end{mdtheorem}\end{mdframed}}
+ skipabove=\baselineskip,ntheorem]{theorem}%
+ {Theorem}[section]
\begin{theorem}[Pythagorean theorem]
...
\end{theorem}
\end{mdexample}
-\newtheorem{mdtheorem}{Theorem}[section]
-\newenvironment{theorem}{\begin{mdframed}%
- [outerlinewidth=2,leftmargin=40,rightmargin=40,%
+%\newtheorem{mdtheorem}{Theorem}[section]
+\newmdtheoremenv[outerlinewidth=2,leftmargin=40,rightmargin=40,%
backgroundcolor=yellow,outerlinecolor=blue,innertopmargin=0pt,%
splittopskip=\topskip,skipbelow=\baselineskip,%
- skipabove=\baselineskip,ntheorem,]%
- \begin{mdtheorem}}%
- {\end{mdtheorem}\end{mdframed}}
+ skipabove=\baselineskip,ntheorem]{theorem}{Theorem}[section]
\begin{theorem}[Pythagorean theorem]
In any right triangle, the area of the square whose side is the hypotenuse
@@ -211,7 +233,7 @@ In this way you can simply use:
\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}
+\begin{mdexample}[deletekeywords={mdframed}]
\newmdtheoremenv[<mdframed-options>]{<envname>}%
[<numberedlike>]{<caption>}[<within>]
\end{mdexample}
@@ -547,7 +569,7 @@ body you will get this warning.
\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.
+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}
@@ -621,7 +643,7 @@ First we want to type out the single box without any settings (but with the calc
\makeatother
\end{mdexample}
I am using the command \mdcommand{leftline} to start the \glqq Framecommands\grqq\ at the left.
-\begin{mdexample}
+\begin{mdexample}[deletekeywords={leftline},moretexcs={leftline}]
\makeatletter
\def\md@putbox@single{\leftline{\box\@tempboxa}}
\makeatother
@@ -638,7 +660,7 @@ For example the leftmargin is:
To create only a line at the left with the correct \mdoption{leftmargin} you can set \mdcommand{md@putboxsingle} as follows
-\begin{mdexample}
+\begin{mdexample}[deletekeywords={leftline},moretexcs={leftline}]
\makeatletter
\def\md@putbox@single{%
\leftline{%
@@ -747,5 +769,97 @@ With the new length \mdcommand{interruptlength} you can manipulate the amount of
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}