diff options
author | Karl Berry <karl@freefriends.org> | 2013-03-07 23:13:00 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2013-03-07 23:13:00 +0000 |
commit | 4e1f696f6b4ab551a453f61da79aa42f4b06d510 (patch) | |
tree | 75b4dfef3b0234553d20ccdec193c118c815d41f /Master/texmf-dist/doc | |
parent | 81b31d750e9806bfcd17916b130f77496b1ee9e3 (diff) |
tcolorbox (7mar13)
git-svn-id: svn://tug.org/texlive/trunk@29309 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r-- | Master/texmf-dist/doc/latex/tcolorbox/CHANGES | 20 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/tcolorbox/README | 4 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/tcolorbox/tcolorbox-example.pdf | bin | 147401 -> 147400 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/tcolorbox/tcolorbox-example.tex | 2 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.pdf | bin | 1500559 -> 1520185 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.tex | 188 |
6 files changed, 168 insertions, 46 deletions
diff --git a/Master/texmf-dist/doc/latex/tcolorbox/CHANGES b/Master/texmf-dist/doc/latex/tcolorbox/CHANGES index f11ff014d33..7b505aac700 100644 --- a/Master/texmf-dist/doc/latex/tcolorbox/CHANGES +++ b/Master/texmf-dist/doc/latex/tcolorbox/CHANGES @@ -1,4 +1,4 @@ -%% The LaTeX package tcolorbox - version 2.00 (2013/03/01)
+%% The LaTeX package tcolorbox - version 2.01 (2013/03/07)
%%
%% -------------------------------------------------------------------------------------------
%% Copyright (c) 2006-2012 by Prof. Dr. Dr. Thomas F. Sturm <thomas dot sturm at unibw dot de>
@@ -70,7 +70,7 @@ version 1.30 (2012/04/20) 'colbacklower'
version 2.00 (2013/03/01)
-- breaking news: the new library 'breakable' add breaking support to tcolorbox.
+- breaking news: the new library 'breakable' adds breaking support to tcolorbox.
- e-TeX now used instead of calc
- new key 'adjust text' and new implementation for 'adjusted title'
- new geometry keys:
@@ -99,5 +99,19 @@ version 2.00 (2013/03/01) 'watermark text', 'watermark text on', 'watermark graphics',
'watermark graphics on', 'watermark tikz', 'watermark tikz on',
'no watermark', 'watermark opacity', 'watermark color',
- 'watermark zoom', 'watermark stretch',
+ 'watermark zoom', 'watermark stretch'
+
+version 2.01 (2013/03/07)
+- bug fix: superfluous vertical space for a breakable box which appeared after a page break
+- bug fix: height computation error when a broken boxed starts with a segmentation line
+- new key for the 'listings' library:
+ 'listing inputencoding'
+- new library 'listingsutf8' as variant of 'listings' with new key
+ 'listing utf8'
+- keys 'toprule at break', 'bottomrule at break',
+ 'enlarge top at break by', 'enlarge bottom at break by'
+ moved from core package to 'breakable' library.
+- new keys for the 'breakable' library:
+ 'topsep at break', 'bottomsep at break', 'pad before break',
+ 'pad after break', 'pad at break'
diff --git a/Master/texmf-dist/doc/latex/tcolorbox/README b/Master/texmf-dist/doc/latex/tcolorbox/README index 217e6249343..f5e5e6fbf9d 100644 --- a/Master/texmf-dist/doc/latex/tcolorbox/README +++ b/Master/texmf-dist/doc/latex/tcolorbox/README @@ -1,4 +1,4 @@ -%% The LaTeX package tcolorbox - version 2.00 (2013/03/01) +%% The LaTeX package tcolorbox - version 2.01 (2013/03/07) %% %% ------------------------------------------------------------------------------------------- %% Copyright (c) 2006-2013 by Prof. Dr. Dr. Thomas F. Sturm <thomas dot sturm at unibw dot de> @@ -32,6 +32,7 @@ Contents of the package 'tcbbreakable.code.tex' LaTeX package file (library of tcolorbox) 'tcbdocumenation.code.tex' LaTeX package file (library of tcolorbox) 'tcblistings.code.tex' LaTeX package file (library of tcolorbox) + 'tcblistingsutf8.code.tex' LaTeX package file (library of tcolorbox) 'tcbskins.code.tex' LaTeX package file (library of tcolorbox) 'tcbtheorems.code.tex' LaTeX package file (library of tcolorbox) 'tcolorbox.pdf' Documentation for tcolorbox @@ -50,6 +51,7 @@ Alternatively, put the files to their respective locations within the TeX instal 'tcbbreakable.code.tex' -> /tex/latex/tcolorbox 'tcbdocumenation.code.tex' -> /tex/latex/tcolorbox 'tcblistings.code.tex' -> /tex/latex/tcolorbox + 'tcblistingsutf8.code.tex' -> /tex/latex/tcolorbox 'tcbtheorems.code.tex' -> /tex/latex/tcolorbox 'tcbskins.code.tex' -> /tex/latex/tcolorbox all other files -> /doc/latex/tcolorbox diff --git a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox-example.pdf b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox-example.pdf Binary files differindex 22711a6773e..432f7194929 100644 --- a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox-example.pdf +++ b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox-example.pdf diff --git a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox-example.tex b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox-example.tex index 67b4a3da847..80aae833f4b 100644 --- a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox-example.tex +++ b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox-example.tex @@ -1,4 +1,4 @@ -%% The LaTeX package tcolorbox - version 2.00 (2013/03/01) +%% The LaTeX package tcolorbox - version 2.01 (2013/03/07) %% tcolorbox-example.tex: an example for tcolorbox %% %% ------------------------------------------------------------------------------------------- diff --git a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.pdf b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.pdf Binary files differindex 2a7701620ad..ad3fbe01abe 100644 --- a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.pdf +++ b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.pdf diff --git a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.tex b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.tex index 1f6ed365176..42b21104154 100644 --- a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.tex +++ b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.tex @@ -1,5 +1,5 @@ % \LaTeX-Main\ -%% The LaTeX package tcolorbox - version 2.00 (2013/03/01) +%% The LaTeX package tcolorbox - version 2.01 (2013/03/07) %% tcolorbox.tex: Manual %% %% ------------------------------------------------------------------------------------------- @@ -81,8 +81,8 @@ pdfkeywords={colored boxes, LaTeX examples, theorems} } -\def\version{2.00}% -\def\datum{2013/03/01}% +\def\version{2.01}% +\def\datum{2013/03/07}% \makeindex %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -175,32 +175,41 @@ The following keys are used inside |\tcbuselibrary| respectively \begin{docTcbKey}[library]{listings}{}{no value} Loads the package |listings| \cite{heinz:2007a} and provides additional - macros for typesetting listings which are described in section \ref{sec:listings} + macros for typesetting listings which are described in Section \ref{sec:listings} from page \pageref{sec:listings}. \end{docTcbKey} +\begin{docTcbKey}[library]{listingsutf8}{}{no value} + Loads the packages |listings| \cite{heinz:2007a} and + |listingsutf8| \cite{oberdiek:2011a} for UTF-8 support. + This is a variant of the library 'listings' + and is described in Section \ref{sec:listings} + from page \pageref{sec:listings}. +\end{docTcbKey} + + \begin{docTcbKey}[library]{theorems}{}{no value} Provides additional - macros for typesetting theorems which are described in section \ref{sec:theorems} + macros for typesetting theorems which are described in Section \ref{sec:theorems} from page \pageref{sec:theorems}. \end{docTcbKey} \begin{docTcbKey}[library]{documentation}{}{no value} Provides additional macros for typesetting \LaTeX\ documentations - which are described in section \ref{sec:documentation} + which are described in Section \ref{sec:documentation} from page \pageref{sec:documentation}. \end{docTcbKey} \begin{docTcbKey}[library]{skins}{}{no value} Loads the package |tikz| \cite{tantau:2010c} and provides additional styles (skins) for the appearance of the colored boxes; see - section \ref{sec:skins} from page \pageref{sec:skins}. + Section \ref{sec:skins} from page \pageref{sec:skins}. \end{docTcbKey} \begin{docTcbKey}[library]{breakable}{}{no value} Provides support for automatic box breaking from one page to another; - see section \ref{sec:breakable} from page \pageref{sec:breakable}. + see Section \ref{sec:breakable} from page \pageref{sec:breakable}. \end{docTcbKey} @@ -532,12 +541,6 @@ This is a \textbf{tcolorbox}. \end{dispExample} \end{docTcbKey} -\begin{docTcbKey}{toprule at break}{=\meta{length}}{no default, initially \texttt{0.5mm}} - Sets the line width of the top rule to \meta{length} \emph{if} the box is \refKey{/tcb/breakable}. - In this case, it is applied to \emph{middle} and \emph{last} parts in a - break sequence. Note that \refKey{/tcb/toprule} overwrites this value - if used afterwards. -\end{docTcbKey} \begin{docTcbKey}{bottomrule}{=\meta{length}}{no default, initially \texttt{0.5mm}} Sets the line width of the bottom rule to \meta{length}. @@ -550,26 +553,19 @@ This is a \textbf{tcolorbox}. \end{dispExample} \end{docTcbKey} -\begin{docTcbKey}{bottomrule at break}{=\meta{length}}{no default, initially \texttt{0.5mm}} - Sets the line width of the bottom rule to \meta{length} \emph{if} the box is \refKey{/tcb/breakable}. - In this case, it is applied to \emph{first} and \emph{middle} parts in a - break sequence. Note that \refKey{/tcb/bottomrule} overwrites this value - if used afterwards. -\end{docTcbKey} -\clearpage \begin{docTcbKey}{leftrule}{=\meta{length}}{no default, initially \texttt{0.5mm}} Sets the line width of the left rule to \meta{length}. \begin{dispExample} \tcbset{colback=red!5!white,colframe=red!75!black} -\clearpage \begin{tcolorbox}[leftrule=3mm] This is a \textbf{tcolorbox}. \end{tcolorbox} \end{dispExample} \end{docTcbKey} +\clearpage \begin{docTcbKey}{rightrule}{=\meta{length}}{no default, initially \texttt{0.5mm}} Sets the line width of the right rule to \meta{length}. \begin{dispExample} @@ -1250,14 +1246,6 @@ This is a \textbf{tcolorbox}. \end{docTcbKey} -\begin{docTcbKey}{enlarge top at break by}{=\meta{length}}{no default, initially \texttt{0mm}} - Enlarges the bounding box distance to the top of the box by \meta{length} - \emph{if} the box is \refKey{/tcb/breakable}. - In this case, it is applied to \emph{middle} and \emph{last} parts in a - break sequence. - \refKey{/tcb/enlarge top by} overwrites this key. -\end{docTcbKey} - \begin{docTcbKey}{enlarge bottom by}{=\meta{length}}{no default, initially |0mm|} Enlarges the bounding box distance to the bottom of the box by \meta{length}. @@ -1274,13 +1262,6 @@ This is a \textbf{tcolorbox}. \end{docTcbKey} -\begin{docTcbKey}{enlarge bottom at break by}{=\meta{length}}{no default, initially \texttt{0mm}} - Enlarges the bounding box distance to the bottom of the box by \meta{length} - \emph{if} the box is \refKey{/tcb/breakable}. - In this case, it is applied to \emph{first} and \emph{middle} parts in a - break sequence. \refKey{/tcb/enlarge bottom by} overwrites this key. -\end{docTcbKey} - \clearpage \begin{docTcbKey}{enlarge left by}{=\meta{length}}{no default, initially |0mm|} @@ -1457,13 +1438,25 @@ Now, we are using the file:\par \clearpage -\section{Library 'listings'}\label{sec:listings} +\section{Library 'listings' / 'listingsutf8'}\label{sec:listings} The library is loaded by a package option or inside the preamble by: \begin{dispListing} \tcbuselibrary{listings} \end{dispListing} This also loads the package |listings| \cite{heinz:2007a}. +Alternatively, if your sources are encoded with UTF-8, you can use the support from +the package |listingsutf8| \cite{oberdiek:2011a} by loading the library +variant 'listingsutf8'. +\begin{dispListing} +\tcbuselibrary{listingsutf8} +\tcbset{listing utf8=latin1}% optional; 'latin1' is the default. +\end{dispListing} +This also loads the packages |listings| \cite{heinz:2007a} +and |listingsutf8| \cite{oberdiek:2011a}. + + + \subsection{Macros of the Library} \begin{docEnvironment}{tcblisting}{\marg{options}} @@ -1479,7 +1472,7 @@ This is a \LaTeX\ example which displays the text as source code and in compiled form. \end{tcblisting} \end{dispExample} -\begin{dispExample} +{\tcbset{breakable}\begin{dispExample} \begin{tcblisting}{colback=yellow!5,colframe=yellow!50!black,listing only, title=This is source code in another language (XML), fonttitle=\bfseries, listing options={language=XML,columns=fullflexible,keywordstyle=\color{red}}} @@ -1491,10 +1484,11 @@ and in compiled form. </project> \end{tcblisting} \end{dispExample} +} \end{docEnvironment} -\clearpage +%\clearpage \begin{docEnvironment}{tcboutputlisting}{} Saves the environment content to a file which is named by the key value of |listing file|. Later, this file can be loaded by @@ -1577,6 +1571,23 @@ Here, we use the predefined style. \end{dispExample} \end{docTcbKey} + +\begin{docTcbKey}{listing inputencoding}{=\meta{encoding}}{no default, initially \texttt{\cs inputencodingname}} + Sets the input encoding value for the predefined listing style |tcblatex| + and |tcbdocumentation| from the library 'documentation'. + The initial value is derived from the package |inputenc| if used. +\end{docTcbKey} + + +\begin{docTcbKey}{listing utf8}{=\meta{one-byte-encoding}}{style, no default, initially |latin1|} + Abbreviation for using \refKey{/tcb/listing inputencoding} + together with UTF-8 support from the package |listingsutf8| \cite{oberdiek:2011a}. + This option is available only for the library variant 'listingsutf8'. + The \meta{one-byte-encoding} is one of + the applicable encodings from \cite{oberdiek:2011a}, e.\,g.\ |latin1|. +\end{docTcbKey} + + \clearpage \begin{docTcbKey}{listing and text}{}{no value, initially set} Typesets the environment content as listing in the upper part and @@ -2155,6 +2166,11 @@ This also loads the library 'listings', see section \ref{sec:listings}, and a bunch of packages, namely |doc|, |pifont|, |marvosym|, |hyperref|, and |makeidx|. +For UTF-8 support, load: +\begin{dispListing} + \tcbuselibrary{listingsutf8,documentation} +\end{dispListing} + \subsection{Macros of the Library} @@ -4246,7 +4262,7 @@ parameters. The differences are: \clearpage -\subsection{Option Keys} +\subsection{Main Option Keys} \begin{docTcbKey}{breakable}{}{no value} Allows the |tcolorbox| to be breakable. If the box is larger than the available space at the current page, the box is automatically broken @@ -4305,6 +4321,89 @@ parameters. The differences are: \end{docTcbKey} +\clearpage +\subsection{Option Keys for the Break Appearance} + +\begin{docTcbKey}{toprule at break}{=\meta{length}}{no default, initially \texttt{0.5mm}} + Sets the line width of the top rule to \meta{length} \emph{if} the box is \refKey{/tcb/breakable}. + In this case, it is applied to \emph{middle} and \emph{last} parts in a + break sequence. Note that \refKey{/tcb/toprule} overwrites this value + if used afterwards. +\end{docTcbKey} + + +\begin{docTcbKey}{bottomrule at break}{=\meta{length}}{no default, initially \texttt{0.5mm}} + Sets the line width of the bottom rule to \meta{length} \emph{if} the box is \refKey{/tcb/breakable}. + In this case, it is applied to \emph{first} and \emph{middle} parts in a + break sequence. Note that \refKey{/tcb/bottomrule} overwrites this value + if used afterwards. +\end{docTcbKey} + + + + +\begin{docTcbKey}{topsep at break}{=\meta{length}}{no default, initially \texttt{0mm}} + Additional vertical space of \meta{length} which is added at the top of + \emph{middle} and \emph{last} parts in a break sequence. In general, + it is not advisable to change this value if these parts start with a rule or a title. +\end{docTcbKey} + +\begin{docTcbKey}{bottomsep at break}{=\meta{length}}{no default, initially \texttt{0mm}} + Additional vertical space of \meta{length} which is added at the bottom of + \emph{first} and \emph{middle} parts in a break sequence. + In general, it is not advisable to change this value if these parts end with a rule. +\end{docTcbKey} + +\begin{docTcbKey}{pad before break}{=\meta{length}}{style, no default, initially \texttt{3.5mm}} + Sets the total amount of vertical space after the text content and before the + break point to \meta{length}. This style sets \refKey{/tcb/toprule at break} to |0pt| + and changes \refKey{/tcb/topsep at break} as required. + In general, it is not advisable to change this value if the + \emph{middle} and \emph{last} parts in a break sequence start with a rule or a title. +\end{docTcbKey} + +\begin{docTcbKey}{pad after break}{=\meta{length}}{style, no default, initially \texttt{3.5mm}} + Sets the total amount of vertical space after the break point and before the + text content to \meta{length}. This style sets \refKey{/tcb/bottomrule at break} to |0pt| + and changes \refKey{/tcb/bottomsep at break} as required. + In general, it is not advisable to change this value if the + \emph{first} and \emph{middle} parts in a break sequence end with a rule. +\end{docTcbKey} + +\begin{docTcbKey}{pad at break}{=\meta{length}}{style, no default, initially \texttt{3.5mm}} + Abbreviation for setting \meta{length} to \refKey{/tcb/pad before break} + and \refKey{/tcb/pad after break}. +\end{docTcbKey} + + +\begin{dispListing} +% \usepackage{lipsum} % preamble +\tcbset{colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries} + +\begin{tcolorbox}[enhanced,breakable,pad at break=0mm, + title={For this box, the pad space at the break point is set to 0mm}] + \lipsum[1-2] +\end{tcolorbox} +\end{dispListing} +{\tcbusetemp} + + + +\begin{docTcbKey}{enlarge top at break by}{=\meta{length}}{no default, initially \texttt{0mm}} + Enlarges the bounding box distance to the top of the box by \meta{length} + \emph{if} the box is \refKey{/tcb/breakable}. + In this case, it is applied to \emph{middle} and \emph{last} parts in a + break sequence. + \refKey{/tcb/enlarge top by} overwrites this key. +\end{docTcbKey} + + +\begin{docTcbKey}{enlarge bottom at break by}{=\meta{length}}{no default, initially \texttt{0mm}} + Enlarges the bounding box distance to the bottom of the box by \meta{length} + \emph{if} the box is \refKey{/tcb/breakable}. + In this case, it is applied to \emph{first} and \emph{middle} parts in a + break sequence. \refKey{/tcb/enlarge bottom by} overwrites this key. +\end{docTcbKey} \clearpage @@ -4487,6 +4586,13 @@ own purposes. date = {1998-02}, } +@manual{oberdiek:2011a, + author = {Heiko Oberdiek}, + title = {The listingsutf8 package}, + url = {http://mirror.ctan.org/macros/latex/contrib/oberdiek/listingsutf8.pdf}, + date = {2011-11-10}, +} + \end{tcbverbatimwrite} \clearpage |