From 2277d4f5877c4b465f623028c370c2eaf269d879 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Fri, 21 Feb 2014 23:12:36 +0000 Subject: tcolorbox (21feb14) git-svn-id: svn://tug.org/texlive/trunk@33022 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/tcolorbox/CHANGES | 20 +++- Master/texmf-dist/doc/latex/tcolorbox/README | 2 +- .../doc/latex/tcolorbox/tcolorbox-example.pdf | Bin 283402 -> 283402 bytes .../doc/latex/tcolorbox/tcolorbox-example.tex | 2 +- .../latex/tcolorbox/tcolorbox.doc.coreoptions.tex | 16 ++++ .../tcolorbox/tcolorbox.doc.documentation.tex | 71 +++++++++++--- .../doc/latex/tcolorbox/tcolorbox.doc.listings.tex | 105 ++++++++++++++++++++- .../texmf-dist/doc/latex/tcolorbox/tcolorbox.pdf | Bin 3430158 -> 3481400 bytes .../texmf-dist/doc/latex/tcolorbox/tcolorbox.tex | 33 ++++--- 9 files changed, 221 insertions(+), 28 deletions(-) (limited to 'Master/texmf-dist/doc/latex') diff --git a/Master/texmf-dist/doc/latex/tcolorbox/CHANGES b/Master/texmf-dist/doc/latex/tcolorbox/CHANGES index 64e18b57952..09fefc3cdde 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.70 (2014/02/06) +%% The LaTeX package tcolorbox - version 2.71 (2014/02/21) %% %% ------------------------------------------------------------------------------------------- %% Copyright (c) 2006-2014 by Prof. Dr. Dr. Thomas F. Sturm @@ -412,3 +412,21 @@ version 2.70 (2014/02/06) 'doc head', 'doc head command', 'doc head environment', 'doc head key', 'doc description', 'doc into index', 'value', 'values' +version 2.71 (2014/02/21) +- bug fix: sidebyside setting with empty left hand side caused false positioning +- new options: + 'external', 'remake' +- library 'listings': + * new options: + 'comment side listing', 'listing side comment', 'comment above listing', + 'listing above comment', 'comment outside listing', 'listing outside comment', + 'image comment', +- library 'documentation': + * automatic inclusion of the 'skins' library + * inclusion of 'makeidx' made dependent on the existence of '\printindex' + * new options: + 'keys', 'index colorize', 'index annotate', + 'color command', 'color environment', 'color key', 'color value', 'color color' + + + diff --git a/Master/texmf-dist/doc/latex/tcolorbox/README b/Master/texmf-dist/doc/latex/tcolorbox/README index 097953248de..c4bb263c551 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.70 (2014/02/06) +%% The LaTeX package tcolorbox - version 2.71 (2014/02/21) %% %% ------------------------------------------------------------------------------------------- %% Copyright (c) 2006-2014 by Prof. Dr. Dr. Thomas F. Sturm diff --git a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox-example.pdf b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox-example.pdf index 492f0a76a7e..40fd4ce9b05 100644 Binary files a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox-example.pdf and b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox-example.pdf differ diff --git a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox-example.tex b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox-example.tex index dd185f81369..5fd04ca11bd 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.70 (2014/02/06) +%% The LaTeX package tcolorbox - version 2.71 (2014/02/21) %% tcolorbox-example.tex: an example for tcolorbox %% %% ------------------------------------------------------------------------------------------- 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 cac968f3641..b2770352663 100644 --- a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.coreoptions.tex +++ b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.coreoptions.tex @@ -2664,6 +2664,22 @@ do \emph{not} use |\tikzexternaldisable| in front of the |tcolorbox|. \refKey{/tcb/shield externalize} is deactivated automatically inside a |tikzpicture|. \end{marker} +\begin{docTcbKey}{external}{=\meta{file name}}{no default, initially unset} + Convenience option which calls |\tikzsetnextfilename|\marg{file name}. Typically, + it may be used inside the option list of a |tcolorbox| to set the + externalization \meta{file name} for the first |tikzpicture| which is discovered + \emph{inside} the box content. + The package |tikz| \cite{tantau:2013a} or the library \mylib{skins} has to be loaded to use this option. + Additionally, |\usetikzlibrary{external}| has to be used. +\end{docTcbKey} + +\begin{docTcbKey}{remake}{\colOpt{=true\textbar false}}{default |true|, initially |false|} + Convenience option which calls |/tikz/external/remake next|. Typically, + it may be used inside the option list of a |tcolorbox| to force the remake + of the first |tikzpicture| which is discovered \emph{inside} the box content. + The package |tikz| \cite{tantau:2013a} or the library \mylib{skins} has to be loaded to use this option. + Additionally, |\usetikzlibrary{external}| has to be used. +\end{docTcbKey} \subsection{Miscellaneous} 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 2b6e64f95c3..b1fe8a9d02d 100644 --- a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.documentation.tex +++ b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.documentation.tex @@ -13,8 +13,15 @@ The library is loaded by a package option or inside the preamble by: \tcbuselibrary{documentation} \end{dispListing} This also loads the library \mylib{listings}, see \Vref{sec:listings}, +the library \mylib{skins}, see \Vref{sec:skins}, and a bunch of packages, namely -|doc|, |pifont|, |marvosym|, |hyperref|, |makeidx|, and |refcount|. +|doc|, |pifont|, |marvosym|, |makeidx|, |refcount|, and |hyperref|. + +\begin{marker} +The package |makeidx| is loaded only, if \docAuxCommand*{printindex} is +\emph{not} already defined. Therefore, one can include an alternative to |makeidx| like +|imakeidx| \emph{before} the library |documentation| is used. +\end{marker} For UTF-8 support, load: \begin{dispListing} @@ -29,6 +36,7 @@ For |minted| \cite{rudolph:2011a} support, load: \subsection{Macros of the Library} +\enlargethispage*{15mm} \begin{docEnvironment}[doclang/environment content=command description]{docCommand}{\oarg{options}\marg{name}\marg{parameters}} Documents a \LaTeX\ macro with given \meta{name} where \meta{name} is written without backslash. The given \meta{options} are set with \refCom{tcbset}. @@ -142,21 +150,21 @@ The environment \docAuxEnvironment{fooauxenv} holds some interesting data. \end{dispExample} \end{docCommand} -\begin{docCommand}{docAuxEnvironment*}{\marg{name}} +\begin{docCommand}{docAuxEnvironment*}{\oarg{key path}\marg{name}} Identical to \refCom{docAuxEnvironment}, but without index entry. \end{docCommand} -\begin{docCommand}{docAuxKey}{\marg{name}} - Documents an auxiliary key with given \meta{name} including path. +\begin{docCommand}{docAuxKey}{\oarg{key path}\marg{name}} + Documents an auxiliary key with given \meta{name} and an optional \meta{key path}. It is automatically indexed. \begin{dispExample} -The key \docAuxEnvironment{/foo/fooaux} holds some interesting data. +The key \docAuxKey[foo]{fooaux} holds some interesting data. \end{dispExample} \end{docCommand} -\begin{docCommand}{docAuxKey*}{\marg{name}} +\begin{docCommand}{docAuxKey*}{\oarg{key path}\marg{name}} Identical to \refCom{docAuxKey}, but without index entry. \end{docCommand} @@ -169,7 +177,7 @@ The color \docColor{foocolor} is available. \end{dispExample} \end{docCommand} -\begin{docCommand}{docAuxColor*}{\marg{name}} +\begin{docCommand}{docColor*}{\marg{name}} Identical to \refCom{docColor}, but without index entry. \end{docCommand} @@ -381,7 +389,7 @@ Some pages back, one can see \refAuxcs{fooaux} as an example. % \begin{docCommand}{colDef}{\marg{text}} -Sets \meta{text} with the definition color, see \refKey{/tcb/color definition}. +Sets \meta{text} with the command color, see \refKey{/tcb/color command}. \begin{dispExample} This is my \colDef{text}. \end{dispExample} @@ -438,8 +446,30 @@ This is my \colOpt{text}. Used for \refKey{/tcb/listing engine}|=minted| only. \end{docTcbKey} + +\begin{docTcbKey}{color command}{=\meta{color}}{no default, initially |Definition|} + Sets the highlight color used by macro definitions. +\end{docTcbKey} + +\begin{docTcbKey}{color environment}{=\meta{color}}{no default, initially |Definition|} + Sets the highlight color used by environment definitions. +\end{docTcbKey} + +\begin{docTcbKey}{color key}{=\meta{color}}{no default, initially |Definition|} + Sets the highlight color used by key definitions. +\end{docTcbKey} + +\begin{docTcbKey}{color value}{=\meta{color}}{no default, initially |Definition|} + Sets the highlight color used by value definitions. +\end{docTcbKey} + +\begin{docTcbKey}{color color}{=\meta{color}}{no default, initially |Definition|} + Sets the highlight color used by color definitions. +\end{docTcbKey} + \begin{docTcbKey}{color definition}{=\meta{color}}{no default, initially |Definition|} - Sets the highlight color used by macro and key definitions. + Sets the highlight color for \refKey{/tcb/color command}, \refKey{/tcb/color environment}, + \refKey{/tcb/color key}, \refKey{/tcb/color value}, and \refKey{/tcb/color color}. \end{docTcbKey} \begin{docTcbKey}{color option}{=\meta{color}}{no default, initially |Option|} @@ -474,7 +504,7 @@ This is my \colOpt{text}. \end{itemize} \end{docTcbKey} -\clearpage + \begin{docTcbKey}{index actual}{=\meta{character}}{no default, initially |@|} Sets the character for 'actual' in automatic indexing. \end{docTcbKey} @@ -494,7 +524,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: @@ -503,7 +533,19 @@ This is my \colOpt{text}. \end{dispListing} \end{docTcbKey} +\begin{docTcbKey}{index annotate}{\colOpt{=true\textbar false}}{default |true|, initially |true|} + If set to |true|, the index entries are annotated with short descriptions + given by \refKey{/tcb/doclang/environment}, \refKey{/tcb/doclang/key}, + and others. +\end{docTcbKey} + +\begin{docTcbKey}{index colorize}{\colOpt{=true\textbar false}}{default |true|, initially |false|} + If set to |true|, the index entries colorized according to the color + settings given by \refKey{/tcb/color environment}, \refKey{/tcb/color key}, + and others. +\end{docTcbKey} +\clearpage The following keys are provided for language specific settings. The English language is predefined. @@ -535,6 +577,10 @@ The English language is predefined. Text used in the index for keys. \end{langTcbKey} +\begin{langTcbKey}{keys}{=\meta{text}}{no default, initially |Keys|} + Heading text used in the index for keys. +\end{langTcbKey} + \begin{langTcbKey}{value}{=\meta{text}}{no default, initially |value|} Text used in the index for values. \end{langTcbKey} @@ -551,7 +597,6 @@ The English language is predefined. Short text for page references. \end{langTcbKey} - \clearpage \begin{docTcbKey}{doc left}{=\meta{length}}{no default, initially |2em|} Sets the left hand offset of the documentation texts from @@ -586,6 +631,7 @@ The English language is predefined. \end{dispExample} \end{docTcbKey} +\enlargethispage*{10mm} \begin{docTcbKey}{doc right indent}{=\meta{length}}{no default, initially |0pt|} Sets the right hand indent of documentation heads from \refEnv{docCommand}, \refEnv{docEnvironment}, \refEnv{docKey}, etc, to \meta{length}. @@ -670,7 +716,6 @@ hand side if too long. Linebreaks can be used inside the \meta{text}. instead of \refEnv{docCommand}. \end{docTcbKey} -%\clearpage \subsection{Predefined Colors of the Library} 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 08c6309378b..6627745ba61 100644 --- a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.listings.tex +++ b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.listings.tex @@ -508,7 +508,7 @@ This is a \LaTeX\ example. \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} + e.\,g.\ in conjunction with \refKey{/tcb/listing and comment} and \refKey{/tcb/comment and listing}. \begin{dispExample} \begin{tcblisting}{comment={This comment is really only a comment}, @@ -519,6 +519,19 @@ This is a \textbf{tcolorbox}. \end{docTcbKey} +\begin{docTcbKey}{image comment}{=\marg{options}\marg{filename}}{style, no default, initially unset} + Uses an image denoted by \meta{filename} as \textit{comment} for the listing. + The image is included by the standard |\includegraphics| macro with + given \meta{options}. +\begin{dispExample} +\begin{tcblisting}{colback=red!5!white,colframe=red!75!black,listing side comment, + image comment={width=2.5cm}{example-image-a.pdf},center lower} +This is a \LaTeX\ example. +\end{tcblisting} +\end{dispExample} +\end{docTcbKey} + +\clearpage \begin{docTcbKey}{listing and comment}{}{no value} Typesets the environment content as listing in the upper part and a given comment in the lower part. @@ -598,6 +611,64 @@ This is a \LaTeX\ example. \end{docTcbKey} +\clearpage +\begin{docTcbKey}{listing side comment}{}{no value} +Typesets the environment content side by side as listing in the left (upper) +part and a given comment in the right (lower) part. +\begin{dispExample} +\begin{tcblisting}{colback=red!5!white,colframe=red!75!black,listing side comment, + righthand width=1.5cm,image comment={width=1.5cm}{example-image-a.pdf}} +This is a \LaTeX\ example. +\end{tcblisting} +\end{dispExample} +\end{docTcbKey} + + +\begin{docTcbKey}{comment side listing}{}{no value} +Typesets the environment content side by side with a given comment in the left (upper) +part and as listing in the right (lower) part. +\begin{dispExample} +\begin{tcblisting}{colback=red!5!white,colframe=red!75!black,comment side listing, + lefthand width=1.5cm,image comment={width=1.5cm}{example-image-a.pdf}} +This is a \LaTeX\ example. +\end{tcblisting} +\end{dispExample} +\end{docTcbKey} + + +\enlargethispage*{2cm} +\begin{docTcbKey}{listing outside comment}{}{no value} +Typesets the environment content side by side as listing in a |tcolorbox| +and a given comment outside the box in the right part of the page. +Nevertheless, the outside text is treated as \emph{lower} part of the +|tcolorbox| and can be formatted with all lower part options. +The space partitioning is done with the side by side options from +Section \ref{subsec:sidebyside}, see page \pageref{subsec:sidebyside}. +\begin{dispExample} +\begin{tcblisting}{colback=red!5!white,colframe=red!75!black,listing outside comment, + righthand width=1.5cm,image comment={width=1.5cm}{example-image-a.pdf}} +This is a \LaTeX\ example. +\end{tcblisting} +\end{dispExample} +\end{docTcbKey} + + +\begin{docTcbKey}{comment outside listing}{}{no value} +Typesets the environment content side by side as listing in a |tcolorbox| +and a given comment outside the box in the left part of the page. +Nevertheless, the outside text is treated as \emph{lower} part of the +|tcolorbox| and can be formatted with all lower part options. +The space partitioning is done with the side by side options from +Section \ref{subsec:sidebyside}, see page \pageref{subsec:sidebyside}. +\begin{dispExample} +\begin{tcblisting}{colback=red!5!white,colframe=red!75!black,comment outside listing, + lefthand width=1.5cm,image comment={width=1.5cm}{example-image-a.pdf}} +This is a \LaTeX\ example. +\end{tcblisting} +\end{dispExample} +\end{docTcbKey} + + \clearpage \begin{docTcbKey}{listing above text}{}{no value} Typesets the environment content as listing in a |tcolorbox| @@ -627,6 +698,38 @@ This is a \LaTeX\ example. \end{docTcbKey} +\clearpage +\begin{docTcbKey}{listing above comment}{}{no value} + Typesets the environment content as listing in a |tcolorbox| + and a given comment outside and below the box. + The outside text is treated as \emph{lower} part of the + |tcolorbox| and can be formatted with all lower part options. + The distance between box and comment is controlled by \refKey{/tcb/middle}. +\begin{dispExample} +\begin{tcblisting}{colback=red!5!white,colframe=red!75!black,listing above comment, + center lower,image comment={width=3cm}{example-image-a.pdf}} +This is a \LaTeX\ example. +\end{tcblisting} +\end{dispExample} +\end{docTcbKey} + + +\begin{docTcbKey}{comment above listing}{}{no value} + Typesets the environment content as listing in a |tcolorbox| + and a given comment outside and above the box. + The outside text is treated as \emph{lower} part of the + |tcolorbox| and can be formatted with all lower part options. + The distance between box and comment is controlled by \refKey{/tcb/middle}. +\begin{dispExample} +\begin{tcblisting}{colback=red!5!white,colframe=red!75!black,comment above listing, + center lower,image comment={width=3cm}{example-image-a.pdf}} +This is a \LaTeX\ example. +\end{tcblisting} +\end{dispExample} +\end{docTcbKey} + + + \clearpage \subsection{Creation of \LaTeX\ Tutorials}\label{sec:latextutorial} The following source code gives a guideline for the creation of \LaTeX\ tutorials. diff --git a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.pdf b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.pdf index ee6a8991e70..1c29db55d11 100644 Binary files a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.pdf and b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.pdf differ diff --git a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.tex b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.tex index bc9dbc13e84..a62aa250081 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.70 (2014/02/06) +%% The LaTeX package tcolorbox - version 2.71 (2014/02/21) %% tcolorbox.tex: Manual %% %% ------------------------------------------------------------------------------------------- @@ -23,7 +23,7 @@ \usepackage[T1]{fontenc} \usepackage[latin1]{inputenc} \usepackage[english]{babel} -\usepackage{lmodern,parskip,array,ifthen,calc,makeidx} +\usepackage{lmodern,parskip,array,ifthen,calc} \usepackage{amsmath,amssymb} \usepackage[svgnames,table,hyperref]{xcolor} \usepackage{tikz} @@ -64,9 +64,16 @@ \usepackage{changepage} \strictpagecheck -\usepackage[all]{tcolorbox} +\providecommand{\tcbpkgprefix}{} +\usepackage[all]{\tcbpkgprefix tcolorbox} -\tcbset{skin=enhanced,doc head={colback=yellow!10!white,interior style=fill}} +\tcbset{skin=enhanced, + doc head={colback=yellow!10!white,interior style=fill}, + doc head key={colback=magenta!5!white,interior style=fill}, + color key=DarkViolet, + color value=Teal, + color color=Teal, + index colorize,index annotate} \urlstyle{sf} \tcbmakedocSubKey{docTcbKey}{tcb} @@ -74,10 +81,15 @@ \tcbmakedocSubKey{newTcbKey}{tcb/new} \makeatletter -\def\index@Skin#1{\index{#1\idx@actual\texttt{#1} Skin}\index{Skins\idx@level#1\idx@actual\texttt{#1}}} +\newrobustcmd{\tcbIndexPrintSkinCA}[1]{\tcb@Index@Print@CA{#1}{\kvtcb@col@key}{Skin}} +\newrobustcmd{\tcbIndexPrintSkinC}[1]{\tcb@Index@Print@C{#1}{\kvtcb@col@key}} +\def\tcb@Print@Skin#1{\textcolor{\kvtcb@col@key}{\ttfamily\bfseries#1}} + + +\def\index@Skin#1{\index{#1\idx@actual\tcbIndexPrintSkinCA{#1}}\index{Skins\idx@level#1\idx@actual\tcbIndexPrintSkinC{#1}}} \newenvironment{docSkin}[1]{\begin{tcb@manual@entry}% \begin{tcb@doc@head}{}% - \hypertarget{skin:#1}{\texttt{/tcb/skin=}\tcb@disp@com{#1}\index@Skin{#1}\protected@edef\@currentlabel{#1}\label{skin:#1}\hfill(skin)}% + \hypertarget{skin:#1}{\texttt{/tcb/skin=}\tcb@Print@Skin{#1}\index@Skin{#1}\protected@edef\@currentlabel{#1}\label{skin:#1}\hfill(skin)}% \end{tcb@doc@head}}% {\end{tcb@manual@entry}} \def\refSkin#1{\tcb@ref@doc{skin:#1}} @@ -85,8 +97,8 @@ \newtcolorbox{marker}[1][]{marker,#1} -\def\version{2.70}% -\def\datum{2014/02/06}% +\def\version{2.71}% +\def\datum{2014/02/21}% \makeindex \hypersetup{ @@ -125,7 +137,7 @@ % documentation brackets, colDef,colOpt,cs, - docAuxCommand,docColor, + docAuxCommand,docColor,docAuxEnvironment,docAuxKey, meta,marg, oarg, refCom,refEnv,refKey, @@ -270,9 +282,8 @@ \end{tcbverbatimwrite} \input{\jobname_preamble_J.tex} - %\tcbset{draftmode} -%\includeonly{tcolorbox.doc.documentation} +%\includeonly{tcolorbox.doc.coreoptions} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \begin{document} -- cgit v1.2.3