Skip to content

Commit

Permalink
6.4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
T-F-S committed Sep 27, 2024
1 parent f7f39a4 commit 2911a3e
Show file tree
Hide file tree
Showing 45 changed files with 250 additions and 187 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# The LaTeX package tcolorbox - version 6.3.0 (2024/07/10)
# The LaTeX package tcolorbox - version 6.4.0 (2024/09/27)


> Copyright (c) 2006-2024 by Prof. Dr. Dr. Thomas F. Sturm <thomas dot sturm at unibw dot de>
Expand Down
19 changes: 19 additions & 0 deletions doc/latex/tcolorbox/CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,25 @@ and this project adheres to



## [6.4.0] - 2024-09-07

### Added
- Libary `documentation`:
- `\refPkg` for referring packages on CTAN (issue #290)

### Changed
- Precautions for tikz options with square brackets (issue #284)
- Usage warnings added for deprecated options `before example`, `after example`, and `graphical environment` (issue #284)
- Documenation for TikZ Picture Option Keys adapted (issue #285)
- Label `tcolorbox` added to LaTeX hooks (issue #287)
- Libary `minted`: Minted option `envname` now supported by package `minted` directly (issue #2)

### Fixed
- Libary `minted`: `minted Warning: Macro \minted@def@optcl is deprecated with minted v3` (issue #2)
- `tcolorbox-tutorial-poster.tex`: minted v3 seems to need escaped comma `\,` instead of `,` inside `breakafter`



## [6.3.0] - 2024-07-10

### Added
Expand Down
2 changes: 1 addition & 1 deletion doc/latex/tcolorbox/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# The LaTeX package tcolorbox - version 6.3.0 (2024/07/10)
# The LaTeX package tcolorbox - version 6.4.0 (2024/09/27)


> Copyright (c) 2006-2024 by Prof. Dr. Dr. Thomas F. Sturm <thomas dot sturm at unibw dot de>
Expand Down
Binary file modified doc/latex/tcolorbox/tcolorbox-example-poster.pdf
Binary file not shown.
2 changes: 1 addition & 1 deletion doc/latex/tcolorbox/tcolorbox-example-poster.tex
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
%% The LaTeX package tcolorbox - version 6.3.0 (2024/07/10)
%% The LaTeX package tcolorbox - version 6.4.0 (2024/09/27)
%% tcolorbox-example-poster.tex: a poster example for tcolorbox
%%
%% -------------------------------------------------------------------------------------------
Expand Down
Binary file modified doc/latex/tcolorbox/tcolorbox-example.pdf
Binary file not shown.
2 changes: 1 addition & 1 deletion doc/latex/tcolorbox/tcolorbox-example.tex
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
%% The LaTeX package tcolorbox - version 6.3.0 (2024/07/10)
%% The LaTeX package tcolorbox - version 6.4.0 (2024/09/27)
%% tcolorbox-example.tex: an example for tcolorbox
%%
%% -------------------------------------------------------------------------------------------
Expand Down
Binary file modified doc/latex/tcolorbox/tcolorbox-tutorial-poster.pdf
Binary file not shown.
4 changes: 2 additions & 2 deletions doc/latex/tcolorbox/tcolorbox-tutorial-poster.tex
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
% \LaTeX-Main\
%% The LaTeX package tcolorbox - version 6.3.0 (2024/07/10)
%% The LaTeX package tcolorbox - version 6.4.0 (2024/09/27)
%% tcolorbox-tutorial-poster.tex: a tutorial for poster creation with tcolorbox
%%
%% -------------------------------------------------------------------------------------------
Expand Down Expand Up @@ -1373,7 +1373,7 @@
\tcbinputlisting{standard jigsaw,size=minimal,toprule=0.5mm,bottomrule=0.5mm,boxsep=2mm,
colback=white,opacityback=0.75,listing only,
enforce breakable,tcb@poster@boxheight,before skip=-\interlineskip,height fixed for=all,
minted options={tabsize=2,fontsize=\small,breaklines,breakafter={,]-}},
minted options={tabsize=2,fontsize=\small,breaklines,breakafter={\,\]-}},

This comment has been minimized.

Copy link
@muzimuzhi

muzimuzhi Sep 27, 2024

Contributor

Starting from fvextra v1.5 (2022-12-01), only escaped comma functions in breakbefore and breakafter (gpoore/fvextra@16de52d).

But it's the refactoring of option processing in minted v3 that made breakafter={,]-} raise errors. I've proposed a fix to minted in gpoore/minted#407.

This comment has been minimized.

Copy link
@muzimuzhi

muzimuzhi Oct 2, 2024

Contributor

I was partially wrong. Un-escaped comma (breakafter={,}) works in fvextra (see gpoore/fvextra#15 (comment)), so it's solely a minted v3 issue.

This comment has been minimized.

Copy link
@muzimuzhi

muzimuzhi Oct 4, 2024

Contributor

Should be fixed in minted v3.1.0.

listing file=tcolorbox-example-poster.tex}%
}
\end{tcbposter}
Expand Down
14 changes: 7 additions & 7 deletions doc/latex/tcolorbox/tcolorbox.doc.breakable.tex
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ \section{Library \mylib{breakable}}\label{sec:breakable}%
\begin{dispListing}
\tcbuselibrary{breakable}
\end{dispListing}
This also loads the package |pdfcol|.
This also loads the package \refPkg{pdfcol}.

\subsection{Technical Overview}
The library \mylib{breakable} supports the automatic breaking of a |tcolorbox|.
Expand Down Expand Up @@ -114,7 +114,7 @@ \subsection{Limitations and Known Bugs}
color changing commands, your color may not survive the break to the next box.
See the documentation for \refKey{/tcb/use color stack} for more information.
\item\tcbdocmarginnote{\tcbdocnew{2014-10-30}}
The |perpage| option of the |footmisc| package is deliberately deactivated
The |perpage| option of the \refPkg{footmisc} package is deliberately deactivated
inside a breakable box since all footnotes are placed at the end
of the box (possibly far away from the reference point).
\item\tcbdocmarginnote{\tcbdocnew{2016-02-15}}
Expand All @@ -127,7 +127,7 @@ \subsection{Limitations and Known Bugs}
Lua\TeX\ version 0.95 changes the behavior of the basic |\vsplit| (a bug?!)
resulting in badly broken boxes. Thanks to Jeremy Engel,
the \mylib{breakable} library contains a patch for this which
also loads the the |ifluatex| package.
also loads the the \refPkg{ifluatex} package.
\end{itemize}


Expand Down Expand Up @@ -315,7 +315,7 @@ \subsection{Main Option Keys}
color changing commands, your color may not survive the break to the next box.
For some engines, there is support for additional color stacks which
allow colors to survive breaks. Such an color stack can be activated
by \refKey{/tcb/use color stack} with help of the |pdfcol| package.
by \refKey{/tcb/use color stack} with help of the \refPkg{pdfcol} package.
This can be done globally or per box.
\begin{marker}
Note that activating \refKey{/tcb/use color stack} inserts a color command with a \emph{whatsit}
Expand All @@ -326,9 +326,9 @@ \subsection{Main Option Keys}
\begin{itemize}
\item pdf\TeX: color stacks supported.
\item Lua\TeX: color stacks supported, but you should consider loading the
|luacolor| package \emph{instead} which avoids the spacing problem.
\refPkg{luacolor} package \emph{instead} which avoids the spacing problem.
\item Xe\TeX: color stacks not supported (yet?). From hearsay,
with the |fontspec| package, you may use |\addfontfeatures{Color=mycolor}|
with the \refPkg{fontspec} package, you may use |\addfontfeatures{Color=mycolor}|
to add a font color which survives the break.
\end{itemize}
If |pdfcol| cannot initialize an additional color stack for the used engine,
Expand Down Expand Up @@ -682,7 +682,7 @@ \subsection{Breakable boxes and the \texttt{multicol} package}\label{subsec:mult
\begin{tcolorbox}[enhanced jigsaw,size=small,breakable,colback=yellow!10!white,
colframe=red!50!white,break at=3cm,height fixed for=all]
Unbreakable |tcolorbox|es can be used without special care inside a
|multicols| environment from the |multicol| package \cite{mittelbach:multicol}.
|multicols| environment from the \refPkg{multicol} package \cite{mittelbach:multicol}.

Since version 3.10, a breakable |tcolorbox| detects, if it is used inside
a |multicols| environment. But choosing break points for a breakable box
Expand Down
2 changes: 1 addition & 1 deletion doc/latex/tcolorbox/tcolorbox.doc.coremacros.tex
Original file line number Diff line number Diff line change
Expand Up @@ -465,7 +465,7 @@ \subsection{Producing \texttt{\textbackslash tcbox} Commands}\label{subsec:macro
or \myverb[brown]{\texttt}, \myverb[brown]{\ttfamily}.
\end{dispExample}

The next example uses |\lstinline| from the |listings| package to
The next example uses |\lstinline| from the \refPkg{listings} package to
typeset the verbatim content.

\begin{dispExample}
Expand Down
40 changes: 20 additions & 20 deletions doc/latex/tcolorbox/tcolorbox.doc.coreoptions.tex
Original file line number Diff line number Diff line change
Expand Up @@ -2640,7 +2640,7 @@ \subsection{Box Content Additions}\label{subsec:contentadditions}

\begin{docTcbKey}{varwidth upper}{\colOpt{=\meta{length}}}{style, default \refKey{/tcb/width}}
This style places the upper part content into a |varwidth| environment.
This style needs the |varwidth| package \cite{arseneau:2011a} to be loaded manually.
This style needs the \refPkg{varwidth} package \cite{arseneau:2011a} to be loaded manually.
The resulting box has a maximal width of \meta{length}.
This option is only senseful for a \refCom{tcbox}.
\begin{exdispExample*}{varwidth_upper}{sbs,lefthand ratio=0.6}
Expand Down Expand Up @@ -3268,7 +3268,7 @@ \subsection{Embedding into the Surroundings}\label{subsec:surroundings}
\refKey{/tcb/before skip balanced} and \refKey{/tcb/after skip balanced}
(see note on page~\pageref{subsec:surroundings}).\par
Sets the keys |before| and |after| to values which are
recommended, if the package |parskip| \emph{is} used and there is no better
recommended, if the package \refPkg{parskip} \emph{is} used and there is no better
idea for |before| and |after|. This is similar to:
\begin{dispListing}
\tcbset{parskip/.style={before={\par\pagebreak[0]\parindent=0pt},
Expand All @@ -3281,7 +3281,7 @@ \subsection{Embedding into the Surroundings}\label{subsec:surroundings}
\refKey{/tcb/before skip balanced} and \refKey{/tcb/after skip balanced}
(see note on page~\pageref{subsec:surroundings}).\par
Sets the keys |before| and |after| to values which are
recommended, if the package |parskip| is \emph{not} used and there is no better
recommended, if the package \refPkg{parskip} is \emph{not} used and there is no better
idea for |before| and |after|. This is similar to:
\begin{dispListing}
\tcbset{noparskip/.style={before={\par\pagebreak[0]\smallskip\parindent=0pt},
Expand All @@ -3293,13 +3293,13 @@ \subsection{Embedding into the Surroundings}\label{subsec:surroundings}
This options is considered to be superseded by
\refKey{/tcb/before skip balanced} and \refKey{/tcb/after skip balanced}
(see note on page~\pageref{subsec:surroundings}).\par
Tries to detect the usage of the package |parskip| and sets
Tries to detect the usage of the package \refPkg{parskip} and sets
the keys |before| and |after| accordingly. Actually, the following is done:
\begin{itemize}
\item If the length of |\parskip| is greater than |0pt| at the beginning of the document,
\refKey{/tcb/parskip} is executed. Here, the usage of package |parskip| is \emph{assumed}.
\refKey{/tcb/parskip} is executed. Here, the usage of package \refPkg{parskip} is \emph{assumed}.
\item Otherwise, if the length of |\parskip| is not greater than |0pt| at the beginning of the document,
\refKey{/tcb/noparskip} is executed. Here, the absence of package |parskip| is \emph{assumed}.
\refKey{/tcb/noparskip} is executed. Here, the absence of package \refPkg{parskip} is \emph{assumed}.
\end{itemize}
\end{docTcbKey}

Expand Down Expand Up @@ -4315,7 +4315,7 @@ \subsection{Counters, Labels, and References}
\item Labels are ensured to reference the correct page number.
\item The \meta{code} is executed only once even during fitting operations for
title and box content.
\item In combination with the |hyperref| package, the hyper anchor is set
\item In combination with the \refPkg{hyperref} package, the hyper anchor is set
to the upper left corner of the |tcolorbox|, i.\,e.\ links inside the pdf document
will jump to the box pleasantly.
\item Since the \meta{code} is executed inside a \TeX\ group, only global
Expand Down Expand Up @@ -4343,8 +4343,8 @@ \subsection{Counters, Labels, and References}
\begin{docTcbKey}[][doc new=2023-02-08]{label is zlabel}{}{no value, initially unset}
Sets |\zlabel| as labelling for |tcolorbox| (global or per box).
When \refKey{/tcb/label} and friends are used, the underlying labeling macro is |\zlabel|.
This needs the |zref| package \cite{oberdiek:zref} or packages building upon |zref| to be loaded.
References can be made by |\zref|. If the |zref-clever| package \cite{barros:zref-clever} is loaded,
This needs the \refPkg{zref} package \cite{oberdiek:zref} or packages building upon \refPkg{zref} to be loaded.
References can be made by |\zref|. If the \refPkg{zref-clever} package \cite{barros:zref-clever} is loaded,
|\zcref|, |\zcpageref|, and similar macros can be applied.
Note that this option is not getting reset by \refKey{/tcb/reset}.
\end{docTcbKey}
Expand All @@ -4362,7 +4362,7 @@ \subsection{Counters, Labels, and References}

\begin{docTcbKey}[][doc new=2014-11-28]{phantomlabel}{=\meta{marker}}{no default, initially unset}
Equivalent to \refKey{/tcb/label} for an \emph{unnumbered} box.
A |\phantomsection| from the package |hyperref| \cite{rahtz:hyperref} is used to set a correct
A |\phantomsection| from the package \refPkg{hyperref} \cite{rahtz:hyperref} is used to set a correct
hyperlink target.
This is not needed and should typically not be used for a numbered box.
\end{docTcbKey}
Expand All @@ -4389,15 +4389,15 @@ \subsection{Counters, Labels, and References}
This option has a different meaning based upon the chosen labeling mechanism.
\begin{itemize}
\item If \refKey{/tcb/label is label} is active:\par
The option key \refKey{/tcb/label type} can be used only in conjunction with the |cleveref| package
The option key \refKey{/tcb/label type} can be used only in conjunction with the \refPkg{cleveref} package
\cite{cubitt:2018a} which has to be loaded separately.
\meta{type} has to be a cross-reference type \emph{known} to |cleveref|
like |theorem|, |algorithm|, |result|, etc. References made with |cleveref|
will use this type. Note that using |label type| will result in compilation
errors, if |cleveref| is not loaded.
For an example, see \Vref{theo:meanvaluetheorem}.
\item If \refKey{/tcb/label is zlabel} is active:\par
The option key \refKey{/tcb/label type} can be used only in conjunction with the |zref-clever| package
The option key \refKey{/tcb/label type} can be used only in conjunction with the \refPkg{zref-clever} package
\cite{barros:zref-clever}
which has to be loaded separately.
\meta{type} has to be a cross-reference type \emph{known} to |zref-clever|.
Expand All @@ -4419,9 +4419,9 @@ \subsection{Counters, Labels, and References}

\clearpage
\begin{docTcbKey}[][doc new and updated={2016-06-22}{2023-02-08}]{nameref}{=\meta{text}}{no default, initially unset}
If the |nameref| package is loaded, the given \meta{text} is used for
If the \refPkg{nameref} package is loaded, the given \meta{text} is used for
corresponding |\nameref| macros.
If the |zref-titleref| package is loaded, the given \meta{text} is used to
If the \refPkg{zref-titleref} package is loaded, the given \meta{text} is used to
set the reference text for |\ztitleref|.
Typically, the \meta{text} will be chosen
to be identical or nearly identical to the one for \refKey{/tcb/title}.
Expand Down Expand Up @@ -4454,7 +4454,7 @@ \subsection{Counters, Labels, and References}

\clearpage
\begin{docTcbKey}[][doc new=2017-02-03]{hypertarget}{=\meta{marker}}{no default, initially unset}
A |\hypertarget| from the package |hyperref| \cite{rahtz:hyperref} is used to
A |\hypertarget| from the package \refPkg{hyperref} \cite{rahtz:hyperref} is used to
create an internal link of an anchor \meta{marker}.
This \meta{marker} can be referenced by |\hyperlink| or
\refKey{/tcb/hyperlink}.
Expand All @@ -4473,7 +4473,7 @@ \subsection{Counters, Labels, and References}


\begin{docTcbKey}[][doc new=2017-02-10]{bookmark}{=\meta{text}}{no default, initially unset}
Sets a PDF bookmark with the given \meta{text}, if the package |bookmark| \cite{oberdiek:bookmark}
Sets a PDF bookmark with the given \meta{text}, if the package \refPkg{bookmark} \cite{oberdiek:bookmark}
is loaded. This bookmark is set with an automated destination (the current box)
and is set one level below the current bookmark level.
\begin{dispExample*}{sbs,lefthand ratio=0.7}
Expand All @@ -4490,7 +4490,7 @@ \subsection{Counters, Labels, and References}

\begin{docTcbKey}[][doc new=2017-02-10]{bookmark*}{=\marg{options}\marg{text}}{no default, initially unset}
Identical to \refKey{/tcb/bookmark}, but additional \meta{options}
from the package |bookmark| \cite{oberdiek:bookmark} can be given.
from the package \refPkg{bookmark} \cite{oberdiek:bookmark} can be given.
\begin{dispExample*}{sbs,lefthand ratio=0.7}
% \usepackage{bookmark}%
\begin{tcolorbox}[colback=red!10,colframe=red!50!black,
Expand Down Expand Up @@ -4692,7 +4692,7 @@ \subsection{Externalization}
See \Fullref{sec:external} for the \mylib{external} library of |tcolorbox|.
\end{marker}

If the \emph{externalization} library of the \texttt{tikz} package is used,
If the \emph{externalization} library of the \refPkg{tikz} package is used,
a |tcolorbox| could trigger the externalization process which will arise
a compilation error.

Expand Down Expand Up @@ -4734,15 +4734,15 @@ \subsection{Externalization}
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:tikz_and_pgf} or the library \mylib{skins} has to be loaded to use this option.
The package \refPkg{tikz} \cite{tantau:tikz_and_pgf} 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:tikz_and_pgf} or the library \mylib{skins} has to be loaded to use this option.
The package \refPkg{tikz} \cite{tantau:tikz_and_pgf} or the library \mylib{skins} has to be loaded to use this option.
Additionally, |\usetikzlibrary{external}| has to be used.
\end{docTcbKey}

Expand Down
Loading

0 comments on commit 2911a3e

Please sign in to comment.