diff options
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r-- | Master/texmf-dist/doc/latex/mdframed/README | 7 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/mdframed/mdframed-doc-en.pdf | bin | 143131 -> 144300 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/mdframed/mdframed-doc-en.tex | 70 |
3 files changed, 48 insertions, 29 deletions
diff --git a/Master/texmf-dist/doc/latex/mdframed/README b/Master/texmf-dist/doc/latex/mdframed/README index 0642e0e369c..adb1030f176 100644 --- a/Master/texmf-dist/doc/latex/mdframed/README +++ b/Master/texmf-dist/doc/latex/mdframed/README @@ -1,4 +1,4 @@ -%%$Id: README 201 2011-10-04 18:57:50Z marco $ +%%$Id: README 209 2011-10-09 11:53:45Z marco $ The standard methods for framing text (\fbox or \fcolorbox) require you to handle page breaks by hand, meaning that you @@ -11,8 +11,7 @@ Author's name: Marco Daniel and Elke Schubert (tikz) License type: lppl ---------------------------- -v0.9f -- fixes bugs (thanks to Lars Madsen) -- added option hidealllines +v0.9h - fixed documentation +- fixed 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 Binary files differindex 29d3c8d605d..b73167e07a2 100644 --- a/Master/texmf-dist/doc/latex/mdframed/mdframed-doc-en.pdf +++ b/Master/texmf-dist/doc/latex/mdframed/mdframed-doc-en.pdf 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 94cefa6bd27..a9ea47561df 100644 --- a/Master/texmf-dist/doc/latex/mdframed/mdframed-doc-en.tex +++ b/Master/texmf-dist/doc/latex/mdframed/mdframed-doc-en.tex @@ -1,6 +1,6 @@ %Documenation of the package mdframed -%%$Id: mdframed-doc-en.tex 201 2011-10-04 18:57:50Z marco $ -%%$Rev: 201 $ +%%$Id: mdframed-doc-en.tex 209 2011-10-09 11:53:45Z marco $ +%%$Rev: 209 $ %%$Author: marco $ %%$Dater:$ %% [latex -> ps -> pdf] @@ -8,7 +8,7 @@ \documentclass[english,11pt,]{scrartcl} %\usepackage{showframe} \usepackage[nofancy,draft,notoday]{svninfo} -\svnInfo $Id: mdframed-doc-en.tex 201 2011-10-04 18:57:50Z marco $ +\svnInfo $Id: mdframed-doc-en.tex 209 2011-10-09 11:53:45Z marco $ \usepackage{babel} \usepackage[utf8]{inputenc} \usepackage[T1]{fontenc} @@ -470,26 +470,9 @@ the second one is a number (e.g. 2) which will be multiplied by \mdoption{1 defa \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}\label{genopt} - - - \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} @@ -515,6 +498,36 @@ the second one is a number (e.g. 2) which will be multiplied by \mdoption{1 defa \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{framemethod=TikZ}.} + +\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. + +\mdDescribeMacro[false]{rightline} With this option you can decide whether all lines should be drawn or not. + +\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. + +\subsection{Footnotes} +Inside the environment you can use the command \mdcommand{footnote} as usual. \mdname uses the syntax of environment \mdpack{minipage} with the same counter. + +Every footnote text will be collect inside a box and will be displayed at the end of the environment \mdname. + +\mdDescribeMacro[\mbox{} \mdcommand{bigskipamount}]{footnotedistance} The length is the distance between the end of the environement \mdname and the displaying of the \mdcommand{footnoterule}. + +\mdDescribeMacro[true]{footnoteinside} The position of the footnotes can be changed with the option \mdoption{footnoteinside}. The footnotes will be displayed at the end of the environment but you can decide whether the output is inside \mdname or after. + +\vskip\baselineskip +\noindent\textbf{Note}\qquad The ouput of the footnotes with the option \mdoption{footnoteinside=false} are not in a splitted frame. I think it isn't useful because the first line of a new page shouldn't be a footnote. + + \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{framemethod=TikZ}. \mdfsetup{skipabove=\baselineskip,skipbelow=\baselineskip} @@ -683,16 +696,17 @@ body you will get this warning. \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 So far it isn't possible to combine the environment \mdcommand{begin\{multicols\}} of the package \mdpack{multicol} with \mdpack{mdframed} with the whole option list. \item Create new styles. \item Improve page breaks. + \item Improve footnotes + \item Improve documentation and create a separate pdf with examples \end{enumerate} \section{Previous versions} @@ -705,7 +719,7 @@ If you have trouble with the new version of \mdname you can load \texttt{mdframe -\textsf{Dick Nickalls;\quad Dr. Dietrich Grau;\quad Piazza Luca\quad Jobst Hoffmann}. +\textsf{Dick Nickalls;\quad Dietrich Grau;\quad Piazza Luca\quad Jobst Hoffmann}. \medskip \noindent Thanks for proofreading @@ -944,7 +958,13 @@ Text\par Text\par Text \twocolumn[\subsection{Revision history}\label{rev}] \setkomafont{subsubsection}{\normalfont\bfseries} \small\raggedright -\minisec{Version 0.9d submitted 04 Oct 2011} +\minisec{Version 0.9g submitted 08 Oct 2011} +\begin{itemize} +\item fixed documentation +\item added small footnote compatibility +\end{itemize} + +\minisec{Version 0.9f submitted 04 Oct 2011} \begin{itemize} \item fixes bugs (thanks to Lars Madsen) \item added option \mdoption{hidealllines} @@ -1044,7 +1064,7 @@ Text\par Text\par Text \minisec{Version 0.3b submitted 1 May 2010} \begin{itemize} -\item fixes some bugs -- thanks to Dr. Dietrich Grau +\item fixes some bugs -- thanks to Dietrich Grau \item added new options: \mdoption{ntheorem} \end{itemize} |