diff options
author | Karl Berry <karl@freefriends.org> | 2013-07-30 22:41:10 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2013-07-30 22:41:10 +0000 |
commit | d7fd9f2468acabe43939c50b2f94605d2612364d (patch) | |
tree | 29b62ed181427e8565d6969265b05c33450ec100 /Master/texmf-dist/doc/latex | |
parent | 6c0928331909ce5c71fe9538707fc786ef7ff6c4 (diff) |
tcolorbox (30jul13)
git-svn-id: svn://tug.org/texlive/trunk@31316 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex')
18 files changed, 421 insertions, 104 deletions
diff --git a/Master/texmf-dist/doc/latex/tcolorbox/CHANGES b/Master/texmf-dist/doc/latex/tcolorbox/CHANGES index 183e401167c..a84d3dc7c50 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.41 (2013/07/23) +%% The LaTeX package tcolorbox - version 2.50 (2013/07/29) %% %% ------------------------------------------------------------------------------------------- %% Copyright (c) 2006-2013 by Prof. Dr. Dr. Thomas F. Sturm <thomas dot sturm at unibw dot de> @@ -301,3 +301,17 @@ version 2.41 (2013/07/23) * capture mode can be changed for 'tcblisting' and '\tcbinputlisting' * new option: 'listing remove caption' +version 2.50 (2013/07/29) +- first line indent corrected for 'parbox=false' +- minor internal improvements +- new option keys + 'height plus', 'height from' +- new library 'minted' with support for the minted package (Pygments support) + * new options 'minted language', 'minted options', 'minted style' +- new library option 'many' +- new common listings options: + 'listing engine' +- library 'documentation': + * new options 'documentation minted style', 'documentation minted options' + + diff --git a/Master/texmf-dist/doc/latex/tcolorbox/README b/Master/texmf-dist/doc/latex/tcolorbox/README index 3b9c7cd1ec1..4f8ef87f4d4 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.41 (2013/07/23) +%% The LaTeX package tcolorbox - version 2.50 (2013/07/29) %% %% ------------------------------------------------------------------------------------------- %% Copyright (c) 2006-2013 by Prof. Dr. Dr. Thomas F. Sturm <thomas dot sturm at unibw dot de> @@ -34,7 +34,9 @@ Contents of the package 'tcbfitting.code.tex' LaTeX package file (library of tcolorbox) 'tcbhooks.code.tex' LaTeX package file (library of tcolorbox) 'tcblistings.code.tex' LaTeX package file (library of tcolorbox) + 'tcblistingscore.code.tex' LaTeX package file (library of tcolorbox) 'tcblistingsutf8.code.tex' LaTeX package file (library of tcolorbox) + 'tcbminted.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 @@ -56,7 +58,9 @@ Alternatively, put the files to their respective locations within the TeX instal 'tcbfitting.code.tex' -> /tex/latex/tcolorbox 'tcbhooks.code.tex' -> /tex/latex/tcolorbox 'tcblistings.code.tex' -> /tex/latex/tcolorbox + 'tcblistingscore.code.tex' -> /tex/latex/tcolorbox 'tcblistingsutf8.code.tex' -> /tex/latex/tcolorbox + 'tcbminted.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 4352b1219e8..7cca51ae8c1 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 bdca33ba0c2..6de86fd545e 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.41 (2013/07/23) +%% The LaTeX package tcolorbox - version 2.50 (2013/07/29) %% tcolorbox-example.tex: an example for tcolorbox %% %% ------------------------------------------------------------------------------------------- diff --git a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.abstract.tex b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.abstract.tex index c38a0d266b9..bcaff6a1810 100644 --- a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.abstract.tex +++ b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.abstract.tex @@ -1,9 +1,12 @@ % !TeX root = tcolorbox.tex % include file of tcolorbox.tex (manual of the LaTeX package tcolorbox) \begin{center} -\vspace*{5mm}\par -{\bfseries\LARGE The \texttt{tcolorbox} package\par} -{\large Manual for version \version\ (\datum)\par}\bigskip +\vspace*{5mm} +\begin{tcolorbox}[center upper,width=9cm,colback=white,colframe=black!50!yellow, + boxrule=0.4pt,enhanced,fuzzy shadow={0mm}{-1mm}{-0.5mm}{0.1mm}{black!50!yellow}] +{\bfseries\LARGE The \texttt{tcolorbox} package\par}\medskip +{\large Manual for version \version\ (\datum)\par} +\end{tcolorbox}\bigskip {\large Thomas F.~Sturm% \footnote{Prof.~Dr.~Dr.~Thomas F.~Sturm, Institut f\"{u}r Mathematik und Informatik, Universit\"{a}t der Bundeswehr M\"{u}nchen, D-85577 Neubiberg, Germany; diff --git a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.bib b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.bib index 05e8cc7d120..5c2f71ae2d4 100644 --- a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.bib +++ b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.bib @@ -130,7 +130,6 @@ date = {2011-01-03}, } - @manual{cubitt:2013a, author = {Toby Cubitt}, title = {The cleveref Package}, @@ -138,3 +137,19 @@ date = {2013-03-22}, } +@manual{rudolph:2011a, + author = {Konrad Rudolph}, + title = {The minted package}, + subtitle = {Highlighted source code in \LaTeX}, + url = {http://mirror.ctan.org/macros/latex/contrib/minted/minted.pdf}, + date = {2011-09-17}, +} + + +@online{pygments:2013, + title = {Pygments}, + subtitle = {Python syntax highlighter}, + date = {2013}, + url = {http://pygments.org/}, +} + diff --git a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.breakable.tex b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.breakable.tex index 3c893dc6d72..1999513a72b 100644 --- a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.breakable.tex +++ b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.breakable.tex @@ -1,14 +1,14 @@ % !TeX root = tcolorbox.tex % include file of tcolorbox.tex (manual of the LaTeX package tcolorbox) \clearpage -\section{Library 'breakable'}\label{sec:breakable} +\section{Library \mylib{breakable}}\label{sec:breakable} The library is loaded by a package option or inside the preamble by: \begin{dispListing} \tcbuselibrary{breakable} \end{dispListing} \subsection{Technical Overview} -The library 'breakable' supports the automatic breaking of a |tcolorbox|. +The library \mylib{breakable} supports the automatic breaking of a |tcolorbox|. This feature is enabled by \refKey{/tcb/breakable} and disabled by \refKey{/tcb/unbreakable}. @@ -316,7 +316,8 @@ the \emph{break sequence} parts are displayed. \clearpage \subsection{Break by Hand (Faked Break)} Since the appearance of broken boxes is done by skins, it is quite easy -to 'fake a break'. For this, you actually don't need the 'breakable' library at +to 'fake a break'. For this, you actually don't need the +\mylib{breakable} library at all. \begin{dispExample} diff --git a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.coremacros.tex b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.coremacros.tex index 45801e6b456..ed881bd08f7 100644 --- a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.coremacros.tex +++ b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.coremacros.tex @@ -194,6 +194,22 @@ numbered title and options. {This is my own box.} \end{dispExample*} +\begin{dispExample} +\newtcbox{\mybox}[1][red]{nobeforeafter,tcbox raise base, + arc=0pt,outer arc=0pt,colback=#1!10!white,colframe=#1!50!black, + boxsep=0pt,left=1pt,right=1pt,top=2pt,bottom=2pt, + boxrule=0pt,bottomrule=1pt,toprule=1pt} +\newtcbox{\xmybox}[1][red]{nobeforeafter,tcbox raise base, + arc=7pt,colback=#1!10!white,colframe=#1!50!black, + before upper={\rule[-3pt]{0pt}{10pt}},boxrule=1pt, + boxsep=0pt,left=6pt,right=6pt,top=2pt,bottom=2pt} + +The \mybox[green]{quick} brown \mybox{fox} \mybox[blue]{jumps} over the +\mybox[green]{lazy} \mybox{dog}.\par +The \xmybox[green]{quick} brown \xmybox{fox} \xmybox[blue]{jumps} over the +\xmybox[green]{lazy} \xmybox{dog}. +\end{dispExample} + \end{docCommand} diff --git a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.coreoptions.tex b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.coreoptions.tex index 159b5112672..d38298947ba 100644 --- a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.coreoptions.tex +++ b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.coreoptions.tex @@ -713,7 +713,8 @@ or to fit commonly for several boxes, e.\,g. if boxes are set side by side. \begin{docTcbKey}{height}{=\meta{length}}{no default} Sets the total height of the colored box to \meta{length} independent - of the box content. + of the box content. \meta{length} is the minimum height of the box, if + \refKey{height plus} is larger than zero. \begin{dispExample} \tcbset{width=(\linewidth-2mm)/3,before=,after=\hfill, colframe=blue!75!black,colback=white} @@ -732,6 +733,48 @@ colframe=blue!75!black,colback=white} \end{dispExample} \end{docTcbKey} +\enlargethispage*{10mm} +\begin{docTcbKey}{height plus}{=\meta{length}}{no default, initially |0pt|} + The box may extend a given fixed \refKey{/tcb/height} up to the given \meta{length}. +\begin{dispExample} +\tcbset{colback=red!5!white,colframe=red!75!black,left=1mm,top=1mm,bottom=1mm, + right=1mm,boxsep=0mm,width=3cm,nobeforeafter} + +\begin{tcolorbox}[height=1cm] +This is a tcolorbox. +\end{tcolorbox} +\begin{tcolorbox}[height=1cm,height plus=1cm] +This is a tcolorbox. +\end{tcolorbox} +\begin{tcolorbox}[height=1cm,height plus=1cm] +This is a tcolorbox. This is a tcolorbox. This is a tcolorbox. +\end{tcolorbox} +\end{dispExample} +\end{docTcbKey} + + +\begin{docTcbKey}{height from}{=\meta{min} \texttt{to} \meta{max}}{style, no default} + Sets the box height to a dimension between \meta{min} and \meta{max}. +\begin{dispExample} +% \usepackage{lipsum} +\newtcolorbox{mybox}{colback=red!5!white,colframe=red!75!black,left=1mm,top=1mm, + bottom=1mm,right=1mm,boxsep=0mm,width=4.5cm,nobeforeafter, + height from=2cm to 8cm} + +\begin{mybox} +This is a tcolorbox. +\end{mybox} +\begin{mybox} +This is a tcolorbox. This is a tcolorbox. This is a tcolorbox. +\end{mybox} +\begin{mybox} +\lipsum[2] +\end{mybox} +\end{dispExample} +\end{docTcbKey} + + + \clearpage \begin{docTcbKey}{space}{=\meta{fraction}}{no default, initially 0} If the height of a |tcolorbox| is not the natural height, the space @@ -2029,7 +2072,7 @@ Feasible values for \meta{mode} are: a lower part and cannot be broken. The colored box is sized according to the dimensions of the content. A shortcut to set this mode is \refKey{/tcb/hbox}. -\item |fitbox|: (needs the 'fitting' library)\\ +\item |fitbox|: (needs the \mylib{fitting} library)\\ This is the default \meta{mode} for \refCom{tcboxfit}. The content cannot have a lower part and cannot be broken. The content is sized according to the dimensions of the colored box. @@ -2133,7 +2176,7 @@ Test\dotfill There are additional option keys which change the appearance of a |tcolorbox|. If only the core package is used, there is only one \emph{skin} and these keys are meaningless. -The library 'skins' adds more skins. The appropriate option keys for skins of +The library \mylib{skins} adds more skins. The appropriate option keys for skins of the core package are therefore described in section \ref{sec:skincorekeys} from page \pageref{sec:skincorekeys}. diff --git a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.documentation.tex b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.documentation.tex index 4d7fa97d35b..a615d0e8d8e 100644 --- a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.documentation.tex +++ b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.documentation.tex @@ -1,7 +1,7 @@ % !TeX root = tcolorbox.tex % include file of tcolorbox.tex (manual of the LaTeX package tcolorbox) \clearpage -\section{Library 'documentation'}\label{sec:documentation} +\section{Library \mylib{documentation}}\label{sec:documentation} This library has the single purpose to support \LaTeX\ package documentations like this one. Actually, the visual nature follows the approach from Till Tantau's |pgf| \cite{tantau:2010c} documentation. @@ -12,7 +12,7 @@ The library is loaded by a package option or inside the preamble by: \begin{dispListing} \tcbuselibrary{documentation} \end{dispListing} -This also loads the library 'listings', see section \ref{sec:listings}, +This also loads the library \mylib{listings}, see section \ref{sec:listings}, and a bunch of packages, namely |doc|, |pifont|, |marvosym|, |hyperref|, |makeidx|, and |refcount|. @@ -21,6 +21,12 @@ For UTF-8 support, load: \tcbuselibrary{listingsutf8,documentation} \end{dispListing} +For |minted| \cite{rudolph:2011a} support, load: +\begin{dispListing} + \tcbuselibrary{documentation,minted} + \tcbset{listing engine=minted} +\end{dispListing} + \subsection{Macros of the Library} @@ -315,6 +321,21 @@ This is my \colOpt{text}. \refKey{/tcb/listing style} which is used for 'normal' listings. \end{docTcbKey} +\begin{docTcbKey}{documentation minted style}{=\meta{key list}}{no default, initially unset} + Sets a \meta{style} known to |Pygments| \cite{pygments:2013} for + the package |minted| \cite{rudolph:2011a}, if used. + Note that this is not identical to the key + \refKey{/tcb/minted style} which is used for 'normal' listings. +\end{docTcbKey} + + +\begin{docTcbKey}{documentation minted options}{=\meta{minted style}}{no default, initially |tabsize=2,fontsize=\textbackslash small|} + Sets the options from the package |minted| \cite{rudolph:2011a} + which are used during typesetting of the listing, if used. + Note that this is not identical to the key + \refKey{/tcb/minted options} which is used for 'normal' listings. +\end{docTcbKey} + \begin{docTcbKey}{color definition}{=\meta{color}}{no default, initially |Definition|} Sets the highlight color used by macro and key definitions. \end{docTcbKey} @@ -367,6 +388,7 @@ This is my \colOpt{text}. \refKey{/tcb/index level}. \end{docTcbKey} +\enlargethispage*{20mm} \begin{docTcbKey}{index german settings}{}{style, no value} Sets the |makeindex| values recommended for German language texts. This is identical to setting the following: diff --git a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.fitting.tex b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.fitting.tex index 48cc75048ab..0ece167694a 100644 --- a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.fitting.tex +++ b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.fitting.tex @@ -1,7 +1,7 @@ % !TeX root = tcolorbox.tex % include file of tcolorbox.tex (manual of the LaTeX package tcolorbox) \clearpage -\section{Library 'fitting'}\label{sec:fitting} +\section{Library \mylib{fitting}}\label{sec:fitting} The library is loaded by a package option or inside the preamble by: \begin{dispListing} \tcbuselibrary{fitting} diff --git a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.hooks.tex b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.hooks.tex index d83df4d7d52..35180832978 100644 --- a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.hooks.tex +++ b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.hooks.tex @@ -1,13 +1,13 @@ % !TeX root = tcolorbox.tex % include file of tcolorbox.tex (manual of the LaTeX package tcolorbox) \clearpage -\section{Library 'hooks'}\label{sec:hooks} +\section{Library \mylib{hooks}}\label{sec:hooks} The library is loaded by a package option or inside the preamble by: \begin{dispListing} \tcbuselibrary{hooks} \end{dispListing} -For the skin related options, the library 'skins' has to be loaded +For the skin related options, the library \mylib{skins} has to be loaded separately. @@ -21,7 +21,7 @@ added to specific places of a colored box. For example, \refKey{/tcb/before uppe places code before the content of the upper part. A following usage of this key overwrites any prior settings. -The library 'hooks' extends \refKey{/tcb/before upper} and several more +The library \mylib{hooks} extends \refKey{/tcb/before upper} and several more existing keys to 'hookable' versions, e.\,g.\ \refKey{/tcb/before upper app} and \refKey{/tcb/before upper pre}. The 'hookable' keys don't overwrite prior settings but either \emph{app}end @@ -274,7 +274,7 @@ The following option keys extend the options given in Subsection \ref{subsec:wat from page \pageref{subsec:watermarks}. \begin{marker} -Watermarks are special overlays. The 'hooks' library allows the combination +Watermarks are special overlays. The \mylib{hooks} library allows the combination of several watermarks and overlays. \end{marker} diff --git a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.intro.tex b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.intro.tex index d009fce353d..1773ac4b7f4 100644 --- a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.intro.tex +++ b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.intro.tex @@ -81,65 +81,111 @@ the preamble by applying the following macro with the same set of keys. The following keys are used inside |\tcbuselibrary| respectively |\usepackage| without the key tree path |/tcb/library/|. -\begin{docTcbKey}[library]{skins}{}{no value} +\begin{docTcbKey}[library]{skins}{}{\mylib{skins}} 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}. \end{docTcbKey} -\begin{docTcbKey}[library]{listings}{}{no value} +\begin{docTcbKey}[library]{listings}{}{\mylib{listings}} Loads the package |listings| \cite{heinz:2007a} and provides additional 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} +\begin{docTcbKey}[library]{listingsutf8}{}{\mylib{listingsutf8}} Loads the packages |listings| \cite{heinz:2007a} and |listingsutf8| \cite{oberdiek:2011a} for UTF-8 support. - This is a variant of the library 'listings' + This is a variant of the library \mylib{listings} and is described in Section \ref{sec:listings} from page \pageref{sec:listings}. \end{docTcbKey} +\begin{docTcbKey}[library]{minted}{}{\mylib{minted}} + Loads the package |minted| \cite{rudolph:2011a} to + typeset listings with the |Pygments| \cite{pygments:2013} tool, + also see \Vref{sec:listings}. +\end{docTcbKey} -\begin{docTcbKey}[library]{theorems}{}{no value} +\begin{docTcbKey}[library]{theorems}{}{\mylib{theorems}} Provides additional macros for typesetting theorems which are described in Section \ref{sec:theorems} from page \pageref{sec:theorems}. \end{docTcbKey} -\begin{docTcbKey}[library]{breakable}{}{no value} +\begin{docTcbKey}[library]{breakable}{}{\mylib{breakable}} Provides support for automatic box breaking from one page to another; see Section \ref{sec:breakable} from page \pageref{sec:breakable}. \end{docTcbKey} -\begin{docTcbKey}[library]{fitting}{}{no value} +\begin{docTcbKey}[library]{fitting}{}{\mylib{fitting}} Provides support for font size adaption of the box content to the box dimensions; see Section \ref{sec:fitting} from page \pageref{sec:fitting}. \end{docTcbKey} -\begin{docTcbKey}[library]{hooks}{}{no value} +\begin{docTcbKey}[library]{hooks}{}{\mylib{hooks}} Extends several option keys to 'hookable' keys; see Section \ref{sec:hooks} from page \pageref{sec:hooks}. \end{docTcbKey} -\begin{docTcbKey}[library]{documentation}{}{no value} +\begin{docTcbKey}[library]{documentation}{}{\mylib{documentation}} Provides additional macros for typesetting \LaTeX\ documentations which are described in Section \ref{sec:documentation} from page \pageref{sec:documentation}. \end{docTcbKey} +\clearpage +\begin{docTcbKey}[library]{many}{}{style, no value} + Loads the libraries \mylib{skins}, \mylib{breakable}, \mylib{hooks}, + \mylib{theorems}, and \mylib{fitting}. + Use this shortcut, if you want to use all features of |tcolorbox| + with exception of typesetting listings and using + the specialized \mylib{documentation} library. +\end{docTcbKey} + \begin{docTcbKey}[library]{most}{}{style, no value} - Loads all libraries except 'documentation'. + Loads all libraries except \mylib{minted} and \mylib{documentation}. Use this shortcut, if you want to use all features of |tcolorbox| - with exception of the specialized 'documentation' library. + with exception of using the |minted| package and using + the specialized \mylib{documentation} library. \end{docTcbKey} \begin{docTcbKey}[library]{all}{}{style, no value} Loads all libraries. Use this shortcut only, if you indend to use the - 'documentation' library. + \mylib{documentation} library. \end{docTcbKey} + +\begin{tcolorbox}[title={Package \texttt{tcolorbox}},center title,fonttitle=\bfseries,arc=0pt, + colback=red!10!white,colframe=red!50!black] + \begin{tcolorbox}[beamer,adjusted title=Basic Features,colframe=blue!50!black,colback=blue!10!white] + Base package + \end{tcolorbox} + \tcbset{every box on layer 2/.style={reset,nobeforeafter,width=\linewidth/3-2mm, + equal height group=packageoverview,beamer,colframe=blue!50!black,colback=blue!10!white}} + \vspace{2mm} + \begin{tcolorbox}[adjusted title=Advanced Features] + \mylib{skins}\\ + \mylib{breakable}\\ + \mylib{theorems}\\ + \mylib{fitting}\\ + \mylib{hooks} + \end{tcolorbox} + \hfill + \begin{tcolorbox}[adjusted title=Listings] + \mylib{listings}\\ + \mylib{listingsutf8} + \tcblower + \mylib{minted} + \end{tcolorbox} + \hfill + \begin{tcolorbox}[adjusted title=Documentation] + \mylib{documentation} + \end{tcolorbox} +\end{tcolorbox} + + + diff --git a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.listings.tex b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.listings.tex index 544afba872b..fbbdd3971d6 100644 --- a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.listings.tex +++ b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.listings.tex @@ -1,26 +1,86 @@ % !TeX root = tcolorbox.tex % include file of tcolorbox.tex (manual of the LaTeX package tcolorbox) \clearpage -\section{Library 'listings' / 'listingsutf8'}\label{sec:listings} -The library is loaded by a package option or inside the preamble by: +\section{Libraries + \mylib{listings}, + \mylib{listingsutf8}, and + \mylib{minted}}\label{sec:listings} + +\subsection{Loading the Libraries} +In contrast to other |tcolorbox| libraries, the libraries +\mylib{listings}, \mylib{listingsutf8}, and \mylib{minted} are concurrent in the sense that +they all do the same thing, i.\,e.\ displaying listings with or without typesetting +the listing in \LaTeX\ parallel. +The difference is the underlying \LaTeX\ package which does the core job for +displaying a listing. So, typically, you need just \emph{one} of these +libraries. If you do not have a clue, which one of them you should use, +you should take \mylib{listingsutf8}. + +\begin{marker} +The order in which the libraries are included influences the default settings and +the \refKey{/tcb/reset} behavior. The settings of a later loaded library overwrite +the settings of a previous loaded library. A library is never loaded twice. +\end{marker} + + +\subsubsection{Loading \mylib{listings}} +This library uses the package |listings| \cite{heinz:2007a} to typeset +listings. It 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 \refKey{/tcb/listing engine} is set to |listings| by the library. +To reactivate this setting, if overwritten by other libraries, use +\begin{dispListing} +\tcbset{listing engine=listings} +\end{dispListing} + +\subsubsection{Loading \mylib{listingsutf8}} +To extend |listings| for UTF-8 encoded sources, you can use the support from the package |listingsutf8| \cite{oberdiek:2011a} by loading the library -variant 'listingsutf8'. +variant \mylib{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} +This also loads the library \mylib{listings} +and the packages |listings| \cite{heinz:2007a} and |listingsutf8| \cite{oberdiek:2011a}. +The \refKey{/tcb/listing engine} is set to |listings| by the library. +To reactivate this setting, if overwritten by other libraries, use +\begin{dispListing} +\tcbset{listing engine=listings} +\end{dispListing} + + +\clearpage +\subsubsection{Loading \mylib{minted}} +This library uses the package |minted| \cite{rudolph:2011a} to typeset +listings. It is loaded by a package option or inside the preamble by: +\begin{dispListing} +\tcbuselibrary{minted} +\end{dispListing} +This also loads the package |minted| \cite{rudolph:2011a}. + +\begin{marker} +The |minted| package uses the external tool |Pygments| \cite{pygments:2013} +to apply syntax highlighting. It has to be installed and set up, before the +library can be used, see \cite{rudolph:2011a} and \cite{pygments:2013}. +The |tcolorbox| library \mylib{minted} does not work, if the package +|minted| \cite{rudolph:2011a} does not work. +\end{marker} + +The \refKey{/tcb/listing engine} is set to |minted| by the library. +To reactivate this setting, if overwritten by other libraries, use +\begin{dispListing} +\tcbset{listing engine=minted} +\end{dispListing} -\subsection{Macros of the Library} +\subsection{Common Macros of the Libraries} \begin{docEnvironment}{tcblisting}{\marg{options}} Creates a colored box based on a \refEnv{tcolorbox}. @@ -35,8 +95,11 @@ This is a \LaTeX\ example which displays the text as source code and in compiled form. \end{tcblisting} \end{dispExample} + \clearpage + \begin{dispExample} +% \usetikzlibrary{listings} /or/ \usetikzlibrary{listingsutf8} \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}}} @@ -49,6 +112,24 @@ and in compiled form. \end{tcblisting} \end{dispExample} +\enlargethispage*{10mm} + +\begin{dispExample} +% \usetikzlibrary{minted} +\begin{tcblisting}{colback=yellow!5,colframe=yellow!50!black,listing only, + title=This is source code in another language (XML), fonttitle=\bfseries, + listing engine=minted,minted language=xml} +<?xml version="1.0"?> +<project name="Package tcolorbox" default="documentation" basedir="."> + <description> + Apache Ant build file (http://ant.apache.org/) + </description> +</project> +\end{tcblisting} +\end{dispExample} + + + \begin{dispExample} % This box is as wide as needed (listing only !!) % \usetikzlibrary{skins} @@ -62,7 +143,7 @@ and in compiled form. \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 @@ -75,7 +156,6 @@ This \textbf{text} is written to a standardized file for later usage. \end{docEnvironment} -\clearpage \begin{docCommand}{tcbinputlisting}{\marg{options}} Creates a colored boxed based on a |tcolorbox|. The text content is read from a file named by the key value of |listing file|. Apart from that, @@ -194,49 +274,21 @@ This is my \LaTeX\ box. {\jobname.tcbtemp} \end{dispExample} -% \begin{dispExample*}{sbs,lefthand ratio=0.6} -% \newtcbinputlisting{\mybox}{colback=red!5!white, - % colframe=red!75!black} -% -% \mybox{This is my own box.} -% \end{dispExample*} -% -% \begin{dispExample*}{sbs,lefthand ratio=0.6} -% \newtcbinputlisting{\mybox}[1]{colback=red!5!white, - % colframe=red!75!black,fonttitle=\bfseries, - % title=#1} -% -% \mybox{Hello there}{This is my own box.} -% \end{dispExample*} -% -% \begin{dispExample*}{sbs,lefthand ratio=0.6} -% \newtcbinputlisting{\mybox}[2][]{colback=red!5!white, - % colframe=red!75!black,fonttitle=\bfseries, - % title=#2,#1} -% -% \mybox[colback=yellow]{Hello there}% - % {This is my own box.} -% \end{dispExample*} -% -% \inputpreamblelisting{B} -% -% \begin{dispExample*}{sbs,lefthand ratio=0.6} -% \pbbox[colback=yellow]{Hello there}% - % {This is my own box.} -% \end{dispExample*} +\begin{dispExample} +\newtcbinputlisting[use counter from=mycbox]{\mylisting}[2][]{% + listing engine=minted,minted language=latex,minted style=colorful, + listing file={#2}, + title=Listing (\thetcbcounter) of \texttt{#2}, + colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries, + listing only,breakable,#1} +\mylisting[before upper=\textit{This is the included file content:}] + {\jobname.tcbtemp} +\end{dispExample} \end{docCommand} - \clearpage -\subsection{Option Keys of the Library} -For the \meta{options} in \refEnv{tcblisting} respectively \refCom{tcbinputlisting} -the following |pgf| keys can be applied. The key tree path |/tcb/| is not to -be used inside these macros. - -\begin{docTcbKey}{listing file}{=\meta{file name}}{no default, initially \cs{jobname.listing}} - Sets the \meta{file name} of the file which is used to save listings. -\end{docTcbKey} +\subsection{Option Keys of the \mylib{listings} Library}\label{sec:speclistingkeys} \begin{docTcbKey}{listing options}{=\meta{key list}}{no default, initially |style=tcblatex|} Sets the options from the package |listings| \cite{heinz:2007a} @@ -252,6 +304,7 @@ and in compiled form. Additionally, we use line numbers here. \end{dispExample} \end{docTcbKey} + \begin{docTcbKey}{no listing options}{}{no value, initially unset} Abbreviation for |listing options={}|. This removes all options for the |listings| package. @@ -265,7 +318,6 @@ All \textit{listings} options removed. \end{dispExample} \end{docTcbKey} -\clearpage \begin{docTcbKey}{listing style}{=\meta{style}}{no default, initially |tcblatex|} Abbreviation for |listing options={style=...}|. This key sets a \meta{style} @@ -279,24 +331,122 @@ Here, we use the predefined style. \end{dispExample} \end{docTcbKey} - +\clearpage \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'. + and |tcbdocumentation| from the library \mylib{documentation}. The initial value is derived from the package |inputenc| if used. \end{docTcbKey} +\begin{docTcbKey}{listing remove caption}{\colOpt{=\meta{boolean value}}}{default |true|, initially |true|} +If set to |true|, some part of the caption building code of the |listings| package +is silenced to prevent some unwanted interaction with the |hyperref| package resulting +in additional vertical space. +If set to |false|, the |listings| package code is kept unchanged. +Note that listings outside \refEnv{tcblisting} and +\refCom{tcbinputlisting} are always processed normally. +Typically, a user is not expected to use this key at all. +\end{docTcbKey} + +See further options in \Vref{sec:commonlistingkeys}. + +\subsection{Option Keys of the \mylib{listingsutf8} Library} +The \mylib{listingsutf8} library is an extension of the +\mylib{listings} library, so +all options from \Vref{sec:speclistingkeys} are applicable. \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'. + This option is available only for the library variant \mylib{listingsutf8}. The \meta{one-byte-encoding} is one of the applicable encodings from \cite{oberdiek:2011a}, e.\,g.\ |latin1|. \end{docTcbKey} +See further options in \Vref{sec:commonlistingkeys}. + + +\subsection{Option Keys of the \mylib{minted} Library} + +\begin{docTcbKey}{minted language}{=\meta{programming language}}{no default, initially |latex|} +Sets a \meta{programming language} known to |Pygments| \cite{pygments:2013}. +\begin{dispExample} +\begin{tcblisting}{listing engine=minted,minted style=trac, + minted language=java, + colback=red!5!white,colframe=red!75!black,listing only} +public class HelloWorld { + // A 'Hello World' in Java + public static void main(String[] args) { + System.out.println("Hello World!"); + } +} +\end{tcblisting} +\end{dispExample} +\end{docTcbKey} + +\clearpage +\begin{docTcbKey}{minted options}{=\meta{key list}}{no default, initially |tabsize=2,fontsize=\textbackslash small|} + Sets the options from the package |minted| \cite{rudolph:2011a} + which are used during typesetting of the listing. +\begin{dispExample} +% \tcbuselibrary{skins} +\newtcblisting{myjava}{listing engine=minted,minted style=colorful, + minted language=java,minted options={fontsize=\small,linenos,numbersep=3mm}, + colback=blue!5!white,colframe=blue!75!black,listing only, + left=5mm,enhanced, + overlay={\begin{tcbclipinterior}\fill[red!20!blue!20!white] (frame.south west) + rectangle ([xshift=5mm]frame.north west);\end{tcbclipinterior}}} + +\begin{myjava} +public class HelloWorld { + // A 'Hello World' in Java + public static void main(String[] args) { + System.out.println("Hello World!"); + } +} +\end{myjava} +\end{dispExample} +\end{docTcbKey} + + +\begin{docTcbKey}{minted style}{=\meta{style}}{no default, initially unset} +Sets a \meta{style} known to |Pygments| \cite{pygments:2013}. This is +independent from \refKey{/tcb/minted options}. Note that styles are always +applied globally; all following examples will be set in the given \meta{style} +until a new style is set. Also note that +setting |\usemintedstyle|\marg{style} only once per document is more economic, if +all styles in a document are the same. +For examples of different styles, see +\refKey{/tcb/minted language} and \refKey{/tcb/minted options}. +\end{docTcbKey} + +See further options in \Vref{sec:commonlistingkeys}. + \clearpage +\subsection{Common Option Keys of all Libraries}\label{sec:commonlistingkeys} +For the \meta{options} in \refEnv{tcblisting} respectively \refCom{tcbinputlisting} +the following |pgf| keys can be applied. The key tree path |/tcb/| is not to +be used inside these macros. + +\begin{docTcbKey}{listing engine}{=\meta{engine}}{no default} + Sets the \meta{engine} which typesets the listings. Feasible values are + \begin{itemize} + \item |listings|, if library \mylib{listings} or + \mylib{listingsutf8} is loaded. + \item |minted|, if library \mylib{minted} is loaded. + \end{itemize} +\end{docTcbKey} + +\begin{docTcbKey}{listing file}{=\meta{file name}}{no default, initially \cs{jobname.listing}} + Sets the \meta{file name} of the file which is used to save listings. +\end{docTcbKey} + + + + + + \begin{docTcbKey}{listing and text}{}{no value, initially set} Typesets the environment content as listing in the upper part and as compiled text in the lower part. @@ -327,6 +477,8 @@ This is a \LaTeX\ example. \end{dispExample} \end{docTcbKey} + +\clearpage \begin{docTcbKey}{text only}{}{no value} Typesets the environment content as compiled text. \begin{dispExample} @@ -337,7 +489,7 @@ This is a \LaTeX\ example. \end{docTcbKey} -\clearpage + \begin{docTcbKey}{comment}{=\meta{text}}{no default, initially empty} Records a comment with \meta{text} as content. The comment is displayed only in conjunction with \refKey{/tcb/listing and comment} @@ -364,7 +516,7 @@ This is a \LaTeX\ example. \end{dispExample} \end{docTcbKey} - +\enlargethispage*{10mm} \begin{docTcbKey}{comment and listing}{}{no value} Typesets a given comment in the upper part and the environment content as listing in the lower part. @@ -430,16 +582,6 @@ This is a \LaTeX\ example. \end{docTcbKey} -\clearpage -\begin{docTcbKey}{listing remove caption}{\colOpt{=\meta{boolean value}}}{default |true|, initially |true|} -If set to |true|, some part of the caption building code of the |listings| package -is silenced to prevent some unwanted interaction with the |hyperref| package resulting -in additional vertical space. -If set to |false|, the |listings| package code is kept unchanged. -Note that listings outside \refEnv{tcblisting} and -\refCom{tcbinputlisting} are always processed normally. -Typically, a user is not expected to use this key at all. -\end{docTcbKey} \clearpage \subsection{Creation of \LaTeX\ Tutorials}\label{sec:latextutorial} @@ -833,3 +975,4 @@ With this, we get: \tcbusetemp + diff --git a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.skins.tex b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.skins.tex index 11ea2274bcd..4608d47c49a 100644 --- a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.skins.tex +++ b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.skins.tex @@ -1,7 +1,7 @@ % !TeX root = tcolorbox.tex % include file of tcolorbox.tex (manual of the LaTeX package tcolorbox) \clearpage -\section{Library 'skins'}\label{sec:skins} +\section{Library \mylib{skins}}\label{sec:skins} The library is loaded by a package option or inside the preamble by: \begin{dispListing} \tcbuselibrary{skins} @@ -13,7 +13,7 @@ the following skins use |tikz| instead of |pgf|. From a technical point of view, a \emph{skin} is a style definition for the appearance of a |tcolorbox|. The core package provides some additional option keys for skins but only a single skin called \refSkin{standard}. -The 'skins' library adds several more skins. To change a skin, only one +The \mylib{skins} library adds several more skins. To change a skin, only one option from the core package has to be set. \begin{docTcbKey}{skin}{=\meta{name}}{style, no default, initially \texttt{standard}} @@ -502,7 +502,7 @@ but all other skins, e.\,g.\ \refSkin{enhanced}. The watermark options rely on the more general overlay options described in Section \ref{subsec:overlays} from page \pageref{subsec:overlays}. Therefore, \emph{watermarks} and \emph{overlays} cannot be used mixed. -But a mixture is possible with the 'hooks' library, see Section \ref{sec:hooks}. +But a mixture is possible with the \mylib{hooks} library, see Section \ref{sec:hooks}. \end{marker} diff --git a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.theorems.tex b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.theorems.tex index 99fbd74fd30..da456b88fc7 100644 --- a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.theorems.tex +++ b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.theorems.tex @@ -1,7 +1,7 @@ % !TeX root = tcolorbox.tex % include file of tcolorbox.tex (manual of the LaTeX package tcolorbox) \clearpage -\section{Library 'theorems'}\label{sec:theorems} +\section{Library \mylib{theorems}}\label{sec:theorems} The library is loaded by a package option or inside the preamble by: \begin{dispListing} \tcbuselibrary{theorems} diff --git a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.pdf b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.pdf Binary files differindex 47df6302cfb..3022a3cffd2 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 e6ac3165013..794352b93f2 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.41 (2013/07/23) +%% The LaTeX package tcolorbox - version 2.50 (2013/07/29) %% tcolorbox.tex: Manual %% %% ------------------------------------------------------------------------------------------- @@ -64,6 +64,7 @@ \strictpagecheck \usepackage[all]{tcolorbox} + \tcbset{skin=enhanced} \urlstyle{sf} @@ -81,8 +82,8 @@ \newtcolorbox{marker}[1][]{marker,#1} -\def\version{2.41}% -\def\datum{2013/07/23}% +\def\version{2.50}% +\def\datum{2013/07/29}% \makeindex \hypersetup{ @@ -156,7 +157,7 @@ comment, file, inputencoding, - listing, + listing,minted, options,outside, style,side, utf, @@ -235,6 +236,14 @@ \newtcolorbox{deprecated}{blank,breakable,watermark text=deprecated} +\newtcbox{\mylib}{enhanced,nobeforeafter,tcbox raise base,boxrule=0.4pt,top=0mm,bottom=0mm, + right=0mm,left=4mm,arc=1pt,boxsep=2pt,before upper={\vphantom{dlg}}, + colframe=green!50!black,coltext=green!25!black,colback=green!10!white, + overlay={\begin{tcbclipinterior}\fill[green!75!blue!50!white] (frame.south west) + rectangle node[text=white,font=\sffamily\bfseries\tiny,rotate=90] {LIB} ([xshift=4mm]frame.north west);\end{tcbclipinterior}}} + +\robustify{\mylib} + %\tcbset{every box/.style={enhanced}} \begin{tcbverbatimwrite}{\jobname_preamble_A.tex} @@ -318,7 +327,8 @@ \input{\jobname_preamble_H.tex} -%\includeonly{tcolorbox.doc.theorems} +%\includeonly{tcolorbox.doc.abstract} + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \begin{document} |