Skip to content

Commit

Permalink
4.13
Browse files Browse the repository at this point in the history
  • Loading branch information
T-F-S committed Mar 22, 2018
1 parent 07984a0 commit 0b857db
Show file tree
Hide file tree
Showing 40 changed files with 199 additions and 95 deletions.
19 changes: 17 additions & 2 deletions doc/latex/tcolorbox/CHANGES
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
%% The LaTeX package tcolorbox - version 4.12 (2018/01/12)
%% The LaTeX package tcolorbox - version 4.13 (2018/03/22)
%%
%% -------------------------------------------------------------------------------------------
%% Copyright (c) 2006-2017 by Prof. Dr. Dr. Thomas F. Sturm <thomas dot sturm at unibw dot de>
%% Copyright (c) 2006-2018 by Prof. Dr. Dr. Thomas F. Sturm <thomas dot sturm at unibw dot de>
%% -------------------------------------------------------------------------------------------
%%
%% This work may be distributed and/or modified under the
Expand Down Expand Up @@ -1035,3 +1035,18 @@ version 4.12 (2018/01/12)
- library 'theorems':
* new options 'theorem label supplement', 'theorem full label supplement'

version 4.13 (2018/03/22)
- typos in 'tcolorbox-tutorial-poster' corrected
- new options:
'grow sidewards by'
- library 'breakable':
* Warning for discarded zero height box content added
- library 'listings':
* Documentation for 'text side listing', 'listing side text',
'comment side listing', 'listing side comment' supplemented with notes.
- library 'skins':
* Options given by '/tcb/graphics options' and '/tikz/fill image options'
are now fully expanded while applied to underlying '\includegraphics'
* new option:
'graphics orientation'

2 changes: 1 addition & 1 deletion doc/latex/tcolorbox/README
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
%% The LaTeX package tcolorbox - version 4.12 (2018/01/12)
%% The LaTeX package tcolorbox - version 4.13 (2018/03/22)
%%
%% -------------------------------------------------------------------------------------------
%% Copyright (c) 2006-2017 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 4.12 (2018/01/12)
%% The LaTeX package tcolorbox - version 4.13 (2018/03/22)
%% 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 4.12 (2018/01/12)
%% The LaTeX package tcolorbox - version 4.13 (2018/03/22)
%% tcolorbox-example.tex: an example for tcolorbox
%%
%% -------------------------------------------------------------------------------------------
Expand Down
Binary file modified doc/latex/tcolorbox/tcolorbox-tutorial-poster.pdf
Binary file not shown.
6 changes: 3 additions & 3 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 4.12 (2018/01/12)
%% The LaTeX package tcolorbox - version 4.13 (2018/03/22)
%% tcolorbox-tutorial-poster.tex: a tutorial for poster creation with tcolorbox
%%
%% -------------------------------------------------------------------------------------------
Expand Down Expand Up @@ -87,7 +87,7 @@
poster = {showframe,columns=4,rows=5},
]
% Here, we insert the poster content later
\end{poster}
\end{tcbposter}
\end{document}
\end{guidelisting}
\end{guide}
Expand Down Expand Up @@ -136,7 +136,7 @@
poster = {showframe,columns=4,rows=5},
]
% Here, we insert the poster content later
\end{poster}
\end{tcbposter}
\end{document}
\end{guidelisting}
\end{guide}
Expand Down
20 changes: 17 additions & 3 deletions doc/latex/tcolorbox/tcolorbox.doc.coreoptions.tex
Original file line number Diff line number Diff line change
Expand Up @@ -1331,6 +1331,7 @@ \subsubsection{Size Shortcuts}
the page.
Note that this style option has to be given \emph{after} all other
geometry keys!
Also see \refKey{/tcb/grow sidewards by} and \refKey{/tcb/spread sidewards}.
\begin{dispListing}
\tcbset{colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries}

Expand Down Expand Up @@ -2935,7 +2936,7 @@ \subsection{Embedding into the Surroundings}\label{subsec:surroundings}
\refKey{/tcb/noparskip},
\refKey{/tcb/after skip},
\refKey{/tcb/breakable}, and
\refKey{/tcb/raster}.
\refEnv{tcbraster}.

This option was created to automatically
avoid overfull box warnings with |\parfillskip| changing packages.
Expand Down Expand Up @@ -3106,12 +3107,24 @@ \subsubsection{Shifting Bounding Box Borders}
enhanced,show bounding box]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
\end{exdispExample}
\end{docTcbKey}

\clearpage

\begin{docTcbKey}[][doc new=2018-03-22]{grow sidewards by}{=\meta{length}}{no default, initially |0mm|}
Shortcut for setting \refKey{/tcb/grow to left by} and \refKey{/tcb/grow to right by}
to \meta{length}. Also see \refKey{/tcb/oversize} and \refKey{/tcb/spread sidewards}.
\begin{exdispExample}[safety=2cm]{grow_sidewards_by}
\tcbset{colframe=blue!75!black,colback=white}

\begin{tcolorbox}[grow sidewards by=2cm,enhanced,show bounding box]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
\end{exdispExample}
\end{docTcbKey}


\clearpage
\subsubsection{Box Alignment}

\begin{docTcbKey}[][doc new=2015-11-20]{flush left}{}{style, no value}
Expand Down Expand Up @@ -3296,6 +3309,7 @@ \subsubsection{Spread Box to Page Borders}
\begin{docTcbKey}[][doc new=2017-02-13]{spread sidewards}{\colOpt{=\meta{length}}}{default |0pt|, initially unset}
Combination of \refKey{/tcb/spread inwards} and \refKey{/tcb/spread outwards}.
The optional \meta{length} is used for all these keys.
Also see \refKey{/tcb/oversize} and \refKey{/tcb/grow sidewards by}.
\begin{dispListing}
\begin{tcolorbox}[enhanced,spread sidewards,
colframe=blue!75!black,colback=white,show bounding box]
Expand Down Expand Up @@ -3907,7 +3921,7 @@ \subsection{Counters, Labels, and References}

\begin{docTcbKey}[][doc new and updated={2016-06-22}{2016-11-18}]{nameref}{=\meta{text}}{no default, initially unset}
If the |nameref| package is loaded, the given \meta{text} is used for
corresponding |\nameref| makros. Typically, the \meta{text} will be chosen
corresponding |\nameref| macros. Typically, the \meta{text} will be chosen
to be identical or nearly identical to the one for \refKey{/tcb/title}.

\inputpreamblelisting{A}
Expand Down
2 changes: 1 addition & 1 deletion doc/latex/tcolorbox/tcolorbox.doc.documentation.tex
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ \section{Library \mylib{documentation}}\label{sec:documentation}%


\subsection{Macros of the Library}
%\enlargethispage*{15mm}
\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}.
Expand Down
2 changes: 1 addition & 1 deletion doc/latex/tcolorbox/tcolorbox.doc.filling.tex
Original file line number Diff line number Diff line change
Expand Up @@ -379,7 +379,7 @@ \subsection{Filling Options}
\end{docTikzKey}


\begin{docTikzKey}{fill image options}{=\meta{graphics options}}{no default, initially empty}
\begin{docTikzKey}[][doc updated=2018-03-18]{fill image options}{=\meta{graphics options}}{no default, initially empty}
The \meta{graphics options} are given to the underlying \docAuxCommand*{includegraphics} command
for the image fill options. This can be just together with
\refKey{/tikz/fill stretch image}, \refKey{/tikz/fill overzoom image}, \refKey{/tikz/fill zoom image},
Expand Down
48 changes: 46 additions & 2 deletions doc/latex/tcolorbox/tcolorbox.doc.graphics.tex
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ \subsection{Macros}
\clearpage
\subsection{Option Keys}

\begin{docTcbKey}[][doc new=2014-11-14]{graphics options}{=\meta{options}}{no default, initially empty}
\begin{docTcbKey}[][doc new and updated={2014-11-14}{2018-03-18}]{graphics options}{=\meta{options}}{no default, initially empty}
Used for \refCom{tcbincludegraphics} and \refCom{tcbincludepdf} to
specify |\includegraphics| \meta{options}.

Expand All @@ -110,7 +110,8 @@ \subsection{Option Keys}
\begin{tcbraster}[raster columns=3,size=fbox,raster equal height,
colframe=red!50!black,colback=red!20!black,drop fuzzy shadow]
\tcbincludegraphics{goldshade.png}
\tcbincludegraphics[graphics options={angle=20}]{goldshade.png}
\newcommand{\myangle}{angle=20}%
\tcbincludegraphics[graphics options=\myangle]{goldshade.png}
\tcbincludegraphics[graphics options={viewport=0cm 0cm 8cm 4cm,clip}]
{goldshade.png}
\end{tcbraster}
Expand Down Expand Up @@ -150,5 +151,48 @@ \subsection{Option Keys}
\end{dispListing}
\end{docTcbKey}

\clearpage


\begin{docTcbKey}[][doc new=2018-03-21]{graphics orientation}{=\meta{orientation}}{no default, initially |as-is|}
Used for \refCom{tcbincludegraphics} and \refCom{tcbincludepdf} to
guarantee a certain \meta{orientation} of the included image.
After all other options for the image are processed, the result is possibly
rotated to be in landscape or portrait mode.

Feasible values for \meta{orientation} are:
\begin{itemize}
\item\docValue{as-is}: no rotation of the processed image.
\item\docValue{landscape}:
the processed image is possibly rotated by 90 degrees
to ensure that the final width is not smaller than the final height.
\item\docValue{landscape*}:
the processed image is possibly rotated by -90 degrees
to ensure that the final width is not smaller than the final height.
\item\docValue{portrait}:
the processed image is possibly rotated by 90 degrees
to ensure that the final height is not smaller than the final width.
\item\docValue{portrait*}:
the processed image is possibly rotated by -90 degrees
to ensure that the final height is not smaller than the final width.
\end{itemize}

\begin{dispExample}
% \tcbuselibrary{raster}
\begin{tcbraster}[raster columns=6,size=fbox,raster equal height,
colframe=red!50!black,colback=red!20!black,drop fuzzy shadow]
\tcbincludegraphics{Basilica_5.png}
\tcbincludegraphics[graphics orientation=landscape]{Basilica_5.png}
\tcbincludegraphics[graphics orientation=portrait]{Basilica_5.png}
\tcbincludegraphics[graphics orientation=portrait*]{Basilica_5.png}
\tcbincludegraphics[graphics options={viewport=0cm 0cm 2cm 3cm,clip}]
{goldshade.png}
\tcbincludegraphics[graphics options={viewport=0cm 0cm 2cm 3cm,clip},
graphics orientation=landscape]{goldshade.png}
\end{tcbraster}
\end{dispExample}


\end{docTcbKey}


16 changes: 12 additions & 4 deletions doc/latex/tcolorbox/tcolorbox.doc.listings.tex
Original file line number Diff line number Diff line change
Expand Up @@ -691,20 +691,26 @@ \subsection{Common Option Keys of all Libraries}\label{sec:commonlistingkeys}
\clearpage
\begin{docTcbKey}{listing side text}{}{no value}
\begin{docTcbKey}{listing side text}{}{style, no value}
Typesets the environment content side by side as listing in the left (upper)
part and as compiled text in the right (lower) part.
This is a shortcut for setting \refKey{/tcb/listing and text} and \refKey{/tcb/sidebyside}.
\begin{dispExample}
\begin{tcblisting}{colback=red!5!white,colframe=red!75!black,listing side text}
This is a \LaTeX\ example.
\end{tcblisting}
\end{dispExample}
\begin{marker}
Note that |sidebyside=false| has to be added, if the setting of
\refKey{/tcb/listing side text} is to be annihilated.
\end{marker}
\end{docTcbKey}
\begin{docTcbKey}{text side listing}{}{no value}
\begin{docTcbKey}{text side listing}{}{style, no value}
Typesets the environment content side by side as compiled text in the left (upper)
part and as listing in the right (lower) part.
This is a shortcut for setting \refKey{/tcb/text and listing} and \refKey{/tcb/sidebyside}.
\begin{dispExample}
\begin{tcblisting}{colback=red!5!white,colframe=red!75!black,text side listing}
This is a \LaTeX\ example.
Expand Down Expand Up @@ -744,9 +750,10 @@ \subsection{Common Option Keys of all Libraries}\label{sec:commonlistingkeys}
\clearpage
\begin{docTcbKey}{listing side comment}{}{no value}
\begin{docTcbKey}{listing side comment}{}{style, 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.
This is a shortcut for setting \refKey{/tcb/listing and comment} and \refKey{/tcb/sidebyside}.
\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}}
Expand All @@ -756,9 +763,10 @@ \subsection{Common Option Keys of all Libraries}\label{sec:commonlistingkeys}
\end{docTcbKey}
\begin{docTcbKey}{comment side listing}{}{no value}
\begin{docTcbKey}{comment side listing}{}{style, 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.
This is a shortcut for setting \refKey{/tcb/comment and listing} and \refKey{/tcb/sidebyside}.
\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}}
Expand Down
2 changes: 2 additions & 0 deletions doc/latex/tcolorbox/tcolorbox.doc.magazine.tex
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,8 @@ \subsection{Creation and Resetting of Box Arrays}\label{subsec:magazine_creation
\end{dispListing}
\end{docCommand}

\enlargethispage*{20mm}

\begin{docTcbKey}[][doc new=2015-07-13]{reset box array}{\colOpt{=\meta{name}}}{default |default|, initially unset}
Resets the size counter of a box array \meta{name} to zero.
Use this or \refCom{boxarrayreset} (which does the same) before
Expand Down
2 changes: 1 addition & 1 deletion doc/latex/tcolorbox/tcolorbox.doc.recording.tex
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ \section{Recording}\label{sec:recording}%
information about example solutions is recorded and read again
in \Vref{sec:recording-solutions}.

\subsection{Makros}\label{sec:recording-makros}
\subsection{Macros}\label{sec:recording-makros}
\begin{docCommand}[doc new=2014-11-28]{tcbstartrecording}{\oarg{file name}}
Opens a file denoted by \meta{file name} for writing the records.
The default file name is |\jobname.records|.
Expand Down
7 changes: 7 additions & 0 deletions doc/latex/tcolorbox/tcolorbox.doc.s_main.sty
Original file line number Diff line number Diff line change
Expand Up @@ -252,3 +252,10 @@
}

\newrobustcmd*{\tcbexclamation}{!}

\newtcbox{\section@box}{tile,before=\clearpage\noindent,after=,
fontupper=\normalfont\Large\bfseries,capture=minipage,colback=blue!80,coltext=white,
boxsep=0mm,top=4mm,bottom=4mm,left=\oddsidemargin+1in,right=\oddsidemargin+1in,
spread sidewards,fuzzy halo=1mm with blue!50!gray}

\renewcommand\section{\@startsection{section}{1}{\z@}{\z@}{5mm}{\section@box}}
21 changes: 2 additions & 19 deletions doc/latex/tcolorbox/tcolorbox.doc.technical.tex
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,6 @@ \section{Technical Overview and Customization}\label{sec:technical}%
The following explanations also cover options and settings from the \mylib{skins} library,
see \Vref{sec:skins}.


%The library is loaded by a package option or inside the preamble by:
%\begin{dispListing}
%\tcbuselibrary{skins}
%\end{dispListing}
%This also loads the package |tikz| \cite{tantau:2015a}. Typically but not necessarily,
%the following skins use |tikz| instead of |pgf|.

\subsection{Skins and Drawing Engines}\label{sec:skincorekeys}
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
Expand All @@ -44,17 +36,6 @@ \subsection{Skins and Drawing Engines}\label{sec:skincorekeys}
\end{dispExample}
\end{docTcbKey}


%\begin{marker}
% On first read, you may skip the rest of this subsection and proceed to
% Subsection \ref{subsec:addstyleoptions} on page \pageref{subsec:addstyleoptions}.
% All following keys in this subsection are automatically set by the selected skin
% and you may never have to temper with them.
% Nevertheless, they can be used after a skin was selected to modify
% this skin.
%\end{marker}


\begin{docTcbKey}{skin first}{=\meta{name}}{style, no default, initially \texttt{standard}}
If the box is set to be \refKey{/tcb/breakable} and \emph{is} broken actually,
then the skin for the \emph{first} part of the break sequence
Expand All @@ -79,6 +60,8 @@ \subsection{Skins and Drawing Engines}\label{sec:skincorekeys}
\end{docTcbKey}


\clearpage

\begin{docTcbKey}{graphical environment}{=\meta{name}}{no default, initially \texttt{pgfpicture}}
Sets the graphical environment for the |tcolorbox| to \meta{name}.
Feasible values are |pgfpicture| and |tikzpicture| or environments which
Expand Down
2 changes: 1 addition & 1 deletion doc/latex/tcolorbox/tcolorbox.doc.theorems.tex
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ \subsection{Macros of the Library}
The new environment \meta{name}|*| takes one optional and one mandatory
parameter and represents an unnumbered variant of the environment \meta{name}.
This variant is not labeled and not listed in lists of theorems.
%\enlargethispage*{20mm}
\enlargethispage*{20mm}
\inputpreamblelisting{F}
\begin{dispExample}
% usage of '\nameref' needs 'nameref' or 'hyperref' to be loaded
Expand Down
5 changes: 3 additions & 2 deletions doc/latex/tcolorbox/tcolorbox.doc.vignette.tex
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,6 @@ \subsection{Generic Geometry Settings}\label{subsec:vignettegeometry}
\end{dispExample*}
\end{vigTcbKey}

\clearpage
\begin{vigTcbKey}[][doc new=2016-04-22]{vertical size}{=\meta{length}}{style, initially |2mm|}
Sets \refKey{/tcb/vig/north size} and \refKey{/tcb/vig/south size},
to the given \meta{length}.
Expand Down Expand Up @@ -281,6 +280,8 @@ \subsection{Generic Color and Style Settings}\label{subsec:vignettestyle}
\end{dispExample*}
\end{vigTcbKey}

\clearpage

\begin{vigTcbKey}[][doc new=2016-04-22]{east style}{=\marg{style}}{no default, initially |red!75!black|}
Sets \tikzname\ \meta{style} options for the east \emph{vignette} part.
\begin{dispExample*}{sbs,righthand width=3cm,center lower}
Expand All @@ -291,7 +292,7 @@ \subsection{Generic Color and Style Settings}\label{subsec:vignettestyle}
\end{dispExample*}
\end{vigTcbKey}

\clearpage

\begin{vigTcbKey}[][doc new=2016-04-22]{west style}{=\marg{style}}{no default, initially |red!75!white|}
Sets \tikzname\ \meta{style} options for the west \emph{vignette} part.
\begin{dispExample*}{sbs,righthand width=3cm,center lower}
Expand Down
Binary file modified doc/latex/tcolorbox/tcolorbox.pdf
Binary file not shown.
Loading

0 comments on commit 0b857db

Please sign in to comment.