Le Package Tcolorbox - Apprendre Le LaTeX / Mohammed Jaiti
Le Package Tcolorbox - Apprendre Le LaTeX / Mohammed Jaiti
Le Package Tcolorbox - Apprendre Le LaTeX / Mohammed Jaiti
ac orci e
. Pellente
5 te
t nisl hen et magna, vitae , tortor sed accu lobor-
drerit mo
arturient sque a nulla. Cum llis. Suspendisse io metus a
lla ullam
montes, n s
cus
ligula ali llus. Donec aliqu libero, pretium a vel, wisi.
qu
u l tr
6
orbox 4
i c
li
rbi aucto gula, fringilla a,
r lorem n
ies et, te
.14
e
on justo. uismod sodales,
l l u
N am lacus
l
sollicitud
o, pretium in vel, wisi.
s. Pe
10 11
corper ve idiculus m atibus mi. Mor , e r at ligula s . Donec al i b e r
a i
stibulum
turpis. P s. Aliquam
u Cras nec bi ac orci et nis liquet magna, v quet, tortor sed at, lobor-
ellentesqu a
et magni nte. Pellentesq l h endrerit i t ae ornare accumsan
e m o l li o d i o
tincidunt s dis parturient ue a nulla. Cum s. Suspendisse metus a t
cursus lu u r na. N m o ntes, s o ciis n u t m ass b ibe
smod sod ctus mau ulla ullamcorper nascetur ridiculu atoque penatibu a. m i . M
ris. vestibulu s s
a
m lacus l les, sollicitudin v tcolorbo m turpis. mus. Aliquam Cras nec
ibero, pre el, wisi. x 4.14 Pellentes e t magnis d
aliquet, t ti u que
ortor sed m at, lobor- Nam dui
lig u
t i n c i d unt urna
i
v i ta e o rn a ccumsan M orbi a l a , f ringilla cursus lu .
a re
Suspendi odio metus a tis vitae, uctor lorem non j a, euismod soda ctus mau
sse ut m u lt r icies et, t u s to . N l e s , so
i s n a to q u
e penatib ssa.
a bibendum ellus. D am lacus libero, llicitudin vel, wi tcolorbo
14 15
m i. Morbi , e ra t l igula aliq o nec aliqu p retium at si. x 4.14
lus mus. us ac orci e u e t , N am dui l
A
s. Pellen liquam
Cras nec t nisl hen et magna, vitae , tortor sed accu lobor- ig
tesque et magni a n te . Pellentes drerit mo o rnare od m s a n M o r bi auctor ula, fringilla a,
l i lorem no
tincidunt s dis parturient que a nulla. Cum lis. Suspendisse o metus a tis vitae,
u l t r i c n justo.
cursus lu u r na . N m o n t e s , scetu s o c i is n toque u t m a s sa. b ib e n du i e s e t , te
ctus mau ulla ullatcolorbox mcorper na4.14 r ridiculu atcolorbox penati4.14 b u s mi. Mor m, erat ligula al llus. Do
ris. vestibulu s Cras nec bi ac orci et nis iquet magn
tcolorbo m turpis. mus. Aliquam
isi. x 4.14 Pellentes
que et magni ante. Pellentesq l hendrerit mo
Nam dui t i s dis par ue a null
li n c i d u n t t u r ie n t montes, n a. Cum
Morbi au gula, fringilla c u rsus luctu u r n a . N u l a
tis vitae, ctor lorem non j a, euismod soda s mauris. la ullamcorper ve scetur ri
bibendum ultricies et, tel usto. Nam lacus les, sollicitudin
Manual for s tibulum
tcolorbversion t
mi. Mor , e r a t lu s .
tcolorbox
D o
bi ac orc ligula aliquet ma nec aliquet, tort pretium at, lobor si.
l ib e r o , ve l , w i
Nam dui 4.14
ox 4 . 1 4
8 19
s nec ant i e g n o r - ligula, fr
e. Pellen t nisl hendrerit m a, vitae ornare o sed accumsan Morbi au (2018/07/26) in
nis dis pa tesque a n ollis. Sus dio metu t i s v i
c t o r lorem n gilla a, euismod
r u ll p e s t ae, ultric o n justo. N sodales,
urna. Nu turient montes, n a. Cum sociis na ndisse ut massa. a b i b e ndum, er i e s e t , tellus. a m lacus libe sollicitudin ve
lla ullam ascetur r toque pe mi. Mor at ligula Donec al ro, pretiu
s mauris. corper ve id na
stibulum iculus mus. Aliq tibus Cras nec b i a c orci et a li q u et magna i q u e t , tortor s m at, lob
turpis. P uam nisl hend , e
elletcolorbox
ntesque 4.14 et magnis tcolorbox ante. Pel
l e n t e s rerit mol vitae ornare odi d accumsan
tincidunt dis parturient ue a nulla. Cum s. Suspendisse
4.14 q l i o metus a
cursus lu u r na. N m o ntes, s o ciis n u t m ass
lla a, eui ctus mau ulla ullamcorper nascetur ridiculu atoque penatibu a.
2
smod sod ris. vestibulu s s
m turpis. mus. Aliquam
0
usto. Na a
m lacus l les, sollicitudin v tcolorbo Pellentes
. Donec ibe el, x 4.14 Thomas F. Sturm et
aliquet, t ro, pretium at, lo wisi. N a m dui lig
que
t incid
magna, v ortor sed bor- ula, fring
rit mollis i ta e o r n a a c c u m s an M o r b i a i lla c u r s us lu
. Suspen re odio metus a tis vitae, uctor lorem non j a, euismod soda
Cum soc di bibendum ultricies et, tel sto. Nam lacus les, sollicitudin u
iis natoq sse ut massa. l u l v tcolorbo
23
tur ridicu u e penatib m i. Morbi , e ra t ligula aliq s . D o nec aliqu i b e r o , p retium at e l , w i s i. x 4.14
lus mus. us ac orci e u e t , N am dui l
lum turp
is. Pellen liquam
A Cras nec t nisl hen et magna, vitae , tortor sed accu lobor- ig
tesque et magni a n t e . Pellentes drerit mo o rnare od m s a n M o r bi auctor ula, fr
l i lorem n
tincidunt s dis parturient que a nulla. Cum lis. Suspendisse o metus a tis vitae,
u l t r ic
u
cursus lu rna. Nulla ull ontes, nascetu ociis natoque m s u t mass b ibendum ie s
ctus mau amcorper r ridiculu penatibu a. m i , erat lig et, te
. Morbi ac u la
t
ris. vestibulu
m t u r
s mus. A
l i q u a m
s
C r a s n e orci et n aliq
pis. Pelle i
et magni c ante. Pellentesq sl hen
in vel, w colorbox
isi. 4.14 ntesque s u
at, lobor- Nam dui
l ig tincidunt dis parturient e a nu
umsan Morbi au
c to
u la , fringilla
a , cursus lu urna. Nulla ull montes, na
tis vitae, r lorem non e u ismod so ctus mau amcorper
sa u l tricies et, j u s t o d a le s, r i s. ves
b i b en d . Nam la sollicitud t c o
. u te c u in l o
mi. Mor m, erat ligula al llus. Donec aliq s libero, pretium vel, wisi.
rbox 4.1
4
b
Cras nec i ac orci et nis quet magna, v et, tortor sed i u a t, lobor- Nam dui
et magni ante. Pellentesq l hendrerit molli itae ornare odio accumsan Morbi au ligula, fringilla
tincidunt s dis parturient ue a nulla. Cum s. Suspendisse metus a tis vitae, ctor lorem non j a, euismod soda
urna. Nu montes, n sociis nat ut massa
. bibendum ultricies et, tel usto. Nam lacus les, sollic
sus luctu l a o mi. Mor , erat ligula al lus. Donec aliq libero, preti
s mauris. la ullamcorper ve scetur ridiculus m que penatibus
stibulum
turpis. P
us. Aliqu
a m Cras nec bi ac orci et nis iquet magna, v uet, tortor sed
x 4 .1 4 ellentesqu
e et magni ante. Pellentesq l hendrerit molli itae ornare odio
sd ue s. m
Cover code
% \usepackage{incgraph}
\begin{inctext}
\begin{tikzpicture}
\definecolorseries{boxcol}{rgb}{last}{blue}{red}
\resetcolorseries[28]{boxcol}
\coordinate (A) at (0,0); \coordinate (B) at (21,29.7);
\path[use as bounding box] (A) rectangle coordinate (C) (B);
\node[transform shape,xslant=0.7,rotate=-10,xshift=0cm] at (C) {%
\begin{tcbraster}[raster columns=4,title=tcolorbox \version,
fonttitle=\small\bfseries,raster width=50cm]
\foreach \b in {1,...,28} {\begin{tcolorbox}[enhanced,
watermark text=\thetcbrasternum,
colframe=boxcol!30!white,
colback=boxcol!25!white!30!white,
colbacktitle=boxcol!!+!50!black!30!white,
colupper=black!30!white]\lipsum[2]\end{tcolorbox}}
\end{tcbraster}%
};
\node at (C) {%
\begin{tcbitemize}[title=tcolorbox \version,fonttitle=\small\bfseries,
enhanced jigsaw,opacityback=0.5,opacitybacktitle=0.75,
halign=center,valign=center,arc=5mm,
raster width=16cm,raster column skip=8mm,raster halign=center,
raster force size=false,
raster row 1/.style={height=6cm},
raster row 2/.style={width=6cm,height=4cm},
raster column 1/.style={flushright title,
frame style={left color=yellow!50!black,right color=green!50!black},
title style={left color=yellow!50!blue,right color=blue!50!green!50!black},
interior style={left color=yellow!70,right color=green!70},
underlay={\draw[line width=6mm,line cap=round,black!60]
([shift={(0.4,-0.15)}]frame.north east)
--([shift={(0.4,0.15)}]frame.south east); }},
raster column 2/.style={
frame style={left color=green!50!black,right color=yellow!50!black},
title style={left color=blue!50!green!50!black,right color=yellow!50!blue},
interior style={left color=green!70,right color=yellow!70}}]
\tcbitem[fontupper=\Huge\bfseries,sharp corners=east,
underlay={\draw[line width=6mm,line cap=round,black!60]
([shift={(0.4,0.30)}]frame.north east)-- coordinate(A) +(0,0.2);
\draw[line width=1mm,line cap=round,black!60](A) -- +(30:1.5cm);
\draw[line width=1mm,line cap=round,black!60](A) -- +(150:1.5cm);}]
tcolorbox
\tcbitem[fontupper=\large\bfseries,sharp corners=west]
Manual for\\ version\\ \version\\(\datum)
\tcbitem[sharp corners=northeast]
\tcbitem[sharp corners=northwest] Thomas F.~Sturm
\end{tcbitemize}%
};
\end{tikzpicture}
\end{inctext}
2
The tcolorbox package
Manual for version 4.14 (2018/07/26)
Thomas F. Sturm1
http://www.ctan.org/pkg/tcolorbox
https://github.com/T-F-S/tcolorbox
Abstract
tcolorbox provides an environment for colored and framed text boxes with a heading
line. Optionally, such a box can be split in an upper and a lower part. The package
tcolorbox can be used for the setting of LATEX examples where one part of the box
displays the source code and the other part shows the output. Another common use
case is the setting of theorems. The package supports saving and reuse of source code
and text parts.
Contents
1 Introduction 8
1.1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.2 Loading the Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.3 Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2 Quick Reference 11
4 Option Keys 18
Contents
4.1 Title . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
4.2 Subtitle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
4.3 Upper Part . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
4.4 Lower Part . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
4.5 Colors and Fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
4.6 Text Alignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
4.7 Geometry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
4.7.1 Width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
4.7.2 Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
4.7.3 Arcs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
4.7.4 Spacing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
4.7.5 Size Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
4.7.6 Toggle Left and Right . . . . . . . . . . . . . . . . . . . . . . . . . 46
4.8 Corners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
4.9 Transparency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
4.10 Height Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
4.11 Box Content Additions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
4.12 Overlays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
1
Prof. Dr. Dr. Thomas F. Sturm, Institut für Mathematik und Informatik, Universität der Bundeswehr
München, D-85577 Neubiberg, Germany; email: [email protected]
3
4.13 Floating Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
4.14 Embedding into the Surroundings . . . . . . . . . . . . . . . . . . . . . . 78
4.15 Bounding Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
4.15.1 Shifting Bounding Box Borders . . . . . . . . . . . . . . . . . . . 82
4.15.2 Box Alignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
4.15.3 Toggle Enlargements . . . . . . . . . . . . . . . . . . . . . . . . . 86
4.15.4 Spread Box to Page Borders . . . . . . . . . . . . . . . . . . . . . 87
4.15.5 Box Extrusion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
4.16 Layered Boxes and Every Box Settings . . . . . . . . . . . . . . . . . . . 91
4.17 Capture Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
4.18 Text Characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
4.19 Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
4.20 \tcbox Specials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
4.21 Counters, Labels, and References . . . . . . . . . . . . . . . . . . . . . . 98
4.22 Even and Odd Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
4.23 Externalization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
4.24 Miscellaneous . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Contents
6 Side by Side 116
6.1 Basic Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
6.2 Advanced Settings from the xparse Library . . . . . . . . . . . . . . . 122
LIB
8 Recording 128
8.1 Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
8.2 Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
8.3 Example: Exercises . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
8.4 Example: Solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
4
10.6.2 Lifted Shadows . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
10.6.3 Generic Shadows . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
10.6.4 TikZ Shadows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
10.7 TikZ Picture Option Keys . . . . . . . . . . . . . . . . . . . . . . . . . . 192
10.8 Underlay Option Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
10.9 Finish Option Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
10.10 Hyper Option Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
10.11 Jigsaw Skin Variants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
10.12 Draft Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
10.13 Skin Family ’standard’ . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
10.14 Skin Family ’enhanced’ . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
10.15 Skin Family ’bicolor’ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
10.16 Skin Family ’tile’ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
10.17 Skin Family ’beamer’ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
10.18 Skin Family ’widget’ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
10.19 Skin Family ’empty’ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
10.20 Skin ’spartan’ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
10.21 Skin ’draft’ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
10.22 Skin Family ’freelance’ . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
Contents
11.2 Option Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
5
14.6.2 Placing Spaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
LIB
LIB
LIB
15.1 Loading the Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
15.1.1 Loading listings . . . . . . . . . . . . . . . . . . . . . . . . . . 298
Contents
16.3 Examples for Definitions and Theorems . . . . . . . . . . . . . . . . . . . 357
16.4 Using other theorem environments with tcolorbox . . . . . . . . . . . . 362
6
20 Library fitting 411
LIB
20.1 Macros of the Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
20.2 Option Keys of the Library . . . . . . . . . . . . . . . . . . . . . . . . . . 413
LIB
21.1 Concept of Hooks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422
21.2 Box Content Additions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424
21.3 Embedding into the Surroundings . . . . . . . . . . . . . . . . . . . . . . 425
21.4 Overlays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426
21.5 Watermarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
21.6 Underlays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430
21.7 Finishes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431
21.8 Skin Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431
21.9 Extras . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
Contents
22 Library xparse 434
LIB
References 478
Index 480
7
1 Introduction
The package originates from the first edition of my book «LATEX – Einführung in das Textsatzsys-
tem» [21] in about 2006. For the LATEX examples and tutorials given there, I wanted to have
accentuated and colored boxes to display source code and compiled text in combination. Since,
in my opinion, this type of boxes is also quite useful to highlight definitions and theorems, I
applied them for my lecture notes in mathematics [18–20] as well. With this package, you are
invited to apply these boxes for similar projects.
Starting with version 2.00, for all internal calculations ε-TEX [2] expressions are used in replace-
ment of the package calc. The breaking news for version 2.00 is the support for breakable boxes.
This new feature allows new applications of the package without affecting the core package too
much if you do not need boxes to break automatically. With version 2.20, the often requested
’side by side’ mode for listings has been added. With version 3.00, boxed titles are introduced
together with improved customization options for overlays, underlays, finishes, and own code
extensions.
Since the first public release in 2011, I received a lot of feedback from all over the world. I want
to thank all who wrote me for supporting this package by sending bug reports and ideas for new
or better features.
1.1 Installation
Typically, tcolorbox will be installed as part of a major LATEX distribution and there is nothing
special to do for a user.
If you intend to make a local installation by hand, see the README file of the tcolorbox package
for some hints. The short story is: you have to install not only tcolorbox.sty, but also all
*.code.tex files in the local texmf tree.
The base package tcolorbox loads the packages pgf [22], verbatim [17], etoolbox [7], and
environ [16]. tcolorbox itself is loaded in the usual manner in the preamble:
\usepackage{tcolorbox}
The package takes option keys in the key-value syntax. Alternatively, you may use these keys
later in the preamble with \tcbuselibraryÕ P. 9 (see there). For example, the key to typeset
listings is:
\usepackage[listings]{tcolorbox}
8
1.3 Libraries
The base package tcolorbox is extendable by program libraries. This is done by using option
keys while loading the package or inside the preamble by applying the following macro with the
same set of keys.
\tcbuselibrary{hkey listi}
Loads the libraries given by the hkey listi.
\tcbuselibrary{listings,theorems}
The following keys are used inside \tcbuselibrary respectively \usepackage without the key
tree path /tcb/library/.
/tcb/library/skins ( skins )
LIB
Loads the package tikz [22] and provides additional styles (skins) for the appearance of
the colored boxes; see Section 10 from page 148.
/tcb/library/vignette ( vignette )
LIB
Provides code for more ornamental; see Section 13 from page 265.
/tcb/library/raster ( raster )
LIB
Provides additional macros and options for typesetting multiple boxes arranged in a kind
of raster; see Section 14 from page 277.
/tcb/library/listings ( listings )
LIB
Loads the package listings [6] and provides additional macros for typesetting listings
which are described in Section 15 from page 298.
/tcb/library/listingsutf8 ( listingsutf8 )
LIB
Loads the packages listings [6] and listingsutf8 [10] for UTF-8 support. This is a
variant of the library listings and is described in Section 15 from page 298.
LIB
/tcb/library/minted ( minted )
Loads the package minted [12] to typeset listings with the Pygments [14] tool, also see LIB
Section 15 on page 298.
/tcb/library/theorems ( theorems )
LIB
Provides additional macros for typesetting theorems which are described in Section 16 from
page 339.
/tcb/library/breakable ( breakable )
LIB
Provides support for automatic box breaking from one page to another; see Section 17 on
page 363.
/tcb/library/magazine ( magazine )
LIB
Provides support for storing broken box parts to be used later or in interchanged order,
Section 18 on page 388.
/tcb/library/poster ( poster )
LIB
Provides support for font size adaption of the box content to the box dimensions; see
Section 20 from page 411.
/tcb/library/hooks ( hooks )
LIB
Extends several option keys to ’hookable’ keys; see Section 21 from page 422.
9
/tcb/library/xparse ( xparse )
LIB
Provides document command production with xparse for tcolorbox; see Section 22 from
page 434.
/tcb/library/external ( external )
LIB
Provides externalization support for stand-alone document snippets, see Section 23 on
page 447.
/tcb/library/documentation ( documentation )
LIB
Provides additional macros for typesetting L TEX documentations which are described in
A
Section 24 from page 459.
/tcb/library/many (style, no value)
Loads the libraries skins , breakable , raster , hooks , theorems , fitting ,
LIB
LIB
LIB
LIB
LIB
LIB
and xparse . Use this shortcut, if you want to use all features of tcolorbox with exception
LIB
LIB
/tcb/library/most (style, no value)
Loads all libraries except minted and documentation . Use this shortcut, if you want
LIB
LIB
to use all features of tcolorbox with exception of using the minted package and using the
specialized documentation library.
LIB
LIB
library.
Package tcolorbox
Basic Features
Base package
LIB LIB
LIB
external listingsutf8
fitting
hooks minted
LIB
magazine
poster
raster
skins
theorems
vignette
xparse
10
2 Quick Reference
tcolorbox
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit,
vestibulum ut, placerat ac, adipiscing vitae,
/tcb/width Õ P. felis.
34 Curabitur dictum gravida
mauris. Nam arcu libero, nonummy eget, consectetuer id, vulputate a, magna.
Donec vehicula augue eu neque. Pellentesque habitant morbi tristique senec-
/tcb/height Õ P. 53
tus et netus et malesuada fames ac turpis egestas. Mauris ut leo. Cras viverra
metus rhoncus sem. Nulla et lectus vestibulum urna fringilla ultrices. Phasel-
/tcb/left skip
lus eu tellus sit amet tortor gravida placerat. Integer /tcb/right
Õ P. 81 skipÕin,
sapien est, iaculis
P. 81
/tcb/grow
pretiumtoquis,
leftviverra
by ac, nunc. Praesent eget sem vel
Õ P. 84 /tcb/grow to bibendum.
leo ultrices right byÕ P. 84
Aenean faucibus. Morbi dolor nulla, malesuada eu, pulvinar at, mollis ac,
nulla. Curabitur auctor semper nulla. Donec varius orci eget risus. Duis nibh
mi, congue eu, accumsan eleifend, sagittis quis, diam. Duis eget orci sit amet
orci dignissim rutrum.
/tcb/topruleÕ P. 35
/tcb/toptitleÕ P. 42 /tcb/boxsepÕ P. 39
tcolorbox
/tcb/bottomtitle Õ P. 43
/tcb/boxsepÕ P. 39
Lorem ipsum dolor sit amet, consectetuer
/tcb/titlerule Õ P. 36 /tcb/boxsep
adipiscing
Õ P. 39
elit. Ut purus elit, vestibulum ut,
placerat ac, adipiscing/tcb/top
Õ P. 42
vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero,
nonummy eget, consectetuer id, vulputate a, magna. Donec vehicula augue eu neque.
Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis
egestas. Mauris ut leo. Cras viverra metus rhoncus sem. Nulla et lectus vestibulum urna
fringilla ultrices. Phasellus eu tellus sit amet tortor gravida placerat. Integer sapien
/tcb/boxsep est,
/tcb/boxsep
Õ P. 39 Õ P. 39
Aenean faucibus. Morbi dolor nulla, malesuada eu, pulvinar at, mollis ac, nulla. Curabitur
auctor semper nulla. Donec varius orci eget risus. Duis nibh mi, congue eu, accumsan
eleifend, sagittis quis, diam. Duis eget orci sit amet orci dignissim rutrum.
/tcb/middleÕ P. 43 /tcb/boxsepÕ P. 39
/tcb/leftruleÕ P. 35 /tcb/middleÕ P. 43 /tcb/boxsep Õ P. 39 /tcb/rightruleÕ P. 35
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem
non justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet,
tortor sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi.
Morbi ac orci et nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque
a nulla. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus
mus. Aliquam tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus
luctus mauris.
/tcb/bottomÕ P. 43 /tcb/boxsepÕ P. 39
/tcb/bottomrule Õ P. 35
11
3 Macros for Box Creation
\begin{tcolorbox}[hoptionsi]
henvironment contenti
\end{tcolorbox}
This is the main environment to create an accentuated colored text box with rounded
corners and, optionally, two parts. The appearance of this box is controlled by numerous
options. In the most simple case the source code
\begin{tcolorbox}
This is a \textbf{tcolorbox}.
\end{tcolorbox}
The text content of the box can be divided in an upper and a lower part by the command
\tcblower. Visually, both parts are separated by a line. For example:
\begin{tcolorbox}
This is another \textbf{tcolorbox}.
\tcblower
Here, you see the lower part of the box.
\end{tcolorbox}
The hoptionsi control the appearance and several functions of the boxes, see Section 4 on
page 18 for the complete list. A quick example is given here:
My nice heading
\tcblower
Used inside tcolorbox to separate the upper box part from the optional lower box part.
The upper and the lower part are treated as separate functional units. If you only want to
draw a line, see \tcblineÕ P. 209 .
12
\tcbset{hoptionsi}
Sets options for every following tcolorboxÕ P. 12 inside the current TEX group. By default,
this does not apply to nested boxes, see Section 4.16 on page 91.
For example, the colors of the boxes may be defined for the whole document by this:
\tcbset{colback=red!5!white,colframe=red!75!black}
\tcbsetforeverylayer{hoptionsi}
Sets options for every following tcolorboxÕ P. 12 inside the current TEX group. In contrast
to \tcbset, this does also apply to nested boxes, see Section 4.16 on page 91. Technically,
the hoptionsi are appended to the default values for every tcolorbox which are applied by
/tcb/resetÕ P. 105 .
You should not use this macro, if you are not completely sure that you want to have the
hoptionsi also for boxes in boxes (in boxes in boxes . . . ).
\tcbset{colback=green!10!white}
\tcbsetforeverylayer{colframe=red!75!black}
\begin{tcolorbox}[reset]
Options given with |\tcbsetforeverylayer| survive a |reset|.
\end{tcolorbox}
This is a tcolorbox.
Nested box
Note that this nested box has a red frame but no green background.
13
\tcbox[hoptionsi]{hbox contenti}
Creates a colored box which is fitted to the width of the given hbox contenti. In principle,
most hoptionsi for a tcolorboxÕ P. 12 can be used for \tcbox with some restrictions. A
\tcbox cannot have a lower part and cannot be broken.
\tcbset{colframe=blue!50!black,colback=white,colupper=red!50!black,
fonttitle=\bfseries,nobeforeafter,center title}
My picture
My table
One Two Three
Men Mice Lions
Upper Middle Lower
Text Hello World
% \usepackage{tikz}
\tcbset{colframe=blue!50!black,colback=white,colupper=red!50!black,
fonttitle=\bfseries,center title}
Hello
World!
HelloWorld!
Hello
World!
14
! See Section 22.2 on page 436 and Section 22.3 on page 439 for more elaborate methods to
create new environments and commands.
\newtcolorbox[hinit optionsi]{hnamei}[hnumberi][hdefaulti]{hoptionsi}
Creates a new environment hnamei based on tcolorboxÕ P. 12 . Basically, \newtcolorbox
operates like \newenvironment. This means, the new environment hnamei optionally takes
hnumberi arguments, where hdefaulti is the default value for the optional first argument.
The hoptionsi are given to the underlying tcolorbox. Note that /tcb/savedelimiterÕ P. 26
is set to the given hnamei automatically. The hinit optionsi allow setting up automatic
numbering, see Section 5 from page 108.
\newtcolorbox{mybox}{colback=red!5!white,
colframe=red!75!black}
This is my own box.
\begin{mybox}
This is my own box.
\end{mybox}
\newtcolorbox{mybox}[1]{colback=red!5!white,
colframe=red!75!black,fonttitle=\bfseries, Hello there
title=#1}
This is my own box with a
\begin{mybox}{Hello there} mandatory title.
This is my own box with a mandatory title.
\end{mybox}
\newtcolorbox{mybox}[2][]{colback=red!5!white,
colframe=red!75!black,fonttitle=\bfseries,
colbacktitle=red!85!black,enhanced,
attach boxed title to top center={yshift=-2mm}, Hello there
title=#2,#1}
This is my own box with a
mandatory title and options.
\begin{mybox}[colback=yellow]{Hello there}
This is my own box with a mandatory title
and options.
\end{mybox}
\renewtcolorbox[hinit optionsi]{hnamei}[hnumberi][hdefaulti]{hoptionsi}
Operates like \newtcolorbox, but based on \renewenvironment instead of
\newenvironment. An existing environment is redefined.
15
\newtcbox[hinit optionsi]{\hnamei}[hnumberi][hdefaulti]{hoptionsi}
Creates a new macro \hnamei based on \tcboxÕ P. 14 . Basically, \newtcbox operates like
\newcommand. The new macro \hnamei optionally takes hnumberi+1 arguments, where
hdefaulti is the default value for the optional first argument. The hoptionsi are given to the
underlying tcbox. The hinit optionsi allow setting up automatic numbering, see Section 5
from page 108.
\newtcbox{\mybox}{colback=red!5!white,
colframe=red!75!black}
This is my own box.
\mybox{This is my own box.}
\newtcbox{\mybox}[1]{colback=red!5!white,
colframe=red!75!black,fonttitle=\bfseries, Hello there
title=#1}
This is my own box.
\mybox{Hello there}{This is my own box.}
\newtcbox{\mybox}[2][]{colback=red!5!white,
colframe=red!75!black,fonttitle=\bfseries, Hello there
title=#2,#1}
This is my own box.
\mybox[colback=yellow]{Hello there}%
{This is my own box.}
\newtcbox{\mybox}[1][red]{on line,
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]{on line,
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}
\renewtcbox[hinit optionsi]{\hnamei}[hnumberi][hdefaulti]{hoptionsi}
Operates like \newtcbox, but based on \renewcommand instead of \newcommand. An existing
macro is redefined.
16
N 2014-10-20 \tcolorboxenvironment{hnamei}{hoptionsi}
An existing environment hnamei is redefined to be boxed inside a tcolorbox with the given
hoptionsi.
% tcbuselibrary{skins}
\newenvironment{myitemize}{%
\begin{itemize}}{\end{itemize}}
\tcolorboxenvironment{myitemize}{blanker,
before skip=6pt,after skip=6pt, Some text.
borderline west={3mm}{0pt}{red}} • Alpha
• Beta
Some text.
• Gamma
\begin{myitemize}
More text.
\item Alpha
\item Beta
\item Gamma
\end{myitemize}
More text.
17
4 Option Keys
For the hoptionsi in tcolorboxÕ P. 12 respectively \tcbsetÕ P. 13 the following pgf keys can be
applied. The key tree path /tcb/ is not to be used inside these macros. It is easy to add your
own style keys using the syntax for pgf keys, see [21, 22] or the examples starting from page 326.
4.1 Title
/tcb/title=htexti (no default, initially empty)
Creates a heading line with htexti as content.
\tcbset{colback=White,arc=0mm,width=(\linewidth-4pt)/4,
equal height group=AT,before=,after=\hfill,fonttitle=\bfseries}
18
N 2014-11-24 /tcb/squeezed title=htexti (style, no default, initially unset)
Creates a single heading line with htexti as content. If the htexti is longer than the available
space, the text is squeezed to fit into the available space.
% \tcbuselibrary{raster}
\begin{tcbitemize}[raster columns=3,raster equal height,
colframe=red!75!black,colback=red!5!white,fonttitle=\bfseries]
\tcbitem[squeezed title={Short title}]
First box
\tcbitem[squeezed title={This is a very very long title}]
Second box
\tcbitem[squeezed title={This title is clearly to long for this application}]
Third box
\end{tcbitemize}
Short title This is a very very long title This title is clearly to long for this application
% \tcbuselibrary{raster}
\begin{tcbitemize}[raster columns=3,raster equal height,
colframe=red!75!black,colback=red!5!white,fonttitle=\bfseries]
\tcbitem[squeezed title*={Short title}]
First box
\tcbitem[squeezed title*={This is a very very long title}]
Second box
\tcbitem[squeezed title*={This title is clearly to long for this application}]
Third box
\end{tcbitemize}
Short title This is a very very long title This title is clearly to long for this application
19
/tcb/detach title (no value)
Detaches the title from its normal position. The text of the title is stored into
\tcbtitletext and the formatted title is available by \tcbtitle. The main application is
to move the title from its usual place to another one.
\newtcolorbox{mybox}[2][]{colbacktitle=red!10!white,
colback=blue!10!white,coltitle=red!70!black,
title={#2},fonttitle=\bfseries,#1}
\begin{mybox}{My title}
This is a \textbf{tcolorbox}.
\end{mybox}
\begin{mybox}[detach title,before upper={\tcbtitle\quad}]{My title}
This is a \textbf{tcolorbox}.
\end{mybox}
\begin{mybox}[detach title,after upper={\par\hfill\tcbtitle}]{My title}
This is a \textbf{tcolorbox}.
\end{mybox}
My title
This is a tcolorbox.
This is a tcolorbox.
My title
! More title options are documented in Section 4.11 on page 64 and Section 10.2 on page 155.
20
4.2 Subtitle
Inside the box content, one or more subtitles can be added. In general, a subtitle is a further
tcolorboxÕ P. 12 which inherits some color and geometry options from the enclosing box. It may
be customized just like any other tcolorboxÕ P. 12 .
N 2014-10-10 \tcbsubtitle[hoptionsi]{htexti}
Used inside a tcolorboxÕ P. 12 to add a subtitle box with the given htexti. This is an inde-
pendent tcolorboxÕ P. 12 which is formatted by several inherited properties of the enclosing
box, by further settings from /tcb/subtitle style, and by the given hoptionsi.
\begin{tcolorbox}[title=My title,
colback=red!5!white, My title
colframe=red!75!black,
fonttitle=\bfseries] This is a tcolorbox.
This is a \textbf{tcolorbox}.
\tcbsubtitle[before skip=\baselineskip]% My subtitle
{My subtitle}
Further text.
Further text.
\end{tcolorbox}
\begin{tcolorbox}[title=My title,
colback=red!5!white,
colframe=red!75!black, My title
colbacktitle=yellow!50!red,
coltitle=red!25!black, This is a tcolorbox.
fonttitle=\bfseries]
This is a \textbf{tcolorbox}. My subtitle
\tcbsubtitle[before skip=\baselineskip]%
Further text.
{My subtitle}
Further text.
\end{tcolorbox}
\begin{tcolorbox}[title=My title,
colback=red!5!white,
colframe=red!75!black,
My title
colbacktitle=yellow!50!red,
coltitle=red!25!black,
This is a tcolorbox.
fonttitle=\bfseries,
subtitle style={boxrule=0.4pt, My subtitle
colback=yellow!50!red!25!white} ] Further text.
This is a \textbf{tcolorbox}.
\tcbsubtitle{My subtitle} Second subtitle
Further text. Further text.
\tcbsubtitle{Second subtitle}
Further text.
\end{tcolorbox}
21
4.3 Upper Part
The text content of a tcolorboxÕ P. 12 may be parted into a mandatory upper part and an op-
tional lower part. These parts are separated by \tcblowerÕ P. 12 . If there is no \tcblowerÕ P. 12
present, there is no lower part and the upper part forms the complete text content.
N 2015-01-06 /tcb/upperbox=hmodei (no default, initially visible)
Controls the treatment of the upper part of the box. If there is no lower part, this is the
complete text content. Feasible values for hmodei are:
• visible: usual type setting of the upper part,
• invisible: empty space instead of the upper part contents.
\begin{tcolorbox}[upperbox=invisible,colback=white]
This is a \textbf{tcolorbox} (but invisible).
\end{tcolorbox}
\bigskip
\begin{tcolorbox}[upperbox=invisible,colback=white]
This is a \textbf{tcolorbox} (but invisible).
\tcblower
This is the lower part.
\end{tcolorbox}
\begin{tcolorbox}[invisible]
This is a \textbf{tcolorbox} (but invisible).
\end{tcolorbox}
22
N 2015-05-04 /tcb/saveto=hfile namei (no default, initially empty)
Saves the content of the box into a file for an optional later usage. This is the counterpart
of /tcb/savelowertoÕ P. 24 , but is saves not only the upper part but the whole content. If
a lower part is present, it is also saved including \tcblowerÕ P. 12 .
\begin{tcolorbox}[invisible,saveto=\jobname_mysave1.tex,colback=white]
This is a \textbf{tcolorbox} which seems to be empty.
The content is saved for later usage.
\end{tcolorbox}
\begin{tcolorbox}[saveto=\jobname_mysave2.tex]
This is a \textbf{tcolorbox}.
\tcblower
This is the lower part.
\end{tcolorbox}
This is a tcolorbox.
23
4.4 Lower Part
/tcb/lowerbox=hmodei (no default, initially visible)
Controls the treatment of the lower part of the box. Feasible values for hmodei are:
• visible: usual type setting of the lower part,
• invisible: empty space instead of the lower part contents,
• ignored: the lower part is not used (here).
The last two values are usually applied in connection with savelowerto.
\begin{tcolorbox}[lowerbox=invisible,colback=white]
This is a \textbf{tcolorbox}.
\tcblower
This is the lower part (but invisible).
\end{tcolorbox}
\begin{tcolorbox}[lowerbox=ignored,colback=white]
This is a \textbf{tcolorbox}.
\tcblower
This is the lower part (but ignored).
\end{tcolorbox}
This is a tcolorbox.
This is a tcolorbox.
\begin{tcolorbox}[lowerbox=invisible,savelowerto=\jobname_bspsave.tex,colback=white]
This is a \textbf{tcolorbox}.
\tcblower
This is the lower part which may be quite complex:
$\displaystyle f(x)=\frac{1+x^2}{1-x^2}$.
\end{tcolorbox}
This is a tcolorbox.
24
/tcb/lower separated=true|false (default true, initially true)
If set to true, the lower part is visually separated from the upper part. It depends on the
chosen skin how the visualization of the separation is done.
% \tcbuselibrary{skins,raster}
\begin{tcbraster}[colback=red!5!white,colframe=red!75!black,
fonttitle=\bfseries,fontlower=\itshape]
%
\begin{tcolorbox}[title=Lower separated]
This is the upper part.
\tcblower
This is the lower part.
\end{tcolorbox}
%
\begin{tcolorbox}[title=Lower not separated,lower separated=false]
This is the upper part.
\tcblower
This is the lower part.
\end{tcolorbox}
%
\begin{tcolorbox}[sidebyside,title=Lower separated]
This is the upper part.
\tcblower
This is the lower part.
\end{tcolorbox}
%
\begin{tcolorbox}[sidebyside,title=Lower not separated,lower separated=false]
This is the upper part.
\tcblower
This is the lower part.
\end{tcolorbox}
%
\begin{tcolorbox}[beamer,title=Lower separated]
This is the upper part.
\tcblower
This is the lower part.
\end{tcolorbox}
%
\begin{tcolorbox}[beamer,title=Lower not separated,lower separated=false]
This is the upper part.
\tcblower
This is the lower part.
\end{tcolorbox}
%
\end{tcbraster}
This is the upper This is the lower This is the upper This is the lower
part. part. part. part.
25
/tcb/savedelimiter=hnamei (no default, initially tcolorbox)
Used in connection with new environment definitions which extend tcolorbox and use
or allow the option savelowerto. To catch the end of the new box environment
hnamei has to be the name of this environment. Additionally, the environment defini-
tion has to use \tcolorbox instead of \begin{tcolorbox} and \endtcolorbox instead of
\end{tcolorbox}.
\newenvironment{mybox}[1]{%
\tcolorbox[savedelimiter=mybox,
savelowerto=\jobname_bspsave2.tex,lowerbox=ignored,
colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries,
title=#1]}%
{\endtcolorbox}
\begin{mybox}{My Example}
Upper part.
\tcblower
Saved lower part!
\end{mybox}
My Example
Upper part.
\newtcolorbox{mybox}[1]{%
savelowerto=\jobname_bspsave2.tex,lowerbox=ignored,
colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries,
title=#1}%
\begin{mybox}{My Example}
Upper part.
\tcblower
Saved lower part!
\end{mybox}
My Example
Upper part.
26
4.5 Colors and Fonts
/tcb/colframe=hcolori (no default, initially black!75!white)
Sets the frame hcolori of the box.
\begin{tcolorbox}[colframe=red!50!white]
This is a \textbf{tcolorbox}. This is a tcolorbox.
\end{tcolorbox}
\begin{tcolorbox}[colback=red!50!white]
This is a \textbf{tcolorbox}. This is a tcolorbox.
\end{tcolorbox}
\begin{tcolorbox}[colbacktitle=red!50!white,
title=My title,coltitle=black, My title
fonttitle=\bfseries]
This is a \textbf{tcolorbox}. This is a tcolorbox.
\end{tcolorbox}
27
/tcb/colupper=hcolori (no default, initially black)
Sets the text hcolori of the upper part.
\begin{tcolorbox}[colupper=red!75!black]
This is a \textbf{tcolorbox}. This is a tcolorbox.
\tcblower
This is the lower part. This is the lower part.
\end{tcolorbox}
\begin{tcolorbox}[collower=red!75!black]
This is a \textbf{tcolorbox}. This is a tcolorbox.
\tcblower
This is the lower part. This is the lower part.
\end{tcolorbox}
\begin{tcolorbox}[coltitle=red!75!black,
Test
colbacktitle=black!10!white,title=Test]
This is a \textbf{tcolorbox}. This is a tcolorbox.
\end{tcolorbox}
28
/tcb/fontupper=htexti (no default, initially empty)
Sets htexti before the content of the upper part (e. g. font settings).
\begin{tcolorbox}[fontupper=Hello!~\sffamily]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
\begin{tcolorbox}[fontlower=\sffamily\bfseries]
This is a \textbf{tcolorbox}.
\tcblower
This is the lower part.
\end{tcolorbox}
This is a tcolorbox.
\begin{tcolorbox}[fonttitle=\sffamily\bfseries\large,title=Hello]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
Hello
This is a tcolorbox.
! More color options are provided by using skins documented in Section 10 from page 148.
29
4.6 Text Alignment
N 2015-05-07 /tcb/halign=halignmenti (no default, initially justify)
If there is no lower part, halign determines the horizontal halignmenti of the text content.
Otherwise, halign determines the horizontal halignmenti of the upper part of the box
only. The feasible values for halignmenti are more or less identical to the corresponding
/tikz/align settings, even if the implementation differs.
• justify: usual left and right justified type setting.
• left: left border justification in analogy to plain TEX.
• flush left: left border justification with \raggedright of LATEX.
• right: right border justification in analogy to plain TEX.
• flush right: right border justification with \raggedleft of LATEX.
• center: centering in analogy to plain TEX.
• flush center: centering with \centering of LATEX.
The differences between the flush and non-flush version are explained in detail in the TikZ
manual [22]. The short story is that the non-flush versions will often look more balanced
but with more hyphenations.
\tcbset{colback=red!5!white,colframe=red!75!black,size=small,
fonttitle=\bfseries,width=3.5cm,box align=top,
nobeforeafter}
\begin{tcolorbox}[adjusted title=center,halign=center]
This is a demonstration text for showing how line breaking works.
\end{tcolorbox}
\begin{tcolorbox}[adjusted title=left,halign=left]
This is a demonstration text for showing how line breaking works.
\end{tcolorbox}
\begin{tcolorbox}[adjusted title=right,halign upper=right]
This is a demonstration text for showing how line breaking works.
\end{tcolorbox}
30
N 2015-05-07 /tcb/halign lower=halignmenti (no default, initially justify)
halign lower determines the horizontal halignmenti of the lower part of the box. The
feasible values for halignmenti are the same as for /tcb/halignÕ P. 30 .
\begin{tcbraster}[raster columns=3,fonttitle=\bfseries,
colback=red!5!white,colframe=red!75!black]
\end{tcbraster}
31
N 2015-05-07 /tcb/halign title=halignmenti (no default, initially justify)
halign lower determines the horizontal halignmenti of the title of the box. The feasible
values for halignmenti are the same as for /tcb/halignÕ P. 30 .
\begin{tcbraster}[raster columns=3,fonttitle=\bfseries,
colback=red!5!white,colframe=red!75!black]
\end{tcbraster}
32
! natural height, see Section 4.10 on page 53.
The vertical alignment settings are only relevant for boxes which are larger than their
\tcbset{width=(\linewidth-2mm)/4,before=,after=\hfill,
colframe=blue!75!black,colback=white,height=2cm}
This is a tcolor-
box. This is a tcolor- This is a tcolor-
box. This is a tcolor-
box. box.
N 2015-05-07 /tcb/valign upper=halignmenti (no default, initially top)
Alias for /tcb/valign.
/tcb/valign lower=halignmenti (no default, initially top)
This key has the same meaning for the lower part as valign for the upper part, i. e., it
determines the vertical halignmenti of the lower part with feasible values top, center,
bottom, scale, and scale*.
N 2015-07-16 /tcb/valign scale limit=hreal numberi (no default, initially 1.1)
Sets an upper scale limit for the scale* setting in /tcb/valign and /tcb/valign lower.
Note that this value is not reset by /tcb/resetÕ P. 105 . So, changes also apply to embedded
boxes.
Also see /tcb/sidebyside alignÕ P. 117 for alignment settings when upper part and lower part
are set side-by-side.
33
4.7 Geometry
4.7.1 Width
/tcb/width=hlengthi (no default, initially \linewidth)
Sets the total width of the colored box to hlengthi. See also /tcb/heightÕ P. 53 .
\tcbset{colback=red!5!white,colframe=red!75!black}
\begin{tcolorbox}[width=\linewidth/2]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
This is a tcolorbox.
\tcbset{colback=red!5!white,colframe=red!75!black}
\begin{tcolorbox}[text width=4cm]
This is a \textbf{tcolorbox} where the text has a width of 4cm.
\end{tcolorbox}
\tcbset{width=4cm,colback=red!5!white,
colframe=red!75!black}
34
4.7.2 Rules
/tcb/toprule=hlengthi (no default, initially 0.5mm)
Sets the line width of the top rule to hlengthi.
\tcbset{colback=red!5!white,colframe=red!75!black}
\begin{tcolorbox}[toprule=3mm]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
This is a tcolorbox.
\tcbset{colback=red!5!white,colframe=red!75!black}
\begin{tcolorbox}[bottomrule=3mm]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
This is a tcolorbox.
\tcbset{colback=red!5!white,colframe=red!75!black}
\begin{tcolorbox}[leftrule=3mm]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
This is a tcolorbox.
\tcbset{colback=red!5!white,colframe=red!75!black}
\begin{tcolorbox}[rightrule=3mm]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
This is a tcolorbox.
35
/tcb/titlerule=hlengthi (no default, initially 0.5mm)
Sets the line width of the rule below the title to hlengthi.
\tcbset{enhanced,colback=red!5!white,colframe=red!75!black,
colbacktitle=red!90!black}
This is a tcolorbox.
\tcbset{colback=red!5!white,colframe=red!75!black}
\begin{tcolorbox}[boxrule=3mm]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
This is a tcolorbox.
! More options for drawing a /tcb/borderlineÕ P. 177 are provided by using skins docu-
mented in Section 10 from page 148.
4.7.3 Arcs
/tcb/arc=hlengthi (no default, initially 1mm)
Sets the inner radius of the four frame arcs to hlengthi.
\tcbset{colback=red!5!white,colframe=red!75!black}
\begin{tcolorbox}[arc=0mm]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
\begin{tcolorbox}[arc=3mm]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
This is a tcolorbox.
This is a tcolorbox.
36
N 2015-05-05 /tcb/circular arc (style, no value)
Sets /tcb/arcÕ P. 36 to match the half of the inner width of the colored box. If width and
height of the box are identical, this gives a circle.
! If the height of the box is smaller than the width, the result will look quite ugly.
\begin{tcolorbox}[width=3cm,
colback=red!5!white,
colframe=red!75!black,
This is a
halign=center,valign=center,
tcolorbox.
square,circular arc]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
! This only works for a fixed /tcb/heightÕ P. 53 . Also, /tcb/bean arc must be used
after width and height are set by option keys.
\tcbset{size=fbox,boxrule=0.5mm,
colback=red!5!white,
colframe=red!75!black,
halign=center,valign=center} Box A
\begin{tcolorbox}[width=3cm,height=2cm,
bean arc]
Box A
\end{tcolorbox}
Box B
\begin{tcolorbox}[width=2cm,height=3cm,
bean arc]
Box B
\end{tcolorbox}
\begin{tcolorbox}[enhanced,
size=minimal,auto outer arc,
width=2.1cm,octogon arc,
colback=red,colframe=white,colupper=white,
fontupper=\fontsize{7mm}{7mm}\selectfont\bfseries\sffamily,
halign=center,valign=center, STOP
square,arc is angular,
borderline={0.2mm}{-1mm}{red} ]
STOP
\end{tcolorbox}
37
N 2015-05-05 /tcb/arc is angular (no value, initially unset)
Using this options applies a patch which straightens the corners arcs of the boxes. The
little arcs are replaced by little straight lines.
! TikZ code. This change may break with future updates of TikZ.
This patch is considered as an experimental feature. It changes some of the original
\tcbset{colback=red!5!white,colframe=red!75!black,
arc=3mm}
\tcbset{colback=red!5!white,colframe=red!75!black}
\begin{tcolorbox}[arc=4mm,outer arc=1mm]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
This is a tcolorbox.
38
4.7.4 Spacing
/tcb/boxsep=hlengthi (no default, initially 1mm)
Sets a common padding of hlengthi between the text content and the frame of the box. This
value is added to the key values of left, right, top, bottom, and middle at the appropriate
places.
\tcbset{colback=red!5!white,colframe=red!75!black,width=(\linewidth-4mm)/2,
before=,after=\hfill}
\begin{tcolorbox}[boxsep=5mm]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
\begin{tcolorbox}[boxsep=5mm,draft]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
frame: w=195.33255pt, h=48.97505pt
\tcbset{colback=red!5!white,colframe=red!75!black}
\begin{tcolorbox}[left=0mm]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
This is a tcolorbox.
\tcbset{colback=red!5!white,colframe=red!75!black}
39
/tcb/lefttitle=hlengthi (no default, initially 4mm)
Sets the left space between title text and frame (additional to boxsep).
\tcbset{colback=red!5!white,colframe=red!75!black}
\begin{tcolorbox}[lefttitle=3cm,title=My Title]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
My Title
This is a tcolorbox.
\tcbset{colback=red!5!white,colframe=red!75!black}
\begin{tcolorbox}[leftupper=3cm,title=My Title]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
My Title
This is a tcolorbox.
\tcbset{colback=red!5!white,colframe=red!75!black}
\begin{tcolorbox}[leftlower=3cm]
This is a \textbf{tcolorbox}.
\tcblower
This is the lower part.
\end{tcolorbox}
This is a tcolorbox.
\tcbset{colback=red!5!white,colframe=red!75!black}
\begin{tcolorbox}[width=5cm,right=2cm]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
This is a tcol-
orbox.
40
N 2017-02-16 /tcb/right*=hlengthi (style, no default)
Sets /tcb/right such that hlengthi is the distance between the right bounding box and the
text parts.
\tcbset{colback=red!5!white,colframe=red!75!black}
\tcbset{colback=red!5!white,colframe=red!75!black}
\tcbset{colback=red!5!white,colframe=red!75!black}
This is a tcol-
orbox with
compressed
upper box
dimensions.
41
/tcb/rightlower=hlengthi (no default, initially 4mm)
Sets the right space between lower text and frame (additional to boxsep).
\tcbset{colback=red!5!white,colframe=red!75!black}
\begin{tcolorbox}[width=5cm,rightlower=2cm]
This is a \textbf{tcolorbox} with standard upper box dimensions.
\tcblower
This is the lower part with large space at right.
\end{tcolorbox}
\tcbset{colback=red!5!white,colframe=red!75!black}
\begin{tcolorbox}[top=0mm]
This is a \textbf{tcolorbox}.
\tcblower
This is the lower part.
\end{tcolorbox}
This is a tcolorbox.
\tcbset{colback=red!5!white,colframe=red!75!black}
\begin{tcolorbox}[toptitle=3mm,title=My title]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
My title
This is a tcolorbox.
42
/tcb/bottom=hlengthi (no default, initially 2mm)
Sets the bottom space between text and frame (additional to boxsep).
\tcbset{colback=red!5!white,colframe=red!75!black}
\begin{tcolorbox}[bottom=0mm]
This is a \textbf{tcolorbox}.
\tcblower
This is the lower part.
\end{tcolorbox}
This is a tcolorbox.
\tcbset{colback=red!5!white,colframe=red!75!black}
\begin{tcolorbox}[bottomtitle=3mm,title=My title]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
My title
This is a tcolorbox.
\tcbset{colback=red!5!white,colframe=red!75!black}
\begin{tcolorbox}[middle=0mm,boxsep=0mm]
This is a \textbf{tcolorbox}.
\tcblower
This is the lower part.
\end{tcolorbox}
This is a tcolorbox.
This is the lower part.
43
4.7.5 Size Shortcuts
/tcb/size=hnamei (no default, initially normal)
Sets all geometry keys with exception of /tcb/widthÕ P. 34 to predefined length values. For
hnamei, the following values are feasible:
• normal: normal sized boxes e.g. of width \linewidth.
• title: title line sized boxes.
• small: small boxes e.g. for keyword highlighting.
• fbox: identical to the standard \fbox.
• tight: no padding space at all.
• minimal: no padding space, no box rules.
\tcbset{colback=red!5!white,colframe=red!75!black}
\foreach \s in {normal,title,small,fbox,tight,minimal} {
\tcbox[size=\s,on line]{\s} }
\foreach \s in {normal,title,small,fbox,tight,minimal} {
\tcbox[size=\s,on line,title=Test]{\s} }
\foreach \s in {normal,title,small,fbox,tight,minimal} {
\begin{tcolorbox}[size=\s,on line,title=Test,width=2.2cm]
\s \tcblower lower\end{tcolorbox} }
Test
Test Test Test
Test Test
normal title small fbox tight minimal
Test
Predefined values
normal title small fbox tight minimal
boxrule 0.5mm 0.4mm 0.3mm 0.4pt 0.4pt 0.0pt
boxsep 1.0mm 1.0mm 1.0mm 3.0pt 0.0pt 0.0pt
left 4.0mm 2.0mm 1.0mm 0.0pt 0.0pt 0.0pt
right 4.0mm 2.0mm 1.0mm 0.0pt 0.0pt 0.0pt
top 2.0mm 0.25mm 0.0mm 0.0pt 0.0pt 0.0pt
bottom 2.0mm 0.25mm 0.0mm 0.0pt 0.0pt 0.0pt
toptitle 0.0mm 0.0mm 0.0mm 0.0pt 0.0pt 0.0pt
bottomtitle 0.0mm 0.0mm 0.0mm 0.0pt 0.0pt 0.0pt
middle 2.0mm 0.75mm 0.5mm 1.0pt 0.2pt 0.0pt
arc 1.0mm 0.75mm 0.5mm 1.0pt 0.0pt 0.0pt
outer arc auto auto auto auto 0.0pt 0.0pt
44
/tcb/oversize=hlengthi (style, default 0pt)
Sets the text width of the upper part to the current line width plus an optional hlengthi.
This is achieved by changing the keys /tcb/widthÕ P. 34 /tcb/enlarge left byÕ P. 83 , and
/tcb/enlarge right byÕ P. 83 appropriately. The resulting box is overlapping into the left
and right margin of the page. Note that this style option has to be given after all other ge-
ometry keys! Also see /tcb/grow sidewards byÕ P. 85 and /tcb/spread sidewardsÕ P. 88 .
\tcbset{colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries}
\begin{tcolorbox}[oversize,title=Oversized box]
\lipsum[2]
\end{tcolorbox}
\begin{tcolorbox}[title=Normal box]
\lipsum[2]
\end{tcolorbox}
Normal box
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem
non justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet,
tortor sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi.
Morbi ac orci et nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque
a nulla. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus
mus. Aliquam tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus
luctus mauris.
45
4.7.6 Toggle Left and Right
U 2017-02-16 /tcb/toggle left and right=htoggle preseti (default evenpage, initially none)
According to the htoggle preseti, the left and the right settings of the tcolorbox are switched
or not. Feasible values are:
• none: no switching.
• forced: the values of the left and right rules, spaces, and corners are switched.
• evenpage: if the page is an even page, the values of the left and right rules, spaces,
and corners are switched. This value also sets /tcb/check odd pageÕ P. 101 to true.
Horizontal bounding box enlargements are not toggled by this option. They
! can be toggled independently by /tcb/toggle enlargementÕ P. 86 . For example,
/tcb/oversizeÕ P. 45 changes the bounding box.
% \usepackage{lipsum}
% \usetikzlibrary{patterns}
% \tcbuselibrary{skins,breakable}
\begin{tcolorbox}[enhanced,breakable,
toggle left and right,sharp corners,
boxrule=0mm,top=0mm,bottom=0mm,left=1mm,right=1mm,
rightrule=1cm,colupper=blue!25!black,
interior style={fill overzoom image=lichtspiel.jpg,fill image opacity=0.25},
frame style={pattern=crosshatch dots light steel blue},
overlay={%
\begin{tcbclipframe}
\tcbifoddpage{\coordinate (X) at ([xshift=-5mm]frame.east);}
{\coordinate (X) at ([xshift=5mm]frame.west);}
\fill[shading=ball,ball color=blue!50!white,opacity=0.5] (X) circle (4mm);
\end{tcbclipframe}}]
\lipsum[1-6]
\end{tcolorbox}
This example switches a 1cm thick rule from the left to the right side depending on the
page number. Thereby, the rule is always on the outer side of the double-sided paper.
Additionally, a ball is drawn on the outer side with help of an overlay.
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum
ut, placerat ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu
libero, nonummy eget, consectetuer id, vulputate a, magna. Donec vehicula augue
eu neque. Pellentesque habitant morbi tristique senectus et netus et malesuada
fames ac turpis egestas. Mauris ut leo. Cras viverra metus rhoncus sem. Nulla et
lectus vestibulum urna fringilla ultrices. Phasellus eu tellus sit amet tortor gravida
placerat. Integer sapien est, iaculis in, pretium quis, viverra ac, nunc. Praesent
eget sem vel leo ultrices bibendum. Aenean faucibus. Morbi dolor nulla, malesuada
eu, pulvinar at, mollis ac, nulla. Curabitur auctor semper nulla. Donec varius orci
eget risus. Duis nibh mi, congue eu, accumsan eleifend, sagittis quis, diam. Duis
eget orci sit amet orci dignissim rutrum.
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor
lorem non justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus.
Donec aliquet, tortor sed accumsan bibendum, erat ligula aliquet magna, vitae
ornare odio metus a mi. Morbi ac orci et nisl hendrerit mollis. Suspendisse ut
massa. Cras nec ante. Pellentesque a nulla. Cum sociis natoque penatibus et
magnis dis parturient montes, nascetur ridiculus mus. Aliquam tincidunt urna.
Nulla ullamcorper vestibulum turpis. Pellentesque cursus luctus mauris.
Nulla malesuada porttitor diam. Donec felis erat, congue non, volutpat at, tin-
cidunt tristique, libero. Vivamus viverra fermentum felis. Donec nonummy pellen-
46
tesque ante. Phasellus adipiscing semper elit. Proin fermentum massa ac quam.
Sed diam turpis, molestie vitae, placerat a, molestie nec, leo. Maecenas lacinia.
Nam ipsum ligula, eleifend at, accumsan nec, suscipit a, ipsum. Morbi blandit
ligula feugiat magna. Nunc eleifend consequat lorem. Sed lacinia nulla vitae enim.
Pellentesque tincidunt purus vel magna. Integer non enim. Praesent euismod nunc
eu purus. Donec bibendum quam in tellus. Nullam cursus pulvinar lectus. Donec
et mi. Nam vulputate metus eu enim. Vestibulum pellentesque felis eu massa.
Quisque ullamcorper placerat ipsum. Cras nibh. Morbi vel justo vitae lacus tin-
cidunt ultrices. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. In hac
habitasse platea dictumst. Integer tempus convallis augue. Etiam facilisis. Nunc
elementum fermentum wisi. Aenean placerat. Ut imperdiet, enim sed gravida sol-
licitudin, felis odio placerat quam, ac pulvinar elit purus eget enim. Nunc vitae
tortor. Proin tempus nibh sit amet nisl. Vivamus quis tortor vitae risus porta
vehicula.
Fusce mauris. Vestibulum luctus nibh at lectus. Sed bibendum, nulla a faucibus
semper, leo velit ultricies tellus, ac venenatis arcu wisi vel nisl. Vestibulum diam.
Aliquam pellentesque, augue quis sagittis posuere, turpis lacus congue quam, in
hendrerit risus eros eget felis. Maecenas eget erat in sapien mattis porttitor.
Vestibulum porttitor. Nulla facilisi. Sed a turpis eu lacus commodo facilisis. Morbi
fringilla, wisi in dignissim interdum, justo lectus sagittis dui, et vehicula libero dui
cursus dui. Mauris tempor ligula sed lacus. Duis cursus enim ut augue. Cras ac
magna. Cras nulla. Nulla egestas. Curabitur a leo. Quisque egestas wisi eget nunc.
Nam feugiat lacus vel est. Curabitur consectetuer.
Suspendisse vel felis. Ut lorem lorem, interdum eu, tincidunt sit amet, laoreet
vitae, arcu. Aenean faucibus pede eu ante. Praesent enim elit, rutrum at, molestie
non, nonummy vel, nisl. Ut lectus eros, malesuada sit amet, fermentum eu, sodales
cursus, magna. Donec eu purus. Quisque vehicula, urna sed ultricies auctor, pede
lorem egestas dui, et convallis elit erat sed nulla. Donec luctus. Curabitur et nunc.
Aliquam dolor odio, commodo pretium, ultricies non, pharetra in, velit. Integer
arcu est, nonummy in, fermentum faucibus, egestas vel, odio.
47
4.8 Corners
The four corners of any tcolorbox can be set individually as /tcb/sharp corners or
as /tcb/rounded cornersÕ P. 49 . These settings are also reflected in the behavior of
/tcb/borderlineÕ P. 177 and /tcb/shadowÕ P. 188 as one would expect.
By default, all four corners are rounded. So, only the /tcb/sharp corners option will be
necessary for most use cases. The /tcb/rounded cornersÕ P. 49 option can be used to revert a
/tcb/sharp corners setting.
/tcb/sharp corners=hpositioni (default all, initially unset)
The hpositioni denotes one or more of the four box corners to be set as sharp corners. The
not assigned corners will retain their mode. Feasible values for hpositioni are:
• northwest
• northeast
• southwest
• southeast
• north
• south
• east
• west
• downhill
• uphill
• all
\begin{tcolorbox}[colback=red!5!white,
colframe=red!75!black,
sharp corners=northwest ] This is a tcolorbox.
This is a \textbf{tcolorbox}.
\end{tcolorbox}
\begin{tcolorbox}[colback=red!5!white,
colframe=red!75!black,
sharp corners ] This is a tcolorbox.
This is a \textbf{tcolorbox}.
\end{tcolorbox}
48
/tcb/rounded corners=hpositioni (default all, initially all)
The /tcb/rounded corners can be used to revert a /tcb/sharp cornersÕ P. 48 setting.
The hpositioni denotes one or more of the four box corners to be set as rounded corners.
The not assigned corners will retain their mode. Feasible values for hpositioni are2 :
• northwest
• northeast
• southwest
• southeast
• north
• south
• east
• west
• downhill
• uphill
• all
\begin{tcolorbox}[colback=red!5!white,
colframe=red!75!black,sharp corners,
rounded corners=northwest ] This is a tcolorbox.
This is a \textbf{tcolorbox}.
\end{tcolorbox}
\begin{tcolorbox}[colback=red!5!white,
colframe=red!75!black,
sharpish corners ] This is a tcolorbox.
This is a \textbf{tcolorbox}.
\end{tcolorbox}
2
The graphical examples assume that the boxes where set to have sharp corners before.
49
The following examples will show the differences between /tcb/rounded cornersÕ P. 49 ,
/tcb/sharpish cornersÕ P. 49 , and /tcb/sharp cornersÕ P. 48 . The later two give the same
core box, but /tcb/borderlineÕ P. 177 and /tcb/shadowÕ P. 188 settings are slightly different.
The following examples use /tcb/drop fuzzy shadowÕ P. 182 .
My title
This is a tcolorbox.
rounded corners
My title
This is a tcolorbox.
sharpish corners
My title
This is a tcolorbox.
sharp corners
50
4.9 Transparency
\begin{tcolorbox}[opacityframe=0.25,
colframe=red]
This is a tcolorbox.
This is a \textbf{tcolorbox}.
\end{tcolorbox}
\begin{tcolorbox}[standard jigsaw,colframe=red,
opacityframe=0.5, opacityback=0.5]
This is a tcolorbox.
This is a \textbf{tcolorbox}.
\end{tcolorbox}
\begin{tcolorbox}[standard jigsaw,colframe=red,
opacityframe=0.5, opacitybacktitle=0.5, This is a title
title filled, title=This is a title]
This is a \textbf{tcolorbox}. This is a tcolorbox.
\end{tcolorbox}
\begin{tcolorbox}[standard jigsaw,colframe=red,
This is a title
opacityfill=0.7, title=This is a title]
This is a \textbf{tcolorbox}. This is a tcolorbox.
\end{tcolorbox}
51
/tcb/opacityupper=hfractioni (no default, initially 1.0)
Sets the text opacity of the upper box part to the given hfractioni.
\begin{tcolorbox}[enhanced,opacityupper=0.5,
interior style={pattern=checkerboard light '
&gray}] This is a tcolorbox.
This is a \textbf{tcolorbox}.
\end{tcolorbox}
\begin{tcolorbox}[enhanced,opacitylower=0.5,
interior style={pattern=checkerboard light '
&gray}] This is a tcolorbox.
This is a \textbf{tcolorbox}.
\tcblower This is the lower part.
This is the lower part.
\end{tcolorbox}
\begin{tcolorbox}[enhanced,opacitytext=0.5,
interior style={pattern=checkerboard light '
&gray}] This is a tcolorbox.
This is a \textbf{tcolorbox}.
\tcblower This is the lower part.
This is the lower part.
\end{tcolorbox}
\begin{tcolorbox}[enhanced,opacitytitle=0.7,
coltitle=black,
fonttitle=\bfseries,title=This is a title, This is a title
title style={pattern=checkerboard light '
&gray}] This is a tcolorbox.
This is a \textbf{tcolorbox}.
\end{tcolorbox}
This is a title
This is a tcolorbox.
52
4.10 Height Control
In a typical usage scenario, the height of a tcolorbox is computed automatically to fit the
content. Nevertheless, the height can be set to a fixed value or to fit commonly for several
boxes, e. g. if boxes are set side by side.
! /tcb/breakable
The height control keys are only applicable to unbreakable boxes. If a box is set to be
Õ P. 365 , the height is always computed according to the natural height.
\tcbset{width=(\linewidth-2mm)/3,before=,after=\hfill,
colframe=blue!75!black,colback=white}
\begin{tcolorbox}[height=1cm,valign=center]
This box has a height of 1cm.
\end{tcolorbox}
\begin{tcolorbox}[height=2cm,valign=center]
This box has a height of 2cm.
\end{tcolorbox}
\begin{tcolorbox}[height=3cm,split=0.5,valign=center,valign lower=center]
This box has a height of 3cm.
\tcblower
Lower part.
\end{tcolorbox}
\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}
This is a tcolorbox.
This is a tcolorbox. This is a tcolorbox. This is a tcolorbox.
This is a tcolorbox.
53
/tcb/height from=hmini to hmaxi (style, no default)
Sets the box height to a dimension between hmini and hmaxi.
% \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}
\tcbset{colback=red!5!white,colframe=red!75!black}
\begin{tcolorbox}[text height=2cm]
This is a \textbf{tcolorbox} where the text area has a height of 2cm.
\end{tcolorbox}
54
N 2014-11-07 /tcb/add to height=hlengthi (style, no default)
Adds hlengthi to the current height of the colored box. /tcb/heightÕ P. 53 has to be set
before this key is used! If this option is used several times, then the /tcb/heightÕ P. 53 is
also increased several times.
\tcbset{height=2cm,
valign=center,width=(\linewidth-2mm)/2,
before=,after=\hfill,colframe=blue!75!black,colback=white}
\begin{tcolorbox}
This box has a height of 2cm.
\end{tcolorbox}
\begin{tcolorbox}[add to height=1cm]
This box has a height of 3cm.
\end{tcolorbox}
\tcbset{valign=center,width=(\linewidth-2mm)/2,
before=,after=\hfill,colframe=blue!75!black,colback=white}
\begin{tcolorbox}
This box has natural height.
\end{tcolorbox}
\begin{tcolorbox}[add to natural height=1cm]
This box has natural height plus 1 cm.
\end{tcolorbox}
55
N 2014-09-22 /tcb/height fill=true|false|maximum (default true, initially false)
If set to true, the height of the tcolorbox is set to the rest of the available vertical space of
U 2016-02-17
the current page. If set to maximum, the page is compressed as much as possible. Note that
the tcolorbox is always set as its own paragraph using this option. Also see /tcb/text
fillÕ P. 67 .
! Note that the library breakable has to be loaded to use this key!
LIB
This height control key is only applicable to unbreakable boxes, but it uses code from
the library breakable . The counterpart for breakable boxes is /tcb/height fixed
LIB
for Õ P. 370 .
This option can and should not be used for boxes in boxes, but it can be used for boxes
inside a tcbrasterÕ P. 279 .
% \usepackage{lipsum}
% \tcbuselibrary{breakable}
\begin{tcolorbox}[height fill,
colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries,
title=Box which fills the rest of the page]
\lipsum[1]
\end{tcolorbox}
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut,
placerat ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero,
nonummy eget, consectetuer id, vulputate a, magna. Donec vehicula augue eu neque.
Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis
egestas. Mauris ut leo. Cras viverra metus rhoncus sem. Nulla et lectus vestibulum urna
fringilla ultrices. Phasellus eu tellus sit amet tortor gravida placerat. Integer sapien est,
iaculis in, pretium quis, viverra ac, nunc. Praesent eget sem vel leo ultrices bibendum.
Aenean faucibus. Morbi dolor nulla, malesuada eu, pulvinar at, mollis ac, nulla. Curabitur
auctor semper nulla. Donec varius orci eget risus. Duis nibh mi, congue eu, accumsan
eleifend, sagittis quis, diam. Duis eget orci sit amet orci dignissim rutrum.
56
N 2017-06-28 /tcb/inherit height=fraction (default 1, initially unset)
If this option is used for a tcolorbox which is embedded inside another (outer) tcolorbox
and if this outer tcolorbox has a fixed height, then the given hfractioni of the available
text height of the outer tcolorbox is used as /tcb/heightÕ P. 53 for the current tcolorbox.
Otherwise, /tcb/natural heightÕ P. 53 is applied for the current tcolorbox.
\tcbset{colframe=blue!75!black,colback=white,fonttitle=\bfseries}
Inner box
Inner box
Inner box
57
N 2015-05-05 /tcb/square (style, no value)
Sets /tcb/heightÕ P. 53 to match the width of the colored box.
\begin{tcolorbox}[width=3cm,
colback=red!5!white,
colframe=red!75!black,
This is a
halign=center,valign=center,
tcolorbox.
square]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
\tcbset{width=(\linewidth-2mm)/3,before=,after=\hfill,
colframe=blue!75!black,colback=white,height=3cm}
\foreach \f in {0.2,0.4,0.7}
{\begin{tcolorbox}[space=\f]
This is the upper part.
\tcblower
This is the lower part.
\end{tcolorbox}}
This is the upper part. This is the upper part. This is the upper part.
58
/tcb/space to both (style)
This is an abbreviation for space=0.5, i. e. the extra space equally distributed between the
upper and the lower part.
\tcbset{width=(\linewidth-2mm)/3,before=,after=\hfill,
colframe=blue!75!black,colback=white,height=3cm}
This is the upper part. This is the upper part. This is the upper part.
• The actual length saved into hmacroi is adapted dynamically during several
compilations – at least two, but maybe more.
• Due to the adaption algorithm, objects can be sized with hmacroi plus any offset
! length.
• Never ever use hmacroi multiplied with a factor. The only exception to this rule
is that the space can be split into parts which sum to hmacroi.
• Never use this in combination with /tcb/fitÕ P. 413 .
\begin{tcolorbox}[colframe=blue!75!black,colback=white,height=3cm,
space to=\myspace]
This is my box of height 3cm. The space is filled with a picture:\\[2mm]
\includegraphics[width=\linewidth,height=\myspace]{goldshade.png}\\[1mm]
This is some other text.
\end{tcolorbox}
59
\begin{tcolorbox}[colframe=blue!75!black,colback=white,height=3cm,
space to=\myspace]
\includegraphics[width=\linewidth,
height=0.33\dimexpr\myspace]{blueshade.png}\\[1mm]
This is my box of height 3cm.\\[2mm]
\includegraphics[width=\linewidth,
height=0.67\dimexpr\myspace]{goldshade.png}
\end{tcolorbox}
\tcbset{width=(\linewidth-2mm)/3,before=,after=\hfill,height=3cm,
colback=white,colframe=blue!75!black,valign=center,valign lower=center}
\foreach \f in {0.1,0.5,0.8}
{\begin{tcolorbox}[split=\f]
This is the upper part.
\tcblower
This is the lower part with a lot of text in several lines.
\end{tcolorbox}}
This is the upper part. This is the upper part. This is the upper part.
This is the lower part This is the lower part This is the lower part
with a lot of text in sev- with a lot of text in sev- with a lot of text in sev-
eral lines. eral lines. eral lines.
60
U 2014-11-07 /tcb/equal height group=hidi (no default)
Boxes which are members of an equal height group will all get the same height, i. e.
the maximum of all their natural heights. The hidi serves to distinguish between different
height groups. Note that you have to compile twice to see changes and that height groups
are global definitions.
\tcbset{width=(\linewidth-2mm)/3,before=,after=\hfill,arc=0mm,
colframe=blue!75!black,colback=white,fonttitle=\bfseries}
My smallest box. This box is also small. This box contains a lot
of text just to fill the
But with a lower part. space with word flowing
and flowing and flowing
until the box is filled with
all of it.
61
/tcb/minimum for equal height group=hidi:hlengthi (no default, initially unset)
Plants a hlengthi into the equal height group with the given hidi. This ensures that the
height will not drop below hlengthi. Note that you cannot reduce a computed height value
by using this key with a small value. The difference to applying /tcb/heightÕ P. 53 directly
is that the boxes are never too small for their content.
\tcbset{colframe=blue!75!black,colback=white,arc=0mm,
before=,after=\hfill,fonttitle=\bfseries,left=2mm,right=2mm,
width=3.5cm,
equal height group=C,
minimum for equal height group=C:3.5cm}
\begin{tcolorbox}
My first box. All boxes will get 3.5cm times 3.5cm
if the content height is not too large.
\end{tcolorbox}%
\begin{tcolorbox}
My second box.
\tcblower
This is the lower part.
\end{tcolorbox}%
\begin{tcblisting}{}
\textbf{Mixed}
with a listing.
\end{tcblisting}
\begin{tcolorbox}[title={Fourth box}]
My final box.
\end{tcolorbox}%
Fourth box
My first box. All My second box. \textbf{Mixed}
boxes will get 3.5cm with a listing. My final box.
times 3.5cm if the This is the lower
content height is part.
not too large. Mixed with a list-
ing.
N 2016-03-24 /tcb/minimum for current equal height group=hlengthi (no default, initially unset)
Sets /tcb/minimum for equal height group for the current equal height group. Appar-
ently, this only works for an already known equal height group, i.e. /tcb/equal height
groupÕ P. 61 has to be set before this option is used. This option is likely to be used in
combination with /tcb/raster equal heightÕ P. 287
% \tcbuselibrary{raster}
\begin{tcbitemize}[raster equal height,colframe=blue!75!black,colback=white,
raster every box/.style={minimum for current equal height group=2cm}]
\tcbitem A
\tcbitem B
\end{tcbitemize}
A B
62
N 2015-11-27 /tcb/use height from group=hidi (style, default current group)
Sets the current box to a fixed /tcb/heightÕ P. 53 which is copied from an equal height
U 2016-02-22
group with the given hidi. If this height is not available during the current compilation, no
fixed height setting is used. If hidi is omitted, the current equal height group is used which
has to be set before by /tcb/equal height groupÕ P. 61 .
Note that the natural height of the current box is not considered for computation of the
group height. The main application for /tcb/use height from group is that the height
can be adapted further by /tcb/add to heightÕ P. 55 .
Height from group ’C’ of the previous example, but reduced by 2cm.
% \tcbuselibrary{raster}
Every line is inside an equal height group:
\begin{tcbraster}[raster equal height=rows,
title=Box \thetcbrasternum,
enhanced,size=small,colframe=red!50!black,colback=red!10!white]
\begin{tcolorbox}First line\\second line\\
The height of this box rules.\end{tcolorbox}
\begin{tcolorbox}[use height from group]Test\end{tcolorbox}
\begin{tcolorbox}[use height from group]
First line\\second line\end{tcolorbox}
\begin{tcolorbox}The height of this box rules.\end{tcolorbox}
\end{tcbraster}
Box 3 Box 4
First line The height of this box rules.
second line
N 2015-11-27 \tcbheightfromgroup{hmacroi}{hidi}
Saves the height from an equal height group with the given hidi to a hmacroi. If this height
is not available during the current compilation, hmacroi is set to 0pt.
63
4.11 Box Content Additions
The following options introduce some arbitrary hcodei to the content of a tcolorbox. These
additions can be given at the beginning or at the ending of the title, the upper part, or the lower
part.
/tcb/before title=hcodei (no default, initially unset)
The given hcodei is placed after the color and font settings and before the content of the
title.
\tcbset{before title={\textcolor{yellow}{\large Important:}~},
colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries}
\begin{tcolorbox}[title=My title]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
Important: My title
This is a tcolorbox.
\tcbset{after title={\hfill\colorbox{Navy}{approved}},
colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries}
\begin{tcolorbox}[title=My title]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
My title approved
This is a tcolorbox.
64
/tcb/before upper=hcodei (no default, initially unset)
The given hcodei is placed after the color and font settings and before the content of the
upper part.
\begin{tcolorbox}[title=My title]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
My title
The story:
This is a tcolorbox.
\begin{tcolorbox}[title=My title]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
My title
This is a tcolorbox.
Read more next week
«This is a tcolorbox.»
An \unskip is placed in front of the given hcodei. From version 3.80 to 3.94, this
! \unskip was omitted to avoid certain problems which (hopefully) should not occur
with the new improved code.
65
/tcb/before lower=hcodei (no default, initially unset)
The given hcodei is placed after the color and font settings and before the content of the
lower part.
\tcbset{before lower=\textit{Behold:~},colback=red!5!white,colframe=red!75!black}
\begin{tcolorbox}
This is a \textbf{tcolorbox}.
\tcblower
This is the lower part.
\end{tcolorbox}
This is a tcolorbox.
This is a tcolorbox.
This is a tcolorbox.
An \unskip is placed in front of the given hcodei. From version 3.80 to 3.94, this
! \unskip was omitted to avoid certain problems which (hopefully) should not occur
with the new improved code.
66
! If /tcb/text fill is used, one cannot have a lower part and the box is unbreakable.
N 2015-07-15 /tcb/text fill (style, no value)
This style sets /tcb/before upperÕ P. 65 and /tcb/after upperÕ P. 65 to embed the up-
per part with a minipage. If a fixed height was applied e.g. by /tcb/heightÕ P. 53 or
/tcb/height fillÕ P. 56 , this minipage gets a matching height. This allows to use verti-
cal glue macros like \vfill to act like expected. If the box has no fixed height, setting
/tcb/text fill has no other effect as making the box unbreakable.
\begin{tcolorbox}[colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries,
height=8cm,text fill,
title=My filled box]
This is a \textbf{tcolorbox}.
\par\vfill
\begin{center}
My middle text.
\end{center}
\par\vfill
This is the end of my box.
\end{tcolorbox}
My filled box
This is a tcolorbox.
My middle text.
67
! If /tcb/tabularx or /tcb/tabularx* are used, one cannot have a lower part.
/tcb/tabularx=hpreamblei (style)
This style sets /tcb/before upper Õ P. 65 and /tcb/after upper Õ P. 65 and several geom-
etry keys to support a tabularx with the given hpreamblei. The packages tabularx [4],
array, and colortbl have to be loaded separately.
% \usepackage{array,tabularx}
% \usepackage{colortbl} - or - \usepackage[table]{xcolor}
\newcolumntype{Y}{>{\raggedleft\arraybackslash}X}% see tabularx
\tcbset{enhanced,fonttitle=\bfseries\large,fontupper=\normalsize\sffamily,
colback=yellow!10!white,colframe=red!50!black,colbacktitle=Salmon!30!white,
coltitle=black,center title}
\begin{tcolorbox}[tabularx={X||Y|Y|Y|Y||Y},title=My table]
Group & One & Two & Three & Four & Sum\\\hline\hline
Red & 1000.00 & 2000.00 & 3000.00 & 4000.00 & 10000.00\\\hline
Green & 2000.00 & 3000.00 & 4000.00 & 5000.00 & 14000.00\\\hline
Blue & 3000.00 & 4000.00 & 5000.00 & 6000.00 & 18000.00\\\hline\hline
Sum & 6000.00 & 9000.00 & 12000.00 & 15000.00 & 42000.00
\end{tcolorbox}
My table
Group One Two Three Four Sum
Red 1000.00 2000.00 3000.00 4000.00 10000.00
Green 2000.00 3000.00 4000.00 5000.00 14000.00
Blue 3000.00 4000.00 5000.00 6000.00 18000.00
Sum 6000.00 9000.00 12000.00 15000.00 42000.00
/tcb/tabularx*={hcodei}{hpreamblei} (style)
This is a variant of /tcb/tabularx which adds some hcodei before the table starts.
% \usepackage{array,tabularx}
% \usepackage{colortbl} - or - \usepackage[table]{xcolor}
\tcbset{enhanced,fonttitle=\bfseries\large,fontupper=\normalsize\sffamily,
colback=yellow!10!white,colframe=red!50!black,colbacktitle=Salmon!30!white,
coltitle=black,center title}
\begin{tcolorbox}[tabularx*={\arrayrulewidth0.5mm}{X|X|X},title=My table]
One & Two & Three \\\hline\hline
1000.00 & 2000.00 & 3000.00\\\hline
2000.00 & 3000.00 & 4000.00
\end{tcolorbox}
My table
One Two Three
1000.00 2000.00 3000.00
2000.00 3000.00 4000.00
68
/tcb/tikz upper=hoptionsi (style)
This style adds a centered tikzpicture environment to the start and end of the upper
part. The hoptionsi may be given as TikZ picture options.
% \usepackage{tikz}
\begin{tcolorbox}[tikz upper,fonttitle=\bfseries,colback=white,colframe=black,
title=\tikzname\ drawing]
\path[fill=yellow,draw=yellow!75!red] (0,0) circle (1cm);
\fill[red] (45:5mm) circle (1mm);
\fill[red] (135:5mm) circle (1mm);
\draw[line width=1mm,red] (215:5mm) arc (215:325:5mm);
\end{tcolorbox}
TikZ drawing
% \usepackage{tikz}
% \tcbuselibrary{skins,listings}
\tcbset{tikz lower,listing side text,fonttitle=\bfseries,
bicolor,colback=LightBlue!50!white,colbacklower=white,colframe=black,
righthand width=3cm}
\begin{tcblisting}{title=\tikzname\ drawing}
\path[fill=yellow,draw=yellow!75!red]
(0,0) circle (1cm);
\fill[red] (45:5mm) circle (1mm);
\fill[red] (135:5mm) circle (1mm);
\draw[line width=1mm,red]
(215:5mm) arc (215:325:5mm);
\end{tcblisting}
TikZ drawing
\path[fill=yellow,draw=yellow!75!red]
(0,0) circle (1cm);
\fill[red] (45:5mm) circle (1mm);
\fill[red] (135:5mm) circle (1mm);
\draw[line width=1mm,red]
(215:5mm) arc (215:325:5mm);
69
/tcb/tikznode upper=hoptionsi (style)
This style places the upper part content into a centered TikZ node. The hoptionsi may be
given as TikZ node options. This style is especially useful for boxes with multiline texts
which are fitted to the text width.
% \usepackage{tikz}
\newtcbox{\headline}[1][]{enhanced,center,
ignore nobreak,fontupper=\Large\bfseries,
colframe=red!50!black,colback=red!10!white,
drop fuzzy shadow=yellow,tikznode upper,#1}
\headline{Important\\Headline}
Important
Headline
% \usepackage{tikz}
\begin{tcolorbox}[bicolor,colback=LightBlue!50!white,colbacklower=white,
colframe=black,tikznode lower={inner sep=2pt,draw=red,fill=yellow}]
Upper part.
\tcblower
Lower part.
\end{tcolorbox}
Upper part.
Lower part.
/tcb/tikznode=hoptionsi (style)
Shortcut for setting /tcb/tikznode upper and /tcb/tikznode lower the same time.
/tcb/varwidth upper=hlengthi (style, default /tcb/widthÕ P. 34 )
This style places the upper part content into a varwidth environment. This style needs
the varwidth package [1] to be loaded manually. The resulting box has a maximal width
of hlengthi. This option is only senseful for a \tcboxÕ P. 14 .
% \usepackage{varwidth}
\newtcbox{\varbox}{colframe=red!50!black, Short text.
colback=red!10!white,varwidth upper}
70
4.12 Overlays
With an overlay, arbitrary hgraphical codei can be added to a tcolorbox. This code is executed
after the frame and interior are drawn and before the text content is drawn. Therefore, you
can decorate the tcolorbox with your own extensions. Common special cases are watermarks
which are implemented using overlays. See Subsection 10.3 from page 165 if you want to add
watermarks.
If you use the core package only, the hgraphical codei has to be pgf code and there is
! not much assistance for positioning. Therefore, the usage of the /tcb/enhancedÕ P. 206
mode from the library skins is recommended which allows tikz code and gives access to
/tcb/geometry nodesÕ P. 137 for positioning.
% \tcbuselibrary{skins} % preamble
\tcbset{frogbox/.style={enhanced,colback=green!10,colframe=green!65!black,
enlarge top by=5.5mm,
overlay={\foreach \x in {2cm,3.5cm} {
\begin{scope}[shift={([xshift=\x]frame.north west)}]
\path[draw=green!65!black,fill=green!10,line width=1mm] (0,0) arc (0:180:5mm);
\path[fill=black] (-0.2,0) arc (0:180:1mm);
\end{scope}}}}}
\begin{tcolorbox}[frogbox,title=My title]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
My title
This is a tcolorbox.
% \usetikzlibrary{patterns} % preamble
% \tcbuselibrary{skins} % preamble
\tcbset{ribbonbox/.style={enhanced,colback=red!5!white,colframe=red!75!black,
fonttitle=\bfseries,
overlay={\path[fill=blue!75!white,draw=blue,double=white!85!blue,
preaction={opacity=0.6,fill=blue!75!white},
line width=0.1mm,double distance=0.2mm,
pattern=fivepointed stars,pattern color=white!75!blue]
([xshift=-0.2mm,yshift=-1.02cm]frame.north east)
-- ++(-1,1) -- ++(-0.5,0) -- ++(1.5,-1.5) -- cycle;}}}
\begin{tcolorbox}[ribbonbox,title=My title]
This is a \textbf{tcolorbox}.
\tcblower
This is the lower part.
\end{tcolorbox}
My title
This is a tcolorbox.
71
/tcb/no overlay (style, no default, initially set)
Removes the overlay if set before.
/tcb/overlay broken=hgraphical codei (no default, initially unset)
If the box is set to be /tcb/breakable Õ P. 365 and is broken actually, then the hgraphical
codei is added to the box drawing process. /tcb/overlayÕ P. 71 overwrites this key.
/tcb/overlay unbroken=hgraphical codei (no default, initially unset)
If the box is set to be /tcb/breakable Õ P. 365 but is not broken actually or if the box is
set to be /tcb/unbreakableÕ P. 366 , then the hgraphical codei is added to the box drawing
process. /tcb/overlayÕ P. 71 overwrites this key.
/tcb/overlay first=hgraphical codei (no default, initially unset)
If the box is set to be /tcb/breakable Õ P. 365 and is broken actually, then the hgraphical
codei is added to the box drawing process for the first part of the break sequence.
/tcb/overlayÕ P. 71 overwrites this key.
/tcb/overlay middle=hgraphical codei (no default, initially unset)
If the box is set to be /tcb/breakableÕ P. 365 and is broken actually, then the hgraphical
codei is added to the box drawing process for the middle parts (if any) of the break sequence.
/tcb/overlayÕ P. 71 overwrites this key.
/tcb/overlay last=hgraphical codei (no default, initially unset)
If the box is set to be /tcb/breakableÕ P. 365 and is broken actually, then the hgraphical
codei is added to the box drawing process for the last part of the break sequence.
/tcb/overlayÕ P. 71 overwrites this key.
/tcb/overlay unbroken and first=hgraphical codei (no default, initially unset)
This is an optimized abbreviation for setting /tcb/overlay unbroken and /tcb/overlay
first together. /tcb/overlayÕ P. 71 overwrites this key.
/tcb/overlay middle and last=hgraphical codei (no default, initially unset)
This is an optimized abbreviation for setting /tcb/overlay middle and /tcb/overlay
last together. /tcb/overlayÕ P. 71 overwrites this key.
/tcb/overlay unbroken and last=hgraphical codei (no default, initially unset)
This is an optimized abbreviation for setting /tcb/overlay unbroken and /tcb/overlay
last together. /tcb/overlayÕ P. 71 overwrites this key.
N 2014-09-19 /tcb/overlay first and middle=hgraphical codei (no default, initially unset)
This is an optimized abbreviation for setting /tcb/overlay first and /tcb/overlay
middle together. /tcb/overlayÕ P. 71 overwrites this key.
This example demonstrates the application of break sequence specific overlay options.
Here, we define an environment myexample based on tcolorbox where the visible drawing
is done totally by overlay keys.
Here, the first application of myexample produces an unbroken tcolorbox. The frame is
drawn by the code given with /tcb/overlay unbroken.
The second application of myexample is broken into several parts which are drawn by
the codes given with /tcb/overlay first, /tcb/overlay middle, and /tcb/overlay
last.
% Preamble:
%\usepackage{tikz,lipsum}
%\tcbuselibrary{skins,breakable}
%\newcounter{example}
\colorlet{colexam}{red!75!black}
\newtcolorbox[use counter=example]{myexample}{%
72
empty,title={Example \thetcbcounter},attach boxed title to top left,
boxed title style={empty,size=minimal,toprule=2pt,top=4pt,
overlay={\draw[colexam,line width=2pt]
([yshift=-1pt]frame.north west)--([yshift=-1pt]frame.north east);}},
coltitle=colexam,fonttitle=\Large\bfseries,
before=\par\medskip\noindent,parbox=false,boxsep=0pt,left=0pt,right=3mm,top=4pt,
breakable,pad at break*=0mm,vfill before first,
overlay unbroken={\draw[colexam,line width=1pt]
([yshift=-1pt]title.north east)--([xshift=-0.5pt,yshift=-1pt]title.north-|frame.east)
--([xshift=-0.5pt]frame.south east)--(frame.south west); },
overlay first={\draw[colexam,line width=1pt]
([yshift=-1pt]title.north east)--([xshift=-0.5pt,yshift=-1pt]title.north-|frame.east)
--([xshift=-0.5pt]frame.south east); },
overlay middle={\draw[colexam,line width=1pt] ([xshift=-0.5pt]frame.north east)
--([xshift=-0.5pt]frame.south east); },
overlay last={\draw[colexam,line width=1pt] ([xshift=-0.5pt]frame.north east)
--([xshift=-0.5pt]frame.south east)--(frame.south west);},%
}
\begin{myexample}
\lipsum[1]
\end{myexample}
\begin{myexample}
\lipsum[2-11]
\end{myexample}
Example 1
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, placerat
ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero, nonummy eget,
consectetuer id, vulputate a, magna. Donec vehicula augue eu neque. Pellentesque habitant
morbi tristique senectus et netus et malesuada fames ac turpis egestas. Mauris ut leo. Cras
viverra metus rhoncus sem. Nulla et lectus vestibulum urna fringilla ultrices. Phasellus eu
tellus sit amet tortor gravida placerat. Integer sapien est, iaculis in, pretium quis, viverra
ac, nunc. Praesent eget sem vel leo ultrices bibendum. Aenean faucibus. Morbi dolor nulla,
malesuada eu, pulvinar at, mollis ac, nulla. Curabitur auctor semper nulla. Donec varius orci
eget risus. Duis nibh mi, congue eu, accumsan eleifend, sagittis quis, diam. Duis eget orci sit
amet orci dignissim rutrum.
Example 2
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem non
justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet, tortor
sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi. Morbi ac
orci et nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque a nulla. Cum
sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam
tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus luctus mauris.
Nulla malesuada porttitor diam. Donec felis erat, congue non, volutpat at, tincidunt tristique,
libero. Vivamus viverra fermentum felis. Donec nonummy pellentesque ante. Phasellus
adipiscing semper elit. Proin fermentum massa ac quam. Sed diam turpis, molestie vitae,
placerat a, molestie nec, leo. Maecenas lacinia. Nam ipsum ligula, eleifend at, accumsan nec,
suscipit a, ipsum. Morbi blandit ligula feugiat magna. Nunc eleifend consequat lorem. Sed
lacinia nulla vitae enim. Pellentesque tincidunt purus vel magna. Integer non enim. Praesent
73
euismod nunc eu purus. Donec bibendum quam in tellus. Nullam cursus pulvinar lectus.
Donec et mi. Nam vulputate metus eu enim. Vestibulum pellentesque felis eu massa.
Quisque ullamcorper placerat ipsum. Cras nibh. Morbi vel justo vitae lacus tincidunt ultrices.
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. In hac habitasse platea dictumst.
Integer tempus convallis augue. Etiam facilisis. Nunc elementum fermentum wisi. Aenean
placerat. Ut imperdiet, enim sed gravida sollicitudin, felis odio placerat quam, ac pulvinar
elit purus eget enim. Nunc vitae tortor. Proin tempus nibh sit amet nisl. Vivamus quis tortor
vitae risus porta vehicula.
Fusce mauris. Vestibulum luctus nibh at lectus. Sed bibendum, nulla a faucibus semper, leo
velit ultricies tellus, ac venenatis arcu wisi vel nisl. Vestibulum diam. Aliquam pellentesque,
augue quis sagittis posuere, turpis lacus congue quam, in hendrerit risus eros eget felis. Mae-
cenas eget erat in sapien mattis porttitor. Vestibulum porttitor. Nulla facilisi. Sed a turpis
eu lacus commodo facilisis. Morbi fringilla, wisi in dignissim interdum, justo lectus sagittis
dui, et vehicula libero dui cursus dui. Mauris tempor ligula sed lacus. Duis cursus enim ut
augue. Cras ac magna. Cras nulla. Nulla egestas. Curabitur a leo. Quisque egestas wisi eget
nunc. Nam feugiat lacus vel est. Curabitur consectetuer.
Suspendisse vel felis. Ut lorem lorem, interdum eu, tincidunt sit amet, laoreet vitae, arcu.
Aenean faucibus pede eu ante. Praesent enim elit, rutrum at, molestie non, nonummy vel,
nisl. Ut lectus eros, malesuada sit amet, fermentum eu, sodales cursus, magna. Donec eu
purus. Quisque vehicula, urna sed ultricies auctor, pede lorem egestas dui, et convallis elit
erat sed nulla. Donec luctus. Curabitur et nunc. Aliquam dolor odio, commodo pretium,
ultricies non, pharetra in, velit. Integer arcu est, nonummy in, fermentum faucibus, egestas
vel, odio.
Sed commodo posuere pede. Mauris ut est. Ut quis purus. Sed ac odio. Sed vehicula
hendrerit sem. Duis non odio. Morbi ut dui. Sed accumsan risus eget odio. In hac habitasse
platea dictumst. Pellentesque non elit. Fusce sed justo eu urna porta tincidunt. Mauris felis
odio, sollicitudin sed, volutpat a, ornare ac, erat. Morbi quis dolor. Donec pellentesque, erat
ac sagittis semper, nunc dui lobortis purus, quis congue purus metus ultricies tellus. Proin
et quam. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos
hymenaeos. Praesent sapien turpis, fermentum vel, eleifend faucibus, vehicula eu, lacus.
Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.
Donec odio elit, dictum in, hendrerit sit amet, egestas sed, leo. Praesent feugiat sapien aliquet
odio. Integer vitae justo. Aliquam vestibulum fringilla lorem. Sed neque lectus, consectetuer
at, consectetuer sed, eleifend ac, lectus. Nulla facilisi. Pellentesque eget lectus. Proin eu
metus. Sed porttitor. In hac habitasse platea dictumst. Suspendisse eu lectus. Ut mi
mi, lacinia sit amet, placerat et, mollis vitae, dui. Sed ante tellus, tristique ut, iaculis eu,
malesuada ac, dui. Mauris nibh leo, facilisis non, adipiscing quis, ultrices a, dui.
Morbi luctus, wisi viverra faucibus pretium, nibh est placerat odio, nec commodo wisi enim
eget quam. Quisque libero justo, consectetuer a, feugiat vitae, porttitor eu, libero. Sus-
pendisse sed mauris vitae elit sollicitudin malesuada. Maecenas ultricies eros sit amet ante.
Ut venenatis velit. Maecenas sed mi eget dui varius euismod. Phasellus aliquet volutpat odio.
Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Pel-
lentesque sit amet pede ac sem eleifend consectetuer. Nullam elementum, urna vel imperdiet
sodales, elit ipsum pharetra ligula, ac pretium ante justo a nulla. Curabitur tristique arcu eu
metus. Vestibulum lectus. Proin mauris. Proin eu nunc eu urna hendrerit faucibus. Aliquam
auctor, pede consequat laoreet varius, eros tellus scelerisque quam, pellentesque hendrerit
ipsum dolor sed augue. Nulla nec lacus.
Suspendisse vitae elit. Aliquam arcu neque, ornare in, ullamcorper quis, commodo eu, libero.
Fusce sagittis erat at erat tristique mollis. Maecenas sapien libero, molestie et, lobortis in,
74
sodales eget, dui. Morbi ultrices rutrum lorem. Nam elementum ullamcorper leo. Morbi
dui. Aliquam sagittis. Nunc placerat. Pellentesque tristique sodales est. Maecenas imperdiet
lacinia velit. Cras non urna. Morbi eros pede, suscipit ac, varius vel, egestas non, eros.
Praesent malesuada, diam id pretium elementum, eros sem dictum tortor, vel consectetuer
odio sem sed wisi.
Sed feugiat. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus
mus. Ut pellentesque augue sed urna. Vestibulum diam eros, fringilla et, consectetuer eu,
nonummy id, sapien. Nullam at lectus. In sagittis ultrices mauris. Curabitur malesuada erat
sit amet massa. Fusce blandit. Aliquam erat volutpat. Aliquam euismod. Aenean vel lectus.
Nunc imperdiet justo nec dolor.
Etiam euismod. Fusce facilisis lacinia dui. Suspendisse potenti. In mi erat, cursus id, nonummy
sed, ullamcorper eget, sapien. Praesent pretium, magna in eleifend egestas, pede pede pretium
lorem, quis consectetuer tortor sapien facilisis magna. Mauris quis magna varius nulla scelerisque
imperdiet. Aliquam non quam. Aliquam porttitor quam a lacus. Praesent vel arcu ut tortor
cursus volutpat. In vitae pede quis diam bibendum placerat. Fusce elementum convallis neque.
Sed dolor orci, scelerisque ac, dapibus nec, ultricies ut, mi. Duis nec dui quis leo sagittis
commodo.
75
Floating box from floatplacement
I am floating
This floating box is placed at the top of a page.
\tcbset{enhanced,colback=red!5!white,colframe=red!75!black,
watermark color=red!15!white}
\begin{tcolorbox}[floatplacement=t,float,
title=Floating box from |floatplacement|,
watermark text={I am floating}]
This floating box is placed at the top of a page.
\end{tcolorbox}
76
N 2014-09-19 /tcb/every float=hcodei (no default, initially empty)
For floating objects, the /tcb/beforeÕ P. 78 and /tcb/afterÕ P. 78 settings are ignored. In-
stead, the given hcodei is inserted before a floating box. If the box is /tcb/breakableÕ P. 365 ,
the given hcodei is inserted before every part of the break sequence. The most common use
case is every float=\centering.
Floating box
77
4.14 Embedding into the Surroundings
Typically, but not necessarily, a tcolorbox is put inside a separate paragraph and has some
vertical space before and after it. This behavior is controlled by the keys before and after.
/tcb/before=hcodei (no default, initially see /tcb/autoparskip)
Sets the hcodei which is executed before the colored box. It is not used for floating
boxes. Also, it is not used, if the box follows a heading immediately and /tcb/ignore
nobreakÕ P. 81 is set to false.
/tcb/after=hcodei (no default, initially see /tcb/autoparskip)
Sets the hcodei which is executed after the colored box. It is not used for floating boxes.
U 2017-02-01 /tcb/parskip (style, no value)
Sets the keys before and after to values which are recommended, if the package parskip
is used and there is no better idea for before and after. This is similar to:
\tcbset{parskip/.style={before={\par\pagebreak[0]\parindent=0pt},
after={\par}}}
\tcbset{myone/.style={colback=LightGreen,colframe=DarkGreen,
equal height group=nobefaf,width=\linewidth/4,nobeforeafter}}
\begin{tcolorbox}[myone,title=Box 1]Box 1\end{tcolorbox}%
\begin{tcolorbox}[myone,title=Box 2]Box 2\end{tcolorbox}%
\begin{tcolorbox}[myone,title=Box 3]Box 3\end{tcolorbox}%
\begin{tcolorbox}[myone,title=Box 4]Box 4\end{tcolorbox}
78
/tcb/baseline=hlengthi (no default, initially 0pt)
Used to set the \pgfsetbaseline value of the resulting tcolorbox.
\tcbset{colframe=red!50!white,width=4cm,nobeforeafter}
Some text\dotfill
\begin{tcolorbox}[baseline=3mm]
One line.
\end{tcolorbox}
\begin{tcolorbox}[baseline=3mm]
First line.\\Second line.
\end{tcolorbox}
First line.
Some text . . . . . . . . . . . . . . . . . . . . . . One line. Second line.
First line.
One line. Second line.
Some text . . . . . . . . . . . . . . . . . . . . . .
\tcbset{colframe=red!50!white,width=4cm,nobeforeafter}
Some text\dotfill
\begin{tcolorbox}[box align=top]
One line.
\end{tcolorbox}
\begin{tcolorbox}[box align=top]
First line.\\Second line.
\end{tcolorbox}
Some text . . . . . . . . . . . . . . . . . . . . . .
One line. First line.
Second line.
79
\tcbset{colframe=red!50!white,width=4cm,nobeforeafter}
Some text\dotfill
\begin{tcolorbox}[box align=center]
One line.
\end{tcolorbox}
\begin{tcolorbox}[box align=center]
First line.\\Second line.
\end{tcolorbox}
\tcbset{colframe=red!50!white,nobeforeafter}
Some text\dotfill
\tcbox[nobeforeafter,box align=base]{One line}
\tcbox[nobeforeafter,box align=base,size=fbox]{Another line}
/tcb/beforeÕ P. 78 .
/tcb/afterÕ P. 78 .
\begin{tcolorbox}[after skip=1cm,
This is a tcolorbox.
colframe=red!50!white]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
Some text.
Some text.
\tcbset{beforeafter skip=0pt,
colframe=red!50!white}
\begin{tcolorbox} This is a tcolorbox.
This is a \textbf{tcolorbox}.
\end{tcolorbox}
\begin{tcolorbox} Second box.
Second box.
\end{tcolorbox}
80
N 2014-11-07 /tcb/left skip=hlengthi (style, no default, initially 0mm)
Inserts some horizontal space of the given hlengthi before the colored box. This style sets
/tcb/grow to left byÕ P. 84 with the negated hlengthi, i.e. the bounding box and box
width are changed.
\noindent\rule{\linewidth}{2pt}
\begin{tcolorbox}[left skip=1cm,
colframe=red!50!white] This is a tcolorbox.
This is a \textbf{tcolorbox}.
\end{tcolorbox}
\noindent\rule{\linewidth}{2pt}
\begin{tcolorbox}[right skip=1cm,
colframe=red!50!white] This is a tcolorbox.
This is a \textbf{tcolorbox}.
\end{tcolorbox}
\noindent\rule{\linewidth}{2pt}
81
4.15 Bounding Box
Normally, every tcolorbox has a bounding box which fits exactly to the dimensions of the
outer frame. Therefore, LATEX reserves exactly the space needed for the box. This behavior
can be changed by enlarging (or shrinking) the bounding box. If the bounding box is enlarged,
the tcolorbox will get some clearance around it. If the bounding box is shrunk, i. e. enlarged
with negative values, the tcolorbox will overlap to other parts of the page. For example, the
tcolorbox could be stretched into the page margin.
The following examples use /tcb/show bounding boxÕ P. 179 to display the actual bound-
! ing box. For this, the library skins has to be included and /tcb/enhancedÕ P. 206 has
LIB
to be set.
\tcbset{colframe=blue!75!black,colback=white}
This is a tcolorbox.
This is a tcolorbox.
\tcbset{colframe=blue!75!black,colback=white}
This is a tcolorbox.
This is a tcolorbox.
82
/tcb/enlarge top at break by=hlengthi (no default, initially 0mm)
Enlarges the bounding box distance to the top of the box by hlengthi, if the box is
/tcb/breakableÕ P. 365 . In this case, it is applied to middle and last parts in a break
sequence. /tcb/enlarge top by overwrites this key.
/tcb/enlarge bottom at break by=hlengthi (no default, initially 0mm)
Enlarges the bounding box distance to the bottom of the box by hlengthi, if the box is
/tcb/breakableÕ P. 365 . In this case, it is applied to first and middle parts in a break
sequence. /tcb/enlarge bottom by overwrites this key.
/tcb/enlarge top by=hlengthi (no default, initially 0mm)
Enlarges the bounding box distance to the top of the box by hlengthi. /tcb/enlarge top
initially byÕ P. 82 and /tcb/enlarge top at break by are set to hlengthi.
/tcb/enlarge bottom by=hlengthi (no default, initially 0mm)
Enlarges the bounding box distance to the bottom of the box by hlengthi. /tcb/enlarge
bottom finally byÕ P. 82 and /tcb/enlarge bottom at break by are set to hlengthi.
/tcb/enlarge left by=hlengthi (no default, initially 0mm)
Enlarges the bounding box distance to the left side of the box by hlengthi.
\tcbset{colframe=blue!75!black,colback=white}
This is a tcolorbox.
This is a tcolorbox.
\tcbset{colframe=blue!75!black,colback=white}
This is a tcolorbox.
This is a tcolorbox.
83
/tcb/enlarge by=hlengthi (no default, initially 0mm)
Enlarges the bounding box distance to all sides of the box by hlengthi.
\tcbset{colframe=blue!75!black,colback=white,width=5cm,nobeforeafter}
\begin{tcolorbox}
This is a \textbf{tcolorbox}.
\end{tcolorbox}
\begin{tcolorbox}[enlarge by=5mm,enhanced,show bounding box]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
This is a tcolorbox.
This is a tcolorbox.
\tcbset{colframe=blue!75!black,colback=white}
\tcbset{colframe=blue!75!black,colback=white}
\bigskip
This is a tcolorbox.
This is a tcolorbox.
84
N 2018-03-22 /tcb/grow sidewards by=hlengthi (no default, initially 0mm)
Shortcut for setting /tcb/grow to left byÕ P. 84 and /tcb/grow to right byÕ P. 84 to
hlengthi. Also see /tcb/oversizeÕ P. 45 and /tcb/spread sidewardsÕ P. 88 .
\tcbset{colframe=blue!75!black,colback=white}
This is a tcolorbox.
\tcbset{colframe=blue!75!black,colback=white}
This is a tcolorbox.
\tcbset{colframe=blue!75!black,colback=white}
This is a tcolorbox.
\tcbset{colframe=blue!75!black,colback=white}
This is a tcolorbox.
85
Floating box from toggle enlargement
This page is an even page. Therefore, the left and right enlargements are toggled. This box stretches
to the right margin on odd pages and to the left margin on even pages. The current document is
one-sided – this feature makes sense for two-sided documents only.
\tcbset{colframe=blue!75!black,colback=white,
grow to left by=20mm,grow to right by=-5mm}
This is a tcolorbox.
This is a tcolorbox.
This page is an even page. Therefore, the left and right enlargements are toggled.
\begin{tcolorbox}[colframe=red!60!black,colback=red!15!white,
fonttitle=\bfseries,title=Floating box from \texttt{toggle enlargement},
width=\textwidth,grow to right by=2cm,toggle enlargement,float=t]
This page is an \tcbifoddpage{odd}{even} page.
Therefore, the left and right enlargements \tcbifoddpage{are not}{are} toggled.
This box stretches to the right margin on odd pages and to the left
margin on even pages. The current document is one-sided -- this feature makes
sense for two-sided documents only.
\end{tcolorbox}
86
4.15.4 Spread Box to Page Borders
The following border options are not applicable to nested boxes, boxes insides tables, etc.
! For boxes inside lists, the options may work, but not necessarily. Also, boxes should be
set with \noindent and full width.
\begin{tcolorbox}[enhanced,spread inwards,
colframe=blue!75!black,colback=white,show bounding box]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
This is a tcolorbox.
\begin{tcolorbox}[enhanced,spread outwards,
colframe=blue!75!black,colback=white,show bounding box]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
This is a tcolorbox.
has to be loaded, and /tcb/height fillÕ P. 56 is set automatically. If the optional hlengthi
is greater than 0pt, the box moves over the border, if hlengthi is lower than 0pt, there is a
margin between box and page border.
\begin{tcolorbox}[enhanced,fill downwards,
colframe=blue!75!black,colback=white,show bounding box]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
This is a tcolorbox.
87
This is an example for ’spread upwards’.
\begin{tcolorbox}[enhanced,spread sidewards,
colframe=blue!75!black,colback=white,show bounding box]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
This is a tcolorbox.
88
4.15.5 Box Extrusion
! The following keys should not be used with breakable boxes or boxes with a lower part.
/tcb/shrink tight (style, no value, initially unset)
The total colored box is shrunk to the dimensions of the upper part. There should be no
lower part and no title. This style sets the /tcb/boxsepÕ P. 39 to 0pt and other geometry
keys to fitting values. This option is likely to be used with the following extrusion keys.
\tcbset{colframe=blue!75!black,colback=white,arc=0mm,boxrule=0.4pt,
nobeforeafter,tcbox raise base,shrink tight}
\begin{tcolorbox}
This is a \textbf{tcolorbox}.
\end{tcolorbox}
This is a tcolorbox.
Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
\tcbset{enhanced,colframe=red,colback=yellow!25!white,
frame style={opacity=0.25},interior style={opacity=0.5},
nobeforeafter,tcbox raise base,shrink tight,extrude by=2mm}
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit,
vestibulum ut, placerat ac, adipiscing vitae, felis.
\tcbox[extrude left by=1cm]{Curabitur} dictum gravida mauris.
Nam arcu libero, nonummy eget, consectetuer id, vulputate a, magna.
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, placerat
ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero, nonummy eget,
consectetuer id, vulputate a, magna.
\tcbset{enhanced,colframe=red,colback=yellow!25!white,
frame style={opacity=0.25},interior style={opacity=0.5},
nobeforeafter,tcbox raise base,shrink tight,extrude by=2mm}
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit,
vestibulum ut, placerat ac, adipiscing vitae, felis.
\tcbox[extrude right by=1cm]{Curabitur} dictum gravida mauris.
Nam arcu libero, nonummy eget, consectetuer id, vulputate a, magna.
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, placerat
ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero, nonummy eget,
consectetuer id, vulputate a, magna.
89
/tcb/extrude top by=hlengthi (style, no default, initially unset)
The (upper part of the) colored box is extruded by the given hlengthi to the top side. The
inner width and the bounding box is kept unchanged and the operation is additive!
\tcbset{enhanced,colframe=red,colback=yellow!25!white,
frame style={opacity=0.25},interior style={opacity=0.5},
nobeforeafter,tcbox raise base,shrink tight,extrude by=2mm}
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit,
vestibulum ut, placerat ac, adipiscing vitae, felis.
\tcbox[extrude top by=1cm]{Curabitur} dictum gravida mauris.
Nam arcu libero, nonummy eget, consectetuer id, vulputate a, magna.
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, placerat
ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero, nonummy eget,
consectetuer id, vulputate a, magna.
\tcbset{enhanced,colframe=red,colback=yellow!25!white,
frame style={opacity=0.25},interior style={opacity=0.5},
nobeforeafter,tcbox raise base,shrink tight,extrude by=2mm}
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit,
vestibulum ut, placerat ac, adipiscing vitae, felis.
\tcbox[extrude bottom by=1cm]{Curabitur} dictum gravida mauris.
Nam arcu libero, nonummy eget, consectetuer id, vulputate a, magna.
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, placerat
ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero, nonummy eget,
consectetuer id, vulputate a, magna.
\tcbset{enhanced,colframe=red,colback=yellow!25!white,
frame style={opacity=0.25},interior style={opacity=0.5},
nobeforeafter,tcbox raise base,shrink tight,extrude by=2mm}
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit,
vestibulum ut, placerat ac, adipiscing vitae, felis. \tcbox{Curabitur} dictum
gravida mauris. \tcbox[colframe=Green,interior style={opacity=0.0}]{Nam}
arcu libero, nonummy eget, consectetuer id, \tcbox{vulputate} a, magna. Donec
vehicula augue eu neque. Pellentesque habitant morbi tristique senectus et netus
et malesuada fames ac turpis egestas. \tcbox{Mauris ut leo.}
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, placerat
ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero, nonummy eget,
consectetuer id, vulputate a, magna. Donec vehicula augue eu neque. Pellentesque habitant morbi
tristique senectus et netus et malesuada fames ac turpis egestas. Mauris ut leo.
90
4.16 Layered Boxes and Every Box Settings
A tcolorbox may contain another tcolorbox and so on. The package takes track of the nesting
level using a counter tcblayer. Counter values may be used for doing some fancy things, but
you should never change the counter value yourself.
The package takes special care for the first four layers or nesting levels, called managed layers.
Here, footnote texts are administrated to find their intended place and specific layer dependent
options may be set by changing /tcb/every box on layer nÕ P. 92 . If needed, the number
of managed layers can be increased by setting \tcbsetmanagedlayersÕ P. 92 to a higher value
than 4.
The following styles have a considerable influence on how layered boxes are processed. Note
especially that nested boxes are getting a /tcb/resetÕ P. 105 by default. You can change this,
but be prepared for suprises if you do.
If the defaults are not changed, a tcolorbox gets its options in the following order. Following
options overwrite preceding options.
1. On package load, all options are set to default values.
2. Every \tcbsetÕ P. 13 command adds or changes options for the following boxes inside the
current TEX group.
3. While entering a tcolorbox, a /tcb/every box on layer nÕ P. 92 or /tcb/every box
on higher layersÕ P. 92 option list is applied. With default settings this means:
• For layer 1 (lowest layer), the /tcb/every box option list is applied. Not overwritten
options given by a preceding \tcbsetÕ P. 13 survive.
• For layer 2 and above (nested boxes), a /tcb/resetÕ P. 105 followed by /tcb/every
box option list is applied. Every resettable options given by a preceding \tcbsetÕ P. 13
and by the sourrounding box(es) are reset.
4. The hoptionsi given to the tcolorbox are applied. Or, if the box was generated by
\newtcolorboxÕ P. 15 or friends, the hoptionsi given there are applied.
5. If the box was generated by \newtcolorboxÕ P. 15 or friends, some automated options are
applied.
/tcb/every box (style)
By default, this style is empty.
% default setting:
\tcbset{every box/.style={}}
The alternative for setting something for every box (on every layer) is
\tcbsetforeverylayerÕ P. 13 :
! % setting all boxes to be enhanced:
\tcbsetforeverylayer{enhanced}
91
/tcb/every box on layer n (style)
Here, n has to be replaced by a number ranging from 1 to the highest managed layer number
(4 by default).
% default settings:
\tcbset{
every box on layer 1/.style={every box},
every box on layer 2/.style={reset,every box},
every box on layer 3/.style={reset,every box},
every box on layer 4/.style={reset,every box},
}
\tcbsetmanagedlayers{hnumberi}
Replaces the highest managed layer number by hnumberi where 4 is the default. This macro
can only be used inside the preamble. Using a hnumberi lower than 4 typically makes no
sense, but is not forbidden.
% \usepackage{lipsum}
% \tcbuselibrary{skins,breakable}
\tcbset{colframe=red!75!black,fonttitle=\bfseries,
colback=red!5!white,
every box/.style={enhanced,watermark text=\thetcblayer,
before=\par\smallskip,after=\par\smallskip},
every box on layer 2/.style={reset,every box,colback=yellow!10!white,
drop fuzzy shadow}}
\begin{tcolorbox}[enhanced jigsaw,breakable,title=Layer 1 Box]
Here comes a footnote\footnote{Footnote from layer 1 box}.
\lipsum[2]
\begin{tcolorbox}[title=Layer 2 Box]
abc\footnote{The footnote of abc}
\end{tcolorbox}
\begin{tcolorbox}[title=Another Box,ams equation]
\tcbhighmath{\sum\limits_{n=1}^{\infty} \frac{1}{n}} = \infty.
\end{tcolorbox}
Some text\footnote{Footnote from some text}.
\begin{tcolorbox}[title=Yet Another Box]
\tcboxfit[height=2cm]{\lipsum[1]}
My text.
\begin{tcolorbox}
Another lipsum text\footnote{A lipsum text}. \lipsum[3]
\begin{tcolorbox}[title=Layer 4,colframe=blue,colback=white]
Layer 4\footnote{Layer 4 footnote}
\end{tcolorbox}
The End\footnote{Last footnote}.
\end{tcolorbox}
\end{tcolorbox}
\end{tcolorbox}
1
Layer 1 Box
Here comes a footnotea . Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel,
wisi. Morbi auctor lorem non justo. Nam lacus libero, pretium at, lobortis vitae, ultricies
et, tellus. Donec aliquet, tortor sed accumsan bibendum, erat ligula aliquet magna, vitae
ornare odio metus a mi. Morbi ac orci et nisl hendrerit mollis. Suspendisse ut massa. Cras
92
123
nec ante. Pellentesque a nulla. Cum sociis natoque penatibus et magnis dis parturient
montes, nascetur ridiculus mus. Aliquam tincidunt urna. Nulla ullamcorper vestibulum
turpis. Pellentesque cursus luctus mauris.
2
Layer 2 Box
abca
a
The footnote of abc
32
Another Box
∞
X 1
= ∞. (1)
n=1
n
Some textb .
Yet Another Box
3
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, placerat ac, adipiscing vitae, felis. Curabitur dictum
gravida mauris. Nam arcu libero, nonummy eget, consectetuer id, vulputate a, magna. Donec vehicula augue eu neque. Pellentesque
habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Mauris ut leo. Cras viverra metus rhoncus sem. Nulla et
lectus vestibulum urna fringilla ultrices. Phasellus eu tellus sit amet tortor gravida placerat. Integer sapien est, iaculis in, pretium quis,
viverra ac, nunc. Praesent eget sem vel leo ultrices bibendum. Aenean faucibus. Morbi dolor nulla, malesuada eu, pulvinar at, mollis ac,
nulla. Curabitur auctor semper nulla. Donec varius orci eget risus. Duis nibh mi, congue eu, accumsan eleifend, sagittis quis, diam. Duis
eget orci sit amet orci dignissim rutrum.
My text.
Another lipsum texta . Nulla malesuada porttitor diam. Donec felis erat,
congue non, volutpat at, tincidunt tristique, libero. Vivamus viverra fer-
mentum felis. Donec nonummy pellentesque ante. Phasellus adipiscing sem-
per elit. Proin fermentum massa ac quam. Sed diam turpis, molestie vitae,
placerat a, molestie nec, leo. Maecenas lacinia. Nam ipsum ligula, eleifend
at, accumsan nec, suscipit a, ipsum. Morbi blandit ligula feugiat magna.
Nunc eleifend consequat lorem. Sed lacinia nulla vitae enim. Pellentesque
tincidunt purus vel magna. Integer non enim. Praesent euismod nunc eu
purus. Donec bibendum quam in tellus. Nullam cursus pulvinar lectus.
Donec et mi. Nam vulputate metus eu enim. Vestibulum pellentesque felis
eu massa.
4
Layer 4
Layer 4a
a
Layer 4 footnote
The Endb .
a
A lipsum text
b
Last footnote
a
Footnote from layer 1 box
b
Footnote from some text
93
4.17 Capture Mode
This is the default hmodei for \tcboxfitÕ P. 411 . The content cannot have a lower part
and cannot be broken. The content is sized according to the dimensions of the colored
box. A shortcut to set this mode is /tcb/fitÕ P. 413 .
\tcbset{colframe=blue!75!black,colback=white}
\begin{tcolorbox}[capture=minipage]
This is a tcolorbox.
\end{tcolorbox}
\begin{tcolorbox}[capture=hbox]
This is a tcolorbox.
\end{tcolorbox}
This is a tcolorbox.
This is a tcolorbox.
This is a tcolorbox.
\tcbset{colframe=blue!75!black,colback=white}
\begin{tcolorbox}[hbox]
This is a tcolorbox.
\end{tcolorbox}
This is a tcolorbox.
94
4.18 Text Characteristics
U 2015-10-14 /tcb/parbox=true|false (default true, initially true)
The text inside a tcolorbox is formatted using a LATEX minipage if the box is unbreakable.
If breakable, the box tries a mimicry of a minipage. In a minipage or parbox, paragraphs
are formatted slightly different as the main text. If the key value is set to false, the normal
main text behavior is restored. In some situations, this has some unwanted side effects. It
is recommended that you use this experimental setting only where you really want to have
this feature.
% \usepackage{lipsum} % preamble
\tcbset{width=(\linewidth-2mm)/2,nobeforeafter,arc=1mm,
colframe=blue!75!black,colback=white,fonttitle=\bfseries,fontupper=\small,
left=2mm,right=2mm,top=1mm,bottom=1mm,equal height group=parbox}
95
/tcb/hyphenationfix=true|false (default true, initially false)
Long words at the beginning of paragraphs in very narrow boxes will not be hyphenated
using pdflatex. This problem is circumvented by applying the hyphenationfix option.
\tcbset{colframe=blue!75!black,
fontupper=\normalsize,
colback=blue!5!white,width=4cm} Rechnungsadjunktentochter.
Statthaltereikonzipist.
\begin{tcolorbox}
Rechnungsadjunktentochter.\par
Statthaltereikonzipist. Rechnungsad-
\end{tcolorbox}
junktentochter.
\begin{tcolorbox}[hyphenationfix] Statthal-
Rechnungsadjunktentochter.\par tereikonzipist.
Statthaltereikonzipist.
\end{tcolorbox}
!
parbox=false and hyphenationfix should not be used together. They are targeting
different box types and they do not blend very well.
4.19 Files
/tcb/tempfile=hfile namei (no default, initially \jobname.tcbtemp)
Sets hfile namei as name for the temporary file which is used inside tcbwritetempÕ P. 126
and \tcbusetempÕ P. 126 implicitely.
The following options are applicable for \tcboxÕ P. 14 and \tcboxmathÕ P. 341 only.
/tcb/tcbox raise=hlengthi (no default, initially 0pt)
Raises the \tcboxÕ P. 14 by the given hlengthi.
\tcbset{colframe=blue!50!black,colback=white,colupper=red!50!black,
fonttitle=\bfseries,nobeforeafter,center title}
Test\dotfill
\tcbox[tcbox raise base]{Hello World 1}\dotfill
\tcbox{Hello World 2}\dotfill
\tcbox[tcbox raise=5mm]{Hello World 3}
Hello World 3
Hello World 2
Test . . . . . . Hello World 1 ...... ......
96
N 2015-03-23 /tcb/tcbox width=hmodei (no default, initially auto)
Controls how \tcboxÕ P. 14 respects a /tcb/widthÕ P. 34 setting. Feasible values for hmodei
are:
• auto (initial setting): ignore /tcb/widthÕ P. 34 and set box width according to its
content.
• auto limited: Set box width according to its content, if it is smaller than
/tcb/widthÕ P. 34 . Otherwise, the content is set like in a tcolorboxÕ P. 12 with line
breaks.
• forced center: Set box width according to /tcb/widthÕ P. 34 . The content is centered
and may overlap the box borders.
• forced left: Set box width according to /tcb/widthÕ P. 34 . The content is left
aligned and may overlap the box borders.
• forced right: Set box width according to /tcb/widthÕ P. 34 . The content is right
aligned and may overlap the box borders.
• minimum center: Set box width according to /tcb/widthÕ P. 34 , if the content fits
into. The content is centered and the box width may grow beyond /tcb/widthÕ P. 34 .
• minimum left: Set box width according to /tcb/widthÕ P. 34 , if the content fits into.
The content is left aligned and the box width may grow beyond /tcb/widthÕ P. 34 .
• minimum right: Set box width according to /tcb/widthÕ P. 34 , if the content fits into.
The content is right aligned and the box width may grow beyond /tcb/widthÕ P. 34 .
\tcbox[tcbox width=auto]{auto}\qquad
\tcbox[tcbox width=auto limited]{auto limited}\qquad
\tcbox[tcbox width=auto limited]{auto limited with long text}\\
\tcbox[tcbox width=forced center]{forced center}\qquad
\tcbox[tcbox width=forced center]{forced center with long text}\\
\tcbox[tcbox width=forced left]{forced left}\qquad
\tcbox[tcbox width=forced left]{forced left with long text}\\
\tcbox[tcbox width=forced right]{forced right}\qquad
\tcbox[tcbox width=forced right]{forced right with long text}\\
\tcbox[tcbox width=minimum center]{minimum center}\qquad
\tcbox[tcbox width=minimum center]{minimum center with long text}\\
\tcbox[tcbox width=minimum left]{minimum left}\qquad
\tcbox[tcbox width=minimum left]{minimum left with long text}\\
\tcbox[tcbox width=minimum right]{minimum right}\qquad
\tcbox[tcbox width=minimum right]{minimum right with long text}
97
4.21 Counters, Labels, and References
/tcb/phantom=hcodei (no default, initially unset)
The hcodei is put in a box at the upper left corner of the tcolorbox. If the tcolorbox
is breakable, the hcodei is executed for the first box of the break sequence only. If there
already was some phantom code given, the new hcodei is appended.
The hcodei is intended to be used for counter stepping, labelling, and related operations
which do not produce visible text.
• The hcodei is executed before the title and box content, i. e. counter values are ensured
to be increased before usage.
• Labels are ensured to reference the correct page number.
• The hcodei is executed only once even during fitting operations for title and box con-
tent.
• In combination with the 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.
• Since the hcodei is executed inside a TEX group, only global operations can survive
this group.
Examples for the phantom usage are given in Section 15.9 from page 333, e. g. Example 15.1
on page 334.
/tcb/nophantom (no value, initially set)
Removes the phantom code if set before.
/tcb/label=hmarkeri (no default, initially unset)
The hmarkeri is set as label text for a reference with the \ref macro. Typically, this
option is used for numbered boxes, see Subsection 5.1 from page 108, e. g. /tcb/new/auto
counterÕ P. 108 .
N 2014-11-28 /tcb/phantomlabel=hmarkeri (no default, initially unset)
Equivalent to /tcb/label for an unnumbered box. A \phantomsection from the package
hyperref [15] is used to set a correct hyperlink target. This is not needed for a numbered
box.
/tcb/label type=htypei (no default, initially unset)
This option key can be used only in conjunction with the cleveref package [5] which has
to be loaded separately. htypei has to be a cross-reference type 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 Theorem 16.3.5 on page 359.
/tcb/no label type (no value, initially set)
Removes a /tcb/label type, if set before.
/tcb/step=hcounteri (no default, initially unset)
Shortcut for phantom={\refstepcounter{#1}}. The given hcounteri is increased and ready
for labelling. This option is not needed when using the convenient automated numbering
introduced with version 2.40, see Subsection 5.1 from page 108.
/tcb/step and label={hcounteri}{hmarkeri} (no default, initially unset)
Shortcut for using /tcb/step and /tcb/label. This option is not needed when using the
convenient automated numbering introduced with version 2.40, see Subsection 5.1 from
page 108.
98
/tcb/list entry=htexti (no default, initially unset)
If the «list of tcolorbox(es)» feature described in Subsection 5.2 from page 115 is used, this
key describes the htexti for an entry into the generated list, e. g.
macros. Typically, the htexti will be chosen to be identical or nearly identical to the one
for /tcb/titleÕ P. 18 .
Definition in the preamble:
\newtcolorbox[auto counter,number within=section]{pabox}[2][]{%
colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries,
title=Examp.~\thetcbcounter: #2,#1}
This is a tcolorbox.
99
N 2017-02-03 /tcb/hypertarget=hmarkeri (no default, initially unset)
A \hypertarget from the package hyperref [15] is used to create an internal link of an an-
chor hmarkeri. This hmarkeri can be referenced by \hyperlink or /tcb/hyperlinkÕ P. 199 .
% \usepackage{hyperref}%
\begin{tcolorbox}[enhanced,
colback=red!10,colframe=red!50!black, Box A
hypertarget=hypertwinA,
hyperlink=hypertwinB, Click me to jump to
title=Box A] Box B.
Click me to jump to Box B.
\end{tcolorbox}
% \usepackage{bookmark}%
Red and bold book-
\begin{tcolorbox}[colback=red!10,colframe=red!50!black,
mark
bookmark*={color=red,italic,bold}%
{Another bookmark example}, Open the bookmark
title=Red and bold bookmark] view of the pre-
Open the bookmark view of the previewer viewer to see the
to see the bookmark. bookmark.
\end{tcolorbox}
100
4.22 Even and Odd Pages
! Also see /tcb/toggle left and rightÕ P. 46 and /tcb/toggle enlargementÕ P. 86 for
further even/odd options.
This box is colored in yellow on an odd page and is colored in red on an even page.
If a box is /tcb/breakableÕ P. 365 , using /tcb/if odd page only acts upon the first
! box. If the setting should be repeated for every partial box of the break sequence,
the option should be packed into /tcb/extrasÕ P. 371 . In this case, /tcb/check odd
page has to be set explicitely! Also see /tcb/if odd page*Õ P. 102 .
101
N 2015-11-13 /tcb/if odd page*={hodd optionsi}{heven optionsi} (style, no default)
! This option needs the breakable library, see Section 17 on page 363.
LIB
For breakable boxes, if the current partial box is on an odd page, the hodd optionsi are
applied. On an even page, the heven optionsi are applied. /tcb/check odd pageÕ P. 101 is
automatically set for precise even/odd page testing.
In contrast to /tcb/if odd pageÕ P. 101 , /tcb/if odd page* is used on every partial box
of a break sequences and not only on the first box. Another difference is that /tcb/if
odd page* is applied quite late during option processing, while /tcb/if odd pageÕ P. 101
is applied immediately.
/tcb/if odd page* is implemented as /tcb/if odd pageÕ P. 101 packed into
/tcb/extrasÕ P. 371 .
% \tcbuselibrary{breakable}
\begin{tcolorbox}[breakable,if odd page*={colback=yellow!50}{colback=red!50}]
This breakable box is colored in yellow on an odd page
and is colored in red on an even page. For every partial box, the
test is repeated, i.e. this would give a yellow, red, yellow, red, \ldots\
sequence for a long content.
\end{tcolorbox}
This breakable box is colored in yellow on an odd page and is colored in red on an even page.
For every partial box, the test is repeated, i.e. this would give a yellow, red, yellow, red, . . .
sequence for a long content.
102
N 2015-11-13 \tcbifoddpage{hodd codei}{heven codei}
If the current box is on an odd page, the hodd codei is executed. On an even page, the heven
codei is executed. For precise even/odd page testing, the /tcb/check odd pageÕ P. 101 has
to be set manually inside the box options.
The macro \tcbifoddpage can be used inside underlay, overlay, or watermark code to test
if the box is on an odd page. This will work also for boxes in a break sequence.
The macro can also be used inside the box content text. For unbreakable boxes, the
correct page test is applied. But for /tcb/breakableÕ P. 365 boxes, \tcbifoddpage will
always give the result for the page of the first box inside the box content text. If needed,
the methods from the packages changepage or ifoddpage could be used here.
\tcbset{colframe=blue!75!black,colback=white,fonttitle=\bfseries}
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, plac-
erat ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero, nonummy
eget, consectetuer id, vulputate a, magna. Donec vehicula augue eu neque. Pellentesque habi-
Odd page!
tant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Mauris ut leo.
Cras viverra metus rhoncus sem. Nulla et lectus vestibulum urna fringilla ultrices. Phasellus
eu tellus sit amet tortor gravida placerat. Integer sapien est, iaculis in, pretium quis, viverra
ac, nunc. Praesent eget sem vel leo ultrices bibendum. Aenean faucibus. Morbi dolor nulla,
malesuada eu, pulvinar at, mollis ac, nulla. Curabitur auctor semper nulla. Donec varius
orci eget risus. Duis nibh mi, congue eu, accumsan eleifend, sagittis quis, diam. Duis eget
orci sit amet orci dignissim rutrum.
103
N 2015-11-13 \thetcolorboxnumber
This is a unique identifier (arabic number) for a tcolorbox. It is locally defined inside boxes
and has no meaning outside. It is used for precise even/odd page testing, but may also be
valuable for elaborate user code.
\begin{tcolorbox}[colback=yellow!5,title=Box \thetcolorboxnumber]
This box is \thetcolorboxnumber.
\tcbox[on line,size=fbox]{This box is \thetcolorboxnumber} and
\tcbox[on line,size=fbox]{this box is \thetcolorboxnumber}.
This box is \thetcolorboxnumber.
\end{tcolorbox}
Box 1123
This box is 1123. This box is 1124 and this box is 1125 . This box is 1123.
N 2015-11-13 \thetcolorboxpage
This macro contains the expanded arabic page number of the current tcolorbox. It is
locally defined inside boxes and has no meaning outside. It is precise only, if /tcb/check
odd pageÕ P. 101 was set.
104
4.23 Externalization
LIB
If the externalization library of the tikz package is used and /tcb/graphical
environmentÕ P. 135 is set to tikzpicture, a tcolorbox could trigger the externalization
process which will arise a compilation error.
To avoid this, there are two possible strategies:
• Ensure, that \tikzexternaldisable is set before a tcolorbox is used. If you typically use
the pattern \tikzexternalenable some picture \tikzexternaldisable, there is nothing
to care about.
• If externalization is enabled globally, use /tcb/shield externalize to shield any
tcolorbox. The preamble code could look like this:
\usetikzlibrary{external}
\tikzexternalize
\tcbset{shield externalize}
4.24 Miscellaneous
/tcb/reset (no value, initially set)
Sets (nearly) all tcolorbox settings (including loaded libraries) back to their default values
plus any settings given by \tcbsetforeverylayerÕ P. 13 . /tcb/savedelimiterÕ P. 26 and
/tcb/captureÕ P. 94 keep their values. Also, all raster values (see Section 14 on page 277)
are not resetted.
This option is useful for boxes in boxes where the inner box should not inherit the settings
of the outer box. Note that for boxes inside boxes the reset is done automatically, if the
standard settings of the package are used (v2.40 and above), see Section 4.16 from page 91.
105
N 2015-01-09 /tcb/only=<hoverlay specificationi>{hoptionsi} (style, no default, initially unset)
Sets the given tcolorbox hoptionsi in dependency of a beamer hoverlay specificationi. Note
that this needs the beamer class. The hoptionsi will only be used on the specified beamer
frames.
\documentclass{beamer}
\usepackage[many]{tcolorbox}
\begin{document}
\begin{frame}
\begin{tcolorbox}[title=My title,fonttitle=\bfseries,
enhanced,colframe=red!50!black,colback=red!10,colbacktitle=red,
sidebyside,righthand width=3cm,
lowerbox=invisible,lower separated=false,
drop lifted shadow,
only=<1>{colbacktitle=yellow,coltitle=red!50!black,colframe=red},
only=<3>{colback=yellow!50,watermark text={Attention!}},
only=<3->{lowerbox=visible} ]
This is a test.
\begin{itemize}[<+->]
\item One
\item Two
\item \alert<3>{Three}
\item Four
\end{itemize}
\tcblower
\begin{equation*}
\int\limits_{1}^{x} \frac{1}{t}~dt = \ln(x).
\end{equation*}
\end{tcolorbox}
\end{frame}
\end{document}
\tcbset{colback=red!5!white,colframe=red!75!black,
code={Useless at this spot but functional.},
fonttitle=\bfseries}
\begin{tcolorbox}[code={\newcommand{\mycommand}{\textit{working}}},
title=My \mycommand\ title]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
This is a tcolorbox.
106
N 2016-10-21 /tcb/void (no value, initially unset)
Annihilates the current tcolorbox as far as possible. Basically, this comments out the whole
tcolorbox by using a key. If the option list of the current tcolorbox contains arbitrary
code with global impact (like counter settings), these actions are not undone automati-
cally. Nevertheless, the effects of /tcb/phantomÕ P. 98 , /tcb/stepÕ P. 98 , /tcb/new/auto
counterÕ P. 108 , etc., are removed by /tcb/void.
A%
\begin{tcolorbox}[
title=This box is completely removed by the following key,
void
]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
B
AB
This option key cannot be applied for every situation. For example, if several box
!
environments with the same environment name are nested, for the outer environment
/tcb/void cannot be used, since the end of the inner environment will be misinter-
preted as end of the outer environment.
107
5 Initialization Option Keys
The initialization options are only applicable for the generation of new environments and com-
mands based on tcolorbox and friends. Particularly, they can be used for
• \newtcolorboxÕ P. 15 ,
• \newtcboxÕ P. 16 ,
• \newtcblistingÕ P. 302 ,
• \newtcbinputlistingÕ P. 304 ,
• \newtcbtheoremÕ P. 339 , and
• \newtcboxfitÕ P. 412 .
Typically, these options may generate counters and alike. It is strongly recommended that
! you use initialization options inside the preamble only. Otherwise, you may get trouble
when using LATEX’s \include features.
Counters assigned using the initialization options are administrated automatically. Especially,
they are increased for each new box. Independent from the real counter name, the counter value
can be referenced by \thetcbcounter, e. g. inside the title of the box. The real counter name
is stored inside \tcbcounter.
/tcb/new/auto counter (no value, initially unset)
Creates a new counter automatically. With /tcb/new/number formatÕ P. 110 and
/tcb/new/number withinÕ P. 110 , the appearance and behavior of the counter can be
changed. The counter value is referenced by \thetcbcounter.
Definition in the preamble:
\newtcolorbox[auto counter,number within=section]{pabox}[2][]{%
colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries,
title=Examp.~\thetcbcounter: #2,#1}
This box is automatically numbered with 5.1 on page 108. Inside the box, the 5.1 can also
be referenced by \thetcbcounter. The real counter name is tcb@cnt@pabox.
108
/tcb/new/use counter from=htcolorboxi (no default, initially unset)
Here, a counter from another htcolorboxi is reused. Note that the settings for
/tcb/new/number formatÕ P. 110 and /tcb/new/number withinÕ P. 110 are inherited and
cannot be changed. The counter value is referenced by \thetcbcounter.
This box is automatically numbered with 5.2 on page 109. Inside the box, the 5.2 can also
be referenced by \thetcbcounter. The real counter name is tcb@cnt@pabox.
% \newcounter{myexample}% preamble
\newtcolorbox[use counter=myexample,number format=\Alph]{mybox}[2][]{%
colback=green!5!white,colframe=green!55!black,fonttitle=\bfseries,
title=Some Box \thetcbcounter: #2,#1}
This box is automatically numbered with A on page 109. Inside the box, the A can also be
referenced by \thetcbcounter. The real counter name is myexample.
109
/tcb/new/number within=hcounteri (no default, initially unset)
The automatic counter is set to zero, if hcounteri is increased. Additionally, during output,
the value of hcounteri is prepended to the value of the automatic counter.
To prepend the automatic counter with the chapter number and to reset it with every new
chapter, use:
number within=chapter
number format=\Roman
This box is automatically numbered with (Q/5/A) on page 110. Inside the box, the (Q/5/A)
can also be referenced by \thetcbcounter. The real counter name is tcb@cnt@phbox.
110
! the preamble.
The following options /tcb/new/crefname and /tcb/new/Crefname need to be set inside
% \usepackage{varioref}
% \usepackage{cleveref}
\begin{mybluebox}[label={myreference}]{My title}
This is an example.
\end{mybluebox}
\Cref{myreference}, \cref{myreference}.\\
\Cpageref{myreference}, \cpageref{myreference}.\\
\nameCref{myreference}, \namecref{myreference}.\\
\labelcref{myreference}, \labelcpageref{myreference}.\\
With \texttt{varioref}:\\
\Vref{myreference}, \vref{myreference}.\\
\Vref*{myreference}, \vref*{myreference}.
This is an example.
111
N 2014-09-19 /tcb/new/blend into=hnamei (style, no default, initially unset)
Used to comfortably blend into an existing schema of naming and numbering for some
selected cases. For example, a tcolorbox can be used to display and entitle an image
pretending to be a standard figure environment. Here, /tcb/titleÕ P. 18 is used instead
of the standard \caption and /tcb/list textÕ P. 99 can be used instead of the optional
parameter of the standard \caption.
Feasible values for hnamei are:
• figures: blend into the standard figure environment.
• tables: blend into the standard table environment.
• listings: blend into the standard lstlisting environment of the package listings
[6].
Note that blend into=listings can only be used in the document con-
!
tent or, preferably, inside a \AtBeginDocument clause! Using it without
\AtBeginDocument inside the preamble does not work since the listings pack-
ages initializes its counter also inside \AtBeginDocument.
\begin{figure}[htb]
\centering\includegraphics[height=4cm]{lichtspiel.jpg}
\caption{A standard figure}
\end{figure}
\newtcolorbox[blend into=figures]{myfigure}[2][]{float=htb,capture=hbox,
title={#2},every float=\centering,#1}
112
N 2015-03-13 /tcb/blend before title=hvaluei (no default, initially colon)
This option formats the title output of /tcb/new/blend intoÕ P. 112 . Note that this is a
common tcolorbox option which should be set globally or in the normal option part of
\newtcolorboxÕ P. 15 .
Feasible values for hvaluei are:
• colon: use name/number plus colon.
• dash: use name/number plus dash.
• colon hang: use name/number plus colon with hanging indent.
• dash hang: use name/number plus dash with hanging indent.
\newtcolorbox[blend into=figures]{myfigure}[2][]{float=htb,capture=hbox,
blend before title=dash hang,title={#2},every float=\centering,#1}
113
N 2015-03-13 /tcb/blend before title code=hcodei (no default)
This option formats the title output of /tcb/new/blend intoÕ P. 112 . The hcodei takes one
parameter, the name/number. Use this, if /tcb/blend before titleÕ P. 113 is not flexible
enough.
\newtcolorbox[blend into=figures]{myfigure}[2][]{float=htb,capture=hbox,
blend before title code={\fbox{##1}\ },title={#2},every float=\centering,#1}
114
5.2 Lists of tcolorboxes
For figures and tables, LATEX provides the \listoffigures and \listoftables commands to
create lists of these numbered entities. Also, a tcolorbox can be part of such a kind of list.
1. Assign a list hnamei by the initialization option /tcb/new/list inside.
2. Optionally, a new htypei for list entries may be assigned by the initialization option
/tcb/new/list type.
3. List entries a generated automatically within each new tcolorbox using the above initial-
ization.
• If /tcb/list entryÕ P. 99 is set, the entry is generated with it.
• Otherwise, if /tcb/titleÕ P. 18 is set, the entry is generated with it.
• Otherwise, the entry is generated with the current number and the environment name.
4. The generated list is displayed by \tcblistof.
/tcb/new/list inside=hnamei (no default, initially unset)
Assigns a list or contents file to the generated tcolorboxes. Entries to this list are saved
to a file which gets the hnamei as file name extension. The list is referenced by this name
in \tcblistof. For example:
list inside=exam
\newcommand*\l@tcolorbox{\@dottedtocline{1}{1.5em}{2.3em}}
\tcblistof[\subsection]{exam}{List of Exercises}
! The core of the list is generated by \@starttoc{hnamei} which can be wrapped into
an own macro.
115
6 Side by Side
A side by side box is a special tcolorboxÕ P. 12 where the upper and lower part of the box are
set side by side. All boxes of this kind are unbreakable.
Further side by side options for code examples are /tcb/listing side textÕ P. 315 ,
! /tcb/text side listingÕ P. 315 , /tcb/listing outside textÕ P. 315 , and /tcb/text
outside listingÕ P. 315 .
\tcbset{colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries}
\begin{tcolorbox}[title=My title,sidebyside]
This is the upper (\textit{left-handed}) part.
\tcblower
This is the lower (\textit{right-handed}) part.
\end{tcolorbox}
My title
This is the upper (left-handed) part. This is the lower (right-handed) part.
% \usepackage{lipsum}
% \tcbuselibrary{skins}
\begin{tcolorbox}[bicolor,sidebyside,righthand width=3cm,
sharp corners,boxrule=.4pt,colback=green!5,colbacklower=green!50!black!50]
\lipsum[2]
\tcblower
\includegraphics[width=\linewidth]{goldshade}%
\end{tcolorbox}
116
U 2015-02-06 /tcb/sidebyside align=halignmenti (no default, initially center)
Sets the vertical halignmenti for the left-handed and right-handed part.
Feasible values for halignmenti are:
• center: identical to minipage option c.
• top: identical to minipage option t (aligns the top lines of the left-handed and right-
handed side according to their baselines).
• bottom: identical to minipage option b (aligns the bottom lines of the left-handed and
right-handed side according to their baselines).
• center seam: aligns the center of the left-handed and right-handed side.
• top seam: aligns the very top seam of the left-handed and right-handed side.
• bottom seam: aligns the very bottom seam of the left-handed and right-handed side.
\tcbset{colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries,nobeforeafter,
left=2mm,right=2mm,sidebyside,sidebyside gap=6mm,width=(\linewidth-2mm)/3}
center, top, and bottom are identical to the known corresponding minipage options. While
this is the preferred approach for text content, the result for boxed content like tables or
images may not be as expected.
For such content, one may use center seam, top seam, and bottom seam. For example,
top seam aligns the very top seam of the left-handed and right-handed side.
117
\tcbset{colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries,
size=small,righthand width=4cm,sidebyside,sidebyside gap=6mm,lower separated=false}
center seam
top seam
This is my description text for the pictures displayed on the
right-handed side.
bottom seam
118
/tcb/sidebyside gap=hlengthi (no default, initially 10mm)
Sets the horizontal distance between the left-handed and right-handed part to hlengthi.
\tcbset{colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries,nobeforeafter,
sidebyside,width=(\linewidth-2mm)/2}
Wide gap
This is
a text Narrow gap
This is
which is
a short
too long This is a text which
text.
for one is too long for one This is a short text.
line. line.
\tcbset{colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries}
My title
\tcbset{colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries}
My title
119
/tcb/lefthand ratio=hfractioni (no default, initially 0.5)
Sets the width of the left-handed part to the given hfractioni of the available space.
hfractioni is a value between 0 and 1.
\tcbset{colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries}
My title
\tcbset{colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries}
My title
120
If one side of a side-by-side box should be adapted to the width of its content, this width has
to be computed beforehand. The following example uses a savebox \mysavebox to store the
picture to determine its width. A more convenient way to handle this task is to use the methods
from Section 6.2 on page 122.
% \tcbuselibrary{skins,xparse}
% \usepackage{lipsum}
% \newsavebox\mysavebox % preamble
\DeclareTotalTColorBox{\mysidebox}{ O{} +m +m }{
bicolor,colback=white,colbacklower=yellow!10,
fonttitle=\bfseries,center title,
sidebyside,
code={\sbox{\mysavebox}{#2}},
lefthand width=\wd\mysavebox,
drop lifted shadow,
#1
}
{\usebox{\mysavebox}\tcblower#3}
\mysidebox[title=The Triangle]{%
\begin{tikzpicture}
\path[fill=red!20,draw=red!50!black]
(0,0) node[below]{A} -- (3,1) node[right]{B}
-- (1,4) node[above]{C} -- cycle;
\end{tikzpicture}%
}{%
\lipsum[1]
}
The Triangle
121
6.2 Advanced Settings from the xparse Library
LIB
! onAll page
following macros and options need the xparse library to be loaded, see Section 22
LIB
434.
% \tcbuselibrary{skins,xparse}
% \usepackage{lipsum}
\tcbsidebyside[title=The Triangle,
sidebyside adapt=left,
bicolor,colback=white,colbacklower=yellow!10,
fonttitle=\bfseries,center title,drop lifted shadow,
]{%
\begin{tikzpicture}
\path[fill=red!20,draw=red!50!black]
(0,0) node[below]{A} -- (3,1) node[right]{B}
-- (1,4) node[above]{C} -- cycle;
\end{tikzpicture}%
}{%
\lipsum[1]
}
The Triangle
122
N 2015-11-20 /tcb/sidebyside adapt=hside(s)i (no default, initially none)
The option allows the left-handed and/or right-handed side to determine the dimensions of
the box. This option is only valid inside \tcbsidebysideÕ P. 122 .
Feasible values for hside(s)i are:
• none: no measurement of left-handed and right-handed side.
• left: the actual width of the left-handed content is used to set /tcb/lefthand
widthÕ P. 119 .
• right: the actual width of the right-handed content is used to set /tcb/righthand
widthÕ P. 119 .
• both: the actual width of the left-handed and right-handed content is used
to set /tcb/lefthand widthÕ P. 119 , /tcb/righthand widthÕ P. 119 , and the overall
/tcb/widthÕ P. 34 .
% \tcbuselibrary{skins,xparse}
\tcbsidebyside[sidebyside adapt=left,
title=Very important table,
beamer,colframe=blue!50!black,colback=blue!10,
lower separated=false,sidebyside gap=5mm
]{%
\begin{tabular}{|l|c|r|}\hline
left & center & right\\\hline
A & B & C\\\hline
D & E & F\\\hline
\end{tabular}
}{%
This table contains the most important figures for
all future actions. You may notice that B follows A,
C follows B, and so on.
}
left center right This table contains the most important figures for all future ac-
A B C tions. You may notice that B follows A, C follows B, and so
D E F on.
% \tcbuselibrary{skins,xparse}
\tcbsidebyside[sidebyside adapt=right,
blanker,sidebyside gap=5mm
]{%
\lipsum[2]
}{%
\begin{tikzpicture}
\path[fill=yellow,draw=yellow!75!red] (0,0) circle (1cm);
\fill[red] (45:5mm) circle (1mm);
\fill[red] (135:5mm) circle (1mm);
\draw[line width=1mm,red] (215:5mm) arc (215:325:5mm);
\end{tikzpicture}
}
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor
lorem non justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus.
Donec aliquet, tortor sed accumsan bibendum, erat ligula aliquet magna, vitae
ornare odio metus a mi. Morbi ac orci et nisl hendrerit mollis. Suspendisse ut
massa. Cras nec ante. Pellentesque a nulla. Cum sociis natoque penatibus et
magnis dis parturient montes, nascetur ridiculus mus. Aliquam tincidunt urna.
Nulla ullamcorper vestibulum turpis. Pellentesque cursus luctus mauris.
123
% \tcbuselibrary{skins,xparse}
\tcbsidebyside[sidebyside adapt=both,
enhanced,center,
title=Both sides adapted,
attach boxed title to top center={yshift=-2mm},
coltitle=black,boxed title style={colback=red!25},
segmentation style=solid,colback=red!5,colframe=red!50
]{%
\begin{tabular}{|l|c|r|}\hline
left & center & right\\\hline
A & B & C\\\hline
D & E & F\\\hline
\end{tabular}
}{%
\begin{tikzpicture}
\path[fill=yellow,draw=yellow!75!red] (0,0) circle (1cm);
\fill[red] (45:5mm) circle (1mm);
\fill[red] (135:5mm) circle (1mm);
\draw[line width=1mm,red] (215:5mm) arc (215:325:5mm);
\end{tikzpicture}
}
124
N 2015-11-20 /tcb/sidebyside switch=true|false (default true, initially false)
If set to true, the hleft-handed contenti and hright-handed contenti of
\tcbsidebysideÕ P. 122 are switched. Obviously, this option is only valid inside
\tcbsidebysideÕ P. 122 .
The side switching can be made even/odd page sensitive, if used inside /tcb/if odd
pageÕ P. 101 .
% \tcbuselibrary{skins,xparse}
\tcbsidebyside{Left}{Right}
\tcbsidebyside[sidebyside switch]{Left}{Right}
Left Right
Right Left
This table contains the most important figures for all future ac- left center right
tions. You may notice that B follows A, C follows B, and so A B C
on. D E F
125
7 Saving and Loading of Verbatim Texts
The following macros are slightly modified versions of the original macros from the known
packages moreverb and verbatim. They are used implicitly inside of a tcolorbox environment,
but they can be used outside also.
\begin{tcbverbatimwrite}{hfile namei}
henvironment contenti
\end{tcbverbatimwrite}
Saves the henvironment contenti to a file named by hfile namei. TEX macros inside the
environment are not expanded.
\begin{tcbverbatimwrite}{\jobname_verbexp.tex}
This text is saved \textit{as is}.
\end{tcbverbatimwrite}
This environment may be used inside an own environment. Note, that inside the environ-
ment definition \tcbverbatimwrite has to be used instead of \begin{tcbverbatimwrite}
and \endtcbverbatimwrite instead of \end{tcbverbatimwrite}.
\newenvironment{myverbatim}{%
\begingroup\tcbverbatimwrite{\jobname_myverb.tex}}%
{\endtcbverbatimwrite\endgroup}
\begin{myverbatim}
This is the text which is saved by my own environment.
\end{myverbatim}
\begin{tcbwritetemp}
henvironment contenti
\end{tcbwritetemp}
Has the same function as tcbverbatimwrite, but uses the key value of tempfile for the
file name.
\begin{tcbwritetemp}
This text is saved \textit{as is}.
\end{tcbwritetemp}
\tcbusetemp
Loads the current temporary file which was saved by tcbwritetemp.
126
N 2017-07-05 /tcb/verbatim ignore percent=true|false (default true, initially false)
If this option is set to be true, the percent sign % is silently ignored for
tcbverbatimwriteÕ P. 126 and all macros and environments which are built us-
ing tcbverbatimwriteÕ P. 126 , e.g. tcbwritetempÕ P. 126 , tcblistingÕ P. 299 , or
dispExampleÕ P. 464 .
This option may be useful for creating some special effects, but mainly it is intended to be
applied for documentation with DocStrip. The creation of this option was motivated by
Yudai Nakata. Note that this option is not getting reset by /tcb/resetÕ P. 105 .
Normal usage:
\begin{tcbwritetemp}
%\begin{center}\bfseries
This is my text.
%\end{center}
\end{tcbwritetemp}
Normal usage:
\tcbusetemp
This is my text.
\tcbset{verbatim ignore percent}
Option applied:
\bigskip Option applied:
This is my text.
\begin{tcbwritetemp}
%\begin{center}\bfseries
This is my text.
%\end{center}
\end{tcbwritetemp}
\tcbusetemp
127
8 Recording
The package provides some macros and options to take records during compilation. This is
done by LATEX file operations to save some data to a file for later usage. The main application
scenario is depicted in Section 8.3 on the next page where information about example solutions
is recorded and read again in Section 8.4 on page 132.
8.1 Macros
\tcbrecord{\string\solution{\thetcbcounter}{solutions/exercise-\thetcbcounter.tex}}
N 2014-11-28 \tcbstoprecording
Closes the current record file which was opened by \tcbstartrecording before.
N 2014-11-28 \tcbinputrecords[hfile namei]
Opens a file denoted by hfile namei for reading the records via \input. The default file
name is the name of the last used record file for saving. \tcbstoprecording has to be
called before.
8.2 Options
128
8.3 Example: Exercises
The following application example creates exercises and their corresponding solutions. Each
pair is generated inside a single tcolorbox where the solution is given below \tcblowerÕ P. 12 .
For every example, the solution part is saved by /tcb/savelowertoÕ P. 24 to a file. The saving
is recorded using /tcb/recordÕ P. 128 . To enlighten the possibilities, the second exercise has no
solution. Finally, the solutions are input in Section 8.4 on page 132.
\NewTotalTColorBox{\solution}{mm}{%
enhanced,colframe=red!20!black,colback=yellow!10!white,coltitle=red!40!black,
fonttitle=\bfseries,
underlay={\begin{tcbclipinterior}
\shade[inner color=red!50!yellow,outer color=yellow!10!white]
(interior.north west) circle (2cm);
\draw[help lines,step=5mm,yellow!80!black,shift={(interior.north west)}]
(interior.south west) grid (interior.north east);
\end{tcbclipinterior}},
title={Solution of Exercise~\ref{exercise@#1} on page~\pageref{exercise@#1}:},
phantomlabel={solution@#1},
attach title to upper=\par,
}{\input{#2}}
\tcbstartrecording
\begin{exercise}
Compute the derivative of the following function:
\begin{equation*}
f(x)=\sin((\sin x)^2)
\end{equation*}
\tcblower
The derivative is:
\begin{align*}
f'(x) &= \left( \sin((\sin x)^2) \right)'
=\cos((\sin x)^2) 2\sin x \cos x.
\end{align*}
129
\end{exercise}
\begin{exercise}[no solution]
It holds:
\begin{equation*}
\frac{d}{dx}\left(\ln|x|\right) = \frac{1}{x}.
\end{equation*}
\end{exercise}
\begin{exercise}
Compute the derivative of the following function:
\begin{equation*}
f(x)=(\sin(\sin x))^2
\end{equation*}
\tcblower
The derivative is:
\begin{align*}
f'(x) &= \left( (\sin(\sin x))^2 \right)'
=2\sin(\sin x)\cos(\sin x)\cos x.
\end{align*}
\end{exercise}
\begin{exercise}
Compute the derivative of the following function:
\begin{equation*}
f(x)=\sqrt{x^3-6x^2+2x}
\end{equation*}
\tcblower
The derivative is:
\begin{align*}
f'(x) &= \left( \sqrt{x^3-6x^2+2x} \right)'
= \frac{3x^2-12x+2}{2\sqrt{x^3-6x^2+2x}}.
\end{align*}
\end{exercise}
\begin{exercise}
Compute the derivative of the following function:
\begin{equation*}
f(x)=\left(\frac{2+3x}{1-2x}\right)^3
\end{equation*}
\tcblower
The derivative is:
\begin{align*}
f'(x) &= \left( \left(\frac{2+3x}{1-2x}\right)^3 \right)'
= 3 \left(\frac{2+3x}{1-2x}\right)^2 \frac{(1-2x)3-(2+3x)(-2)}{(1-2x)^2}
= \frac{21(2+3x)^2}{(1-2x)^4}.
\end{align*}
\end{exercise}
\begin{exercise}
Compute the derivative of the following function:
\begin{equation*}
f(x)=\frac{\cos x}{(\tan 2x)^2}
\end{equation*}
\tcblower
The derivative is:
\begin{align*}
f'(x) &= \left( \frac{\cos x}{(\tan 2x)^2} \right)'
= \left( \frac{\cos x (\cos 2x)^2}{(\sin 2x)^2} \right)'\\
&= \frac{(\sin 2x)^2 [(-\sin x)(\cos 2x)^2+(\cos x)4\cos 2x (-\sin 2x)]
- \cos x (\cos 2x)^2 4\sin 2x \cos 2x}{(\sin 2x)^4}\\
&= -\frac{\cos(2x) [\sin x \sin 2x \cos 2x+ 4\cos x(\sin 2x)^2
+ 4 \cos x (\cos 2x)^2]}{(\sin 2x)^3}\\
130
&= -\frac{\cos(2x) [\sin x \sin 2x \cos 2x+ 4\cos x]}{(\sin 2x)^3}.
\end{align*}
\end{exercise}
\begin{exercise}
Compute the derivative of the following function:
\begin{equation*}
f(x)=\cos((2x^2+3)^3)
\end{equation*}
\tcblower
The derivative is:
\begin{align*}
f'(x) &= \left( \cos((2x^2+3)^3) \right)'
=-\sin((2x^2+3)^3) 3(2x^2+3)^2 2\cdot 2x\\
&=-12x(2x^2+3)^2\sin((2x^2+3)^3).
\end{align*}
\end{exercise}
\begin{exercise}
Compute the derivative of the following function:
\begin{equation*}
f(x)=(x^2+1)\sqrt{x^4+1}
\end{equation*}
\tcblower
The derivative is:
\begin{align*}
f'(x) &= \left( (x^2+1)\sqrt{x^4+1} \right)'
= 2x\sqrt{x^4+1} + \frac{2x^3(x^2+1)}{\sqrt{x^4+1}}.
\end{align*}
\end{exercise}
\tcbstoprecording
131
Exercise 8.5: Compute the derivative of the following function:
3
2 + 3x
f (x) =
1 − 2x
Solution on page 133
This concludes the example given in Section 8.3 on page 129. Now, the saved and recorded
solutions are included.
\tcbinputrecords
132
Solution of Exercise 8.5 on page 132:
The derivative is:
3 !0 2
2 + 3x 2 + 3x (1 − 2x)3 − (2 + 3x)(−2) 21(2 + 3x)2
f (x) =
0
=3 = .
1 − 2x 1 − 2x (1 − 2x)2 (1 − 2x)4
133
9 Technical Overview and Customization
This section provides a technical overview of the skin concept of tcolorbox. For most appli-
cations of tcolorbox, one will not need to know the bells and whistles described herein. You
may proceed to Section 10 on page 148 where the customization options for most users are
documented.
The following explanations also cover options and settings from the skins library, see Sec-
LIB
tion 10 on page 148.
From a technical point of view, a skin is a style definition for the appearance of a tcolorbox.
The core package provides some additional option keys for skins but only two skins called
standardÕ P. 204 and standard jigsawÕ P. 205 . The skins library adds several more skins. To
LIB
change to a skin, only one option from the core package has to be set.
/tcb/skin=hnamei (style, no default, initially standard)
Sets the current skin to hnamei. This is a style definition which sets all the following keys,
i. e. for many use cases there is nothing more to do.
\tcbset{colback=Salmon!50!white,colframe=FireBrick!75!black,
width=(\linewidth-8mm)/2,before=,after=\hfill,equal height group=ske}
My title My title
134
/tcb/graphical environment=hnamei (no default, initially pgfpicture)
Sets the graphical environment for the tcolorbox to hnamei. Feasible values are
pgfpicture and tikzpicture or environments which inherit from one of these two. This
key is set by a /tcb/skinÕ P. 134 and may seldom be used directly.
The skin of a tcolorbox is drawn by up to four engines. Afterwards, the text content is drawn
which is not part of a skin. The four steps are:
1. The frame of the box, drawn by /tcb/frame engine.
2. The interior of the box. The interior of a box with title is drawn differently from a box
without title. /tcb/interior titled engine or /tcb/interior engineÕ P. 136 is used
to draw the interior.
3. The segmentation (line) of the box, if there is a lower part; drawn by /tcb/segmentation
engineÕ P. 136 .
4. The title area of the box, if there is a title and /tcb/title filledÕ P. 27 is set to true;
drawn by /tcb/title engineÕ P. 136 .
/tcb/frame engine=hnamei (no default, initially standard)
Sets the frame drawing engine for a box to hnamei. Typically, this key is set by a
/tcb/skinÕ P. 134 . Feasible values for hnamei are:
• standard: the original code from the core package,
• path: a tikz path which is controlled by /tcb/frame styleÕ P. 148 ,
• pathjigsaw: a tikz path which is controlled by /tcb/frame styleÕ P. 148 ,
• pathfirst: a tikz path which is controlled by /tcb/frame styleÕ P. 148 ,
• pathfirstjigsaw: a tikz path which is controlled by /tcb/frame styleÕ P. 148 ,
• pathmiddle: a tikz path which is controlled by /tcb/frame styleÕ P. 148 ,
• pathmiddlejigsaw: a tikz path which is controlled by /tcb/frame styleÕ P. 148 ,
• pathlast: a tikz path which is controlled by /tcb/frame styleÕ P. 148 ,
• pathlastjigsaw: a tikz path which is controlled by /tcb/frame styleÕ P. 148 ,
• freelance: deprecated.
• spartan: a quite spartan code.
• empty: draw nothing.
/tcb/interior titled engine=hnamei (no default, initially standard)
Sets the interior drawing engine for a titled box to hnamei. Typically, this key is set by a
/tcb/skinÕ P. 134 . Feasible values for hnamei are:
• standard: the original code from the core package,
• path: a tikz path which is controlled by /tcb/interior styleÕ P. 149 ,
• pathfirst: a tikz path which is controlled by /tcb/interior styleÕ P. 149 ,
• pathmiddle: a tikz path which is controlled by /tcb/interior styleÕ P. 149 ,
• pathlast: a tikz path which is controlled by /tcb/interior styleÕ P. 149 ,
• freelance: deprecated.
• spartan: a quite spartan code.
• empty: draw nothing.
135
/tcb/interior engine=hnamei (no default, initially standard)
Sets the interior drawing engine for an untitled box to hnamei. Typically, this key is set
by a /tcb/skinÕ P. 134 . Feasible values for hnamei are:
• standard: the original code from the core package,
• path: a tikz path which is controlled by /tcb/interior styleÕ P. 149 ,
• pathfirst: a tikz path which is controlled by /tcb/interior styleÕ P. 149 ,
• pathmiddle: a tikz path which is controlled by /tcb/interior styleÕ P. 149 ,
• pathlast: a tikz path which is controlled by /tcb/interior styleÕ P. 149 ,
• freelance: deprecated.
• spartan: a quite spartan code.
• empty: draw nothing.
/tcb/segmentation engine=hnamei (no default, initially standard)
Sets the segmentation (line) drawing engine for a box to hnamei. Typically, this key is set
by a /tcb/skinÕ P. 134 . Feasible values for hnamei are:
• standard: the original code from the core package,
• path: a tikz path which is controlled by /tcb/segmentation styleÕ P. 151 ,
• freelance: deprecated.
• spartan: a quite spartan code.
• empty: draw nothing.
/tcb/title engine=hnamei (no default, initially standard)
Sets the title area drawing engine for a titled box to hnamei. Typically, this key is set by a
/tcb/skinÕ P. 134 . Feasible values for hnamei are:
• standard: the original code from the core package,
• path: a tikz path which is controlled by /tcb/title styleÕ P. 151 ,
• pathfirst: a tikz path which is controlled by /tcb/title styleÕ P. 151 ,
• pathmiddle: a tikz path which is controlled by /tcb/title styleÕ P. 151 ,
• pathlast: a tikz path which is controlled by /tcb/title styleÕ P. 151 ,
• freelance: deprecated.
• spartan: a quite spartan code.
• empty: draw nothing.
136
/tcb/geometry nodes=true|false (default true, initially false)
If set to true, up to four tikz nodes are defined for a tcolorbox which are named frame,
interior, segmentation, and title. These nodes describe the boundaries of the equally
named parts of a tcolorbox. They are used by most engines based on TikZ. Typically, this
key is set automatically by a /tcb/skinÕ P. 134 .
\tcbset{colback=Salmon!50!white,colframe=FireBrick!75!black,
width=(\linewidth-8mm)/2,before=,after=\hfill,equal height group=geon}
137
9.2 Code Option Keys
The following code options are applicable for all skins. The used hgraphical codei can be any
pgf code. For all skins with exception of standardÕ P. 204 and standard jigsawÕ P. 205 , the
hgraphical codei can also be any TikZ code.
/tcb/frame code=hgraphical codei (code, default from standard)
The given hgraphical codei is used for drawing the frame of the box.
\tcbset{colback=red!5!white,colframe=red!75!black}
\begin{tcolorbox}[enhanced,frame code={
\foreach \n in {north east,north west,south east,south west}
{\path [fill=red!75!black] (interior.\n) circle (3mm); }; }]
This is a \textbf{tcolorbox}.
\tcblower
This is the lower part.
\end{tcolorbox}
This is a tcolorbox.
My title
This is a tcolorbox.
138
/tcb/interior code=hgraphical codei (code, default from standard)
The given hgraphical codei is used for drawing the interior of the box, if the box is without
a title.
\tcbset{colback=red!5!white,colframe=red!75!black}
\begin{tcolorbox}[enhanced,interior code={
\path[draw=red!5!white,line width=5mm,line cap=round]
([xshift=3mm,yshift=-3mm]interior.north west)
--([xshift=-3mm,yshift=3mm]interior.south east)
([xshift=3mm,yshift=3mm]interior.south west)
--([xshift=-3mm,yshift=-3mm]interior.north east);}]
This is a \textbf{tcolorbox}.
\tcblower
This is the lower part.
\end{tcolorbox}
This is a tcolorbox.
\tcbset{colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries}
My title
This is a tcolorbox.
139
/tcb/title code=hgraphical codei (code, default from standard)
The given hgraphical codei is used for drawing the title area of the box.
\tcbset{colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries,
coltitle=black}
My title
This is a tcolorbox.
140
9.3 Subskins
A subskin is a new /tcb/skinÕ P. 134 based on an existing skin which is extended or changed.
Never use geometry settings or bounding box options inside a subskin definition! If one skin
is replaced by another skin, the overall bounding box should stay constant. Especially, if a
! skin is used for a breakable box, unpredictable and unpleasant results could arise otherwise.
If you want to change the geometry also, use an additional style. See the skin beamerÕ P. 228
and the style /tcb/beamerÕ P. 228 as pattern.
\tcbsubskin{hnamei}{hbase skini}{hoptionsi}
Creates a new skin hnamei which inherits all properties of an existing hbase skini plus the
given hoptionsi. The new skin hnamei can be used as value for the keys /tcb/skinÕ P. 134 ,
/tcb/skin firstÕ P. 134 , /tcb/skin middleÕ P. 134 , and /tcb/skin lastÕ P. 134 . As hbase
skini, one can take standardÕ P. 204 , emptyÕ P. 237 , enhancedÕ P. 206 , or any skin from the
skins library, see Section 10 on page 148.
LIB
% \tcbuselibrary{skins}
\tcbsubskin{mycross}{empty}{frame code={%
\draw[red,line width=5pt] (frame.south west)--(frame.north east);
\draw[red,line width=5pt] (frame.north west)--(frame.south east);},
skin first=mycross,skin middle=mycross,skin last=mycross }
\begin{tcolorbox}[skin=mycross]
This is my content.
\end{tcolorbox}
This is my content.
141
9.4 Drawing Scheme
Depending on the complexity of a tcolorbox definition, the resulting box is drawn in a more
or less complex series of steps.
To document and demonstrate these drawing steps, we consider the following box definition:
\newtcolorbox{testbox}[1][]{enhanced,title=Test Box,
boxrule=1mm,titlerule=0.5mm,colframe=blue!50!black,
interior style={top color=blue!20!green!50!white,bottom color=blue!20!yellow!50!white},
colbacktitle=blue!50!green!90!white,segmentation style={solid},
fonttitle=\bfseries,drop fuzzy shadow,borderline={0.3mm}{0.35mm}{yellow!50!white},
underlay={\path[fill image opacity=0.15,fill image scale=0.9,
fill stretch picture={\draw[blue,line width=2mm] circle (1);}]
(interior.south west) rectangle (interior.north east);},
watermark text={Watermark},watermark color={green!20!white},
finish={\begin{tcbclipframe}
\path[bottom color=black,top color=black!50!white,opacity=0.1]
(frame.south west) -- (frame.south east) -- (frame.north east) -- cycle;
\path[top color=white,bottom color=black!50!white,opacity=0.1]
(frame.south west) -- (frame.north east) -- (frame.north west) -- cycle;
\end{tcbclipframe}},#1}
Test Box
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem
non justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet,
tortor sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi.
Morbi ac orci et nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque
1. shadow
a nulla. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus
mus. Aliquam tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus
luctus mauris.
Lower part
Test Box
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem
non justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet,
tortor sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi.
Morbi ac orci et nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque
2. frame
a nulla. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus
mus. Aliquam tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus
luctus mauris.
Lower part
• /tcb/colframeÕ P. 27 , /tcb/opacityframeÕ P. 51
• /tcb/frame codeÕ P. 138
• /tcb/frame styleÕ P. 148
142
Test Box
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem
non justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet,
tortor sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi.
Morbi ac orci et nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque
3. interior
a nulla. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus
mus. Aliquam tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus
luctus mauris.
Lower part
• /tcb/colbackÕ P. 27 , /tcb/opacitybackÕ P. 51
• /tcb/interior codeÕ P. 139 , /tcb/interior titled codeÕ P. 138
• /tcb/interior styleÕ P. 149
Test Box
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem
non justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet,
tortor sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi.
Morbi ac orci et nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque
4. title area
a nulla. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus
mus. Aliquam tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus
luctus mauris.
Lower part
• /tcb/colbacktitleÕ P. 27 , /tcb/opacitybacktitleÕ P. 51
• /tcb/title codeÕ P. 140
• /tcb/title styleÕ P. 151
Test Box
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem
non justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet,
tortor sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi.
Morbi ac orci et nisl hendrerit mollis.5.Suspendisse ut massa. Cras nec ante. Pellentesque
segmentation
a nulla. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus
mus. Aliquam tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus
luctus mauris.
Lower part
• /tcb/lower separatedÕ P. 25
• /tcb/segmentation codeÕ P. 139
• /tcb/segmentation styleÕ P. 151
143
Test Box
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem
non justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet,
tortor sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi.
Morbi ac orci et nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque
6. border line
a nulla. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus
mus. Aliquam tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus
luctus mauris.
Lower part
Test Box
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem
non justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet,
tortor sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi.
Morbi ac orci et nisl hendrerit mollis. Suspendisse
7. underlay ut massa. Cras nec ante. Pellentesque
a nulla. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus
mus. Aliquam tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus
luctus mauris.
Lower part
Test Box
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem
Watermark
non justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet,
tortor sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi.
Morbi ac orci et nisl hendrerit mollis. Suspendisse
8. overlay ut massa. Cras nec ante. Pellentesque
a nulla. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus
mus. Aliquam tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus
luctus mauris.
Lower part
144
Test Box
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem
Watermark
non justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet,
tortor sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi.
Morbi ac orci et nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque
9. text content
a nulla. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus
mus. Aliquam tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus
luctus mauris.
Lower part
Test Box
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem
Watermark
non justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet,
tortor sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi.
Morbi ac orci et nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque
10. finish
a nulla. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus
mus. Aliquam tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus
luctus mauris.
Lower part
% \usepackage{lipsum}
\begin{testbox}
\lipsum[2]
\tcblower
Lower part
\end{testbox}
Test Box
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem non justo.
Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet, tortor sed ac-
cumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi. Morbi ac orci et
Watermark
nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque a nulla. Cum sociis
natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam tincidunt
urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus luctus mauris.
Lower part
145
9.5 Useful Properties
The following macros describe certain properties which may be used for the drawing scheme, see
Section 9.4 on page 142. Sometimes, they are even available inside the box content. All of them
are considered to be read-only and should never be redefined by the user.
N 2016-02-16 \tcbheightspace
If the height of a tcolorbox is not the natural height, the space difference between the
forced and the natural size is hold by \tcbheightspace. This macro is not usable inside
the box content, but for skins or inside /tcb/underlayÕ P. 195 , /tcb/overlayÕ P. 71 , etc.
If such a space information is needed inside the box content, see /tcb/space toÕ P. 59
instead.
% \tcbuselibrary{skins}
\newtcolorbox{testbox}[2][]{enhanced,size=fbox,
colframe=blue!75!black,colback=white,height=#2,
underlay={\node[above,inner sep=3pt] at (interior.south){%
\includegraphics[width=\tcbtextwidth,height=\tcbheightspace-3pt]{goldshade.png}};
},
#1}
\begin{testbox}{3cm}
This is my box. The space is filled with a picture.
\end{testbox}
\begin{testbox}{2cm}
This is my box. The space is filled with a picture.
\end{testbox}
N 2016-02-16 \tcbtextwidth
This property describes the box content width.
• If there also is a lower part, it describes the width of the upper part.
• For /tcb/sidebysideÕ P. 116 boxes, it describes the combined text width plus segmen-
tation.
• This property can be used inside the box content text with exception of /tcb/fitÕ P. 413
boxes.
• \tcbtextwidth can be used for all box types for skins or inside /tcb/underlayÕ P. 195 ,
/tcb/overlayÕ P. 71 , etc.
\begin{tcolorbox}[colframe=blue!75!black]
Inside a box: \tcbtextwidth\ (=\the\linewidth).
\end{tcolorbox}
146
N 2016-02-16 \tcbtextheight
This property describes the designated box content height. If the box is larger than the
natural height, the actual content will be smaller than \tcbtextheight.
• For boxes with a fixed /tcb/heightÕ P. 53 , this property can be used inside the box
content text. For other boxes, it denotes 0pt inside the box content.
• \tcbtextheight can be used for all box types for skins or inside /tcb/underlayÕ P. 195 ,
/tcb/overlayÕ P. 71 , etc.
% \tcbuselibrary{skins}
\begin{tcolorbox}[enhanced,colframe=blue!75!black,
underlay={\node[left,red] at (frame.east) {Here: \tcbtextheight};}]
Inside a box with natural height: \tcbtextheight.
\end{tcolorbox}
\begin{tcolorbox}[enhanced,colframe=blue!75!black,height=1cm,
underlay={\node[left,red] at (frame.east) {Here: \tcbtextheight};}]
Inside a box with fixed height: \tcbtextheight.
\end{tcolorbox}
N 2017-04-25 \tcbsegmentstate
This macro contains 0, 1, or 2. Itis set for every unbroken box and every broken partial
box with the following meaning:
• 0: The current (partial) box contains only an upper part.
• 1: The current (partial) box contains an upper and a lower part. The segmentation
node can be used for positioning.
• 2: The current (partial) box contains only a lower part. This can only be true for
parts of breakable boxes.
Skins like bicolorÕ P. 219 use this property to paint the (partial) boxes.
% \tcbuselibrary{skins,raster}
\begin{tcbraster}[raster equal height,enhanced,
watermark text=\tcbsegmentstate]
\begin{tcolorbox}Upper part\end{tcolorbox}
\begin{tcolorbox}Upper part\tcblower Lower part\end{tcolorbox}
\end{tcbraster}
Upper part
0 Upper part
Lower part 1
147
10 Library skins
LIB
The library is loaded by a package option or inside the preamble by:
\tcbuselibrary{skins}
This also loads the package tikz [22]. Typically but not necessarily, the following skins use
tikz instead of pgf.
The following style options are applicable for all skins which use engines of type path, pathfirst,
pathmiddle, or pathlast. Especially, the skin enhancedÕ P. 206 supports all of them and
standardÕ P. 204 none.
/tcb/frame style=htikz keysi (style, no default)
The htikz keysi are used inside the tikz path command for drawing the frame of the box.
This option is available if the /tcb/frame engineÕ P. 135 is set to path, pathfirst,
pathmiddle, or pathlast. It is not available for standard.
\tcbset{colback=red!5!white,fonttitle=\bfseries}
\tcbset{colback=red!5!white,fonttitle=\bfseries}
My title
\begin{tcolorbox}[enhanced,title=My title,
frame style image=blueshade.png] This is a tcolorbox.
This is a \textbf{tcolorbox}.
\tcblower This is the lower part.
This is the lower part.
\end{tcolorbox}
148
/tcb/frame style tile={hgraphics optionsi}{hfile namei} (no default, initially unset)
Fills the frame with a tile pattern based on an external image referenced by hfile namei. The
hgraphics optionsi are given to the underlying \includegraphics command. For advanced
features like blending of a picture with the background, use /tcb/frame styleÕ P. 148 to-
gether with /tikz/fill tile imageÕ P. 261 .
\tcbset{colback=red!5!white,coltitle=red!30!black,
opacityback=0.75,fonttitle=\bfseries}
My title
\begin{tcolorbox}[enhanced,title=My title,
frame style tile={width=1cm}{pink_marble.png}] This is a tcolorbox.
This is a \textbf{tcolorbox}.
\tcblower This is the lower part.
This is the lower part.
\end{tcolorbox}
\tcbset{colback=red!5!white,colframe=red!75!black,
fonttitle=\bfseries,coltitle=black}
My title
\begin{tcolorbox}[enhanced,title=My title,
frame hidden] This is a tcolorbox.
This is a \textbf{tcolorbox}.
\tcblower This is the lower part.
This is the lower part.
\end{tcolorbox}
149
/tcb/interior style image=hfile namei (no default, initially unset)
Fills the interior with an external image referenced by hfile namei. For advanced features
like blending of a picture with the background, use /tcb/interior styleÕ P. 149 together
with /tikz/fill stretch imageÕ P. 257 .
\tcbset{colframe=red!75!black,fonttitle=\bfseries}
My title
\begin{tcolorbox}[enhanced,title=My title,
interior style image=goldshade.png] This is a tcolorbox.
This is a \textbf{tcolorbox}.
\tcblower This is the lower part.
This is the lower part.
\end{tcolorbox}
\tcbset{colframe=red!75!black,fonttitle=\bfseries}
My title
\begin{tcolorbox}[enhanced,title=My title,
interior style tile={width=2cm}{crinklepaper.png}] This is a tcolorbox.
This is a \textbf{tcolorbox}.
\tcblower This is the lower part.
This is the lower part.
\end{tcolorbox}
150
/tcb/segmentation style=htikz keysi (style, no default)
The htikz keysi are used inside the tikz path command for drawing the segmentation line
of the box.
This option is available if the /tcb/segmentation engineÕ P. 136 is set to path. It is not
available for standard.
\tcbset{colback=red!5!white,colframe=red!75!black,
fonttitle=\bfseries}
My title
\begin{tcolorbox}[enhanced,title=My title,
segmentation style={double=white,draw=blue, This is a tcolorbox.
double distance=1pt,solid}]
This is a \textbf{tcolorbox}. This is the lower part.
\tcblower
This is the lower part.
\end{tcolorbox}
\tcbset{colback=red!5!white,colframe=red!75!black,
fonttitle=\bfseries}
My title
\begin{tcolorbox}[title=My title,
enhanced,segmentation hidden] This is a tcolorbox.
This is a \textbf{tcolorbox}.
\tcblower This is the lower part.
This is the lower part.
\end{tcolorbox}
\tcbset{colback=red!5!white,colframe=red!75!black,
coltitle=blue!50!black,fonttitle=\bfseries}
My title
\begin{tcolorbox}[enhanced,title=My title,
title style={left color=blue!15!yellow, This is a tcolorbox.
right color=red!85!black}]
This is a \textbf{tcolorbox}. This is the lower part.
\tcblower
This is the lower part.
\end{tcolorbox}
151
/tcb/title style image=hfile namei (no default, initially unset)
Fills the title area with an external image referenced by hfile namei. For advanced features
like blending of a picture with the background, use /tcb/title styleÕ P. 151 together with
/tikz/fill stretch imageÕ P. 257 .
\tcbset{colback=blue!5!white,colframe=blue!75!black,
fonttitle=\bfseries}
My title
\begin{tcolorbox}[enhanced,title=My title,
title style image=blueshade.png] This is a tcolorbox.
This is a \textbf{tcolorbox}.
\tcblower This is the lower part.
This is the lower part.
\end{tcolorbox}
\tcbset{colback=red!5!white,colframe=red!75!black,
coltitle=blue!50!black,fonttitle=\bfseries}
My title
\begin{tcolorbox}[enhanced,title=My title,
title style tile={width=1cm}{pink_marble.png}] This is a tcolorbox.
This is a \textbf{tcolorbox}.
\tcblower This is the lower part.
This is the lower part.
\end{tcolorbox}
\tcbset{colback=red!5!white,colframe=red!75!black,
fonttitle=\bfseries}
My title
\begin{tcolorbox}[title=My title,
enhanced,title hidden] This is a tcolorbox.
This is a \textbf{tcolorbox}.
\tcblower This is the lower part.
This is the lower part.
\end{tcolorbox}
152
N 2015-01-14 /tcb/titlerule style=htikz keysi (style, no default)
The htikz keysi are used to draw a title rule, i.e. a rule below the optional title. The
width of the rule is controlled by /tcb/titleruleÕ P. 36 . It may be set directly to a
smaller width to create mixed effects with the standard rule. This option is implemented
as an /tcb/underlayÕ P. 195 . Thus, it is not available for standardÕ P. 204 and standard
jigsawÕ P. 205 , but for all other skins, e.g. enhancedÕ P. 206 . As an underlay, this option can
be used multiple times and is removed by /tcb/no underlayÕ P. 195 .
\begin{tcolorbox}[enhanced,
colback=red!5!white,colframe=red!75!black,
colbacktitle=red!50!yellow,fonttitle=\bfseries, My title
title=My title,
titlerule=1mm, This is a tcolorbox.
titlerule style=yellow ]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
\begin{tcolorbox}[enhanced,
colback=red!5!white,colframe=red!75!black,
colbacktitle=red!50!yellow,fonttitle=\bfseries, My title
title=My title,
titlerule=1mm, This is a tcolorbox.
titlerule style={yellow,line width=0.5mm} ]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
\begin{tcolorbox}[enhanced,
colback=red!10!white,colframe=red!75!black,
colbacktitle=red!50!yellow,fonttitle=\bfseries,
frame hidden, My title
title=My title,
boxrule=0pt,titlerule=1mm, This is a tcolorbox.
titlerule style=red!50!black ]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
%\usetikzlibrary{arrows.meta}
\begin{tcolorbox}[empty,
coltitle=red!75!black,fonttitle=\bfseries,
borderline horizontal={0.5mm}{0pt}{red!50!white}, My title
title=My title,
titlerule style={red, This is a tcolorbox.
arrows = {Hooks[arc=270]-Hooks[arc=270]}} ]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
153
The combined TikZ style applied to frame, interior, and title background can used by authors
in customizing code.
/tikz/tcb fill frame (style, no value)
This is a TikZ style which is finally applied to the frame of the box.
% \tcbuselibrary{hooks}
\tcbset{enhanced,colback=red!5!white,
colframe=red!75!black,fonttitle=\bfseries,
frame code app={\path[tcb fill frame] My title
([yshift=-2mm]frame.north)
circle (8mm); } } This is a tcolorbox.
% \tcbuselibrary{hooks}
\tcbset{enhanced,colback=red!5!white,
colframe=red!75!black,fonttitle=\bfseries,
interior titled code app={\path[tcb fill interior]
([yshift=-0.1pt]interior.north east) My title
--([yshift=3pt]interior.north)
--([yshift=-0.1pt]interior.north west) This is a tcolorbox.
--cycle;} }
This is the lower part.
\begin{tcolorbox}[title=My title]
This is a \textbf{tcolorbox}.
\tcblower
This is the lower part.
\end{tcolorbox}
% \tcbuselibrary{hooks}
\tcbset{enhanced,colback=red!5!white,
colframe=red!75!black,fonttitle=\bfseries,
colbacktitle=blue!75!black, My title
title code app={\path[tcb fill title]
(title) circle (5mm); } } This is a tcolorbox.
154
10.2 Boxed Title Option Keys
The following options place the title text into an own \tcboxÕ P. 14 . This boxed title can be
customized independently from the main box using /tcb/boxed title styleÕ P. 159 . The place-
ment can be influenced by hboxtitle optionsi.
/tcb/attach boxed title to top left={hboxtitle optionsi} (style, default empty)
The title is boxed with a \tcboxÕ P. 14 and attached to the top left corner of the main box.
\begin{tcolorbox}[enhanced,title=My title,
attach boxed title to bottom center] This is a tcolorbox.
This is a \textbf{tcolorbox}.
\end{tcolorbox} My title
155
N 2016-02-26 /tcb/attach boxed title to top={hboxtitle optionsi} (style, default empty)
This is a convenient style to mimic a standard title. It uses /tcb/attach boxed title to
top centerÕ P. 155 , /tcb/minipage boxed titleÕ P. 163 , and sizes the boxed title to match
the base box.
\begin{tcolorbox}[enhanced,title=My title,
attach boxed title to top, My title
boxed title style={colframe=red}]
This is a \textbf{tcolorbox}. This is a tcolorbox.
\end{tcolorbox}
\begin{tcolorbox}[enhanced,title=My title,
attach boxed title to top*, My title
boxed title style={colframe=red}]
This is a \textbf{tcolorbox}. This is a tcolorbox.
\end{tcolorbox}
\begin{tcolorbox}[enhanced,title=My title,
attach boxed title to bottom, This is a tcolorbox.
boxed title style={colframe=red}]
This is a \textbf{tcolorbox}. My title
\end{tcolorbox}
\begin{tcolorbox}[enhanced,title=My title,
attach boxed title to bottom*] This is a tcolorbox.
This is a \textbf{tcolorbox}.
\end{tcolorbox} My title
156
10.2.2 Options for the Boxed Title Placement
The hboxtitle optionsi of the keys described above are shift values. The dimensions of the boxed
title are stored into two macros \tcboxedtitleheight and \tcboxedtitlewidth. These macros
can be used inside the following hboxtitle optionsi:
/tcb/boxtitle/xshift=hlengthi (no default, initially 0pt)
The boxed title is shifted by hlengthi in the horizontal direction.
\begin{tcolorbox}[enhanced,title=My title,
attach boxed title to top left={xshift=-2mm}, My title
boxed title style={size=small,colback=blue}]
This is a \textbf{tcolorbox}. This is a tcolorbox.
\end{tcolorbox}
\begin{tcolorbox}[enhanced,title=My title,
attach boxed title to top center=
{yshift=-\tcboxedtitleheight/2}, My title
boxed title style={size=small,colback=blue}] This is a tcolorbox.
This is a \textbf{tcolorbox}.
\end{tcolorbox}
\begin{tcolorbox}[enhanced,title=My title,
attach boxed title to top center=
My title
{yshift=-3mm,yshifttext=-1mm},
boxed title style={size=small,colback=blue}] This is a tcolorbox.
This is a \textbf{tcolorbox}.
\end{tcolorbox}
\begin{tcolorbox}[enhanced,title=My title,
attach boxed title to top center={yshift*=-3mm}, My title
boxed title style={size=small,colback=blue}]
This is a \textbf{tcolorbox}. This is a tcolorbox.
\end{tcolorbox}
The bounding box of the resulting total tcolorbox is adapted automatically to the vertical
! dimensions of the boxed title. Possible horizontal enlargements are not automatically
computed.
\begin{tcolorbox}[enhanced,title=My title,
attach boxed title to top left=
{xshift=-2mm,yshift=-2mm}, My title
boxed title style={size=small,colback=blue},
This is a tcolorbox.
show bounding box]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
157
10.2.3 Options for the Boxed Title Box
The boxed title options are implemented as an underlay, see Section 10.8 on page 195.
! Therefore, a boxed title is not drawn, if a skin does not support underlays like
standardÕ P. 204 . Still, the room for the boxed titles gets reserved in these cases.
! code
A TikZ node title is produced by a boxed title which can be used inside /tcb/frame
Õ P. 138 , /tcb/interior codeÕ P. 139 , underlays, overlays, and finishes.
A boxed title is almost always the first underlay. The only exceptions are underlays defined
!
by /tcb/underlay boxed titleÕ P. 196 which are drawn before. Additionally, underlays
defined by /tcb/underlay boxed titleÕ P. 196 are only drawn, if a boxed title is actually
set. They are ignored, if there is no boxed title.
% \tcbuselibrary{raster}
\begin{tcbraster}[raster columns=3,enhanced,boxrule=0.4pt,
title=My title,attach boxed title to top center]
\begin{tcolorbox}[boxed title size=title]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
\begin{tcolorbox}[boxed title size=standard]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
\begin{tcolorbox}[boxed title size=copy]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
\end{tcbraster}
My title
My title My title
158
U 2016-02-26 /tcb/boxed title style=hoptionsi (style, initially empty)
By default, a boxed title is dimensioned with /tcb/sizeÕ P. 44 =title and inherits the
/tcb/skinÕ P. 134 and /tcb/colframeÕ P. 27 of the main box. Also, the /tcb/colbackÕ P. 27
is inherited from the main /tcb/colbacktitleÕ P. 27 . Font and color of the title text are set
as usual. All other hoptionsi are set by the /tcb/boxed title style key. Since a boxed
title is set by \tcboxÕ P. 14 , all tcolorbox options are applicable here. If /tcb/boxed title
style is used several times, the hoptionsi are is appended.
\begin{tcolorbox}[enhanced,title=My title,
fonttitle=\bfseries,coltitle=green!25!black,
attach boxed title to top center=
My title
{yshift=-2mm,yshifttext=-1mm},
boxed title style={colframe=green!75!black, This is a tcolorbox.
colback=yellow!50!green}]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
\begin{tcolorbox}[enhanced,title=My title,
colframe=red!50!black,colback=red!10!white,
arc=1mm,colbacktitle=red!10!white,
fonttitle=\bfseries,coltitle=red!50!black,
attach boxed title to top left=
{xshift=3.2mm,yshift=-0.50mm}, My title
boxed title style={skin=enhancedfirst jigsaw,
size=small,arc=1mm,bottom=-1mm, This is a tcolorbox.
interior style={fill=none,
top color=red!30!white,
bottom color=red!20!white}}]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
\begin{tcolorbox}[enhanced,title=My title,
colframe=blue!50!black,colback=blue!10!white,colbacktitle=blue!5!yellow!10!white,
fonttitle=\bfseries,coltitle=black,attach boxed title to top center=
{yshift=-0.25mm-\tcboxedtitleheight/2,yshifttext=2mm-\tcboxedtitleheight/2},
boxed title style={boxrule=0.5mm,
frame code={ \path[tcb fill frame] ([xshift=-4mm]frame.west)
-- (frame.north west) -- (frame.north east) -- ([xshift=4mm]frame.east)
-- (frame.south east) -- (frame.south west) -- cycle; },
interior code={ \path[tcb fill interior] ([xshift=-2mm]interior.west)
-- (interior.north west) -- (interior.north east)
-- ([xshift=2mm]interior.east) -- (interior.south east) -- (interior.south west)
-- cycle;} }]
\lipsum[2]
\end{tcolorbox}
My title
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem non
justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet, tortor
sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi. Morbi ac
orci et nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque a nulla. Cum
sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam
tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus luctus mauris.
159
% \usepackage{varwidth}
\newtcolorbox{mybox}[2][]{enhanced,skin=enhancedlast jigsaw,
attach boxed title to top left={xshift=-4mm,yshift=-0.5mm},
fonttitle=\bfseries\sffamily,varwidth boxed title=0.7\linewidth,
colbacktitle=blue!45!white,colframe=red!50!black,
interior style={top color=blue!10!white,bottom color=red!10!white},
boxed title style={empty,arc=0pt,outer arc=0pt,boxrule=0pt},
underlay boxed title={
\fill[blue!45!white] (title.north west) -- (title.north east)
-- +(\tcboxedtitleheight-1mm,-\tcboxedtitleheight+1mm)
-- ([xshift=4mm,yshift=0.5mm]frame.north east) -- +(0mm,-1mm)
-- (title.south west) -- cycle;
\fill[blue!45!white!50!black] ([yshift=-0.5mm]frame.north west)
-- +(-0.4,0) -- +(0,-0.3) -- cycle;
\fill[blue!45!white!50!black] ([yshift=-0.5mm]frame.north east)
-- +(0,-0.3) -- +(0.4,0) -- cycle; },
title={#2},#1}
\begin{mybox}{My title}
\lipsum[2]
\end{mybox}
My title
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem non
justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet, tortor
sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi. Morbi ac
orci et nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque a nulla. Cum
sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam
tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus luctus mauris.
% \usepackage{varwidth}
\newtcolorbox{mybox}[2][]{enhanced,
attach boxed title to top left={xshift=1cm,yshift=-2mm},
fonttitle=\bfseries,varwidth boxed title=0.7\linewidth,
colbacktitle=green!45!white,coltitle=green!10!black,colframe=green!50!black,
interior style={top color=yellow!10!white,bottom color=green!10!white},
boxed title style={boxrule=0.75mm,colframe=white,
borderline={0.1mm}{0mm}{green!50!black},
borderline={0.1mm}{0.75mm}{green!50!black},
interior style={top color=green!10!white,bottom color=green!10!white,
middle color=green!50!white},
drop fuzzy shadow},
title={#2},#1}
\begin{mybox}{My title}
\lipsum[2]
\end{mybox}
My title
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem non
justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet, tortor
sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi. Morbi ac
orci et nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque a nulla. Cum
sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam
tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus luctus mauris.
160
\newtcolorbox{flipbox}[2][]{
enhanced,colframe=blue!50!black,colback=yellow!5,fonttitle=\bfseries,
flip title={interior hidden},title={#2},#1}
\begin{flipbox}{My title}
\lipsum[2]
\end{flipbox}
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem non
justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet, tortor
sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi. Morbi ac
orci et nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque a nulla. Cum
sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam
tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus luctus mauris.
My title
% \usepackage{varwidth}
\newtcolorbox{mybox}[2][]{skin=enhancedlast jigsaw,interior hidden,
boxsep=0pt,top=0pt,colframe=red,coltitle=red!50!black,
fonttitle=\bfseries\sffamily,
attach boxed title to bottom center,
boxed title style={empty,boxrule=0.5mm},
varwidth boxed title=0.5\linewidth,
underlay boxed title={
\draw[white,line width=0.5mm]
([xshift=0.3mm-\tcboxedtitleheight*2,yshift=0.3mm]title.north west)
--([xshift=-0.3mm+\tcboxedtitleheight*2,yshift=0.3mm]title.north east);
\path[draw=red,top color=white,bottom color=red!50!white,line width=0.5mm]
([xshift=0.25mm-\tcboxedtitleheight*2,yshift=0.25mm]title.north west)
cos +(\tcboxedtitleheight,-\tcboxedtitleheight/2)
sin +(\tcboxedtitleheight,-\tcboxedtitleheight/2)
-- ([xshift=0.25mm,yshift=0.25mm]title.south west)
-- ([yshift=0.25mm]title.south east)
cos +(\tcboxedtitleheight,\tcboxedtitleheight/2)
sin +(\tcboxedtitleheight,\tcboxedtitleheight/2); },
title={#2},#1}
\begin{mybox}{My title}
\lipsum[2]
\end{mybox}
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem non
justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet, tortor
sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi. Morbi ac
orci et nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque a nulla. Cum
sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam
tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus luctus mauris.
My title
161
% \usepackage{varwidth}
\newtcolorbox{mybox}[2][]{enhanced,
before skip=2mm,after skip=2mm,
colback=black!5,colframe=black!50,boxrule=0.2mm,
attach boxed title to top left={xshift=1cm,yshift*=1mm-\tcboxedtitleheight},
varwidth boxed title*=-3cm,
boxed title style={frame code={
\path[fill=tcbcol@back!30!black]
([yshift=-1mm,xshift=-1mm]frame.north west)
arc[start angle=0,end angle=180,radius=1mm]
([yshift=-1mm,xshift=1mm]frame.north east)
arc[start angle=180,end angle=0,radius=1mm];
\path[left color=tcbcol@back!60!black,right color=tcbcol@back!60!black,
middle color=tcbcol@back!80!black]
([xshift=-2mm]frame.north west) -- ([xshift=2mm]frame.north east)
[rounded corners=1mm]-- ([xshift=1mm,yshift=-1mm]frame.north east)
-- (frame.south east) -- (frame.south west)
-- ([xshift=-1mm,yshift=-1mm]frame.north west)
[sharp corners]-- cycle;
},interior engine=empty,
},
fonttitle=\bfseries,
title={#2},#1}
\begin{mybox}[colbacktitle=green]{My title}
\lipsum[2]
\end{mybox}
\begin{mybox}[colbacktitle=red]{My title}
\lipsum[3]
\end{mybox}
My title
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem non
justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet, tortor
sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi. Morbi ac
orci et nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque a nulla. Cum
sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam
tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus luctus mauris.
My title
Nulla malesuada porttitor diam. Donec felis erat, congue non, volutpat at, tincidunt tristique,
libero. Vivamus viverra fermentum felis. Donec nonummy pellentesque ante. Phasellus
adipiscing semper elit. Proin fermentum massa ac quam. Sed diam turpis, molestie vitae,
placerat a, molestie nec, leo. Maecenas lacinia. Nam ipsum ligula, eleifend at, accumsan
nec, suscipit a, ipsum. Morbi blandit ligula feugiat magna. Nunc eleifend consequat lorem.
Sed lacinia nulla vitae enim. Pellentesque tincidunt purus vel magna. Integer non enim.
Praesent euismod nunc eu purus. Donec bibendum quam in tellus. Nullam cursus pulvinar
lectus. Donec et mi. Nam vulputate metus eu enim. Vestibulum pellentesque felis eu massa.
162
/tcb/hbox boxed title (no value, initially set)
The title text content is captured with a horizontal box. Especially, there are no linebreak
possible.
\begin{mybox}{Short title}
This is a \textbf{tcolorbox}. This title is not really very short
\end{mybox}\bigskip
This is a tcolorbox.
\begin{mybox}{This title is not really very short}
This is a \textbf{tcolorbox}.
\end{mybox}
\begin{mybox}{Short title}
This is a \textbf{tcolorbox}. This title is not really
\end{mybox}\bigskip very short
This is a tcolorbox.
\begin{mybox}{This title is not really very short}
This is a \textbf{tcolorbox}.
\end{mybox}
\begin{mybox}{Short title}
This is a \textbf{tcolorbox}. This title is not
\end{mybox}\bigskip really very short
This is a tcolorbox.
\begin{mybox}{This title is not really very short}
This is a \textbf{tcolorbox}.
\end{mybox}
163
/tcb/tikznode boxed title=hoptionsi (initially unset)
The title text content is captured with a TikZ node with given TikZ hoptionsi. The text is
centered by default
% \usepackage{varwidth}
\newtcolorbox{mybox}[1]{varwidth boxed title*=-2cm,
enhanced,attach boxed title to top center=
{yshift=-3mm,yshifttext=-1mm}, Short title
boxed title style={size=small,colback=red}, This is a tcolorbox.
center title,title={#1}}
164
10.3 Watermark Option Keys
The following watermark options are applicable for all skins which use tikzpicture as
/tcb/graphical environmentÕ P. 135 . Therefore, the skin standardÕ P. 204 does not support
these watermarks, but all other skins, e. g. enhancedÕ P. 206 .
The watermark options rely on the more general overlay options described in Section 4.12
! from page 71. Therefore, watermarks and overlays cannot be used mixed. But a mixture
is possible with the hooks library, see Section 21.
LIB
/tcb/watermark text=htexti (no default, initially unset)
Writes some htexti in the center of the interior region of a tcolorbox. This htexti is written
after the frame and interior are drawn and before the text content is drawn. It is zoomed
or stretched according the values of /tcb/watermark zoomÕ P. 168 or /tcb/watermark
stretchÕ P. 170 .
\tcbset{colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries}
My title
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, plac-
erat ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero, nonummy
eget, consectetuer id, vulputate a, magna. Donec vehicula augue eu neque. Pellentesque habi-
tant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Mauris ut leo.
Cras viverra metus rhoncus sem. Nulla et lectus vestibulum urna fringilla ultrices. Phasellus
eu tellus sit amet tortor gravida placerat. Integer sapien est, iaculis in, pretium quis, viverra
ac, nunc. Praesent eget sem vel leo ultrices bibendum. Aenean faucibus. Morbi dolor nulla,
My Watermark
malesuada eu, pulvinar at, mollis ac, nulla. Curabitur auctor semper nulla. Donec varius
orci eget risus. Duis nibh mi, congue eu, accumsan eleifend, sagittis quis, diam. Duis eget
orci sit amet orci dignissim rutrum.
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem non
justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet, tortor
sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi. Morbi ac
orci et nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque a nulla. Cum
sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam
tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus luctus mauris.
165
/tcb/watermark graphics=hfile namei (no default, initially unset)
Draws an external picture referenced by hfile namei in the center of the interior region of
a tcolorbox. The picture is drawn after the frame and interior are drawn and before the
text content is drawn. It is zoomed or stretched according the values of /tcb/watermark
zoomÕ P. 168 or /tcb/watermark stretchÕ P. 170 .
\tcbset{colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries}
My title
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, plac-
erat ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero, nonummy
eget, consectetuer id, vulputate a, magna. Donec vehicula augue eu neque. Pellentesque habi-
tant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Mauris ut leo.
Cras viverra metus rhoncus sem. Nulla et lectus vestibulum urna fringilla ultrices. Phasellus
eu tellus sit amet tortor gravida placerat. Integer sapien est, iaculis in, pretium quis, viverra
ac, nunc. Praesent eget sem vel leo ultrices bibendum. Aenean faucibus. Morbi dolor nulla,
malesuada eu, pulvinar at, mollis ac, nulla. Curabitur auctor semper nulla. Donec varius
orci eget risus. Duis nibh mi, congue eu, accumsan eleifend, sagittis quis, diam. Duis eget
orci sit amet orci dignissim rutrum.
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem non
justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet, tortor
sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi. Morbi ac
orci et nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque a nulla. Cum
sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam
tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus luctus mauris.
166
/tcb/watermark tikz=hgraphical codei (no default, initially unset)
Draws the given tikz hgraphical codei in the center of the interior region of a tcolorbox.
The code is executed after the frame and interior are drawn and before the text con-
tent is drawn. The result is zoomed or stretched according the values of /tcb/watermark
zoomÕ P. 168 or /tcb/watermark stretchÕ P. 170 .
\tcbset{colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries}
\begin{tcolorbox}[enhanced,title=My title,
watermark tikz={\draw[line width=2mm] circle (1cm)
node{\fontfamily{ptm}\fontseries{b}\fontsize{20mm}{20mm}\selectfont ?};}]
\lipsum[1]
\tcblower
\lipsum[2]
\end{tcolorbox}
My title
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, plac-
erat ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero, nonummy
eget, consectetuer id, vulputate a, magna. Donec vehicula augue eu neque. Pellentesque habi-
tant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Mauris ut leo.
Cras viverra metus rhoncus sem. Nulla et lectus vestibulum urna fringilla ultrices. Phasellus
?
eu tellus sit amet tortor gravida placerat. Integer sapien est, iaculis in, pretium quis, viverra
ac, nunc. Praesent eget sem vel leo ultrices bibendum. Aenean faucibus. Morbi dolor nulla,
malesuada eu, pulvinar at, mollis ac, nulla. Curabitur auctor semper nulla. Donec varius
orci eget risus. Duis nibh mi, congue eu, accumsan eleifend, sagittis quis, diam. Duis eget
orci sit amet orci dignissim rutrum.
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem non
justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet, tortor
sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi. Morbi ac
orci et nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque a nulla. Cum
sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam
tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus luctus mauris.
167
/tcb/watermark opacity=hfractioni (no default, initially 1.00)
Sets the opacity value ∈ [0, 1] for a watermark.
\tcbset{enhanced,colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries,
watermark text=Watermark,nobeforeafter,width=(\linewidth-2mm)/2}
Nam dui ligula, fringilla a, euismod so- Nam dui ligula, fringilla a, euismod so-
dales, sollicitudin vel, wisi. Morbi auc- dales, sollicitudin vel, wisi. Morbi auc-
tor lorem non justo. Nam lacus libero, tor lorem non justo. Nam lacus libero,
pretium at, lobortis vitae, ultricies et, tel- pretium at, lobortis vitae, ultricies et, tel-
lus. Donec aliquet, tortor sed accumsan lus. Donec aliquet, tortor sed accumsan
bibendum, erat ligula aliquet magna, vi- bibendum, erat ligula aliquet magna, vi-
Watermark
tae ornare odio metus a mi. Morbi ac
orci et nisl hendrerit mollis. Suspendisse
ut massa. Cras nec ante. Pellentesque
Watermark
tae ornare odio metus a mi. Morbi ac
orci et nisl hendrerit mollis. Suspendisse
ut massa. Cras nec ante. Pellentesque
a nulla. Cum sociis natoque penatibus a nulla. Cum sociis natoque penatibus
et magnis dis parturient montes, nascetur et magnis dis parturient montes, nascetur
ridiculus mus. Aliquam tincidunt urna. ridiculus mus. Aliquam tincidunt urna.
Nulla ullamcorper vestibulum turpis. Pel- Nulla ullamcorper vestibulum turpis. Pel-
lentesque cursus luctus mauris. lentesque cursus luctus mauris.
Nam dui ligula, fringilla a, euismod so- Nam dui ligula, fringilla a, euismod so-
dales, sollicitudin vel, wisi. Morbi auc- dales, sollicitudin vel, wisi. Morbi auc-
tor lorem non justo. Nam lacus libero, tor lorem non justo. Nam lacus libero,
pretium at, lobortis vitae, ultricies et, tel- pretium at, lobortis vitae, ultricies et, tel-
lus. Donec aliquet, tortor sed accumsan lus. Donec aliquet, tortor sed accumsan
bibendum, erat ligula aliquet magna, vi- bibendum, erat ligula aliquet magna, vi-
Watermark
tae ornare odio metus a mi. Morbi ac
orci et nisl hendrerit mollis. Suspendisse
ut massa. Cras nec ante. Pellentesque
a nulla. Cum sociis natoque penatibus
tae ornare odio metus a mi. Morbi ac
Watermark
orci et nisl hendrerit mollis. Suspendisse
ut massa. Cras nec ante. Pellentesque
a nulla. Cum sociis natoque penatibus
et magnis dis parturient montes, nascetur et magnis dis parturient montes, nascetur
ridiculus mus. Aliquam tincidunt urna. ridiculus mus. Aliquam tincidunt urna.
Nulla ullamcorper vestibulum turpis. Pel- Nulla ullamcorper vestibulum turpis. Pel-
lentesque cursus luctus mauris. lentesque cursus luctus mauris.
168
/tcb/watermark shrink=hfractioni (no default, initially unset)
Identically to /tcb/watermark zoomÕ P. 168 , but the watermark never gets enlarged. Thus,
the watermark keeps its original size or is shrunk.
/tcb/watermark overzoom=hfractioni (no default, initially unset)
Sets the overzoom value for a watermark. The overzoom respects the aspect ratio. The
value 1.0 means to fill the whole box until the watermark touches all four sides of the frame.
\tcbset{enhanced,colback=white,colframe=blue!50!black,fonttitle=\bfseries,
watermark opacity=0.5,
watermark graphics=lichtspiel.jpg,nobeforeafter,width=(\linewidth-2mm)/2}
Lorem ipsum dolor sit amet, consectetuer Lorem ipsum dolor sit amet, consectetuer
adipiscing elit. Ut purus elit, vestibu- adipiscing elit. Ut purus elit, vestibu-
lum ut, placerat ac, adipiscing vitae, felis. lum ut, placerat ac, adipiscing vitae, felis.
Curabitur dictum gravida mauris. Nam Curabitur dictum gravida mauris. Nam
arcu libero, nonummy eget, consectetuer arcu libero, nonummy eget, consectetuer
id, vulputate a, magna. Donec vehicula id, vulputate a, magna. Donec vehicula
augue eu neque. Pellentesque habitant augue eu neque. Pellentesque habitant
morbi tristique senectus et netus et male- morbi tristique senectus et netus et male-
suada fames ac turpis egestas. Mauris suada fames ac turpis egestas. Mauris
ut leo. Cras viverra metus rhoncus sem. ut leo. Cras viverra metus rhoncus sem.
Nulla et lectus vestibulum urna fringilla Nulla et lectus vestibulum urna fringilla
ultrices. Phasellus eu tellus sit amet tor- ultrices. Phasellus eu tellus sit amet tor-
tor gravida placerat. Integer sapien est, tor gravida placerat. Integer sapien est,
iaculis in, pretium quis, viverra ac, nunc. iaculis in, pretium quis, viverra ac, nunc.
Praesent eget sem vel leo ultrices biben- Praesent eget sem vel leo ultrices biben-
dum. Aenean faucibus. Morbi dolor dum. Aenean faucibus. Morbi dolor
nulla, malesuada eu, pulvinar at, mollis nulla, malesuada eu, pulvinar at, mollis
ac, nulla. Curabitur auctor semper nulla. ac, nulla. Curabitur auctor semper nulla.
Donec varius orci eget risus. Duis nibh Donec varius orci eget risus. Duis nibh
mi, congue eu, accumsan eleifend, sagittis mi, congue eu, accumsan eleifend, sagittis
quis, diam. Duis eget orci sit amet orci quis, diam. Duis eget orci sit amet orci
dignissim rutrum. dignissim rutrum.
If a /tcb/watermark overzoom value of 1.0 is used in connection with invisible top and
bottom rules which still have a thickness greater than 0pt, the space of these invisible rules
! may not be covered by the watermark. For example, this situation may occur during the
breaking of /tcb/enhancedÕ P. 206 boxes. To avoid this optical glitch, just set /tcb/pad
at breakÕ P. 369 to any desired value.
169
/tcb/watermark stretch=hfractioni (no default, initially unset)
Sets the stretch value for a watermark. The stretch value is applied to width and height in
relation to the box dimensions. It does not respect the aspect ratio. The value 1.0 means
to fill the whole box.
\tcbset{enhanced,colback=white,colframe=blue!50!black,fonttitle=\bfseries,
watermark graphics=lichtspiel.jpg,watermark opacity=0.5,
nobeforeafter,width=(\linewidth-2mm)/2}
Nam dui ligula, fringilla a, euismod so- Nam dui ligula, fringilla a, euismod so-
dales, sollicitudin vel, wisi. Morbi auc- dales, sollicitudin vel, wisi. Morbi auc-
tor lorem non justo. Nam lacus libero, tor lorem non justo. Nam lacus libero,
pretium at, lobortis vitae, ultricies et, tel- pretium at, lobortis vitae, ultricies et, tel-
lus. Donec aliquet, tortor sed accumsan lus. Donec aliquet, tortor sed accumsan
bibendum, erat ligula aliquet magna, vi- bibendum, erat ligula aliquet magna, vi-
tae ornare odio metus a mi. Morbi ac tae ornare odio metus a mi. Morbi ac
orci et nisl hendrerit mollis. Suspendisse orci et nisl hendrerit mollis. Suspendisse
ut massa. Cras nec ante. Pellentesque ut massa. Cras nec ante. Pellentesque
a nulla. Cum sociis natoque penatibus a nulla. Cum sociis natoque penatibus
et magnis dis parturient montes, nascetur et magnis dis parturient montes, nascetur
ridiculus mus. Aliquam tincidunt urna. ridiculus mus. Aliquam tincidunt urna.
Nulla ullamcorper vestibulum turpis. Pel- Nulla ullamcorper vestibulum turpis. Pel-
lentesque cursus luctus mauris. lentesque cursus luctus mauris.
/tcb/watermark color=hcolori (no default, initially mixed background and frame color)
Sets the color for the watermark.
\tcbset{colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries}
My title
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, plac-
erat ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero, nonummy
eget, consectetuer id, vulputate a, magna. Donec vehicula augue eu neque. Pellentesque habi-
tant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Mauris ut leo.
My Watermark
Cras viverra metus rhoncus sem. Nulla et lectus vestibulum urna fringilla ultrices. Phasellus
eu tellus sit amet tortor gravida placerat. Integer sapien est, iaculis in, pretium quis, viverra
ac, nunc. Praesent eget sem vel leo ultrices bibendum. Aenean faucibus. Morbi dolor nulla,
malesuada eu, pulvinar at, mollis ac, nulla. Curabitur auctor semper nulla. Donec varius
orci eget risus. Duis nibh mi, congue eu, accumsan eleifend, sagittis quis, diam. Duis eget
orci sit amet orci dignissim rutrum.
170
/tcb/clip watermark=true|false (default true, initially true)
Sets the watermark to be clipped to the interior area.
\tcbset{enhanced,colback=white,colframe=blue!50!white,fonttitle=\bfseries,
watermark opacity=0.5,watermark stretch=1.00,arc=3mm,
watermark graphics=lichtspiel.jpg}
Clip (default)
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, plac-
erat ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero, nonummy
eget, consectetuer id, vulputate a, magna. Donec vehicula augue eu neque. Pellentesque habi-
tant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Mauris ut leo.
Cras viverra metus rhoncus sem. Nulla et lectus vestibulum urna fringilla ultrices. Phasellus
eu tellus sit amet tortor gravida placerat. Integer sapien est, iaculis in, pretium quis, viverra
ac, nunc. Praesent eget sem vel leo ultrices bibendum. Aenean faucibus. Morbi dolor nulla,
malesuada eu, pulvinar at, mollis ac, nulla. Curabitur auctor semper nulla. Donec varius
orci eget risus. Duis nibh mi, congue eu, accumsan eleifend, sagittis quis, diam. Duis eget
orci sit amet orci dignissim rutrum.
No clip
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, plac-
erat ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero, nonummy
eget, consectetuer id, vulputate a, magna. Donec vehicula augue eu neque. Pellentesque habi-
tant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Mauris ut leo.
Cras viverra metus rhoncus sem. Nulla et lectus vestibulum urna fringilla ultrices. Phasellus
eu tellus sit amet tortor gravida placerat. Integer sapien est, iaculis in, pretium quis, viverra
ac, nunc. Praesent eget sem vel leo ultrices bibendum. Aenean faucibus. Morbi dolor nulla,
malesuada eu, pulvinar at, mollis ac, nulla. Curabitur auctor semper nulla. Donec varius
orci eget risus. Duis nibh mi, congue eu, accumsan eleifend, sagittis quis, diam. Duis eget
orci sit amet orci dignissim rutrum.
171
10.4 Clip Environments
The following clip environments are applicable for all skins which use engines of type path,
pathfirst, pathmiddle, or pathlast. Especially, the skin enhancedÕ P. 206 supports all of
them and standardÕ P. 204 none. The typical area of application is inside overlay code, see
Section 4.12 from page 71.
\begin{tcbclipframe}
henvironment contenti
\end{tcbclipframe}
Defines a Tikz scope which clips to the frame area path.
\makeatletter
\newtcolorbox{picturebox}[2][]{%
enhanced,frame hidden,interior hidden,fonttitle=\bfseries,
overlay={\begin{tcbclipframe}\node at (frame)
{\includegraphics[width=\tcb@width,height=\tcb@height]{#2}};\end{tcbclipframe}%
\begin{tcbclipinterior}\fill[white,opacity=0.75]
(frame.south west) rectangle (frame.north east);\end{tcbclipinterior}},#1}
\makeatother
My Picture Box
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, plac-
erat ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero, nonummy
eget, consectetuer id, vulputate a, magna. Donec vehicula augue eu neque. Pellentesque habi-
tant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Mauris ut leo.
Cras viverra metus rhoncus sem. Nulla et lectus vestibulum urna fringilla ultrices. Phasellus
eu tellus sit amet tortor gravida placerat. Integer sapien est, iaculis in, pretium quis, viverra
ac, nunc. Praesent eget sem vel leo ultrices bibendum. Aenean faucibus. Morbi dolor nulla,
malesuada eu, pulvinar at, mollis ac, nulla. Curabitur auctor semper nulla. Donec varius
orci eget risus. Duis nibh mi, congue eu, accumsan eleifend, sagittis quis, diam. Duis eget
orci sit amet orci dignissim rutrum.
172
\begin{tcbinvclipframe}
henvironment contenti
\end{tcbinvclipframe}
Defines a Tikz scope which clips to the outside of the frame area path.
\tcbset{enhanced jigsaw,fonttitle=\bfseries,opacityback=0.35,colback=blue!5!white,
frame style={left color=red!75!black,right color=red!10!yellow}}
A translucent box
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem non
justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet, tortor
sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi. Morbi ac
orci et nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque a nulla. Cum
sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam
tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus luctus mauris.
173
\begin{tcbclipinterior}
henvironment contenti
\end{tcbclipinterior}
Defines a Tikz scope which clips to the interior area path.
\begin{tcolorbox}[enhanced,title=My Title,
overlay={\begin{tcbclipinterior}
\draw[red,line width=1cm] (interior.north west)--(interior.south east);
\draw[red,line width=1cm] (interior.south west)--(interior.north east);
\end{tcbclipinterior}}]
\lipsum[1]
\end{tcolorbox}
My Title
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, plac-
erat ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero, nonummy
eget, consectetuer id, vulputate a, magna. Donec vehicula augue eu neque. Pellentesque habi-
tant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Mauris ut leo.
Cras viverra metus rhoncus sem. Nulla et lectus vestibulum urna fringilla ultrices. Phasellus
eu tellus sit amet tortor gravida placerat. Integer sapien est, iaculis in, pretium quis, viverra
ac, nunc. Praesent eget sem vel leo ultrices bibendum. Aenean faucibus. Morbi dolor nulla,
malesuada eu, pulvinar at, mollis ac, nulla. Curabitur auctor semper nulla. Donec varius
orci eget risus. Duis nibh mi, congue eu, accumsan eleifend, sagittis quis, diam. Duis eget
orci sit amet orci dignissim rutrum.
\begin{tcbcliptitle}
henvironment contenti
\end{tcbcliptitle}
Defines a Tikz scope which clips to the title area path.
\begin{tcolorbox}[enhanced,title=My Title,colframe=blue,colback=yellow!10!white,
overlay={\begin{tcbcliptitle}\node at (title)
{\includegraphics[width=\linewidth]{lichtspiel.jpg}};\end{tcbcliptitle}}]
\lipsum[1]
\end{tcolorbox}
My Title
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, plac-
erat ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero, nonummy
eget, consectetuer id, vulputate a, magna. Donec vehicula augue eu neque. Pellentesque habi-
tant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Mauris ut leo.
Cras viverra metus rhoncus sem. Nulla et lectus vestibulum urna fringilla ultrices. Phasellus
eu tellus sit amet tortor gravida placerat. Integer sapien est, iaculis in, pretium quis, viverra
ac, nunc. Praesent eget sem vel leo ultrices bibendum. Aenean faucibus. Morbi dolor nulla,
malesuada eu, pulvinar at, mollis ac, nulla. Curabitur auctor semper nulla. Donec varius
orci eget risus. Duis nibh mi, congue eu, accumsan eleifend, sagittis quis, diam. Duis eget
orci sit amet orci dignissim rutrum.
174
/tcb/clip title=true|false (default true, initially false)
Sets the title to be clipped to the title area.
\tcbset{enhanced,width=5cm,colframe=red!50!white,coltitle=black,
colbacktitle=yellow!50!white}
This is a tcolorbox.
This is a tcolorbox.
\newcommand{\mygraphics}[2][]{%
\tcbox[enhanced,boxsep=0pt,top=0pt,bottom=0pt,left=0pt,
right=0pt,boxrule=0.4pt,drop fuzzy shadow,clip upper,
colback=black!75!white,toptitle=2pt,bottomtitle=2pt,nobeforeafter,
center title,fonttitle=\small\sffamily,title=\detokenize{#2}]
{\includegraphics[width=\the\dimexpr(\linewidth-4mm)/2\relax]{#2}}}
\mygraphics{lichtspiel.jpg}\hfill
\mygraphics{Basilica_5.png}
lichtspiel.jpg
Basilica_5.png
175
The example for /tcb/clip upperÕ P. 175 sizes the box according to the dimensions of the pic-
ture. To do it the other way around, the watermark options provide an easy solution.
\newcommand{\mygraphics}[2][]{%
\tcbox[enhanced,capture=minipage,boxsep=0pt,top=0pt,bottom=0pt,left=0pt,
right=0pt,boxrule=0.4pt,drop fuzzy shadow,nobeforeafter,
colback=black!75!white,toptitle=2pt,bottomtitle=2pt,
center title,fonttitle=\small\sffamily,title=\detokenize{#2},
width=(\linewidth-4mm)/2,height=6cm,colbacktitle={black},
watermark zoom=1.0,watermark graphics={#2}]{}}
\mygraphics{lichtspiel.jpg}\hfill
\mygraphics{Basilica_5.png}
lichtspiel.jpg Basilica_5.png
\begin{tcblisting}{}
Donau\-dampf\-schiff\-fahrts\-ka\-pi\-t\"ans\-m\"ut\-zen\-fran\-sen
\end{tcblisting}
\begin{tcblisting}{clip lower}
Donau\-dampf\-schiff\-fahrts\-ka\-pi\-t\"ans\-m\"ut\-zen\-fran\-sen
\end{tcblisting}
Donaudampfschifffahrtska-
pitänsmützenfransen
Donau\-dampf\-schiff\-fahrts\-ka\-pi\-t\"ans\-m\"ut\-zen\-fran\-sen
Donaudampfschifffahrtska-
pitänsmützenfransen
Donau\-dampf\-schiff\-fahrts\-ka\-pi\-t\"ans\-m\"ut\-zen\-fran\-sen
176
10.5 Border Line Option Keys
The following borderline options are applicable for most skins which use tikzpicture as
/tcb/graphical environmentÕ P. 135 . Therefore, the skin standardÕ P. 204 does not support
these border lines, but most other skins, e. g. enhancedÕ P. 206 .
The borderlines are independent from the normal tcolorbox rules. They may be used with or
without the /tcb/segmentation engineÕ P. 136 .
The borderlines are stackable, i. e. several different border lines can be used on the same
tcolorbox. They are drawn after the box frame and box interior and before overlays or water-
marks.
! lines are created by a TikZ drawing process. This can be used to apply different effects.
Technically, the normal tcolorbox rules result from a TikZ filling process. The border
\begin{tcolorbox}[enhanced,title=Rounded corners,fonttitle=\bfseries,boxsep=5pt,
arc=8pt,
borderline={0.5pt}{0pt}{red},
borderline={0.5pt}{5pt}{blue,dotted},
borderline={0.5pt}{-5pt}{green} ]
This is a tcolorbox.
\end{tcolorbox}
\bigskip
\begin{tcolorbox}[enhanced,title=Sharp corners,fonttitle=\bfseries,boxsep=5pt,
arc=8pt,sharp corners=downhill,
borderline={0.5pt}{0pt}{red},
borderline={0.5pt}{5pt}{blue,dotted},
borderline={0.5pt}{-5pt}{green} ]
This is a tcolorbox.
\end{tcolorbox}
Rounded corners
This is a tcolorbox.
Sharp corners
This is a tcolorbox.
177
% \usepackage{lipsum}
\begin{tcolorbox}[enhanced,arc=3mm,boxrule=1.5mm,boxsep=1.5mm,
colback=yellow!20!white,
colframe=blue,
borderline={1mm}{1mm}{white},
borderline={1mm}{2mm}{red} ]
\lipsum[1]
\end{tcolorbox}
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut,
placerat ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero,
nonummy eget, consectetuer id, vulputate a, magna. Donec vehicula augue eu neque. Pel-
lentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.
Mauris ut leo. Cras viverra metus rhoncus sem. Nulla et lectus vestibulum urna fringilla
ultrices. Phasellus eu tellus sit amet tortor gravida placerat. Integer sapien est, iaculis
in, pretium quis, viverra ac, nunc. Praesent eget sem vel leo ultrices bibendum. Aenean
faucibus. Morbi dolor nulla, malesuada eu, pulvinar at, mollis ac, nulla. Curabitur auctor
semper nulla. Donec varius orci eget risus. Duis nibh mi, congue eu, accumsan eleifend,
sagittis quis, diam. Duis eget orci sit amet orci dignissim rutrum.
% \usepackage{lipsum}
\begin{tcolorbox}[enhanced,arc=3mm,boxrule=1.5mm,
frame hidden,colback=blue!10!white,
borderline={1mm}{0mm}{blue,dotted} ]
\lipsum[2]
\end{tcolorbox}
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem non
justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet, tortor
sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi. Morbi
ac orci et nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque a nulla.
Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.
Aliquam tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus luctus
mauris.
% \usepackage{lipsum}
\begin{tcolorbox}[enhanced,skin=enhancedmiddle,
frame hidden,interior hidden,top=0mm,bottom=0mm,boxsep=0mm,
borderline={0.75mm}{0mm}{red},
borderline={0.75mm}{0.75mm}{red!50!yellow},
borderline={0.75mm}{1.5mm}{yellow}, ]
\lipsum[3]
\end{tcolorbox}
Nulla malesuada porttitor diam. Donec felis erat, congue non, volutpat at, tincidunt tris-
tique, libero. Vivamus viverra fermentum felis. Donec nonummy pellentesque ante. Phasellus
adipiscing semper elit. Proin fermentum massa ac quam. Sed diam turpis, molestie vitae,
placerat a, molestie nec, leo. Maecenas lacinia. Nam ipsum ligula, eleifend at, accumsan nec,
suscipit a, ipsum. Morbi blandit ligula feugiat magna. Nunc eleifend consequat lorem. Sed
lacinia nulla vitae enim. Pellentesque tincidunt purus vel magna. Integer non enim. Praesent
euismod nunc eu purus. Donec bibendum quam in tellus. Nullam cursus pulvinar lectus.
Donec et mi. Nam vulputate metus eu enim. Vestibulum pellentesque felis eu massa.
178
% \usepackage{lipsum}
\newtcolorbox{mygreenbox}[2][]{%
enhanced,width=\linewidth-6pt,
enlarge top by=3pt,enlarge bottom by=3pt,
enlarge left by=3pt,enlarge right by=3pt,
title={#2},frame hidden,boxrule=0pt,top=1mm,bottom=1mm,
colframe=green!30!black, colbacktitle=green!50!yellow,
coltitle=black, colback=green!25!white,
borderline={0.5pt}{-0.5pt}{green!75!blue},
borderline={1pt}{-3pt}{green!50!blue},#1}
\begin{mygreenbox}{My title}
\lipsum[4]
\end{mygreenbox}
My title
Quisque ullamcorper placerat ipsum. Cras nibh. Morbi vel justo vitae lacus tincidunt
ultrices. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. In hac habitasse platea
dictumst. Integer tempus convallis augue. Etiam facilisis. Nunc elementum fermentum wisi.
Aenean placerat. Ut imperdiet, enim sed gravida sollicitudin, felis odio placerat quam, ac
pulvinar elit purus eget enim. Nunc vitae tortor. Proin tempus nibh sit amet nisl. Vivamus
quis tortor vitae risus porta vehicula.
\tcbset{enhanced,nobeforeafter,width=4cm,fonttitle=\bfseries}
Enlarged
Normal Shadow
This is a tcolorbox.
This is a tcolorbox. This is a tcolorbox.
179
The following partial borderlines act slightly different from the complete borderlines de-
! scribed before. They ignore rounded corner settings, their length is not modified by their
hoffseti, they ignore skin settings but adapt to breakable boxes.
\begin{tcolorbox}[enhanced,
borderline north={2pt}{-2pt}{red}]
This is a tcolorbox.
This is a \textbf{tcolorbox}.
\end{tcolorbox}
\begin{tcolorbox}[enhanced,
borderline south={2pt}{-2pt}{red}]
This is a tcolorbox.
This is a \textbf{tcolorbox}.
\end{tcolorbox}
\begin{tcolorbox}[enhanced,
borderline east={2pt}{-2pt}{red}]
This is a tcolorbox.
This is a \textbf{tcolorbox}.
\end{tcolorbox}
\begin{tcolorbox}[enhanced,
borderline west={2pt}{-2pt}{red}]
This is a tcolorbox.
This is a \textbf{tcolorbox}.
\end{tcolorbox}
180
N 2014-10-20 /tcb/borderline horizontal={hwidthi}{hoffseti}{hoptionsi} (no default, initially unset)
Adds a new borderline with the given hwidthi to the north and south of the tcolorbox. A
positive hoffseti value moves the borderlines inside the tcolorbox and a negative hoffseti
value moves them outside without changing the bounding box.
\begin{tcolorbox}[blanker,top=3mm,bottom=3mm,
borderline horizontal={2pt}{0pt}{red}]
This is a tcolorbox.
This is a \textbf{tcolorbox}.
\end{tcolorbox}
\begin{tcolorbox}[blanker,left=3mm,right=3mm,
borderline vertical={2pt}{0pt}{red}]
This is a tcolorbox.
This is a \textbf{tcolorbox}.\\
My second line.
My second line.
\end{tcolorbox}
\begin{tcolorbox}[enhanced,colback=yellow!10!white,boxrule=0pt,frame hidden,
borderline north={1mm}{-2mm}{red},
borderline south={1mm}{-2mm}{blue},
borderline west={1mm}{-2mm}{green},
borderline east={1mm}{-2mm}{yellow}]
\lipsum[1]
\end{tcolorbox}
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, placerat
ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero, nonummy eget,
consectetuer id, vulputate a, magna. Donec vehicula augue eu neque. Pellentesque habitant morbi
tristique senectus et netus et malesuada fames ac turpis egestas. Mauris ut leo. Cras viverra metus
rhoncus sem. Nulla et lectus vestibulum urna fringilla ultrices. Phasellus eu tellus sit amet tortor
gravida placerat. Integer sapien est, iaculis in, pretium quis, viverra ac, nunc. Praesent eget sem
vel leo ultrices bibendum. Aenean faucibus. Morbi dolor nulla, malesuada eu, pulvinar at, mollis
ac, nulla. Curabitur auctor semper nulla. Donec varius orci eget risus. Duis nibh mi, congue eu,
accumsan eleifend, sagittis quis, diam. Duis eget orci sit amet orci dignissim rutrum.
181
10.6 Shadow Option Keys
The following shadow options are applicable for most skins which use tikzpicture as
/tcb/graphical environmentÕ P. 135 . Therefore, the skin standardÕ P. 204 does not support
these shadows, but most other skins, e. g. enhancedÕ P. 206 .
The shadows are stackable, i. e. several different shadows can be used on the same tcolorbox.
They are drawn before the box frame is drawn.
/tcb/no shadow (no default)
Removes all shadows if set before.
\tcbset{enhanced,colback=red!5!white,
colframe=red!75!black,fonttitle=\bfseries}
This is a tcolorbox.
\begin{tcolorbox}[drop shadow]
This is a tcolorbox.
\end{tcolorbox}\par\bigskip Another shadow
\begin{tcolorbox}[title=Another shadow,
drop shadow=blue] This is a tcolorbox.
This is a tcolorbox.
\end{tcolorbox}
\tcbset{enhanced,colback=red!5!white,
colframe=red!75!black,fonttitle=\bfseries}
This is a tcolorbox.
\begin{tcolorbox}[drop fuzzy shadow]
This is a tcolorbox.
\end{tcolorbox}\par\bigskip Another shadow
\begin{tcolorbox}[title=Another shadow,
drop fuzzy shadow=blue] This is a tcolorbox.
This is a tcolorbox.
\end{tcolorbox}
\tcbset{enhanced,colback=red!5!white,
colframe=red!75!black,fonttitle=\bfseries}
This is a tcolorbox.
\begin{tcolorbox}[drop midday shadow]
This is a tcolorbox.
\end{tcolorbox}\par\bigskip Another shadow
\begin{tcolorbox}[title=Another shadow,
drop midday shadow=blue] This is a tcolorbox.
This is a tcolorbox.
\end{tcolorbox}
182
/tcb/drop fuzzy midday shadow=hcolori (style, default black!50!white)
Adds a new fuzzy shadow with standard dimensions to the stack of shadows. Optionally,
the hcolori for the shadow can be changed.
\tcbset{enhanced,colback=red!5!white,
colframe=red!75!black,fonttitle=\bfseries}
This is a tcolorbox.
\begin{tcolorbox}[drop fuzzy midday shadow]
This is a tcolorbox.
\end{tcolorbox}\par\bigskip Another shadow
\begin{tcolorbox}[title=Another shadow,
drop fuzzy midday shadow=blue] This is a tcolorbox.
This is a tcolorbox.
\end{tcolorbox}
\tcbset{enhanced,colback=red!5!white,
colframe=red!75!black,fonttitle=\bfseries} My own halo
\tcbset{enhanced,colback=red!5!white,
colframe=red!75!black,fonttitle=\bfseries} My own halo
\begin{tcolorbox}[blank,enhanced jigsaw,boxsep=2pt,arc=2pt,
fuzzy halo=2mm with red!50!white,
fuzzy halo=1mm with white]
\lipsum[1]
\end{tcolorbox}
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, placerat
ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero, nonummy eget,
consectetuer id, vulputate a, magna. Donec vehicula augue eu neque. Pellentesque habitant morbi
tristique senectus et netus et malesuada fames ac turpis egestas. Mauris ut leo. Cras viverra metus
rhoncus sem. Nulla et lectus vestibulum urna fringilla ultrices. Phasellus eu tellus sit amet tortor
gravida placerat. Integer sapien est, iaculis in, pretium quis, viverra ac, nunc. Praesent eget sem
vel leo ultrices bibendum. Aenean faucibus. Morbi dolor nulla, malesuada eu, pulvinar at, mollis
ac, nulla. Curabitur auctor semper nulla. Donec varius orci eget risus. Duis nibh mi, congue eu,
accumsan eleifend, sagittis quis, diam. Duis eget orci sit amet orci dignissim rutrum.
183
For all following shadows, the optionally given hcolori for the shadow can be changed equivalent
to the preceding examples.
/tcb/drop shadow southeast=hcolori (style, default black!50!white)
Adds a new shadow with standard dimensions to the stack of shadows. This shadow is
identical to /tcb/drop shadowÕ P. 182 .
184
/tcb/drop shadow northeast=hcolori (style, default black!50!white)
Adds a new shadow with standard dimensions to the stack of shadows.
\begin{tcolorbox}[drop shadow northeast,
enhanced,colback=red!5!white,colframe=red!75!black]
This is a tcolorbox.
This is a tcolorbox.
\end{tcolorbox}
185
/tcb/drop fuzzy shadow northwest=hcolori (style, default black!50!white)
Adds a new fuzzy shadow with standard dimensions to the stack of shadows.
186
10.6.2 Lifted Shadows
/tcb/drop lifted shadow=hcolori (style, default black!50!white)
Adds a new lifted shadow with standard dimensions to the stack of shadows. Optionally,
the hcolori for the shadow can be changed.
\tcbset{enhanced,colback=red!5!white,
boxrule=0.4pt,sharp corners,
colframe=red!75!black,fonttitle=\bfseries}
This is a tcolorbox.
\begin{tcolorbox}[drop lifted shadow]
This is a tcolorbox.
\end{tcolorbox}\par\bigskip Another shadow
\begin{tcolorbox}[title=Another shadow, This is a tcolorbox.
drop lifted shadow=blue]
This is a tcolorbox.
\end{tcolorbox}
\tcbset{enhanced,colback=red!5!white,
boxrule=0.4pt,sharp corners,
colframe=red!75!black,fonttitle=\bfseries}
This is a tcolorbox.
\tcbox[drop small lifted shadow,size=fbox]
{This is a tcolorbox.} Another shadow
\par\bigskip
\begin{tcolorbox}[title=Another shadow, This is a tcolorbox.
drop small lifted shadow=black]
This is a tcolorbox.
\end{tcolorbox}
\tcbset{enhanced,colback=red!5!white,
colframe=red!75!black,fonttitle=\bfseries}
This is a tcolorbox.
\begin{tcolorbox}[drop large lifted shadow]
This is a tcolorbox.
\end{tcolorbox}\par\bigskip Another shadow
\begin{tcolorbox}[title=Another shadow,
drop large lifted shadow=blue] This is a tcolorbox.
This is a tcolorbox.
\end{tcolorbox}
187
10.6.3 Generic Shadows
/tcb/shadow={hxshifti}{hyshifti}{hoffseti}{hoptionsi} (no default)
Adds a new shadow to the stack of shadows. This shadow follows the outline of the
tcolorbox but is shifted by hxshifti and hyshifti. The hoffseti value is a distance value
from the frame outline. A positive hoffseti value shrinks the shadow and a negative hoffseti
value enlarges the shadow. The shadow is filled along a TikZ path with the given TikZ
hoptionsi.
The shadows adapt to the rounded corners of the tcolorbox. An shrinked shadow will
switch to sharp corners if necessary, an enlarged shadow may become more rounded de-
pending on several factors. But /tcb/sharp cornersÕ P. 48 have sharp shadows.
Shadows are not considered for the bounding box computation by default. Large
! shadows may be overlaped by the following content. But, the bounding box can be
adapted if necessary.
\tcbset{enhanced,colback=red!5!white,
colframe=red!75!black,fonttitle=\bfseries}
188
/tcb/fuzzy shadow={hxshifti}{hyshifti}{hoffseti}{hstepi}{hoptionsi} (no default)
Adds a new fuzzy shadow to the stack of shadows. Actually, this option adds several
shadows which appear like a shadow with a fuzzy border. This fuzzy shadow follows the
outline of the tcolorbox but is shifted by hxshifti and hyshifti. The hoffseti value is a
distance value from the frame outline. A positive hoffseti value shrinks the shadow and a
negative hoffseti value enlarges the shadow. The {hstepi} value describes a shrink offset
used for the combination of the partial shadows. The shadow is filled along a TikZ path
with the given TikZ hoptionsi but any opacity value will be ignored.
\tcbset{enhanced,colback=red!5!white,
colframe=red!75!black,fonttitle=\bfseries}
\newtcolorbox{mybox}[1][]{enhanced,
fuzzy shadow={1.0mm}{-1.0mm}{0.12mm}{0mm}{blue!50!white},
fuzzy shadow={-1.0mm}{-1.0mm}{0.12mm}{0mm}{red!50!white},
fuzzy shadow={-1.0mm}{1.0mm}{0.12mm}{0mm}{green!50!white},
fuzzy shadow={1.0mm}{1.0mm}{0.12mm}{0mm}{yellow!50!white},#1
}
This is a tcolorbox.
189
N 2015-05-05 /tcb/smart shadow arc=true|false (default true, initially true)
If set to true, the shadow drawing algorithm tries to do a somewhat smart calculation of
the arc for the shadow. The result is pleasing for typical boxes with rounded corners, but
gives strange results for circular boxes.
\tcbset{enhanced,nobeforeafter,colback=red!5!white,
colframe=red!75!black,width=3cm,square,halign=center,valign=center
}
\begin{tcolorbox}[drop shadow]
Smart shadow arc (arguably better than normal)
\end{tcolorbox}
\hfill
\begin{tcolorbox}[smart shadow arc=false, drop shadow]
Normal shadow arc
\end{tcolorbox}
\hfill
\begin{tcolorbox}[circular arc, drop shadow]
Smart shadow arc (worse than normal)
\end{tcolorbox}
\hfill
\begin{tcolorbox}[circular arc, smart shadow arc=false, drop shadow]
Normal shadow arc
\end{tcolorbox}
Smart
Smart
shadow arc
Normal shadow arc Normal
(arguably
shadow arc (worse than shadow arc
better than
normal)
normal)
\tcbset{enhanced,colback=red!5!white,
boxrule=0.1pt,
colframe=red!75!black,fonttitle=\bfseries}
My own shadow
\begin{tcolorbox}[title=My own shadow,
lifted shadow={1mm}{-2mm}{3mm}{0.1mm}% This is a tcolorbox.
{black!50!white}]
This is a tcolorbox.
\end{tcolorbox}
190
10.6.4 TikZ Shadows
Alternativ to the package shadow options described before, shadows from the «Shadows Library»
of TikZ can be used. Such shadows can be added directly to the frame path using /tcb/frame
styleÕ P. 148 .
% \usetikzlibrary{shadows}
\begin{tcolorbox}[enhanced,
colback=red!5!white,colframe=red!75!black,
This is a tcolorbox.
frame style={drop shadow} ]
This is a tcolorbox.
\end{tcolorbox}
% \usetikzlibrary{shadows}
\begin{tcolorbox}[enhanced,height=3cm,
colback=red!5!white,colframe=red!75!black,
halign=center,valign=center, This is a tcolorbox.
frame style={circular drop shadow} ]
This is a tcolorbox.
\end{tcolorbox}
% \usetikzlibrary{shadows}
\begin{tcolorbox}[enhanced,width=2.5cm,
square,circular arc,
halign=center,valign=center,
tcolorbox
colback=red!5!white,colframe=red!75!black,
frame style={circular glow={fill=red}} ]
tcolorbox
\end{tcolorbox}
191
10.7 TikZ Picture Option Keys
The following general options are applicable for skins which use tikzpicture as
/tcb/graphical environmentÕ P. 135 . Therefore, the skin standardÕ P. 204 does not support
these options, but most other skins, e. g. enhancedÕ P. 206 .
/tcb/tikz=htikz option listi (no default, initially empty)
Adds the given htikz option listi to the main tikzpicture environment used to draw the
color box, see [22]. If this option is applied a second time, the new htikz option listi is
appended to the current option list.
\tcbset{enhanced,colback=red!5!white,
colframe=red!75!black,fonttitle=\bfseries}
Transparent box
\begin{tcolorbox}[title=Transparent box,
tikz={opacity=0.5,transparency group}] This is a tcolorbox.
This is a tcolorbox.
\end{tcolorbox}
\tcbset{enhanced,colback=red!5!white,
colframe=red!75!black,fonttitle=\bfseries,
x
fontupper=\bfseries\Huge, bo
!
d
d
halign title=center,halign=center} te
l
ta
Ro
\begin{tcolorbox}[title=Rotated box,
tikz={rotate=30}] S o
Sold!
\end{tcolorbox}
192
/tcb/rotate=hanglei (no default, initially unset)
Rotates the tcolorbox by the given hanglei. Note that this is a TikZ coordinate transfor-
mation i.e. not all graphical elements like shadings will really be rotated.
\tcbset{enhanced,colback=red!5!white,
colframe=red!75!black,fonttitle=\bfseries} x
bo x.
te d r bo
\begin{tcolorbox}[title=Rotated box,rotate=30] ta l o
Ro tco
This is a tcolorbox. i sa
\end{tcolorbox} is
Th
\tcbset{enhanced,colback=red!5!white,
colframe=red!75!black,fonttitle=\bfseries} Scaled box
This is a tcolorbox.
\begin{tcolorbox}[title=Scaled box,scale=0.5]
This is a tcolorbox. Scaled box
\end{tcolorbox}
\begin{tcolorbox}[title=Scaled box,scale=1.25] This is a tcolorbox.
This is a tcolorbox.
\end{tcolorbox}
\begin{tcolorbox}[enhanced,remember,colback=red!5!white,colframe=red!75!black,
fonttitle=\bfseries,title=The four corners of a paper,
overlay={\draw[red!50!white,line width=1mm,opacity=0.5,shorten >=3mm]
(frame.north west) edge[->] (current page.north west)
(frame.north east) edge[->] (current page.north east)
(frame.south west) edge[->] (current page.south west)
(frame.south east) edge[->] (current page.south east);}]
This is a tcolorbox.
\end{tcolorbox}
This is a tcolorbox.
193
/tcb/remember as=hnamei (style, no default, initially unset)
The frame node will be remembered by the given hnamei to be referenced in other TikZ
pictures.
% \usepackage{lipsum}
\newtcolorbox{mybox}[1][]{enhanced,colframe=blue!75!black,colback=blue!10!white,
fonttitle=\bfseries,#1}
\lipsum[2]
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem non justo.
Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet, tortor sed accumsan
D bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi. Morbi ac orci et nisl hendrerit C
mollis. Suspendisse ut massa. Cras nec ante. Pellentesque a nulla. Cum sociis natoque penatibus et
magnis dis parturient montes, nascetur ridiculus mus. Aliquam tincidunt urna. Nulla ullamcorper
vestibulum turpis. Pellentesque cursus luctus mauris.
Fourth Box
This is a test.
194
10.8 Underlay Option Keys
Underlays are quite similar to overlays described in Section 4.12 on page 71. Underlays are
drawn after the frame and interior are drawn and before overlays and the text content is drawn;
see Section 9.4 on page 142 for the general drawing scheme.
The differences between underlays and overlays are:
• Underlays are not applicable for the skins standardÕ P. 204 and standard jigsawÕ P. 205 ,
whereas overlays are applicable also for these skins. The skin spartanÕ P. 247 supports
underlays but no overlays.
• Underlays are stackable, i. e. several different underlays can be used on the same
tcolorbox. Overlays are not stackable by default (but with some help of the library
hooks ).
LIB
• Boxed titles are implemented with underlays (Section 10.2 on page 155), watermarks are
implemented with overlays (Section 10.3 on page 165).
/tcb/underlay=hgraphical codei (no default, initially unset)
Adds hgraphical codei to the box drawing process. This hgraphical codei is drawn after the
frame and interior and before the text content.
\newtcolorbox{mybox}[1][]{enhanced,colback=red!5!white,
colbacktitle=red!85!black!50!white,
colframe=red!75!black,fonttitle=\bfseries,watermark color=yellow!50!white,
underlay={\begin{tcbclipinterior}
\draw[red!40!white,line width=1cm] (interior.south west)--(interior.north east);
\end{tcbclipinterior}},
attach boxed title to top center={yshift=-2mm},#1}
My box
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem non
justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet, tortor
My Watermark
sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi. Morbi ac
orci et nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque a nulla. Cum
sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam
tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus luctus mauris.
195
/tcb/underlay broken=hgraphical codei (no default, initially unset)
If the box is set to be /tcb/breakableÕ P. 365 and is broken actually, then the hgraphical
codei is added to the box drawing process. /tcb/underlayÕ P. 195 overwrites this key.
/tcb/underlay unbroken=hgraphical codei (no default, initially unset)
If the box is set to be /tcb/breakableÕ P. 365 but is not broken actually or if the box is
set to be /tcb/unbreakableÕ P. 366 , then the hgraphical codei is added to the box drawing
process. /tcb/underlayÕ P. 195 overwrites this key.
/tcb/no underlay unbroken (style, no default, initially set)
Removes the unbroken underlay if set before.
/tcb/underlay first=hgraphical codei (no default, initially unset)
If the box is set to be /tcb/breakable Õ P. 365 and is broken actually, then the hgraphical
codei is added to the box drawing process for the first part of the break sequence.
/tcb/underlayÕ P. 195 overwrites this key.
/tcb/no underlay first (style, no default, initially set)
Removes the first underlay if set before.
/tcb/underlay middle=hgraphical codei (no default, initially unset)
If the box is set to be /tcb/breakable Õ P. 365 and is broken actually, then the hgraphical
codei is added to the box drawing process for the middle parts (if any) of the break sequence.
/tcb/underlayÕ P. 195 overwrites this key.
/tcb/no underlay middle (style, no default, initially set)
Removes the middle underlay if set before.
/tcb/underlay last=hgraphical codei (no default, initially unset)
If the box is set to be /tcb/breakableÕ P. 365 and is broken actually, then the hgraphical
codei is added to the box drawing process for the last part of the break sequence.
/tcb/underlayÕ P. 195 overwrites this key.
/tcb/no underlay last (style, no default, initially set)
Removes the last underlay if set before.
/tcb/underlay boxed title=hgraphical codei (no default, initially unset)
If the box has a boxed title, see Section 10.2 on page 155, then the hgraphical codei is added
to the box drawing process before the boxed title is drawn.
/tcb/no underlay boxed title (style, no default, initially set)
Removes the boxed title underlay if set before.
/tcb/underlay unbroken and first=hgraphical codei (no default, initially unset)
This is an abbreviation for setting /tcb/underlay unbroken and /tcb/underlay first
together. /tcb/underlayÕ P. 195 overwrites this key.
/tcb/underlay middle and last=hgraphical codei (no default, initially unset)
This is an abbreviation for setting /tcb/underlay middle and /tcb/underlay last to-
gether. /tcb/underlayÕ P. 195 overwrites this key.
/tcb/underlay unbroken and last=hgraphical codei (no default, initially unset)
This is an abbreviation for setting /tcb/underlay unbroken and /tcb/underlay last
together. /tcb/underlayÕ P. 195 overwrites this key.
N 2014-09-19 /tcb/underlay first and middle=hgraphical codei (no default, initially unset)
This is an abbreviation for setting /tcb/underlay first and /tcb/underlay middle to-
gether. /tcb/underlayÕ P. 195 overwrites this key.
196
10.9 Finish Option Keys
Finishes are quite similar to underlays described in Section 10.8 on page 195 and overlays
described in Section 4.12 on page 71. Finishes are drawn after the text content is drawn; see
Section 9.4 on page 142 for the general drawing scheme. Therefore, a finish will reduce the
readability of the text content.
Finishes are intended for special effects like highlights or glosses or text over text.
• Finishes are only applicable for the skins enhancedÕ P. 206 , emptyÕ P. 237 , freelanceÕ P. 250 ,
bicolorÕ P. 219 , beamerÕ P. 228 , and widgetÕ P. 233 .
• Finishes are stackable, i. e. several different finishes can be used on the same tcolorbox.
/tcb/finish=hgraphical codei (no default, initially unset)
Adds hgraphical codei to the box drawing process. This hgraphical codei is drawn after the
text content.
\newtcolorbox{mybox}[1][]{enhanced,colback=red!5!white,
colbacktitle=red!85!black!50!white,colframe=red!75!black,fonttitle=\bfseries,
finish={\begin{tcbclipframe}
\path[bottom color=black,top color=black!50!white,opacity=0.1]
(frame.south west) -- (frame.south east) -- (frame.north east) -- cycle;
\path[top color=white,bottom color=black!50!white,opacity=0.1]
(frame.south west) -- (frame.north east) -- (frame.north west) -- cycle;
\end{tcbclipframe}},#1}
\begin{mybox}[title=My box]
\lipsum[2]
\end{mybox}
My box
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem non
justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet, tortor
sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi. Morbi ac
orci et nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque a nulla. Cum
sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam
tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus luctus mauris.
\newtcolorbox{mybox}[1][]{enhanced,colback=red!5!white,
colbacktitle=red!85!black!50!white,colframe=red!75!black,fonttitle=\bfseries,
finish={\node[draw,fill=white,fill opacity=0.85,inner sep=5mm,
rounded corners] at (frame.center) {\Huge\bfseries Finish!};},#1}
\begin{mybox}[title=My box]
\lipsum[2]
\end{mybox}
My box
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem non
Finish!
justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet, tortor
sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi. Morbi ac
orci et nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque a nulla. Cum
sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam
tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus luctus mauris.
197
/tcb/no finish (style, no default, initially set)
Removes the finish if set before.
/tcb/finish broken=hgraphical codei (no default, initially unset)
If the box is set to be /tcb/breakable Õ P. 365 and is broken actually, then the hgraphical
codei is added to the box drawing process. /tcb/finishÕ P. 197 overwrites this key.
/tcb/finish unbroken=hgraphical codei (no default, initially unset)
If the box is set to be /tcb/breakable Õ P. 365 but is not broken actually or if the box is
set to be /tcb/unbreakableÕ P. 366 , then the hgraphical codei is added to the box drawing
process. /tcb/finishÕ P. 197 overwrites this key.
/tcb/no finish unbroken (style, no default, initially set)
Removes the unbroken finish if set before.
/tcb/finish first=hgraphical codei (no default, initially unset)
If the box is set to be /tcb/breakableÕ P. 365 and is broken actually, then the hgraphical
codei is added to the box drawing process for the first part of the break sequence.
/tcb/finishÕ P. 197 overwrites this key.
/tcb/no finish first (style, no default, initially set)
Removes the first finish if set before.
/tcb/finish middle=hgraphical codei (no default, initially unset)
If the box is set to be /tcb/breakableÕ P. 365 and is broken actually, then the hgraphical
codei is added to the box drawing process for the middle parts (if any) of the break sequence.
/tcb/finishÕ P. 197 overwrites this key.
/tcb/no finish middle (style, no default, initially set)
Removes the middle finish if set before.
/tcb/finish last=hgraphical codei (no default, initially unset)
If the box is set to be /tcb/breakable Õ P. 365 and is broken actually, then the hgraphical
codei is added to the box drawing process for the last part of the break sequence.
/tcb/finishÕ P. 197 overwrites this key.
/tcb/no finish last (style, no default, initially set)
Removes the last finish if set before.
/tcb/finish unbroken and first=hgraphical codei (no default, initially unset)
This is an abbreviation for setting /tcb/finish unbroken and /tcb/finish first to-
gether. /tcb/finishÕ P. 197 overwrites this key.
/tcb/finish middle and last=hgraphical codei (no default, initially unset)
This is an abbreviation for setting /tcb/finish middle and /tcb/finish last together.
/tcb/finishÕ P. 197 overwrites this key.
/tcb/finish unbroken and last=hgraphical codei (no default, initially unset)
This is an abbreviation for setting /tcb/finish unbroken and /tcb/finish last to-
gether. /tcb/finishÕ P. 197 overwrites this key.
N 2014-09-19 /tcb/finish first and middle=hgraphical codei (no default, initially unset)
This is an abbreviation for setting /tcb/finish first and /tcb/finish middle together.
/tcb/finishÕ P. 197 overwrites this key.
198
10.10 Hyper Option Keys
All options of this section need the package hyperref [15] to be loaded separately. All these
options are implemented as /tcb/finishÕ P. 197 and can be disabled by /tcb/no finishÕ P. 198 .
! If the package hyperref [15] is not loaded or if the standardÕ P. 204 skin is used, all hyper
option are silently ignored.
% \section{Library skins}\label{sec:skins}%
\begin{tcolorbox}[beamer,colback=red!50,
Jump to the heading
hyperref=sec:skins]
of Section 10.
Jump to the heading of Section~\ref*{sec:skins}.
\end{tcolorbox}
% \section{Library skins}\label{sec:skins}%
\begin{tcolorbox}[enhanced,colback=yellow!10,
underlay={\node[red,fill=red!30,inner sep=3mm] Jump to the head-
(click) at (frame.center) {X};}, ing of Section 10
hyperref node={sec:skins}{click}] (X marksX the click
Jump to the heading of Section~\ref*{sec:skins} point).
(X marks the click point).
\end{tcolorbox}
% \usepackage{hyperref}%
\begin{tcolorbox}[enhanced,
colback=blue!10,colframe=blue!50!black, Box B
hypertarget=hypertwinB,
hyperlink=hypertwinA, Click me to jump to
title=Box B] Box A.
Click me to jump to Box A.
\end{tcolorbox}
199
N 2017-02-03 /tcb/hyperlink interior=hmarkeri (no default, initially unset)
Identical to /tcb/hyperlinkÕ P. 199 , but only the interior of a tcolorbox is made a hyper-
link (without frame and title).
N 2017-02-03 /tcb/hyperlink title=hmarkeri (no default, initially unset)
Identical to /tcb/hyperlinkÕ P. 199 , but only the title of a tcolorbox is made a hyperlink.
N 2017-02-03 /tcb/hyperlink node={hmarkeri}{hnodei} (no default, initially unset)
Identical to /tcb/hyperlink Õ P. 199 , but only the given TikZ hnodei is made a hyperlink.
This hnodei may be frame, interior, title, or any other named node used for drawing the
tcolorbox. The hnodei may be defined inside /tcb/underlayÕ P. 195 , /tcb/overlayÕ P. 71
or /tcb/finishÕ P. 197 . If the later is used, define the node before /tcb/hyperlink node
is applied.
N 2017-02-03 /tcb/hyperurl=hurli (no default, initially unset)
The whole frame of a tcolorbox is make an active hyperlink for an hurli in the same manner
as using \href or \url. Such, the tcolorbox is made a clickable button (depending on the
previewer).
\begin{tcolorbox}[enhanced,colback=red!50,
hyperurl=http://www.ctan.org/pkg/tcolorbox] View CTAN with a
View CTAN with a browser. browser.
\end{tcolorbox}
\begin{tcolorbox}[enhanced,colback=green!50,
hyperurl*={page=3,pdfnewwindow=true}%
Open example file
{tcolorbox-example.pdf}]
on Page 3.
Open example file on Page~3.
\end{tcolorbox}
200
10.11 Jigsaw Skin Variants
As described in Section 9.1 on page 134, a tcolorbox is drawn by up to four engines. Typically,
the frame engine fills the complete box area with color and the other engines fill certain areas
with other colors. Finally, only the area which you see as frame of the box will display the frame
color. For most applications, this is a good approach.
For certain boxes, a more delicate procedure is needed. E.g., if the box should be translucent,
an already painted area cannot be made unpainted. Therefore, more elaborate frame engines
saw holes into the frame where the interior area and optionally the title area will be painted.
The resulting skins are called jigsaw skins. For standardÕ P. 204 and enhancedÕ P. 206 , there are
variants called standard jigsawÕ P. 205 and enhanced jigsawÕ P. 213 .
\newcommand{\ballexample}{\begin{tikzpicture}
\path[use as bounding box] (0,0.8) rectangle +(0.1,0.1);
\shadedraw [shading=ball] (0,0) circle (1cm);
\shadedraw [ball color=red] (3,-2.2) circle (1cm);
\end{tikzpicture}}
\tcbset{enhanced,colback=blue!5!white,
frame style={left color=red!75!black,right color=red!10!yellow},
fonttitle=\bfseries }
\ballexample
\ballexample
A normal box
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem non justo.
Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet, tortor sed accum-
san bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi. Morbi ac orci et nisl
hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque a nulla. Cum sociis natoque
penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam tincidunt urna. Nulla
ullamcorper vestibulum turpis. Pellentesque cursus luctus mauris.
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem non justo.
Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet, tortor sed accum-
san bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi. Morbi ac orci et nisl
hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque a nulla. Cum sociis natoque
penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam tincidunt urna. Nulla
ullamcorper vestibulum turpis. Pellentesque cursus luctus mauris.
201
\tcbset{enhanced,colback=red!10!white,coltitle=black,
frame style={left color=red!75!black,right color=red!10!yellow},
fonttitle=\bfseries,interior hidden,title hidden}
\begin{tcolorbox}[enhanced jigsaw,
title=A jigsaw box with hidden interior and title]
This is a tcolorbox.
\end{tcolorbox}
This is a tcolorbox.
This is a tcolorbox.
\newtcolorbox{mybox}{skin=enhancedmiddle jigsaw,leftrule=5mm,rightrule=5mm,
boxsep=0mm,top=0mm,bottom=0mm,
frame style={top color=blue,bottom color=red},interior hidden}
\begin{mybox}
\lipsum[2]
\end{mybox}
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem non
justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet, tortor
sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi. Morbi ac
orci et nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque a nulla. Cum
sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam
tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus luctus mauris.
202
10.12 Draft Mode
To reduce the compiliation time while drafting a document, the draft mode can be applied.
Basically, it changes all skins to spartanÕ P. 247 and sets the /tcb/fit algorithmÕ P. 419 to
squeeze. Especially, when fuzzy shadows are used, the speedup will be considerable high.
It is strongly recommended that the draft mode is not used for the final document. Use
! spartanÕ P. 247 directly, if you want to stay with it. The draft mode implementation may
change in future.
Normally, switching to the draft mode should not alter the geometry of your document.
Since overlays are deactivated, any code placed there (e.g. counter changes) is not executed
! anymore! Also, /tcb/remember asÕ P. 194 will not have any effect. You may exclude critical
code with \tcbinterruptdraftmode / \tcbcontinuedraftmode from converting to draft
mode.
\tcbstartdraftmode
Any following tcolorbox code is put into draft mode. All skin settings are overruled with
spartanÕ P. 247 . Overlays, watermarks, shadows, borderlines, and rounded corners are de-
activated for all tcolorbox layers.
\tcbstopdraftmode
The draft mode is deactivated for the following code.
\tcbinterruptdraftmode
If the compilation is in draft mode, the draft mode is deactivated until a following
\tcbcontinuedraftmode is detected.
If the compilation is not in draft mode, nothing happens and a following
\tcbcontinuedraftmode will not start the draft mode.
! nested.
The pair \tcbinterruptdraftmode and \tcbcontinuedraftmode cannot be used
\tcbcontinuedraftmode
Continues the draft mode which was suspended by a preceding \tcbinterruptdraftmode.
Nothing happens, if there was no draft mode before \tcbinterruptdraftmode.
\newtcolorbox{mybeamer}[2][]{beamer,colback=Salmon!50!white,
colframe=FireBrick!75!black,adjusted title={#2},#1}
\begin{mybeamer}{Beamer box}
This box looks like a box provided by the \texttt{beamer} class.
\end{mybeamer}\par\medskip
\begin{mybeamer}[draftmode]{Beamer box}
This box looks like a box provided by the \texttt{beamer} class.
\end{mybeamer}
Beamer box
Beamer box
203
10.13 Skin Family ’standard’
Note that the option keys /tcb/frame styleÕ P. 148 , /tcb/interior styleÕ P. 149 ,
! /tcb/segmentation styleÕ P. 151 , and /tcb/title styleÕ P. 151 are not be applicable to
the standard skin. Also, watermarks (see Subsection 10.3) are not usable with the standard
skin.
/tcb/skin=standard (skin)
This is the standard skin from the core package. All drawing engines are set to type
standard. The drawing is based on pgf commands and does not need the tikz package.
Environment and engines for the skin ’standard’
More content.
204
/tcb/skin=standard jigsaw (skin)
This is the standard jigsaw skin from the core package. It differs from the skin
standardÕ P. 204 by its frame engine, see Section 10.11 on page 201.
Environment and engines for the skin ’standard jigsaw’
More content.
205
10.14 Skin Family ’enhanced’
/tcb/skin=enhanced (skin)
This skin translates the drawing commands of the core package into tikz path com-
mands. Therefore, it allows all tikz high level options for these paths and has
more flexibility compared to the standardÕ P. 204 skin. You pay for this with some
prolonged compilation time. The tikz path options can be given with the op-
tion keys /tcb/frame style Õ P. 148 , /tcb/interior styleÕ P. 149 , /tcb/segmentation
More content.
206
% \usetikzlibrary{shadings} % preamble
\tcbset{skin=enhanced,fonttitle=\bfseries,
frame style={upper left=blue,upper right=red,lower left=yellow,lower right=green},
interior style={white,opacity=0.5},
segmentation style={black,solid,opacity=0.2,line width=1pt}}
With the ’enhanced’ skin, it is quite easy to produce fancy looking effects.
% \usetikzlibrary{decorations.pathmorphing} % preamble
\tcbset{skin=enhanced,fonttitle=\bfseries,boxrule=1mm,
frame style={draw=FireBrick,fill=Salmon},drop fuzzy shadow,
interior style={draw=FireBrick,top color=Salmon!10,bottom color=Salmon!20},
segmentation style={draw=FireBrick,solid,decorate,
decoration={coil,aspect=0,segment length=10.1mm}}}
207
/tcb/enhanced standard (style, no value)
For unbreakable boxes, this is identical to using /tcb/enhancedÕ P. 206 . But, for breakable
boxes, the break sequence is identical to the standardÕ P. 204 skin, see Section 17.8 from
page 378.
/tcb/blank (style, initially unset)
This style relies on the skin enhancedÕ P. 206 . All drawing operations are hidden and all
margins are set to 0pt. See /tcb/blankerÕ P. 238 for switching off the drawing engines.
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, placerat
ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero, nonummy eget,
consectetuer id, vulputate a, magna. Donec vehicula augue eu neque. Pellentesque habitant morbi
A blank box
tristique senectus et netus et malesuada fames ac turpis egestas. Mauris ut leo. Cras viverra metus
rhoncus sem. Nulla et lectus vestibulum urna fringilla ultrices. Phasellus eu tellus sit amet tortor
gravida placerat. Integer sapien est, iaculis in, pretium quis, viverra ac, nunc. Praesent eget sem
vel leo ultrices bibendum. Aenean faucibus. Morbi dolor nulla, malesuada eu, pulvinar at, mollis
ac, nulla. Curabitur auctor semper nulla. Donec varius orci eget risus. Duis nibh mi, congue eu,
accumsan eleifend, sagittis quis, diam. Duis eget orci sit amet orci dignissim rutrum.
208
\tcbline
Sometimes, a line is only a line. With \tcblowerÕ P. 12 you separate the box content into two
functional units. \tcbline draws only a line which looks like the segmentation line between
upper and lower part. Furthermore, you can use \tcbline more than just once. \tcbline
always uses the path drawing engine. Therefore, the /tcb/segmentation styleÕ P. 151 can
be applied.
\tcbset{enhanced,colframe=blue!50!black,colback=white}
\begin{tcolorbox}[colupper=red!50!black,collower=green!50!black]
\lipsum[1]
\tcbline
\lipsum[2]
\tcblower
\lipsum[3]
\tcbline
\lipsum[4]
\end{tcolorbox}
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, plac-
erat ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero, nonummy
eget, consectetuer id, vulputate a, magna. Donec vehicula augue eu neque. Pellentesque habi-
tant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Mauris ut leo.
Cras viverra metus rhoncus sem. Nulla et lectus vestibulum urna fringilla ultrices. Phasellus
eu tellus sit amet tortor gravida placerat. Integer sapien est, iaculis in, pretium quis, viverra
ac, nunc. Praesent eget sem vel leo ultrices bibendum. Aenean faucibus. Morbi dolor nulla,
malesuada eu, pulvinar at, mollis ac, nulla. Curabitur auctor semper nulla. Donec varius
orci eget risus. Duis nibh mi, congue eu, accumsan eleifend, sagittis quis, diam. Duis eget
orci sit amet orci dignissim rutrum.
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem non
justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet, tortor
sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi. Morbi ac
orci et nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque a nulla. Cum
sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam
tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus luctus mauris.
Nulla malesuada porttitor diam. Donec felis erat, congue non, volutpat at, tincidunt tris-
tique, libero. Vivamus viverra fermentum felis. Donec nonummy pellentesque ante. Phasellus
adipiscing semper elit. Proin fermentum massa ac quam. Sed diam turpis, molestie vitae,
placerat a, molestie nec, leo. Maecenas lacinia. Nam ipsum ligula, eleifend at, accumsan
nec, suscipit a, ipsum. Morbi blandit ligula feugiat magna. Nunc eleifend consequat lorem.
Sed lacinia nulla vitae enim. Pellentesque tincidunt purus vel magna. Integer non enim.
Praesent euismod nunc eu purus. Donec bibendum quam in tellus. Nullam cursus pulvinar
lectus. Donec et mi. Nam vulputate metus eu enim. Vestibulum pellentesque felis eu massa.
Quisque ullamcorper placerat ipsum. Cras nibh. Morbi vel justo vitae lacus tincidunt ul-
trices. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. In hac habitasse platea
dictumst. Integer tempus convallis augue. Etiam facilisis. Nunc elementum fermentum wisi.
Aenean placerat. Ut imperdiet, enim sed gravida sollicitudin, felis odio placerat quam, ac
pulvinar elit purus eget enim. Nunc vitae tortor. Proin tempus nibh sit amet nisl. Vivamus
quis tortor vitae risus porta vehicula.
\tcbline*
Equivalent to \tcbline, but in a breakable box, \tcbline* is removed if at a page/box
break. Also, it is removed at the end of a box.
209
/tcb/skin=enhancedfirst (skin)
This is a flavor of enhancedÕ P. 206 which is used as a first part in a break sequence for
enhancedÕ P. 206 . Nevertheless, this skin can be applied independently.
Environment and engines for the skin ’enhancedfirst’
More content.
210
/tcb/skin=enhancedmiddle (skin)
This is a flavor of enhancedÕ P. 206 which is used as a middle part in a break sequence for
enhancedÕ P. 206 . Nevertheless, this skin can be applied independently.
Environment and engines for the skin ’enhancedmiddle’
More content.
211
/tcb/skin=enhancedlast (skin)
This is a flavor of enhancedÕ P. 206 which is used as a last part in a break sequence for
enhancedÕ P. 206 . Nevertheless, this skin can be applied independently.
Environment and engines for the skin ’enhancedlast’
More content.
212
/tcb/skin=enhanced jigsaw (skin)
This is the jigsaw variant of skin enhancedÕ P. 206 . It differs by its frame engine, see Sec-
tion 10.11 on page 201.
Environment and engines for the skin ’enhanced jigsaw’
More content.
213
/tcb/skin=enhancedfirst jigsaw (skin)
This is the jigsaw variant of skin enhancedfirstÕ P. 210 . It differs by its frame engine, see
Section 10.11 on page 201.
Environment and engines for the skin ’enhancedfirst jigsaw’
More content.
214
/tcb/skin=enhancedmiddle jigsaw (skin)
This is the jigsaw variant of skin enhancedmiddleÕ P. 211 . It differs by its frame engine, see
Section 10.11 on page 201.
Environment and engines for the skin ’enhancedmiddle jigsaw’
More content.
\begin{tcolorbox}[marker]
\lipsum[2]
\end{tcolorbox}
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem non justo.
Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet, tortor sed accumsan
!
bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi. Morbi ac orci et nisl hendrerit
mollis. Suspendisse ut massa. Cras nec ante. Pellentesque a nulla. Cum sociis natoque penatibus et
magnis dis parturient montes, nascetur ridiculus mus. Aliquam tincidunt urna. Nulla ullamcorper
vestibulum turpis. Pellentesque cursus luctus mauris.
215
This examples demonstrates the creation of several text marker environments based on
enhancedmiddleÕ P. 211 .
\tcbset{textmarker/.style={%
skin=enhancedmiddle jigsaw,breakable,parbox=false,
boxrule=0mm,leftrule=5mm,rightrule=5mm,boxsep=0mm,arc=0mm,outer arc=0mm,
left=3mm,right=3mm,top=1mm,bottom=1mm,toptitle=1mm,bottomtitle=1mm,oversize}}
\newtcolorbox{yellow}{textmarker,colback=yellow!5!white,colframe=yellow}
\newtcolorbox{orange}{textmarker,colback=DarkOrange!5!white,
colframe=DarkOrange!75!yellow}
\newtcolorbox{red}{textmarker,colback=red!5!white,colframe=red}
\newtcolorbox{blue}{textmarker,colback=DeepSkyBlue!5!white,colframe=DeepSkyBlue}
\newtcolorbox{green}{textmarker,colback=Chartreuse!5!white,colframe=Chartreuse}
\newtcolorbox{rainbow}{textmarker,interior hidden,
frame style={top color=blue,bottom color=red,middle color=green}}
\begin{yellow}
\lipsum[1-3]
\end{yellow}
\begin{orange}
\lipsum[4]
\end{orange}
\begin{red}
\lipsum[5]
\end{red}
\begin{green}
\lipsum[6]
\end{green}
\begin{blue}
\lipsum[7]
\end{blue}
\begin{rainbow}
\lipsum[8]
\end{rainbow}
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, placerat
ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero, nonummy eget,
consectetuer id, vulputate a, magna. Donec vehicula augue eu neque. Pellentesque habitant
morbi tristique senectus et netus et malesuada fames ac turpis egestas. Mauris ut leo. Cras
viverra metus rhoncus sem. Nulla et lectus vestibulum urna fringilla ultrices. Phasellus eu tellus
sit amet tortor gravida placerat. Integer sapien est, iaculis in, pretium quis, viverra ac, nunc.
Praesent eget sem vel leo ultrices bibendum. Aenean faucibus. Morbi dolor nulla, malesuada
eu, pulvinar at, mollis ac, nulla. Curabitur auctor semper nulla. Donec varius orci eget risus.
Duis nibh mi, congue eu, accumsan eleifend, sagittis quis, diam. Duis eget orci sit amet orci
dignissim rutrum.
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem non
justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet, tortor sed
accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi. Morbi ac orci et
nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque a nulla. Cum sociis
natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam tincidunt
urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus luctus mauris.
Nulla malesuada porttitor diam. Donec felis erat, congue non, volutpat at, tincidunt tristique,
216
libero. Vivamus viverra fermentum felis. Donec nonummy pellentesque ante. Phasellus adip-
iscing semper elit. Proin fermentum massa ac quam. Sed diam turpis, molestie vitae, placerat
a, molestie nec, leo. Maecenas lacinia. Nam ipsum ligula, eleifend at, accumsan nec, suscipit a,
ipsum. Morbi blandit ligula feugiat magna. Nunc eleifend consequat lorem. Sed lacinia nulla
vitae enim. Pellentesque tincidunt purus vel magna. Integer non enim. Praesent euismod nunc
eu purus. Donec bibendum quam in tellus. Nullam cursus pulvinar lectus. Donec et mi. Nam
vulputate metus eu enim. Vestibulum pellentesque felis eu massa.
Quisque ullamcorper placerat ipsum. Cras nibh. Morbi vel justo vitae lacus tincidunt ultrices.
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. In hac habitasse platea dictumst.
Integer tempus convallis augue. Etiam facilisis. Nunc elementum fermentum wisi. Aenean
placerat. Ut imperdiet, enim sed gravida sollicitudin, felis odio placerat quam, ac pulvinar elit
purus eget enim. Nunc vitae tortor. Proin tempus nibh sit amet nisl. Vivamus quis tortor vitae
risus porta vehicula.
Fusce mauris. Vestibulum luctus nibh at lectus. Sed bibendum, nulla a faucibus semper, leo velit
ultricies tellus, ac venenatis arcu wisi vel nisl. Vestibulum diam. Aliquam pellentesque, augue
quis sagittis posuere, turpis lacus congue quam, in hendrerit risus eros eget felis. Maecenas
eget erat in sapien mattis porttitor. Vestibulum porttitor. Nulla facilisi. Sed a turpis eu
lacus commodo facilisis. Morbi fringilla, wisi in dignissim interdum, justo lectus sagittis dui, et
vehicula libero dui cursus dui. Mauris tempor ligula sed lacus. Duis cursus enim ut augue. Cras
ac magna. Cras nulla. Nulla egestas. Curabitur a leo. Quisque egestas wisi eget nunc. Nam
feugiat lacus vel est. Curabitur consectetuer.
Suspendisse vel felis. Ut lorem lorem, interdum eu, tincidunt sit amet, laoreet vitae, arcu.
Aenean faucibus pede eu ante. Praesent enim elit, rutrum at, molestie non, nonummy vel, nisl.
Ut lectus eros, malesuada sit amet, fermentum eu, sodales cursus, magna. Donec eu purus.
Quisque vehicula, urna sed ultricies auctor, pede lorem egestas dui, et convallis elit erat sed
nulla. Donec luctus. Curabitur et nunc. Aliquam dolor odio, commodo pretium, ultricies non,
pharetra in, velit. Integer arcu est, nonummy in, fermentum faucibus, egestas vel, odio.
Sed commodo posuere pede. Mauris ut est. Ut quis purus. Sed ac odio. Sed vehicula hendrerit
sem. Duis non odio. Morbi ut dui. Sed accumsan risus eget odio. In hac habitasse platea
dictumst. Pellentesque non elit. Fusce sed justo eu urna porta tincidunt. Mauris felis odio,
sollicitudin sed, volutpat a, ornare ac, erat. Morbi quis dolor. Donec pellentesque, erat ac sagittis
semper, nunc dui lobortis purus, quis congue purus metus ultricies tellus. Proin et quam. Class
aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos hymenaeos. Praesent
sapien turpis, fermentum vel, eleifend faucibus, vehicula eu, lacus.
Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.
Donec odio elit, dictum in, hendrerit sit amet, egestas sed, leo. Praesent feugiat sapien aliquet
odio. Integer vitae justo. Aliquam vestibulum fringilla lorem. Sed neque lectus, consectetuer
at, consectetuer sed, eleifend ac, lectus. Nulla facilisi. Pellentesque eget lectus. Proin eu metus.
Sed porttitor. In hac habitasse platea dictumst. Suspendisse eu lectus. Ut mi mi, lacinia sit
amet, placerat et, mollis vitae, dui. Sed ante tellus, tristique ut, iaculis eu, malesuada ac, dui.
Mauris nibh leo, facilisis non, adipiscing quis, ultrices a, dui.
217
/tcb/skin=enhancedlast jigsaw (skin)
This is the jigsaw variant of skin enhancedlastÕ P. 212 . It differs by its frame engine, see
Section 10.11 on page 201.
Environment and engines for the skin ’enhancedlast’
More content.
218
10.15 Skin Family ’bicolor’
/tcb/skin=bicolor (skin)
This skin is quite similar to the standardÕ P. 204 and enhancedÕ P. 206 skin. But instead of a
segmentation line, the optional lower part of the box is filled with a different color or drawn
with a different style.
Environment and engines for the skin ’bicolor’
• The most basic usage of this skin is to set the background color of the lower part by
/tcb/colbacklowerÕ P. 220 and all other options like for the standardÕ P. 204 skin.
\begin{tcolorbox}[skin=bicolor,title=The title,
colframe=FireBrick!75!black,colback=Salmon!50!white,colbacklower=Salmon]
The upper part.
\tcblower
The lower part.
\end{tcolorbox}
The title
• The more advanced usage of this skin is to apply the /tcb/frame styleÕ P. 148
and the /tcb/interior styleÕ P. 149 like for the enhancedÕ P. 206 skin. Also, the
/tcb/segmentation styleÕ P. 151 can be used, but it is applied to the whole lower
part.
\begin{tcolorbox}[skin=bicolor,title=The title,
frame style={top color=FireBrick,
bottom color=FireBrick!15!white,draw=black},
interior style={left color=Salmon,right color=Salmon!50!white},
segmentation style={right color=Salmon,left color=Salmon!50!white}]
The upper part.
\tcblower
The lower part.
\end{tcolorbox}
The title
219
\begin{tcbraster}[bicolor,raster equal height,raster columns=4,
colback=LightGreen,colframe=DarkGreen,colbacklower=LimeGreen!75!LightGreen,
colbacktitle=LimeGreen!75!DarkGreen,
left=1mm,right=1mm,top=1mm,bottom=1mm,middle=1mm]
\begin{tcolorbox}
This is my content.
\end{tcolorbox}
\begin{tcolorbox}
This is my content.
\tcblower
More content.
\end{tcolorbox}
\begin{tcolorbox}[adjusted title=My title]
This is my content.
\end{tcolorbox}
\begin{tcolorbox}[adjusted title=My title]
This is my content.
\tcblower
More content.
\end{tcolorbox}
\end{tcbraster}
More content.
git commit
git commit -a
git commit - am ' changes to my example '
The option ’-a’ automatically stages all tracked and modified files before the commit.
This can be combined with the message option ’-m’ as seen in the third line.
220
/tcb/skin=bicolorfirst (skin)
This is a flavor of bicolorÕ P. 219 which is used as a first part in a break sequence for
bicolorÕ P. 219 . Nevertheless, this skin can be applied independently.
Environment and engines for the skin ’bicolorfirst’
More content.
221
/tcb/skin=bicolormiddle (skin)
This is a flavor of bicolorÕ P. 219 which is used as a middle part in a break sequence for
bicolorÕ P. 219 . Nevertheless, this skin can be applied independently.
Environment and engines for the skin ’bicolormiddle’
More content.
222
/tcb/skin=bicolorlast (skin)
This is a flavor of bicolorÕ P. 219 which is used as a last part in a break sequence for
bicolorÕ P. 219 . Nevertheless, this skin can be applied independently.
Environment and engines for the skin ’bicolorlast’
More content.
223
10.16 Skin Family ’tile’
N 2016-02-25 /tcb/skin=tile (skin)
This skin is a variant of skin bicolorÕ P. 219 . Especially, the optional lower part of the
box is colored by /tcb/colbacklowerÕ P. 220 . The main difference to bicolorÕ P. 219 is that
tile has no frame.
Environment and engines for the skin ’tile’
More content.
224
N 2016-02-25 /tcb/skin=tilefirst (skin)
This is a flavor of tileÕ P. 224 which is used as a first part in a break sequence for tileÕ P. 224 .
Nevertheless, this skin can be applied independently.
Environment and engines for the skin ’tilefirst’
More content.
225
N 2016-02-25 /tcb/skin=tilemiddle (skin)
This is a flavor of tileÕ P. 224 which is used as a middle part in a break sequence for
tileÕ P. 224 . Nevertheless, this skin can be applied independently.
Environment and engines for the skin ’tilemiddle’
More content.
226
N 2016-02-25 /tcb/skin=tilelast (skin)
This is a flavor of tileÕ P. 224 which is used as a last part in a break sequence for tileÕ P. 224 .
Nevertheless, this skin can be applied independently.
Environment and engines for the skin ’tilelast’
More content.
227
10.17 Skin Family ’beamer’
/tcb/skin=beamer (skin)
This skin resembles boxes known from the beamer class and therefore is called ’beamer’. It
uses the normal colors from the core package but shades them a little bit. To use this skin,
the tikz library shadings has to be included in the preamble by:
\usetikzlibrary{shadings}
More content.
228
\begin{tcolorbox}[beamer,colback=Salmon!50!white,colframe=FireBrick!75!black,
adjusted title=A colored box with the 'beamer' skin]
This box looks like a box provided by the \texttt{beamer} class.
\end{tcolorbox}
\begin{tcolorbox}[beamer,colframe=blue,colback=black,
watermark graphics=lichtspiel.jpg,
coltext=white,watermark opacity=0.75,watermark stretch=1.0,
title=Beamer Box with background picture]
\lipsum[1]
\end{tcolorbox}
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, placerat
ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero, nonummy eget,
consectetuer id, vulputate a, magna. Donec vehicula augue eu neque. Pellentesque habitant morbi
tristique senectus et netus et malesuada fames ac turpis egestas. Mauris ut leo. Cras viverra metus
rhoncus sem. Nulla et lectus vestibulum urna fringilla ultrices. Phasellus eu tellus sit amet tortor
gravida placerat. Integer sapien est, iaculis in, pretium quis, viverra ac, nunc. Praesent eget sem
vel leo ultrices bibendum. Aenean faucibus. Morbi dolor nulla, malesuada eu, pulvinar at, mollis
ac, nulla. Curabitur auctor semper nulla. Donec varius orci eget risus. Duis nibh mi, congue eu,
accumsan eleifend, sagittis quis, diam. Duis eget orci sit amet orci dignissim rutrum.
\newtcolorbox{myblock}[2][]{%
beamer,breakable,colback=LightBlue,colframe=DarkBlue,#1,title=#2}%
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, placerat
ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero, nonummy eget,
consectetuer id, vulputate a, magna. Donec vehicula augue eu neque. Pellentesque habitant morbi
tristique senectus et netus et malesuada fames ac turpis egestas. Mauris ut leo. Cras viverra metus
rhoncus sem. Nulla et lectus vestibulum urna fringilla ultrices. Phasellus eu tellus sit amet tortor
gravida placerat. Integer sapien est, iaculis in, pretium quis, viverra ac, nunc. Praesent eget sem
vel leo ultrices bibendum. Aenean faucibus. Morbi dolor nulla, malesuada eu, pulvinar at, mollis
ac, nulla. Curabitur auctor semper nulla. Donec varius orci eget risus. Duis nibh mi, congue eu,
accumsan eleifend, sagittis quis, diam. Duis eget orci sit amet orci dignissim rutrum.
229
/tcb/skin=beamerfirst (skin)
This is a flavor of beamerÕ P. 228 which is used as a first part in a break sequence for
beamerÕ P. 228 . Nevertheless, this skin can be applied independently.
Environment and engines for the skin ’beamerfirst’
More content.
230
/tcb/skin=beamermiddle (skin)
This is a flavor of beamerÕ P. 228 which is used as a middle part in a break sequence for
beamerÕ P. 228 . Nevertheless, this skin can be applied independently.
Environment and engines for the skin ’beamermiddle’
More content.
231
/tcb/skin=beamerlast (skin)
This is a flavor of beamerÕ P. 228 which is used as a last part in a break sequence for
beamerÕ P. 228 . Nevertheless, this skin can be applied independently.
Environment and engines for the skin ’beamerlast’
More content.
232
10.18 Skin Family ’widget’
/tcb/skin=widget (skin)
This skin uses the normal colors from the core package but shades them a little bit. To use
this skin, the tikz library shadings has to be included in the preamble by:
\usetikzlibrary{shadings}
The appearance of the skin can be controlled by /tcb/frame styleÕ P. 148 , /tcb/interior
styleÕ P. 149 , and /tcb/segmentation styleÕ P. 151 , if needed.
Environment and engines for the skin ’widget’
More content.
233
\begin{tcolorbox}[widget,colback=Salmon!50!white,colframe=FireBrick!75!black,
adjusted title=A colored box with the 'widget' skin]
This is my content.
\end{tcolorbox}
This is my content.
/tcb/skin=widgetfirst (skin)
This is a flavor of widgetÕ P. 233 which is used as a first part in a break sequence for
widgetÕ P. 233 . Nevertheless, this skin can be applied independently.
Environment and engines for the skin ’widgetfirst’
More content.
234
/tcb/skin=widgetmiddle (skin)
This is a flavor of widgetÕ P. 233 which is used as a middle part in a break sequence for
widgetÕ P. 233 . Nevertheless, this skin can be applied independently.
Environment and engines for the skin ’widgetmiddle’
More content.
235
/tcb/skin=widgetlast (skin)
This is a flavor of widgetÕ P. 233 which is used as a last part in a break sequence for
widgetÕ P. 233 . Nevertheless, this skin can be applied independently.
Environment and engines for the skin ’widgetlast’
More content.
236
10.19 Skin Family ’empty’
/tcb/skin=empty (skin)
This skin sets all engines to empty, i. e. nothing is drawn at all. Therefore, this skin is a
good starting point to create a complete new style by yourself.
Environment and engines for the skin ’empty’
More content.
237
/tcb/blanker (style, initially unset)
This style relies on the skin emptyÕ P. 237 . All engines are set to empty and all margins are
set to 0pt. In contrast to /tcb/blankÕ P. 208 , the graphical paths are not constructed with
exception of the geometry nodes.
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, placerat
ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero, nonummy eget,
consectetuer id, vulputate a, magna. Donec vehicula augue eu neque. Pellentesque habitant morbi
A blank box
tristique senectus et netus et malesuada fames ac turpis egestas. Mauris ut leo. Cras viverra metus
rhoncus sem. Nulla et lectus vestibulum urna fringilla ultrices. Phasellus eu tellus sit amet tortor
gravida placerat. Integer sapien est, iaculis in, pretium quis, viverra ac, nunc. Praesent eget sem
vel leo ultrices bibendum. Aenean faucibus. Morbi dolor nulla, malesuada eu, pulvinar at, mollis
ac, nulla. Curabitur auctor semper nulla. Donec varius orci eget risus. Duis nibh mi, congue eu,
accumsan eleifend, sagittis quis, diam. Duis eget orci sit amet orci dignissim rutrum.
% \tcbuselibrary{fitting}
\newtcboxfit{\mybox}[1]{blanker,width=4cm,height=7cm,top=4pt,
watermark text=#1}
\begin{tabular}{|c|c|c|}\hline
A & B & C\\\hline
\mybox{A}{\lipsum[1]} & \mybox{B}{\lipsum[2]} & \mybox{C}{\lipsum[3]}\\\hline
\end{tabular}
A B C
Lorem ipsum dolor sit amet, con- Nam dui ligula, fringilla a, Nulla malesuada porttitor diam.
sectetuer adipiscing elit. Ut pu-
euismod sodales, sollicitudin Donec felis erat, congue non,
rus elit, vestibulum ut, placerat ac, volutpat at, tincidunt tristique,
vel, wisi. Morbi auctor lorem
adipiscing vitae, felis. Curabitur
libero. Vivamus viverra fermen-
dictum gravida mauris. Nam non justo. Nam lacus libero,
arcu libero, nonummy eget, con- tum felis. Donec nonummy pel-
sectetuer id, vulputate a, magna.
pretium at, lobortis vitae, ul- lentesque ante. Phasellus adip-
Donec vehicula augue eu neque. tricies et, tellus. Donec ali- iscing semper elit. Proin fer-
mentum massa ac quam. Sed
ABC
Pellentesque habitant morbi tris- quet, tortor sed accumsan
tique senectus et netus et male-
bibendum, erat ligula aliquet diam turpis, molestie vitae, plac-
suada fames ac turpis egestas. erat a, molestie nec, leo. Maece-
Mauris ut leo. Cras viverra me- magna, vitae ornare odio me- nas lacinia. Nam ipsum ligula,
tus rhoncus sem. Nulla et lectus tus a mi. Morbi ac orci et nisl eleifend at, accumsan nec, sus-
vestibulum urna fringilla ultrices.
Phasellus eu tellus sit amet tor-
hendrerit mollis. Suspendisse cipit a, ipsum. Morbi blan-
tor gravida placerat. Integer sapien ut massa. Cras nec ante. Pel- dit ligula feugiat magna. Nunc
est, iaculis in, pretium quis, viverra lentesque a nulla. Cum sociis eleifend consequat lorem. Sed
ac, nunc. Praesent eget sem vel lacinia nulla vitae enim. Pellen-
natoque penatibus et magnis
leo ultrices bibendum. Aenean fau- tesque tincidunt purus vel magna.
cibus. Morbi dolor nulla, male- dis parturient montes, nasce- Integer non enim. Praesent euis-
suada eu, pulvinar at, mollis ac, tur ridiculus mus. Aliquam mod nunc eu purus. Donec biben-
nulla. Curabitur auctor semper
tincidunt urna. Nulla ullam- dum quam in tellus. Nullam cur-
nulla. Donec varius orci eget risus.
Duis nibh mi, congue eu, accumsan corper vestibulum turpis. Pel- sus pulvinar lectus. Donec et mi.
eleifend, sagittis quis, diam. Duis lentesque cursus luctus mau- Nam vulputate metus eu enim.
eget orci sit amet orci dignissim Vestibulum pellentesque felis eu
rutrum.
ris. massa.
238
/tcb/blankest (style, initially unset)
This style extends /tcb/blankerÕ P. 238 . All engines are set to empty and all margins are
set to 0pt. In contrast to /tcb/blankerÕ P. 238 , also title, shadow, underlay, overlay, finish
and borderline are removed.
% \tcbuselibrary{raster}
\begin{tcbraster}[raster columns=3,raster equal height,
title=Box \thetcbrasternum,
enhanced,size=small,colframe=red!50!black,colback=red!10!white,
coltitle=yellow!85!black,
drop fuzzy shadow,watermark text={Box \thetcbrasternum},
borderline={.25mm}{-0.5mm}{green!40!black},
finish={\begin{tcbclipframe}\draw[blue,opacity=0.1,line width=1cm]
(frame.south west) -- (frame.north east);\end{tcbclipframe}},
]
\begin{tcolorbox}\lipsum[4]\end{tcolorbox}
\begin{tcolorbox}[blanker]\lipsum[4]\end{tcolorbox}
\begin{tcolorbox}[blankest]\lipsum[4]\end{tcolorbox}
\end{tcbraster}
Box 1
vallis augue. Etiam facilisis.
Nunc elementum fermentum
wisi. Aenean placerat. Ut
imperdiet, enim sed gravida
Box 2
erat. Ut imperdiet, enim sed
gravida sollicitudin, felis odio
placerat quam, ac pulvinar elit
gravida sollicitudin, felis odio
placerat quam, ac pulvinar elit
purus eget enim. Nunc vitae tor-
purus eget enim. Nunc vitae tor- tor. Proin tempus nibh sit amet
sollicitudin, felis odio plac-
tor. Proin tempus nibh sit amet nisl. Vivamus quis tortor vitae
erat quam, ac pulvinar elit
nisl. Vivamus quis tortor vitae risus porta vehicula.
purus eget enim. Nunc vitae
tortor. Proin tempus nibh sit risus porta vehicula.
amet nisl. Vivamus quis tor-
tor vitae risus porta vehicula.
239
/tcb/skin=emptyfirst (skin)
This is a flavor of emptyÕ P. 237 which is used as a first part in a break sequence for
emptyÕ P. 237 . Nevertheless, this skin can be applied independently.
Environment and engines for the skin ’emptyfirst’
More content.
240
/tcb/skin=emptymiddle (skin)
This is a flavor of emptyÕ P. 237 which is used as a middle part in a break sequence for
emptyÕ P. 237 . Nevertheless, this skin can be applied independently.
Environment and engines for the skin ’emptymiddle’
More content.
241
/tcb/skin=emptylast (skin)
This is a flavor of emptyÕ P. 237 which is used as a last part in a break sequence for
emptyÕ P. 237 . Nevertheless, this skin can be applied independently.
Environment and engines for the skin ’emptylast’
More content.
242
This example demonstrates a breakable customized box. Here, we define an environment
freebox. The first application of freebox produces an unbroken tcolorbox. The box is
drawn by the code given by /tcb/frame codeÕ P. 138 and /tcb/interior codeÕ P. 139 .
The second application of freebox is broken into several parts which are drawn
by the codes given by /tcb/skin first is subskin ofÕ P. 141 , /tcb/skin middle is
subskin ofÕ P. 141 , and /tcb/skin last is subskin ofÕ P. 141 .
% Preamble:
%\usepackage{tikz,lipsum}
%\tcbuselibrary{skins,breakable}
\tikzset{coltria/.style={fill=red!15!white}}
\newtcolorbox{freebox}[1][]{empty,breakable,leftrule=5mm,left=2mm,
frame style={fill,top color=red!75!black,bottom color=red!75!black,middle color=red},
colback=yellow!50!white,
watermark color=red!50!yellow!75!white,
watermark text on=unbroken is unbroken box,
watermark text on=first is first part,
watermark text on=middle is middle part,
watermark text on=last is last part,
% code for unbroken boxes:
frame code={\path[tcb fill frame] (frame.south west)--(frame.north west)
--([xshift=-5mm]frame.north east)--([yshift=-5mm]frame.north east)
--([yshift=5mm]frame.south east)--([xshift=-5mm]frame.south east)--cycle; },
interior code={\path[tcb fill interior] (interior.south west)--(interior.north west)
--([xshift=-4.8mm]interior.north east)--([yshift=-4.8mm]interior.north east)
--([yshift=4.8mm]interior.south east)--([xshift=-4.8mm]interior.south east)
--cycle; },
% code for the first part of a break sequence:
skin first is subskin of={emptyfirst}{%
frame code={\path[tcb fill frame] (frame.south west)--(frame.north west)
--([xshift=-5mm]frame.north east)--([yshift=-5mm]frame.north east)
--(frame.south east)--cycle;
\path[coltria] ([xshift=2.5mm,yshift=1mm]frame.south west) -- +(120:2mm)
-- +(60:2mm)-- cycle; },
interior code={\path[tcb fill interior] (interior.south west|-frame.south)
--(interior.north west)--([xshift=-4.8mm]interior.north east)
--([yshift=-4.8mm]interior.north east)--(interior.south east|-frame.south)
--cycle; },
},%
% code for the middle part of a break sequence:
skin middle is subskin of={emptymiddle}{%
frame code={\path[tcb fill frame] (frame.south west)--(frame.north west)
--(frame.north east)--(frame.south east)--cycle;
\path[coltria] ([xshift=2.5mm,yshift=-1mm]frame.north west) -- +(240:2mm)
-- +(300:2mm) -- cycle;
\path[coltria] ([xshift=2.5mm,yshift=1mm]frame.south west) -- +(120:2mm)
-- +(60:2mm) -- cycle;
},
interior code={\path[tcb fill interior] (interior.south west|-frame.south)
--(interior.north west|-frame.north)--(interior.north east|-frame.north)
--(interior.south east|-frame.south)--cycle; },
},
% code for the last part of a break sequence:
skin last is subskin of={emptylast}{%
frame code={\path[tcb fill frame] (frame.south west)--(frame.north west)
--(frame.north east)--([yshift=5mm]frame.south east)
--([xshift=-5mm]frame.south east)--cycle;
\path[coltria] ([xshift=2.5mm,yshift=-1mm]frame.north west) -- +(240:2mm)
-- +(300:2mm) -- cycle;
},
interior code={\path[tcb fill interior] (interior.south west)
243
--(interior.north west|-frame.north)--(interior.north east|-frame.north)
--([yshift=4.8mm]interior.south east)--([xshift=-4.8mm]interior.south east)
--cycle; },
},
#1}
\begin{freebox}
\lipsum[1]
\end{freebox}
\begin{freebox}
\lipsum[1-12]
\end{freebox}
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut,
placerat ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero,
nonummy eget, consectetuer id, vulputate a, magna. Donec vehicula augue eu neque.
unbroken box
Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis
egestas. Mauris ut leo. Cras viverra metus rhoncus sem. Nulla et lectus vestibulum
urna fringilla ultrices. Phasellus eu tellus sit amet tortor gravida placerat. Integer
sapien est, iaculis in, pretium quis, viverra ac, nunc. Praesent eget sem vel leo ultrices
bibendum. Aenean faucibus. Morbi dolor nulla, malesuada eu, pulvinar at, mollis ac,
nulla. Curabitur auctor semper nulla. Donec varius orci eget risus. Duis nibh mi,
congue eu, accumsan eleifend, sagittis quis, diam. Duis eget orci sit amet orci dignissim
rutrum.
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut,
placerat ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero,
nonummy eget, consectetuer id, vulputate a, magna. Donec vehicula augue eu neque.
Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis
egestas. Mauris ut leo. Cras viverra metus rhoncus sem. Nulla et lectus vestibulum
urna fringilla ultrices. Phasellus eu tellus sit amet tortor gravida placerat. Integer
sapien est, iaculis in, pretium quis, viverra ac, nunc. Praesent eget sem vel leo ultrices
bibendum. Aenean faucibus. Morbi dolor nulla, malesuada eu, pulvinar at, mollis ac,
first part
nulla. Curabitur auctor semper nulla. Donec varius orci eget risus. Duis nibh mi,
congue eu, accumsan eleifend, sagittis quis, diam. Duis eget orci sit amet orci dignissim
rutrum.
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem
non justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec
aliquet, tortor sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio
metus a mi. Morbi ac orci et nisl hendrerit mollis. Suspendisse ut massa. Cras nec
ante. Pellentesque a nulla. Cum sociis natoque penatibus et magnis dis parturient
montes, nascetur ridiculus mus. Aliquam tincidunt urna. Nulla ullamcorper vestibulum
turpis. Pellentesque cursus luctus mauris.
Nulla malesuada porttitor diam. Donec felis erat, congue non, volutpat at, tincidunt
tristique, libero. Vivamus viverra fermentum felis. Donec nonummy pellentesque ante.
Phasellus adipiscing semper elit. Proin fermentum massa ac quam. Sed diam turpis,
molestie vitae, placerat a, molestie nec, leo. Maecenas lacinia. Nam ipsum ligula,
eleifend at, accumsan nec, suscipit a, ipsum. Morbi blandit ligula feugiat magna. Nunc
eleifend consequat lorem. Sed lacinia nulla vitae enim. Pellentesque tincidunt purus vel
magna. Integer non enim. Praesent euismod nunc eu purus. Donec bibendum quam
in tellus. Nullam cursus pulvinar lectus. Donec et mi. Nam vulputate metus eu enim.
244
Vestibulum pellentesque felis eu massa.
Quisque ullamcorper placerat ipsum. Cras nibh. Morbi vel justo vitae lacus tincidunt
ultrices. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. In hac habitasse
platea dictumst. Integer tempus convallis augue. Etiam facilisis. Nunc elementum
fermentum wisi. Aenean placerat. Ut imperdiet, enim sed gravida sollicitudin, felis odio
placerat quam, ac pulvinar elit purus eget enim. Nunc vitae tortor. Proin tempus nibh
sit amet nisl. Vivamus quis tortor vitae risus porta vehicula.
Fusce mauris. Vestibulum luctus nibh at lectus. Sed bibendum, nulla a faucibus semper,
leo velit ultricies tellus, ac venenatis arcu wisi vel nisl. Vestibulum diam. Aliquam
pellentesque, augue quis sagittis posuere, turpis lacus congue quam, in hendrerit risus
eros eget felis. Maecenas eget erat in sapien mattis porttitor. Vestibulum porttitor.
Nulla facilisi. Sed a turpis eu lacus commodo facilisis. Morbi fringilla, wisi in dignissim
interdum, justo lectus sagittis dui, et vehicula libero dui cursus dui. Mauris tempor
ligula sed lacus. Duis cursus enim ut augue. Cras ac magna. Cras nulla. Nulla egestas.
Curabitur a leo. Quisque egestas wisi eget nunc. Nam feugiat lacus vel est. Curabitur
consectetuer.
Suspendisse vel felis. Ut lorem lorem, interdum eu, tincidunt sit amet, laoreet vitae,
arcu. Aenean faucibus pede eu ante. Praesent enim elit, rutrum at, molestie non,
nonummy vel, nisl. Ut lectus eros, malesuada sit amet, fermentum eu, sodales cursus,
magna. Donec eu purus. Quisque vehicula, urna sed ultricies auctor, pede lorem egestas
dui, et convallis elit erat sed nulla. Donec luctus. Curabitur et nunc. Aliquam dolor
odio, commodo pretium, ultricies non, pharetra in, velit. Integer arcu est, nonummy in,
middle part
fermentum faucibus, egestas vel, odio.
Sed commodo posuere pede. Mauris ut est. Ut quis purus. Sed ac odio. Sed vehicula
hendrerit sem. Duis non odio. Morbi ut dui. Sed accumsan risus eget odio. In hac
habitasse platea dictumst. Pellentesque non elit. Fusce sed justo eu urna porta tincidunt.
Mauris felis odio, sollicitudin sed, volutpat a, ornare ac, erat. Morbi quis dolor. Donec
pellentesque, erat ac sagittis semper, nunc dui lobortis purus, quis congue purus metus
ultricies tellus. Proin et quam. Class aptent taciti sociosqu ad litora torquent per
conubia nostra, per inceptos hymenaeos. Praesent sapien turpis, fermentum vel, eleifend
faucibus, vehicula eu, lacus.
Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis
egestas. Donec odio elit, dictum in, hendrerit sit amet, egestas sed, leo. Praesent feu-
giat sapien aliquet odio. Integer vitae justo. Aliquam vestibulum fringilla lorem. Sed
neque lectus, consectetuer at, consectetuer sed, eleifend ac, lectus. Nulla facilisi. Pel-
lentesque eget lectus. Proin eu metus. Sed porttitor. In hac habitasse platea dictumst.
Suspendisse eu lectus. Ut mi mi, lacinia sit amet, placerat et, mollis vitae, dui. Sed
ante tellus, tristique ut, iaculis eu, malesuada ac, dui. Mauris nibh leo, facilisis non,
adipiscing quis, ultrices a, dui.
Morbi luctus, wisi viverra faucibus pretium, nibh est placerat odio, nec commodo wisi
enim eget quam. Quisque libero justo, consectetuer a, feugiat vitae, porttitor eu, libero.
Suspendisse sed mauris vitae elit sollicitudin malesuada. Maecenas ultricies eros sit
amet ante. Ut venenatis velit. Maecenas sed mi eget dui varius euismod. Phasellus
aliquet volutpat odio. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices
posuere cubilia Curae; Pellentesque sit amet pede ac sem eleifend consectetuer. Nullam
elementum, urna vel imperdiet sodales, elit ipsum pharetra ligula, ac pretium ante justo
a nulla. Curabitur tristique arcu eu metus. Vestibulum lectus. Proin mauris. Proin eu
nunc eu urna hendrerit faucibus. Aliquam auctor, pede consequat laoreet varius, eros
tellus scelerisque quam, pellentesque hendrerit ipsum dolor sed augue. Nulla nec lacus.
Suspendisse vitae elit. Aliquam arcu neque, ornare in, ullamcorper quis, commodo eu,
libero. Fusce sagittis erat at erat tristique mollis. Maecenas sapien libero, molestie et,
245
lobortis in, sodales eget, dui. Morbi ultrices rutrum lorem. Nam elementum ullamcorper
leo. Morbi dui. Aliquam sagittis. Nunc placerat. Pellentesque tristique sodales est.
Maecenas imperdiet lacinia velit. Cras non urna. Morbi eros pede, suscipit ac, varius
last part
vel, egestas non, eros. Praesent malesuada, diam id pretium elementum, eros sem dictum
tortor, vel consectetuer odio sem sed wisi.
Sed feugiat. Cum sociis natoque penatibus et magnis dis parturient montes, nasce-
tur ridiculus mus. Ut pellentesque augue sed urna. Vestibulum diam eros, fringilla et,
consectetuer eu, nonummy id, sapien. Nullam at lectus. In sagittis ultrices mauris. Cur-
abitur malesuada erat sit amet massa. Fusce blandit. Aliquam erat volutpat. Aliquam
euismod. Aenean vel lectus. Nunc imperdiet justo nec dolor.
Etiam euismod. Fusce facilisis lacinia dui. Suspendisse potenti. In mi erat, cursus id,
nonummy sed, ullamcorper eget, sapien. Praesent pretium, magna in eleifend egestas,
pede pede pretium lorem, quis consectetuer tortor sapien facilisis magna. Mauris quis
magna varius nulla scelerisque imperdiet. Aliquam non quam. Aliquam porttitor quam
a lacus. Praesent vel arcu ut tortor cursus volutpat. In vitae pede quis diam bibendum
placerat. Fusce elementum convallis neque. Sed dolor orci, scelerisque ac, dapibus nec,
ultricies ut, mi. Duis nec dui quis leo sagittis commodo.
246
10.20 Skin ’spartan’
/tcb/skin=spartan (skin)
This skin is quite . . . spartan. It supports no rounded corners, no overlays, no shadows, no
borderlines, and no finishes. The only exception are underlays. One cannot do very fancy
things with this skin, but it compiles very fast. Therefore, the spartan skin is used for the
draft mode, see Section 10.12 on page 203. Nevertheless, it can be used as a normal skin.
Environment and engines for the skin ’spartan’
More content.
247
10.21 Skin ’draft’
/tcb/skin=draft (skin)
This skin is intended to be used while drafting new geometric settings for a tcolorbox.
Environment and engines for the skin ’draft’
upper: w=87.49236pt, h=41.88667pt More content. This is my content. upper: This is my content.
w=87.49236pt, h=7.95pt
upper: w=87.49236pt, h=25.53104pt
lower: w=87.49236pt, h=22.55563pt
interior: w=98.8734pt, h=53.26772pt
interior: w=98.8734pt, h=53.26772pt lower:
interior: w=98.8734pt, h=36.91208pt
interior: w=87.49236pt,
More
w=98.8734pt, h=6.2pt
content. h=36.91208pt
248
\vspace*{3mm}
\begin{tcolorbox}[draft,title=A colored box with the 'draft' skin]
\lipsum[1-3]
\tcblower
\lipsum[4-6]
\end{tcolorbox}
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, placerat
ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero, nonummy eget,
consectetuer id, vulputate a, magna. Donec vehicula augue eu neque. Pellentesque habitant morbi
tristique senectus et netus et malesuada fames ac turpis egestas. Mauris ut leo. Cras viverra metus
rhoncus sem. Nulla et lectus vestibulum urna fringilla ultrices. Phasellus eu tellus sit amet tortor
gravida placerat. Integer sapien est, iaculis in, pretium quis, viverra ac, nunc. Praesent eget sem
vel leo ultrices bibendum. Aenean faucibus. Morbi dolor nulla, malesuada eu, pulvinar at, mollis
ac, nulla. Curabitur auctor semper nulla. Donec varius orci eget risus. Duis nibh mi, congue eu,
accumsan eleifend, sagittis quis, diam. Duis eget orci sit amet orci dignissim rutrum.
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem non justo.
Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet, tortor sed accum-
san bibendum, erat ligula aliquet magna,
upper: vitae ornare
w=392.64822pt, odio metus a mi. Morbi ac orci et nisl
h=249.95pt
hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque a nulla. Cum sociis natoque
penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam tincidunt urna. Nulla
ullamcorper vestibulum turpis. Pellentesque cursus luctus mauris.
Nulla malesuada porttitor diam. Donec felis erat, congue non, volutpat at, tincidunt tristique,
libero. Vivamus viverra fermentum felis. Donec nonummy pellentesque ante. Phasellus adipiscing
semper elit. Proin fermentum massa ac quam. Sed diam turpis, molestie vitae, placerat a, molestie
nec, leo. Maecenas lacinia. Nam ipsum ligula, eleifend at, accumsan nec, suscipit a, ipsum.
Morbi blandit ligula feugiat magna. Nunc eleifend consequat lorem. Sed lacinia nulla vitae enim.
Pellentesque tincidunt purus vel magna. Integer non enim. Praesent euismod nunc eu purus.
Donec bibendum quam in tellus. Nullam cursus pulvinar lectus. Donec et mi. Nam vulputate
metus eu enim. Vestibulum pellentesque felis eu massa.
Quisque ullamcorper placerat ipsum. Cras nibh. Morbi vel justo vitae lacus tincidunt ultrices.
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. In hac habitasse platea dictumst. Integer
tempus convallis augue. Etiam facilisis. Nunc elementum fermentum wisi. Aenean placerat. Ut
imperdiet, enim sed gravida sollicitudin, felis odio placerat quam, ac pulvinar elit purus eget enim.
Nunc vitae tortor. Proin tempus nibh sit amet nisl. Vivamus quis tortor vitae risus porta vehicula.
Fusce mauris. Vestibulum luctus nibh at lectus. Sed bibendum, nulla a faucibus semper, leo velit
ultricies tellus, ac venenatis arcu wisi vel nisl. Vestibulum diam. Aliquam pellentesque, augue quis
sagittis posuere, turpis lacus congue quam, in hendrerit risus eros eget felis. Maecenas eget erat
in sapien mattis porttitor. Vestibulum porttitor. Nulla facilisi. Sed a turpis eu lacus commodo
facilisis. Morbi fringilla, wisi in dignissim interdum, justo
lower: w=392.64822pt, lectus sagittis dui, et vehicula libero dui
h=205.95pt
cursus dui. Mauris tempor ligula sed lacus. Duis cursus enim ut augue. Cras ac magna. Cras
nulla. Nulla egestas. Curabitur a leo. Quisque egestas wisi eget nunc. Nam feugiat lacus vel est.
Curabitur consectetuer.
Suspendisse vel felis. Ut lorem lorem, interdum eu, tincidunt sit amet, laoreet vitae, arcu. Aenean
faucibus pede eu ante. Praesent enim elit, rutrum at, molestie non, nonummy vel, nisl. Ut
lectus eros, malesuada sit amet, fermentum eu, sodales cursus, magna. Donec eu purus. Quisque
vehicula, urna sed ultricies auctor, pede lorem egestas dui, et convallis elit erat sed nulla. Donec
luctus. Curabitur et nunc. Aliquam dolor odio, commodo pretium, ultricies non, pharetra in,
velit. Integer arcu est, nonummy in, fermentum faucibus, egestas vel, odio.
interior: w=421.10092pt, h=490.04318pt
249
10.22 Skin Family ’freelance’
This skin family ’freelance’ is deprecated with tcolorbox 3.00. It is not longer needed,
because /tcb/frame codeÕ P. 138 , /tcb/interior codeÕ P. 139 , /tcb/interior titled
codeÕ P. 138 , and /tcb/title codeÕ P. 140 can be applied to every skin now. In this sense,
250
11 Inclusion of Boxed Image Files
The skins library adds some commands to conveniently include boxed image files. For the
LIB
following macros and options, the skins library has to be loaded by a package option or inside
LIB
the preamble by:
\tcbuselibrary{skins}
See Section 10 on page 148 for the documentation of all other options of the skins library.
LIB
11.1 Macros
N 2014-11-14 \tcbincludegraphics[hoptionsi]{hfile namei}
In principle, this macro includes an image file denoted by hfile namei using the standard
U 2016-07-13
\includegraphics and puts it into a tcolorboxÕ P. 12 . The hoptionsi are tcolorbox keys
to set up the colored box. Use /tcb/graphics optionsÕ P. 254 to specify options for the
underlying \includegraphics. Some tcolorbox option keys are automatically set, namely
/tcb/enhancedÕ P. 206 and options to center the image inside the box.
The sizing of the included image is done depending on the following:
• If a /tcb/widthÕ P. 34 is specified, but no fixed /tcb/heightÕ P. 53 , the image is sized
to fill the inner width of the box. The height of the box adapts to the image.
• If a fixed /tcb/heightÕ P. 53 is specified, the image is sized to fill the fixed inner area
of the box.
• If the /tcb/captureÕ P. 94 mode /tcb/hboxÕ P. 94 is specified, the image is sized ac-
cording to given \includegraphics options only. The box adapts to the image.
% \tcbuselibrary{raster}
\begin{tcbraster}[raster columns=3,raster force size=false,size=fbox,
colframe=red!50!black,colback=red!20!black,
fonttitle=\bfseries,center title,drop fuzzy shadow]
\tcbincludegraphics[title=Normal]{goldshade.png}
\tcbincludegraphics[title=Fixed height,height=3cm]{goldshade.png}
\tcbincludegraphics[title=hbox mode,hbox,graphics options={width=3cm}]
{goldshade.png}
\end{tcbraster}
Normal
hbox mode
Fixed height
251
The auxiliary macro \imagename may be used inside \tcbincludegraphicsÕ P. 251 to dis-
play the name of the file. \imagename is already partially detokenized and is allowed to
contain special characters like the underscore. Note that an appropriate font is required to
display such characters.
% \tcbuselibrary{raster}
\begin{tcbraster}[size=fbox,
colframe=red!50!black,colback=red!20!black,
fonttitle=\bfseries\ttfamily,center title,drop fuzzy shadow]
\tcbincludegraphics[title=\imagename]{goldshade.png}
\tcbincludegraphics[finish={
\node[fill=white,fill opacity=0.5,text opacity=1]
at (frame.center) {\bfseries\ttfamily\imagename};}]{blueshade.png}
\end{tcbraster}
goldshade.png
blueshade.png
252
N 2014-11-14 \tcbincludepdf[hoptionsi]{hfile namei}
This is a generalized version of \tcbincludegraphicsÕ P. 251 which allows to include a
complete PDF file denoted by hfile namei. Every page is boxed into an own tcolorboxÕ P. 12
customized by the given hoptionsi. It is reasonable to put such a series of boxes inside a
tcbrasterÕ P. 279 for alignment.
Use /tcb/graphics pagesÕ P. 254 to use a selection of pages instead of using the whole file.
The auxiliary macro \imagepage may be used inside \tcbincludepdf to display the current
page number.
% \tcbuselibrary{raster}
\begin{tcbraster}[raster columns=3,colframe=blue,colback=white,
colbacktitle=blue!50!white,fonttitle=\small\bfseries\ttfamily,
left=0pt,right=0pt,top=0pt,bottom=0pt,boxsep=0pt,boxrule=0.6pt,
toptitle=1mm,bottomtitle=1mm,drop lifted shadow,center title,
graphics pages={1,...,6},title={\imagename\ [\imagepage]}]
\tcbincludepdf{tcolorbox-example.pdf}
\end{tcbraster}
3 Theorems
I
Theorem 3.1: Summation of Numbers
Here I am
For all natural number n it holds: 6 Breakable Boxes
I’m invisible until you find me.
Breakable box
n(n + 1)
n
X
i= . (3) Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit,
2
vestibulum ut, placerat ac, adipiscing vitae, felis. Curabitur dictum
i=1
Funny settings. gravida mauris. Nam arcu libero, nonummy eget, consectetuer id, vulpu-
tate a, magna. Donec vehicula augue eu neque. Pellentesque habitant
We have given Theorem 3.1 on page 2.
morbi tristique senectus et netus et malesuada fames ac turpis egestas.
Mauris ut leo. Cras viverra metus rhoncus sem. Nulla et lectus vestibu-
My title 3.2 Theorem (Summation of Numbers): For all natural number n it holds: lum urna fringilla ultrices. Phasellus eu tellus sit amet tortor gravida
This box is filled with an external image. placerat. Integer sapien est, iaculis in, pretium quis, viverra ac, nunc.
Title and interior are made partly transparent to show the image. Praesent eget sem vel leo ultrices bibendum. Aenean faucibus. Morbi
n(n + 1)
n
X
i= . (4) dolor nulla, malesuada eu, pulvinar at, mollis ac, nulla. Curabitur auc-
i=1
2 tor semper nulla. Donec varius orci eget risus. Duis nibh mi, congue
My title eu, accumsan eleifend, sagittis quis, diam. Duis eget orci sit amet orci
This box uses a boxed title. The box of the title can be formatted inde- dignissim rutrum.
pendently from the main box. Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi
auctor lorem non justo. Nam lacus libero, pretium at, lobortis vitae,
1 2 3
IV
ultricies et, tellus. Donec aliquet, tortor sed accumsan bibendum, erat Fusce sed justo eu urna porta tincidunt. Mauris felis odio, sollicitudin sectetuer tortor sapien facilisis magna. Mauris quis magna varius nulla
II
ligula aliquet magna, vitae ornare odio metus a mi. Morbi ac orci et sed, volutpat a, ornare ac, erat. Morbi quis dolor. Donec pellentesque, scelerisque imperdiet. Aliquam non quam. Aliquam porttitor quam a
nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellen- erat ac sagittis semper, nunc dui lobortis purus, quis congue purus metus lacus. Praesent vel arcu ut tortor cursus volutpat. In vitae pede quis
tesque a nulla. Cum sociis natoque penatibus et magnis dis parturient ultricies tellus. Proin et quam. Class aptent taciti sociosqu ad litora diam bibendum placerat. Fusce elementum convallis neque. Sed dolor
montes, nascetur ridiculus mus. Aliquam tincidunt urna. Nulla ullam- torquent per conubia nostra, per inceptos hymenaeos. Praesent sapien orci, scelerisque ac, dapibus nec, ultricies ut, mi. Duis nec dui quis leo
corper vestibulum turpis. Pellentesque cursus luctus mauris. turpis, fermentum vel, eleifend faucibus, vehicula eu, lacus. sagittis commodo.
Nulla malesuada porttitor diam. Donec felis erat, congue non, volutpat Pellentesque habitant morbi tristique senectus et netus et malesuada
at, tincidunt tristique, libero. Vivamus viverra fermentum felis. Donec fames ac turpis egestas. Donec odio elit, dictum in, hendrerit sit amet,
nonummy pellentesque ante. Phasellus adipiscing semper elit. Proin fer- egestas sed, leo. Praesent feugiat sapien aliquet odio. Integer vitae justo.
III
mentum massa ac quam. Sed diam turpis, molestie vitae, placerat a, Aliquam vestibulum fringilla lorem. Sed neque lectus, consectetuer at,
molestie nec, leo. Maecenas lacinia. Nam ipsum ligula, eleifend at, ac- consectetuer sed, eleifend ac, lectus. Nulla facilisi. Pellentesque eget
cumsan nec, suscipit a, ipsum. Morbi blandit ligula feugiat magna. Nunc lectus. Proin eu metus. Sed porttitor. In hac habitasse platea dictumst.
eleifend consequat lorem. Sed lacinia nulla vitae enim. Pellentesque tin- Suspendisse eu lectus. Ut mi mi, lacinia sit amet, placerat et, mollis
cidunt purus vel magna. Integer non enim. Praesent euismod nunc eu vitae, dui. Sed ante tellus, tristique ut, iaculis eu, malesuada ac, dui.
purus. Donec bibendum quam in tellus. Nullam cursus pulvinar lectus. Mauris nibh leo, facilisis non, adipiscing quis, ultrices a, dui.
Donec et mi. Nam vulputate metus eu enim. Vestibulum pellentesque Morbi luctus, wisi viverra faucibus pretium, nibh est placerat odio, nec
felis eu massa. commodo wisi enim eget quam. Quisque libero justo, consectetuer a,
Quisque ullamcorper placerat ipsum. Cras nibh. Morbi vel justo vi- feugiat vitae, porttitor eu, libero. Suspendisse sed mauris vitae elit sol-
tae lacus tincidunt ultrices. Lorem ipsum dolor sit amet, consectetuer licitudin malesuada. Maecenas ultricies eros sit amet ante. Ut venenatis
adipiscing elit. In hac habitasse platea dictumst. Integer tempus con- velit. Maecenas sed mi eget dui varius euismod. Phasellus aliquet volut-
vallis augue. Etiam facilisis. Nunc elementum fermentum wisi. Aenean pat odio. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices
placerat. Ut imperdiet, enim sed gravida sollicitudin, felis odio placerat posuere cubilia Curae; Pellentesque sit amet pede ac sem eleifend con-
quam, ac pulvinar elit purus eget enim. Nunc vitae tortor. Proin tempus sectetuer. Nullam elementum, urna vel imperdiet sodales, elit ipsum
nibh sit amet nisl. Vivamus quis tortor vitae risus porta vehicula. pharetra ligula, ac pretium ante justo a nulla. Curabitur tristique arcu
Fusce mauris. Vestibulum luctus nibh at lectus. Sed bibendum, nulla a eu metus. Vestibulum lectus. Proin mauris. Proin eu nunc eu urna
faucibus semper, leo velit ultricies tellus, ac venenatis arcu wisi vel nisl. hendrerit faucibus. Aliquam auctor, pede consequat laoreet varius, eros
Vestibulum diam. Aliquam pellentesque, augue quis sagittis posuere, tellus scelerisque quam, pellentesque hendrerit ipsum dolor sed augue.
turpis lacus congue quam, in hendrerit risus eros eget felis. Maecenas Nulla nec lacus.
eget erat in sapien mattis porttitor. Vestibulum porttitor. Nulla facilisi. Suspendisse vitae elit. Aliquam arcu neque, ornare in, ullamcorper quis,
Sed a turpis eu lacus commodo facilisis. Morbi fringilla, wisi in dignissim commodo eu, libero. Fusce sagittis erat at erat tristique mollis. Maece-
interdum, justo lectus sagittis dui, et vehicula libero dui cursus dui. nas sapien libero, molestie et, lobortis in, sodales eget, dui. Morbi ultri-
Mauris tempor ligula sed lacus. Duis cursus enim ut augue. Cras ac ces rutrum lorem. Nam elementum ullamcorper leo. Morbi dui. Aliquam
magna. Cras nulla. Nulla egestas. Curabitur a leo. Quisque egestas wisi sagittis. Nunc placerat. Pellentesque tristique sodales est. Maecenas im-
eget nunc. Nam feugiat lacus vel est. Curabitur consectetuer. perdiet lacinia velit. Cras non urna. Morbi eros pede, suscipit ac, varius
Suspendisse vel felis. Ut lorem lorem, interdum eu, tincidunt sit amet, vel, egestas non, eros. Praesent malesuada, diam id pretium elementum,
laoreet vitae, arcu. Aenean faucibus pede eu ante. Praesent enim elit, eros sem dictum tortor, vel consectetuer odio sem sed wisi.
rutrum at, molestie non, nonummy vel, nisl. Ut lectus eros, malesuada sit Sed feugiat. Cum sociis natoque penatibus et magnis dis parturi-
amet, fermentum eu, sodales cursus, magna. Donec eu purus. Quisque ent montes, nascetur ridiculus mus. Ut pellentesque augue sed urna.
vehicula, urna sed ultricies auctor, pede lorem egestas dui, et convallis Vestibulum diam eros, fringilla et, consectetuer eu, nonummy id, sapien.
elit erat sed nulla. Donec luctus. Curabitur et nunc. Aliquam dolor Nullam at lectus. In sagittis ultrices mauris. Curabitur malesuada erat
odio, commodo pretium, ultricies non, pharetra in, velit. Integer arcu sit amet massa. Fusce blandit. Aliquam erat volutpat. Aliquam euis-
est, nonummy in, fermentum faucibus, egestas vel, odio. mod. Aenean vel lectus. Nunc imperdiet justo nec dolor.
Sed commodo posuere pede. Mauris ut est. Ut quis purus. Sed ac odio. Etiam euismod. Fusce facilisis lacinia dui. Suspendisse potenti. In
Sed vehicula hendrerit sem. Duis non odio. Morbi ut dui. Sed accumsan mi erat, cursus id, nonummy sed, ullamcorper eget, sapien. Praesent
risus eget odio. In hac habitasse platea dictumst. Pellentesque non elit. pretium, magna in eleifend egestas, pede pede pretium lorem, quis con-
4 5 6
253
11.2 Option Keys
N 2014-11-14 /tcb/graphics options=hoptionsi (no default, initially empty)
Used for \tcbincludegraphicsÕ P. 251 and \tcbincludepdfÕ P. 253 to specify
U 2018-03-18
\includegraphics hoptionsi.
% \tcbuselibrary{raster}
\begin{tcbraster}[raster columns=3,size=fbox,raster equal height,
colframe=red!50!black,colback=red!20!black,drop fuzzy shadow]
\tcbincludegraphics{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}
\tcbset{
graphics directory={.},
graphics directory={examples},
graphics directory={../../pictures},
}
\tcbset{
graphics pages={1,3,7},
graphics pages={1,...,10},
graphics pages={1,3,...,18},
graphics pages={100,...,\pdfpages},
}
254
N 2018-03-21 /tcb/graphics orientation=horientationi (no default, initially as-is)
Used for \tcbincludegraphicsÕ P. 251 and \tcbincludepdfÕ P. 253 to guarantee a certain
horientationi 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 horientationi are:
• as-is: no rotation of the processed image.
• landscape: the processed image is possibly rotated by 90 degrees to ensure that the
final width is not smaller than the final height.
• landscape*: the processed image is possibly rotated by -90 degrees to ensure that the
final width is not smaller than the final height.
• portrait: the processed image is possibly rotated by 90 degrees to ensure that the
final height is not smaller than the final width.
• portrait*: the processed image is possibly rotated by -90 degrees to ensure that the
final height is not smaller than the final width.
% \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}
255
12 TikZ Image and Picture Fill Extensions; Auxiliary Macros
The skins library adds some image and picture fill options to the vast option set of TikZ [22].
LIB
These options can be used in any tikzpicture. For the following options, the skins library
LIB
has to be loaded by a package option or inside the preamble by:
\tcbuselibrary{skins}
See Section 10 on page 148 for the documentation of all other options of the skins library.
LIB
12.1 Fill Plain
/tikz/fill plain image=hfile namei (no default, initially unset)
Fills the current path with an external image referenced by hfile namei. The image is put
in the center of the path, but it is not resized to fit into the path area.
\begin{tikzpicture}
\path[draw,fill plain image=goldshade.png]
(2.75,-0.75) -- (3,0) -- (2.75,0.75)
\foreach \w in {45,90,...,315}
{ -- (\w:1.5cm) } -- cycle;
\end{tikzpicture}
\begin{tikzpicture}
\path[draw,fill plain '
&image*={width=2.5cm}{goldshade.png}]
(2.75,-0.75) -- (3,0) -- (2.75,0.75)
\foreach \w in {45,90,...,315}
{ -- (\w:1.5cm) } -- cycle;
\end{tikzpicture}
\begin{tikzpicture}
\path[draw,fill plain picture={%
\draw[red!50!yellow,line width=2mm]
(0,0) circle (1cm);
\draw[red,line width=5mm] (-1,-1) -- (1,1);
\draw[red,line width=5mm] (-1,1) -- (1,-1);
}]
(2.75,-0.75) -- (3,0) -- (2.75,0.75)
\foreach \w in {45,90,...,315}
{ -- (\w:1.5cm) } -- cycle;
\end{tikzpicture}
256
12.2 Fill Stretch
/tikz/fill stretch image=hfile namei (no default, initially unset)
Fills the current path with an external image referenced by hfile namei. The image is
stretched to fill the path area.
\begin{tikzpicture}
\path[fill stretch image=goldshade.png]
(2.75,-0.75) -- (3,0) -- (2.75,0.75)
\foreach \w in {45,90,...,315}
{ -- (\w:1.5cm) } -- cycle;
\end{tikzpicture}
\begin{tikzpicture}
\path[fill stretch image*=
{angle=90,origin=c}{goldshade.png}]
(2.75,-0.75) -- (3,0) -- (2.75,0.75)
\foreach \w in {45,90,...,315}
{ -- (\w:1.5cm) } -- cycle;
\end{tikzpicture}
\begin{tikzpicture}
\path[draw,fill stretch picture={%
\draw[red!50!yellow,line width=2mm]
(0,0) circle (1cm);
\draw[red,line width=5mm] (-1,-1) -- (1,1);
\draw[red,line width=5mm] (-1,1) -- (1,-1);
}]
(2.75,-0.75) -- (3,0) -- (2.75,0.75)
\foreach \w in {45,90,...,315}
{ -- (\w:1.5cm) } -- cycle;
\end{tikzpicture}
257
12.3 Fill Overzoom
/tikz/fill overzoom image=hfile namei (no default, initially unset)
Fills the current path with an external image referenced by hfile namei. The image is
zoomed such that the path area fills the image.
\begin{tikzpicture}
\path[fill overzoom image=goldshade.png]
(2.75,-0.75) -- (3,0) -- (2.75,0.75)
\foreach \w in {45,90,...,315}
{ -- (\w:1.5cm) } -- cycle;
\end{tikzpicture}
\begin{tikzpicture}
\path[fill overzoom image*=
{angle=90,origin=c}{goldshade.png}]
(2.75,-0.75) -- (3,0) -- (2.75,0.75)
\foreach \w in {45,90,...,315}
{ -- (\w:1.5cm) } -- cycle;
\end{tikzpicture}
\begin{tikzpicture}
\path[draw,fill overzoom picture={%
\draw[red!50!yellow,line width=2mm]
(0,0) circle (1cm);
\draw[red,line width=5mm] (-1,-1) -- (1,1);
\draw[red,line width=5mm] (-1,1) -- (1,-1);
}]
(2.75,-0.75) -- (3,0) -- (2.75,0.75)
\foreach \w in {45,90,...,315}
{ -- (\w:1.5cm) } -- cycle;
\end{tikzpicture}
258
12.4 Fill Zoom
/tikz/fill zoom image=hfile namei (no default, initially unset)
Fills the current path with an external image referenced by hfile namei. The image is
zoomed such that it fits inside the path area. Typically, some parts of the path area will
stay unfilled.
\begin{tikzpicture}
\path[draw,fill zoom image=goldshade.png]
(2.75,-0.75) -- (3,0) -- (2.75,0.75)
\foreach \w in {45,90,...,315}
{ -- (\w:1.5cm) } -- cycle;
\end{tikzpicture}
\begin{tikzpicture}
\path[draw,fill zoom image*=
{angle=90,origin=c}{goldshade.png}]
(2.75,-0.75) -- (3,0) -- (2.75,0.75)
\foreach \w in {45,90,...,315}
{ -- (\w:1.5cm) } -- cycle;
\end{tikzpicture}
\begin{tikzpicture}
\path[draw,fill zoom picture={%
\draw[red!50!yellow,line width=2mm]
(0,0) circle (1cm);
\draw[red,line width=5mm] (-1,-1) -- (1,1);
\draw[red,line width=5mm] (-1,1) -- (1,-1);
}]
(2.75,-0.75) -- (3,0) -- (2.75,0.75)
\foreach \w in {45,90,...,315}
{ -- (\w:1.5cm) } -- cycle;
\end{tikzpicture}
259
12.5 Fill Shrink
/tikz/fill shrink image=hfile namei (no default, initially unset)
Fills the current path with an external image referenced by hfile namei. The image is
zoomed such that it fits inside the path area, but it never gets enlarged. Typically, some
parts of the path area will stay unfilled.
\begin{tikzpicture}
\path[draw,fill shrink image=goldshade.png]
(2.75,-0.75) -- (3,0) -- (2.75,0.75)
\foreach \w in {45,90,...,315}
{ -- (\w:1.5cm) } -- cycle;
\end{tikzpicture}
\begin{tikzpicture}
\path[draw,fill shrink '
&image*={width=1.5cm}{goldshade.png}]
(2.75,-0.75) -- (3,0) -- (2.75,0.75)
\foreach \w in {45,90,...,315}
{ -- (\w:1.5cm) } -- cycle;
\end{tikzpicture}
\begin{tikzpicture}
\path[draw,fill shrink picture={%
\draw[red!50!yellow,line width=2mm]
(0,0) circle (1cm);
\draw[red,line width=5mm] (-1,-1) -- (1,1);
\draw[red,line width=5mm] (-1,1) -- (1,-1);
}]
(2.75,-0.75) -- (3,0) -- (2.75,0.75)
\foreach \w in {45,90,...,315}
{ -- (\w:1.5cm) } -- cycle;
\end{tikzpicture}
260
12.6 Fill Tile
/tikz/fill tile image=hfile namei (no default, initially unset)
Fills the current path with a tile pattern using an external image referenced by hfile namei.
\begin{tikzpicture}
\path[fill tile image=pink_marble.png]
(2.75,-0.75) -- (3,0) -- (2.75,0.75)
\foreach \w in {45,90,...,315}
{ -- (\w:1.5cm) } -- cycle;
\end{tikzpicture}
\begin{tikzpicture}
\path[fill tile image*={width=1cm}{pink_marble.png}]
(2.75,-0.75) -- (3,0) -- (2.75,0.75)
\foreach \w in {45,90,...,315}
{ -- (\w:1.5cm) } -- cycle;
\end{tikzpicture}
\begin{tikzpicture}
\path[draw,fill tile picture={%
\draw[red!50!yellow,line width=2mm]
(0,0) circle (1cm);
\draw[red,line width=5mm] (-1,-1) -- (1,1);
\draw[red,line width=5mm] (-1,1) -- (1,-1);
}]
(2.75,-0.75) -- (3,0) -- (2.75,0.75)
\foreach \w in {45,90,...,315}
{ -- (\w:1.5cm) } -- cycle;
\end{tikzpicture}
\begin{tikzpicture}
\path[draw,fill tile picture*={0.25}{%
\draw[red!50!yellow,line width=2mm]
(0,0) circle (1cm);
\draw[red,line width=5mm] (-1,-1) -- (1,1);
\draw[red,line width=5mm] (-1,1) -- (1,-1);
}]
(2.75,-0.75) -- (3,0) -- (2.75,0.75)
\foreach \w in {45,90,...,315}
{ -- (\w:1.5cm) } -- cycle;
\end{tikzpicture}
261
12.7 Filling Options
/tikz/fill image opacity=hfractioni (no default, initially 1.0)
Sets the fill opacity for the image or picture fill options to the given hfractioni.
\begin{tikzpicture}
\path[fill stretch image=goldshade.png] (0,0) circle (1cm);
\path[fill=red,fill stretch image=goldshade.png,fill image opacity=0.75]
(2,0) circle (1cm);
\path[fill=red,fill stretch image=goldshade.png,fill image opacity=0.5]
(4,0) circle (1cm);
\path[fill=red,fill stretch image=goldshade.png,fill image opacity=0.25]
(6,0) circle (1cm);
\path[fill=red] (8,0) circle (1cm);
\end{tikzpicture}
\begin{tikzpicture}
\path[draw,fill zoom image=goldshade.png]
(0,0) rectangle +(2,2);
\begin{tikzpicture}
\path[fill image options={width=1cm},
fill tile image=pink_marble.png]
(2.75,-0.75) -- (3,0) -- (2.75,0.75)
\foreach \w in {45,90,...,315}
{ -- (\w:1.5cm) } -- cycle;
\end{tikzpicture}
262
Image blending example
\begin{tikzpicture}[every node/.style=
{circle,minimum width=2cm}]
\node[fill stretch image=blueshade.png]
(A) at (120:3cm) {A}; A + B
\node[fill stretch image=goldshade.png]
(B) at (60:3cm) {B};
\node[
preaction={fill stretch image=blueshade.png},
fill stretch image=goldshade.png,
fill image opacity=0.5] (C) {C};
\path (A) -- node{$+$} (B); C
\draw[->,very thick] (A)--(C);
\draw[->,very thick] (B)--(C);
\end{tikzpicture}
N 2014-05-05 \tcbpatcharcangular
The TikZ package provides a nice rounded corners option to replace all corners by little
arcs. \tcbpatcharcangular is a patch which straightens the arcs. To say it more prosaic,
the little arcs are replaced by little straight lines.
\begin{tikzpicture}
\draw[thick,rounded corners=8pt]
(0,0) -- (0,2) -- (1,3.25) -- (2,2) -- (2,0)
-- (0,2) -- (2,2) -- (0,0) -- (2,0);
\tcbpatcharcangular
\draw[thick,rounded corners=8pt,xshift=2.5cm]
(0,0) -- (0,2) -- (1,3.25) -- (2,2) -- (2,0)
-- (0,2) -- (2,2) -- (0,0) -- (2,0);
\end{tikzpicture}
N 2014-05-05 \tcbpatcharcround
This macro reverts \tcbpatcharcangular, i.e., the patch from \tcbpatcharcangular is
replaced by the original code.
263
12.9 Extracting Node Dimensions
The following auxiliary macros are defined by the skins library. They allow to determine
LIB
the width and height of an arbitrary TikZ node. To be more specific, they determine the east-
to-west and the north-to-south dimensions which may be not the maximal dimensions for a
non-rectangular node. Note that the following dimensions are measured exactly including the
line width of the border line. If a new rectangle or node with the same dimensions and a border
is to be drawn, this border width has to be substracted.
N 2014-09-19 \tcbsettowidthofnode{hregisteri}{hnodei}
Sets the east-to-west dimension of the given hnodei to the TEX hregisteri.
N 2014-09-19 \tcbsetmacrotowidthofnode{hmacroi}{hnodei}
Defines hmacroi as the east-to-west dimension of the given hnodei.
N 2014-09-19 \tcbsettoheightofnode{hregisteri}{hnodei}
Sets the north-to-south dimension of the given hnodei to the TEX hregisteri.
N 2014-09-19 \tcbsetmacrotoheightofnode{hmacroi}{hnodei}
Defines hmacroi as the north-to-south dimension of the given hnodei.
\begin{tikzpicture}
\node[align=center,draw=red,fill=yellow] (A) {This is my\\example node};
\tcbsetmacrotowidthofnode\mywidth{A}
\tcbsetmacrotoheightofnode\myheight{A}
\path[fill=blue!25!white] % rectangle widthout border
([xshift=2mm]A.south east)
rectangle node{Copy} +(\mywidth,\myheight);
\node[draw=blue,fill=blue!25!white, % standard border width 0.4pt
minimum width=\mywidth-0.4pt, % minus width of border
minimum height=\myheight-0.4pt % minus height of border
]
at ([xshift=5cm]A) {Copy 2};
\end{tikzpicture}
This is my
Copy Copy 2
example node
N 2016-02-03 \tcbhypernode{hmacroi}{hnodei}
Applies a hyperlink creating hmacroi from the package hyperref [15] to an existing tikz
hnodei. \tcbhypernode can only be used inside a tikzpicture environment. The last
argument of the hmacroi is to be omitted and should stand for an object (text) which is to be
made a hyperlink. For example, use \hyperref[name] instead of \hyperref[name]{text}.
% \usepackage{hyperref}
\begin{tikzpicture}
\node[align=center,draw=red,fill=red!5] (mybutton)
{Click me to jump to Section~\ref*{sec:tikzimagefilling}};
\tcbhypernode{\hyperref[sec:tikzimagefilling]}{mybutton}
\end{tikzpicture}
264
13 Library vignette
LIB
The library is loaded by a package option or inside the preamble by:
\tcbuselibrary{vignette}
This also loads the LIB skins library, see Section 10 on page 148, and the fadings library of tikz
[22].
N 2016-04-22 \tcbvignette{hoptionsi}
In this context, a vignette is a four part rectangular frame. It is constructed as several
TikZ paths and, therefore, can only be used inside a tikzpicture environment or inside
tcolorboxÕ P. 12 options.
The hoptionsi control position, size and style settings of the vignette. Theses options have
the common key path /tcb/vig/ and are described in the following.
The next examples show direct \tcbvignette usage without a tcolorboxÕ P. 12 .
\begin{tikzpicture}
\tcbvignette{}
\end{tikzpicture}
\begin{tikzpicture}
\node[draw,fill=blue!15!white] (A) {Test};
Test
\tcbvignette{outside node=A,raised color=blue}
\end{tikzpicture}
\begin{tikzpicture}
\node[draw,fill=blue!15!white] (A) {Another Test};
\tcbvignette{size=3mm,outside node=A,
Another Test
north style=red,east style=yellow,
south style=blue,west style=green}
\end{tikzpicture}
\begin{tikzpicture}
\node[inner sep=3mm,fill=red!75] (A) {Test};
Test
\tcbvignette{over node=A,fade in}
\end{tikzpicture}
\tcbvignette can be used directly inside appropriate options keys for tcolorboxÕ P. 12 .
Note that options like /tcb/underlayÕ P. 195 need /tcb/enhancedÕ P. 206 or similar settings.
265
\begin{tcolorbox}[enhanced,size=small,sharp corners,
colback=green!10,colframe=green!50!black,
boxrule=1mm,titlerule=0mm,
My title
title=My title,center title,fonttitle=\bfseries,
underlay={\tcbvignette{size=1mm,inside node=frame, This is a tcolor-
raised color=green!50!black}}] box.
This is a tcolorbox.
\end{tcolorbox}
Mostly, convenient short cuts like /tcb/underlay vignetteÕ P. 272 can be used to add a
vignette to a tcolorboxÕ P. 12 . Here, \tcbvignetteÕ P. 265 is used internally.
\begin{tcolorbox}[enhanced,size=small,sharp corners,
colback=green!10,colframe=green!50!black,
boxrule=1mm,titlerule=0mm, My title
title=My title,center title,fonttitle=\bfseries, This is a tcolor-
underlay vignette] box.
This is a tcolorbox.
\end{tcolorbox}
\begin{tikzpicture}
\fill [black!20] (0,0) rectangle (3,2);
\path [pattern=checkerboard,pattern color=black!30]
(0,0) rectangle (3,2);
\tcbvignette{xmin=1cm,xmax=2.5cm,ymin=0.5cm,ymax=1.75cm}
\end{tikzpicture}
\begin{tikzpicture}
\fill [black!20] (0,0) rectangle (3,2);
\path [pattern=checkerboard,pattern color=black!30]
(0,0) rectangle (3,2);
\tcbvignette{lower left corner={1,0.5},
upper right corner={2.5,1.75}}
\end{tikzpicture}
266
N 2016-04-22 /tcb/vig/inside node=hnamei (style, initally unset)
Places the \tcbvignetteÕ P. 265 inside the node with the given hnamei. The outer limits of
the vignette are adapted to the node geometry.
\begin{tikzpicture}
\node[minimum width=2cm,minimum height=1cm] (A) {Node A};
\tcbvignette{inside node=A} Node A
\draw[very thick] (A.south west) rectangle (A.north east);
\end{tikzpicture}
\begin{tikzpicture}
\node[minimum width=2cm,minimum height=1cm] (A) {Node A};
\tcbvignette{outside node=A} Node A
\draw[very thick] (A.south west) rectangle (A.north east);
\end{tikzpicture}
\begin{tikzpicture}
\tcbvignette{north size=4mm}
\end{tikzpicture}
\begin{tikzpicture}
\tcbvignette{south size=4mm}
\end{tikzpicture}
\begin{tikzpicture}
\tcbvignette{east size=4mm}
\end{tikzpicture}
267
N 2016-04-22 /tcb/vig/west size=hlengthi (no default, initially 2mm)
Sets the thickness of the west vignette part.
\begin{tikzpicture}
\tcbvignette{west size=4mm}
\end{tikzpicture}
\begin{tikzpicture}
\tcbvignette{vertical size=4mm}
\end{tikzpicture}
\begin{tikzpicture}
\tcbvignette{horizontal size=4mm}
\end{tikzpicture}
\begin{tikzpicture}
\tcbvignette{size=4mm}
\end{tikzpicture}
! /tcb/vig/north sizeÕ P. 267 , /tcb/vig/south sizeÕ P. 267 , etc. have to be set before
/tcb/vig/outside nodeÕ P. 267 is used.
\begin{tikzpicture}
\tcbvignette{north style=blue}
\end{tikzpicture}
\begin{tikzpicture}
\tcbvignette{south style={draw=blue,fill=yellow}}
\end{tikzpicture}
268
N 2016-04-22 /tcb/vig/east style={hstylei} (no default, initially red!75!black)
Sets TikZ hstylei options for the east vignette part.
\begin{tikzpicture}
\tcbvignette{east style={left color=yellow!75!black,
right color=blue!75!black}}
\end{tikzpicture}
\begin{tikzpicture}
\tcbvignette{west style={preaction={fill=black!20},
pattern=checkerboard,
pattern color=black!30}}
\end{tikzpicture}
\begin{tikzpicture}
\tcbvignette{scope={transparency group,opacity=0.25}}
\end{tikzpicture}
\begin{tikzpicture}
\tcbvignette{raised color=blue}
\end{tikzpicture}
\begin{tikzpicture}
\tcbvignette{lowered color=green!75!black}
\end{tikzpicture}
\begin{tikzpicture}
\tcbvignette{color from=red to blue!50}
\end{tikzpicture}
269
N 2016-04-22 /tcb/vig/draw method=direct|clipped (no default, initially direct)
Especially, if shadings or fadings are used, the drawn vignette graphs are displayed some-
times not as perfect as expected. Glitches and imperfections are very dependent on the
previewer software. The /tcb/vig/draw method intends to give a choice of alternative
drawing methods.
• direct: The vignette parts are drawn/filled by using a single TikZ graph. This is the
preferred (and default) method for solid color graphs.
• clipped: The vignette parts are drawn somewhat oversized and are clipped to the
intended region. In combination with shadings and fadings this seems to give a bet-
ter/different optical result (depends on the previewer).
\begin{tikzpicture}
\tcbvignette{color from=red to yellow}
\end{tikzpicture}
\begin{tikzpicture}
\tcbvignette{color from=red to yellow,draw method=clipped}
\end{tikzpicture}
The fadings library of tikz [22] is loaded automatically by the vignette library. Amongst
LIB
others, the fadings west, east, north, and south are defined inside the fadings library.
The vignette library adds some more fadings called semi west, semi east, semi north,
LIB
and semi south. These fadings are much weaker than the normal fadings.
\begin{tikzpicture}
\fill [black!20] (0,0) rectangle (1,1);
\path [pattern=checkerboard,pattern color=black!30]
(0,0) rectangle (1,1);
\fill [path fading=semi west,blue] (0,0) rectangle (1,1);
\end{tikzpicture}
west east
north south
270
N 2016-04-22 /tcb/vig/fade in={hstylei} (style, default white)
Sets the four style options /tcb/vig/north styleÕ P. 268 , /tcb/vig/south styleÕ P. 268 ,
/tcb/vig/east styleÕ P. 269 , and /tcb/vig/west styleÕ P. 269 such that the paths fade
from outside to inside.
\begin{tikzpicture}
\fill [black!20] (-0.5,-0.5) rectangle (1.5,1.5);
\path [pattern=checkerboard,pattern color=black!30]
(-0.5,-0.5) rectangle (1.5,1.5);
\tcbvignette{fade in=blue}
\end{tikzpicture}
271
13.5 Vignette as Underlay
\begin{tcolorbox}[enhanced,size=small,sharp corners,
colback=green!10,colframe=green!50!black,
boxrule=2mm,titlerule=0mm, My title
title=My title,center title,fonttitle=\bfseries, This is a tcolor-
underlay vignette] box.
This is a tcolorbox.
\end{tcolorbox}
\begin{tcolorbox}[enhanced,size=small,arc=0pt,
colback=blue!10,colframe=blue,boxrule=2mm,
This is a tcolor-
underlay vignette={size=1.5mm}]
box.
This is a tcolorbox.
\end{tcolorbox}
\begin{tcolorbox}[enhanced,size=small,sharp corners,
colframe=red,interior hidden,boxrule=2mm,
colupper=white,center upper,fontupper=\bfseries, This is a
underlay vignette] tcolorbox.
This is a tcolorbox.
\end{tcolorbox}
\begin{tcolorbox}[enhanced,size=small,sharp corners,
colback=red!50!yellow,frame hidden,boxrule=2mm,
underlay vignette={color from=red!50!yellow to white, This is a tcolor-
draw method=clipped,size=2.1mm}] box.
This is a tcolorbox.
\end{tcolorbox}
\tcbox[enhanced,sharp corners,colback=red!10,colframe=red]
{Test} Test
272
N 2016-04-22 /tcb/underlay raised shading vignette={hoptionsi} (style, no default)
This is a special style derived from /tcb/underlay vignetteÕ P. 272 , where the frame color
is shaded to create a soft raised frame impression.
\begin{tcolorbox}[enhanced,sharp corners,
colback=green!10,
colframe=green!50!black,
My title
size=small,boxrule=2mm,titlerule=0mm,
title=My title,center title,fonttitle=\bfseries, This is a tcolor-
underlay raised shading vignette] box.
This is a tcolorbox.
\end{tcolorbox}
\begin{tcolorbox}[enhanced,sharp corners,
colback=green!10,
colframe=green!50!black,
My title
size=small,boxrule=2mm,titlerule=0mm,
title=My title,center title,fonttitle=\bfseries, This is a tcolor-
underlay raised fading vignette] box.
This is a tcolorbox.
\end{tcolorbox}
273
13.6 Vignette as Finish
\begin{tcolorbox}[enhanced,size=small,
colback=green!10,colframe=green!50!black,
boxrule=0.5mm,titlerule=0mm, My title
title=My title,center title,fonttitle=\bfseries, This is a tcolor-
finish vignette={size=1mm}] box.
This is a tcolorbox.
\end{tcolorbox}
\tcbincludegraphics[blankest,width=3cm,
finish vignette={size=3mm}]{pink_marble.png}
\begin{tcolorbox}[enhanced,size=small,
colback=green!10,colframe=green!50!black,
boxrule=0.5mm,titlerule=0mm, My title
title=My title,center title,fonttitle=\bfseries, This is a tcolor-
finish raised fading vignette={size=1mm}] box.
This is a tcolorbox.
\end{tcolorbox}
\tcbincludegraphics[blankest,width=3cm,
finish raised fading vignette={size=3mm}]{pink_marble.png}
274
N 2016-04-22 /tcb/finish fading vignette={hoptionsi} (style, no default)
This puts a \tcbvignetteÕ P. 265 with the given hoptionsi as /tcb/finishÕ P. 197 to a
tcolorboxÕ P. 12 . The default style settings fade the box into white from inside to outside.
Note that /tcb/vig/over nodeÕ P. 267 is used here. /tcb/vig/over node offsetÕ P. 267
can be adapted to overlap the box more or less. The fade color can be set using
/tcb/vig/base colorÕ P. 269 .
\begin{tcolorbox}[enhanced,size=small,
colback=green!10,colframe=green!50!black,
boxrule=0.5mm,titlerule=0mm, My title
title=My title,center title,fonttitle=\bfseries, This is a tcolor-
finish fading vignette={size=2mm}] box.
This is a tcolorbox.
\end{tcolorbox}
\tcbincludegraphics[blankest,width=3cm,
finish fading vignette={size=3mm}]{pink_marble.png}
Example
\begin{tcolorbox}[colback=blue!50!black,size=small,
title=Example]
\tcbincludegraphics[blankest,
finish fading vignette={base color=blue!50!black,size=3mm,
over node offset=0.2mm}]{pink_marble.png}
\end{tcolorbox}
275
\begin{tcbitemize}[raster columns=3,bicolor,
raster equal height,sharp corners,boxrule=2mm,
colframe=red,colback=yellow!5,colbacklower=yellow!25!red!20]
\tcbitem A
\tcbitem[underlay vignette] B
\tcbitem[underlay={\tcbvignette{inside node=interior,
lowered color=red,size=1mm}}] C
\tcbitem[underlay vignette,
underlay={\tcbvignette{inside node=interior,
lowered color=red,size=1mm}}] D
\tcbitem[boxrule=3mm,underlay vignette={size=2mm},
underlay={\tcbvignette{inside node=interior,
lowered color=red,size=1mm}}] E
\tcbitem[underlay raised shading vignette] F
\tcbitem[underlay raised shading vignette,
underlay={\tcbvignette{inside node=interior,
lowered color=red,size=1mm}}] G
\tcbitem[title=H1,underlay={\tcbvignette{inside node=interior,
lowered color=red,size=1mm}},finish vignette] H2
\tcbitem[boxrule=0.25mm,colback=red!30,finish vignette] I1 \tcblower I2
\tcbitem[tile,colback=red!30,finish raised fading vignette] J1 \tcblower J2
\tcbitem[boxrule=1mm,underlay={\tcbvignette{inside node=interior,
raised color=red,size=1mm}}] K
\tcbitem[boxrule=1mm,title=L1,underlay={\tcbvignette{inside node=title,
lowered color=red,size=0.5mm}}] L2
\end{tcbitemize}
A B C
D E F
H1 I1
G
H2 I2
J1 L1
K
L2
J2
276
14 Library raster
LIB
The library is loaded by a package option or inside the preamble by:
\tcbuselibrary{raster}
A raster is used to align several colored boxes in a regular way. It can be seen as a far related
counterpart to the matrix construct of TikZ, but it differs in many aspects.
In principle, tcolorboxes are arranged in rows and columns when put inside a tcbrasterÕ P. 279
environment. The boxes are fluently added to the raster like adding text to a paragraph.
Especially, line/row breaks are done automatically and one cannot end a line/row ahead of
schedule. Further, a raster is not restricted to a single page but may break into an arbitrary
series of pages.
/tcb/raster width
Lorem ipsum dolor sit amet, consectetuer adipiscing
elit. Ut purus elit, vestibulum ut, placerat ac, adipisc-
NamÕdui ligula, fringilla a, euismod sodales, sollici-
P. 283
tudin vel, wisi. Morbi auctor lorem non justo. Nam
ing vitae, felis. Curabitur dictum gravida mauris. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tel-
arcu libero, nonummy eget, consectetuer id, vulputate lus. Donec aliquet, tortor sed accumsan bibendum, erat
a, magna. Donec vehicula augue eu neque. Pellentesque ligula aliquet magna, vitae ornare odio metus a mi.
habitant morbi tristique senectus et netus et malesuada Morbi ac orci et nisl hendrerit mollis. Suspendisse ut
fames ac turpis egestas. Mauris ut leo. Cras viverra massa. Cras nec ante. Pellentesque a nulla. Cum sociis
metus rhoncus sem. Nulla et lectus vestibulum urna natoque penatibus et magnis dis parturient montes,
/tcb/raster left skip Õ P. 285
fringilla ultrices. Phasellus eu tellus sit amet tortor /tcb/raster right skip
nascetur ridiculus mus. Aliquam tincidunt urna. Nulla
Õ P. 285
gravida placerat. Integer sapien est, iaculis in, pretium ullamcorper vestibulum turpis. Pellentesque cursus luc-
quis, viverra ac, nunc. Praesent eget sem vel leo ultrices tus mauris.
bibendum. Aenean faucibus. Morbi dolor nulla, male-
suada eu, pulvinar at, mollis ac, nulla. Curabitur auctor
/tcb/raster column skipÕ P. 285
semper nulla. Donec varius orci eget risus. Duis nibh
mi, congue eu, accumsan eleifend, sagittis quis, diam.
Duis eget orci sit amet orci dignissim rutrum.
/tcb/raster row skipÕ P. 285
Box #3 Box #4
Nulla malesuada porttitor diam. Donec felis erat, Quisque ullamcorper placerat ipsum. Cras nibh. Morbi
congue non, volutpat at, tincidunt tristique, libero. Vi- vel justo vitae lacus tincidunt ultrices. Lorem ipsum
vamus viverra fermentum felis. Donec nonummy pel- dolor sit amet, consectetuer adipiscing elit. In hac
lentesque ante. Phasellus adipiscing semper elit. Proin habitasse platea dictumst. Integer tempus convallis au-
277
\begin{tcbraster}[raster columns=3,raster rows=3,raster height=\linewidth,
enhanced,size=small,sharp corners,arc=8mm,colframe=red!50!black,
colback=yellow!10!white,watermark overzoom=1.0,fit algorithm=hybrid* ]
\begin{tcolorbox}[rounded corners=northwest,boxrule=0pt,
watermark graphics=lichtspiel.jpg]\end{tcolorbox}
\tcboxfit{\lipsum[1]}
\begin{tcolorbox}[rounded corners=northeast,boxrule=0pt,
watermark graphics=goldshade.png]\end{tcolorbox}
\tcboxfit{\lipsum[2]}
\begin{tcolorbox}[valign=center,halign=center]Nine Boxes.\end{tcolorbox}
\tcboxfit{\lipsum[3]}
\begin{tcolorbox}[rounded corners=southwest,boxrule=0pt,
watermark graphics=goldshade.png]\end{tcolorbox}
\tcboxfit{\lipsum[4]}
\begin{tcolorbox}[rounded corners=southeast,boxrule=0pt,
watermark graphics=lichtspiel.jpg]\end{tcolorbox}
\end{tcbraster}
Nam dui ligula, fringilla a, euismod so- Nulla malesuada porttitor diam. Donec
dales, sollicitudin vel, wisi. Morbi auc- felis erat, congue non, volutpat at, tin-
cidunt tristique, libero. Vivamus viverra
tor lorem non justo. Nam lacus libero, fermentum felis. Donec nonummy pellen-
pretium at, lobortis vitae, ultricies et, tesque ante. Phasellus adipiscing semper
tellus. Donec aliquet, tortor sed ac- elit. Proin fermentum massa ac quam.
cumsan bibendum, erat ligula aliquet Sed diam turpis, molestie vitae, placerat
magna, vitae ornare odio metus a mi. a, molestie nec, leo. Maecenas lacinia.
Nam ipsum ligula, eleifend at, accumsan
Morbi ac orci et nisl hendrerit mollis. Nine Boxes. nec, suscipit a, ipsum. Morbi blandit
Suspendisse ut massa. Cras nec ante. ligula feugiat magna. Nunc eleifend conse-
Pellentesque a nulla. Cum sociis na- quat lorem. Sed lacinia nulla vitae enim.
toque penatibus et magnis dis parturi- Pellentesque tincidunt purus vel magna.
ent montes, nascetur ridiculus mus. Integer non enim. Praesent euismod nunc
eu purus. Donec bibendum quam in tel-
Aliquam tincidunt urna. Nulla ul- lus. Nullam cursus pulvinar lectus. Donec
lamcorper vestibulum turpis. Pellen- et mi. Nam vulputate metus eu enim.
tesque cursus luctus mauris. Vestibulum pellentesque felis eu massa.
278
14.2 Macros of the Library
N 2014-11-10 \begin{tcbraster}[hoptionsi]
U 2017-02-01
henvironment contenti
\end{tcbraster}
A raster arranges enclosed boxes in a regular way, mainly into rows and columns. The
hoptionsi are used to control the raster parameters and to set the properties for the enclosed
boxes.
• The raster is only allowed to contain a series of tcolorboxÕ P. 12 environments or
derived constructs. With some small restrictions, boxes created with \tcboxfitÕ P. 411
can also be added. Boxes created with \tcboxÕ P. 14 are not reasonable here, but may
be used to a certain degree.
• Do not add anything else between the boxes inside the raster with exception of white-
space. Especially, do not use \\ or \par to end a row; row breaks are done automati-
cally.
• The boxes inside a raster are numbered automatically. \thetcbrasternum may be
used inside a box to access this number.
\begin{tcbraster}[raster columns=3, raster equal height,
size=small,colframe=red!50!black,colback=red!10!white,colbacktitle=red!50!white,
title={Box \# \thetcbrasternum}]
\begin{tcolorbox}First box\end{tcolorbox}
\begin{tcolorbox}Second box\end{tcolorbox}
\begin{tcolorbox}This is a box\\with a second line\end{tcolorbox}
\begin{tcolorbox}Another box\end{tcolorbox}
\begin{tcolorbox}A box again\end{tcolorbox}
\end{tcbraster}
Box # 4 Box # 5
Another box A box again
Box # 1 Box # 2
First box Second box
Box # 3 Box # 4
This is a box Another box
with a second line
Box # 5
A box again
279
N 2014-11-10 \begin{tcbitemize}[hoptionsi]
henvironment contenti
\end{tcbitemize}
This is a special case of a tcbrasterÕ P. 279 with the given hoptionsi.
• Here, the enclosed boxes are created using \tcbitem.
• There has to be at least one \tcbitem.
• One cannot use anything else than \tcbitem to add something to the raster.
This leads to a very compact syntax.
Box # 1 Box # 2
First box Second box
Box # 3 Box # 4
This is a box Another box
with a second line
Box # 5
A box again
N 2014-11-10 \tcbitem[hoptionsi]
Used inside tcbitemize to create a new tcolorboxÕ P. 12 with the given hoptionsi.
280
N 2016-02-19 \begin{tcboxedraster}[hraster optionsi]{hbox optionsi}
henvironment contenti
\end{tcboxedraster}
This is a convenience environment which combines a tcolorboxÕ P. 12 with an embedded
tcbrasterÕ P. 279 . The hbox optionsi are given to the outer tcolorboxÕ P. 12 , while the
hraster optionsi are given to the embedded tcbrasterÕ P. 279 . This environment is especially
useful for rasters inside rasters.
\begin{tcboxedraster}[raster columns=3, raster equal height,
size=small,colframe=red!50!black,colback=red!10!white,colbacktitle=red!50!white,
title={Box \# \thetcbrasternum}]
{colback=yellow!10,fonttitle=\bfseries,title=Boxed Raster}
\begin{tcolorbox}First box\end{tcolorbox}
\begin{tcolorbox}Second box\end{tcolorbox}
\begin{tcolorbox}This is a box\\with a second line\end{tcolorbox}
\begin{tcolorbox}Another box\end{tcolorbox}
\begin{tcolorbox}A box again\end{tcolorbox}
\end{tcboxedraster}
Boxed Raster
Box # 4 Box # 5
Another box A box again
% \tcbuselibrary{skins}
\begin{tcbraster}[raster columns=2, raster equal height,
raster every box/.style={size=small,colframe=red!50!black,colback=red!10!white,
valign=center,halign=center}]
\begin{tcolorbox}One\end{tcolorbox}
\begin{tcolorbox}Two\end{tcolorbox}
\begin{tcboxedraster}{blankest}
\begin{tcolorbox}Three\end{tcolorbox}
\begin{tcolorbox}Four\end{tcolorbox}
\begin{tcolorbox}Five\end{tcolorbox}
\begin{tcolorbox}Six\end{tcolorbox}
\end{tcboxedraster}
\begin{tcolorbox}Seven\end{tcolorbox}
\end{tcbraster}
One Two
Three Four
Seven
Five Six
281
N 2016-04-27 \begin{tcboxeditemize}[hraster optionsi]{hbox optionsi}
henvironment contenti
\end{tcboxeditemize}
This is a convenience environment which combines a tcolorboxÕ P. 12 with an embedded
tcbitemizeÕ P. 280 . The hbox optionsi are given to the outer tcolorboxÕ P. 12 , while the
hraster optionsi are given to the embedded tcbitemizeÕ P. 280 . This environment is espe-
cially useful for rasters inside rasters.
Boxed Itemize
Box # 4 Box # 5
Another box A box again
282
14.3 Option Keys of the Library
\begin{tcbitemize}[raster columns=3,
size=small,colframe=red!50!black,colback=red!10!white]
\tcbitem One
\tcbitem Two
\tcbitem Three
\tcbitem Four
\end{tcbitemize}
\begin{tcbitemize}[raster columns=4,
size=small,colframe=blue!50!black,colback=blue!10!white]
\tcbitem One
\tcbitem Two
\tcbitem Three
\tcbitem Four
\end{tcbitemize}
Four
\begin{tcbitemize}[raster width=\linewidth/2,
size=small,colframe=red!50!black,colback=red!10!white]
\tcbitem One
\tcbitem Two
\tcbitem Three
\tcbitem Four
\end{tcbitemize}
One Two
Three Four
283
N 2014-11-10 /tcb/raster height=hlengthi (no default, initially 0pt)
Sets the raster height per /tcb/raster rowsÕ P. 283 to the given hlengthi. This forces an
appropriate height for the enclosed boxes. /tcb/raster before skip and /tcb/raster
after skip are not part of this calculation. If the hlengthi is set to 0pt, this feature is
deactivated.
\begin{tcbitemize}[raster height=4cm, raster rows=2,
size=small,colframe=red!50!black,colback=red!10!white]
\tcbitem One
\tcbitem Two
\tcbitem[enhanced,
finish={\draw[blue,very thick,<->] (frame.south)
-- node[right,pos=.75]{4cm} +(0,4); }]
Three
\tcbitem Four
\tcbitem Five
\end{tcbitemize}
One Two
4cm
Three Four
Five
One Two
Three Four
284
N 2014-11-10 /tcb/raster left skip=hlengthi (no default, initially 0pt)
Space of the given hlengthi is inserted horizontally left of the raster.
One Two
Three Four
One Two
Three Four
One Two
Three Four
One Two
Three Four
285
N 2014-11-10 /tcb/raster halign=halignmenti (no default, initially left)
Defines the horizontal alignment for the boxes of the rows of a raster, if these rows are not
completely filled (mainly: the last one).
Feasible values for halignmenti are:
• left: align to the left side,
• center: align to the center,
• right: align to the right side.
\begin{tcbitemize}[raster halign=center,
size=small,colframe=red!50!black,colback=red!10!white]
\tcbitem One
\tcbitem Two
\tcbitem Three
\end{tcbitemize}
One Two
Three
286
N 2014-11-10 /tcb/raster equal height=htypei (default all, initially none)
Puts the enclosed boxes into a common /tcb/equal height groupÕ P. 61 . The hidi of the
U 2017-02-28
equal height group is chosen automatically, but it may be set manually by /tcb/raster
equal height group. Also see /tcb/minimum for current equal height groupÕ P. 62 .
Feasible values for htypei are:
• none: no equal height setting,
• rows: all boxes in a row are set to equal height,
• all: all boxes in the raster are set to equal height.
Note that you have to compile twice to see changes.
One
Two
Three Four
One
Two
Three Four
\tcbset{size=small,colframe=red!50!black,colback=red!10!white}
\begin{tcolorbox}[equal height group=raster-manual-id]
A single box
\end{tcolorbox}
\begin{tcbitemize}[raster equal height,raster equal height group=raster-manual-id]
\tcbitem One
\tcbitem \Huge Two
\end{tcbitemize}
A single box
One
Two
287
N 2014-11-10 /tcb/raster force size=true|false (default true, initially true)
Enforces the raster size computations onto the enclosed boxes. If set to false, individual
settings can be used (for the better or worse).
One Two
Three Four
Five Six
The following styles can be defined to address certain boxes inside a raster. Note that such style
definitions are not removed by /tcb/resetÕ P. 105 or /tcb/raster reset. The style definitions
are used in the order given below.
N 2014-11-24 /tcb/raster every box (style)
This style is used for every box.
N 2014-11-10 /tcb/raster odd column (style)
This style is used for every box in an odd column.
\begin{tcbitemize}[size=small,colframe=red!50!black,colback=red!10!white,
raster odd column/.style={colframe=blue!50!black,colback=blue!10!white}]
\tcbitem One
\tcbitem Two
\tcbitem Three
\tcbitem Four
\end{tcbitemize}
One Two
Three Four
288
N 2014-11-10 /tcb/raster even row (style)
This style is used for every box in an even row.
N 2014-11-10 /tcb/raster row m (style)
This style is used for every box in the m-th row. m has to be replaced by a number.
\begin{tcbitemize}[size=small,colframe=red!50!black,colback=red!10!white,
raster row 2/.style={colframe=blue!50!black,colback=blue!10!white}]
\tcbitem One
\tcbitem Two
\tcbitem Three
\tcbitem Four
\end{tcbitemize}
One Two
Three Four
\begin{tcbitemize}[size=small,colframe=red!50!black,colback=red!10!white,
raster columns=3,
raster even number/.style={colframe=blue!50!black,colback=blue!10!white}]
\tcbitem One
\tcbitem Two
\tcbitem Three
\tcbitem Four
\tcbitem Five
\tcbitem Six
\end{tcbitemize}
\begin{tcbitemize}[size=small,colframe=red!50!black,colback=red!10!white,
raster number 4/.style={colframe=blue!50!black,colback=blue!10!white}]
\tcbitem One
\tcbitem Two
\tcbitem Three
\tcbitem Four
\end{tcbitemize}
One Two
Three Four
289
14.5 Combining Columns or Rows
1 2 3
multicolumn=1
4 6
multicolumn=2
multicolumn=3
10 11
multicolumn=2
290
N 2016-02-19 /tcb/raster multirow=hnumberi (no default, initially unset)
This option has to be set inside the option list of a tcolorboxÕ P. 12 inside a tcbrasterÕ P. 279
or inside \tcbitemÕ P. 280 inside tcbitemizeÕ P. 280 . This option not really merges boxes,
but simply sizes the current box to fit the space of hnumberi rows.
multirow=2
291
For rasters without fixed /tcb/raster heightÕ P. 284 , /tcb/raster multirowÕ P. 291 can-
not be used. Note that \tcbtextheightÕ P. 147 also cannot be used like in the previous
example.
But, with combination of /tcb/raster equal heightÕ P. 287 and /tcb/space toÕ P. 59 , a
similar effect can be created:
\begin{tcbitemize}[raster columns=3,raster equal height=rows,
raster every box/.style={colframe=red!50!black,colback=red!10!white}]
\tcbitem
\tcbitem
\tcbitem
\tcbitem[colframe=blue!50!black,colback=blue!10!white]
\lipsum[2]
\tcbitem[raster multicolumn=2,blankest,space to=\myspace]
\begin{tcbitemize}[raster columns=2]
\tcbitem This is a box of the inner raster.
\tcbitem
\tcbitem[height=\myspace]
\tcbitem[height=\myspace]
\end{tcbitemize}
\end{tcbitemize}
292
14.6 Rasters inside Rasters
A raster inside a raster cannot be used directly, because a raster can only contain a tcolorbox
or something derived from a tcolorbox. So, a raster can be put inside a tcolorbox inside a raster.
Some examples for such constructions can be found at tcboxedrasterÕ P. 281 , /tcb/raster
multicolumnÕ P. 290 , /tcb/raster multirowÕ P. 291 .
One raster+tcolorbox+raster
Two
One raster+tcboxedraster
Two
One tcbitemize+tcbitem+tcbitemize
Two
293
14.6.2 Placing Spaces
If the heights of boxes inside staggered rasters should be matched, the space has to be distributed
accordingly.
• For fixed height boxes/rasters using /tcb/raster heightÕ P. 284 , the height of boxes is
available by \tcbtextheightÕ P. 147 . This can be used to size deeper layered boxes/rasters.
• For boxes/rasters layed out using /tcb/raster equal heightÕ P. 287 , space can be dis-
tributed by /tcb/space toÕ P. 59 . It can take several compilations until all spaces are
distributed correctly.
Two
Three Four
294
\begin{tcbitemize}[raster columns=4,raster rows=4,raster height=0.8\linewidth,
raster every box/.style={size=small,beamer,
colframe=blue!75!yellow,colback=red!75!yellow!20,
center title,title=Box}]
\tcbitem One
\tcbitem Two
\tcbitem Three
\tcbitem Four
\tcbitem[raster multirow=2,blankest]
\begin{tcbitemize}[raster columns=1,raster rows=2,raster height=\tcbtextheight]
\tcbitem Twelve
\tcbitem Eleven
\end{tcbitemize}
\tcbitem[raster multirow=2,raster multicolumn=2,
colframe=red!75!yellow,colback=blue!75!yellow!20]
This is an example with fixed height boxes.
\tcbitem[raster multirow=2,blankest]
\begin{tcbitemize}[raster columns=1,raster rows=2,raster height=\tcbtextheight]
\tcbitem Five
\tcbitem Six
\end{tcbitemize}
\tcbitem Ten
\tcbitem Nine
\tcbitem Eight
\tcbitem Seven
\end{tcbitemize}
Box Box
Eleven Six
295
\begin{tcbitemize}[raster equal height=rows,
raster every box/.style={colframe=red!50!black,colback=red!10!white}]
\tcbitem[blankest,space to=\myspace]
\begin{tcbitemize}[raster columns=1]
\tcbitem One
\tcbitem[add to natural height=\myspace]
This box will adapt its height.
\end{tcbitemize}
\tcbitem This is a flexible height box.
\tcbitem \lipsum[4]
\tcbitem[blankest,space to=\myspace]
\begin{tcbitemize}[raster columns=1]
\tcbitem One
\tcbitem[add to natural height=\myspace]
This box will adapt its height.
\end{tcbitemize}
\end{tcbitemize}
296
\begin{tcbitemize}[raster equal height=rows,
raster every box/.style={colframe=red!50!black,colback=red!10!white}]
\tcbitem[blankest,space to=\myspace]
\begin{tcbitemize}[raster columns=1]
\tcbitem One
\tcbitem[add to natural height=\myspace]
This box will adapt its height.
\tcbitem \lipsum[4]
\end{tcbitemize}
\tcbitem[blankest,space to=\myspace]
\begin{tcbitemize}[raster columns=1]
\tcbitem[blankest]\includegraphics[width=\linewidth]{goldshade.png}
\tcbitem[add to natural height=\myspace]
This box will adapt its height.
\end{tcbitemize}
\end{tcbitemize}
One
297
15 Libraries listings , listingsutf8 , and minted
LIB
LIB
LIB
15.1 Loading the Libraries
In contrast to other tcolorbox libraries, the libraries listings , listingsutf8 , and minted
LIB
LIB
LIB
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 one of these libraries. If
you do not have a clue, which one of them you should use, you should take listingsutf8 .
LIB
The order in which the libraries are included influences the default settings and the
! /tcb/resetÕ P. 105 behavior. The settings of a later loaded library overwrite the settings
of a previous loaded library. A library is never loaded twice.
This library uses the package listings [6] to typeset listings. It is loaded by a package option
or inside the preamble by:
\tcbuselibrary{listings}
\tcbset{listing engine=listings}
! This library is not needed (and troublesome) when using XeL TEX. A
To extend listings for UTF-8 encoded sources, you can use the support from the package
listingsutf8 [10] by loading the library variant listingsutf8 .
LIB
\tcbuselibrary{listingsutf8}
\tcbset{listing utf8=latin1}% optional; 'latin1' is the default.
This also loads the library listings and the packages listings [6] and listingsutf8 [10].
LIB
The /tcb/listing engineÕ P. 310 is set to listings by the library. To reactivate this setting,
if overwritten by other libraries, use
\tcbset{listing engine=listings}
298
15.1.3 Loading minted
LIB
This library uses the package minted [12] to typeset listings. It is loaded by a package option
or inside the preamble by:
\tcbuselibrary{minted}
The minted package uses the external tool Pygments [14] to apply syntax highlighting.
! It has to be installed and set up, before the library can be used, see [12] and [14]. The
tcolorbox library minted does not work, if the package minted [12] does not work.
LIB
The /tcb/listing engineÕ P. 310 is set to minted by the library. To reactivate this setting, if
overwritten by other libraries, use
\tcbset{listing engine=minted}
\begin{tcblisting}{colback=red!5!white,colframe=red!75!black}
This is a \LaTeX\ example which displays the text as source code
and in compiled form.
\end{tcblisting}
This is a LATEX example which displays the text as source code and in compiled form.
299
% \tcbuselibrary{listings} /or/ \tcbuselibrary{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}}}
<?xml version="1.0"?>
<project name="Package tcolorbox" default="documentation" basedir=".">
<description>
Apache Ant build file (http://ant.apache.org/)
</description>
</project>
\end{tcblisting}
<?xml version="1.0"?>
<project name="Package␣tcolorbox" default="documentation" basedir=".">
<description>
Apache Ant build file (http://ant.apache.org/)
</description>
</project>
% \tcbuselibrary{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}
<?xml version="1.0"?>
<project name="Package tcolorbox" default="documentation" basedir=".">
<description>
Apache Ant build file (http://ant.apache.org/)
</description>
</project>
\begin{tikzpicture}
\fill[red] (0,0) rectangle (1,1);
\end{tikzpicture}
300
\begin{tcboutputlisting}
henvironment contenti
\end{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 \tcbinputlisting or \tcbuselistingtext or
\tcbuselistinglisting.
\begin{tcboutputlisting}
This \textbf{text} is written to a standardized file for later usage.
\end{tcboutputlisting}
\tcbinputlisting{hoptionsi}
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, the function is equal to that of
tcblistingÕ P. 299 .
\tcbinputlisting{colback=red!5!white,colframe=red!75!black,text only}
\tcbinputlisting{colback=green!5,colframe=green!75!black,listing only}
\begin{tikzpicture}
\fill[red] (0,0) rectangle (1,1);
\end{tikzpicture}
\tcbuselistingtext
Loads text from a file named by the key value of listing file.
\tcbuselistingtext
\tcbuselistinglisting
Typesets text as listing from a file named by the key value of listing file.
\tcbuselistinglisting
\begin{tikzpicture}
\fill[red] (0,0) rectangle (1,1);
\end{tikzpicture}
\tcbusetemplisting
Typesets text as listing from a temporary file which was written by tcbwritetempÕ P. 126 .
301
! See Section 22.4 on page 442 and Section 22.5 on page 444 for more elaborate methods to
create new environments and commands.
\newtcblisting[hinit optionsi]{hnamei}[hnumberi][hdefaulti]{hoptionsi}
Creates a new environment hnamei based on tcblistingÕ P. 299 . Basically, \newtcblisting
operates like \newenvironment. This means, the new environment hnamei option-
ally takes hnumberi arguments, where hdefaulti is the default value for the optional
first argument. The hoptionsi are given to the underlying tcblisting. Note that
/tcb/savedelimiterÕ P. 26 is set to the given hnamei automatically. The hinit optionsi
allow setting up automatic numbering, see Section 5 from page 108.
\newtcblisting{mybox}{%
colback=red!5!white,
colframe=red!75!black} This is my \LaTeX\ box.
\newtcblisting{mybox}[1]{%
colback=red!5!white,
Listing Box
colframe=red!75!black,
fonttitle=\bfseries,
title=#1}
This is my \LaTeX\ box.
\newtcblisting{mybox}[2][]{%
colback=red!5!white,
colframe=red!75!black,
fonttitle=\bfseries, Listing Box
title=#2,#1}
This is my \LaTeX\ box.
\begin{mybox}[listing only]
{Listing Box}
This is my \LaTeX\ box.
\end{mybox} Listing Box
\bigskip
This is my This is my
\begin{mybox}[listing side text] \LaTeX\ box. LATEX box.
{Listing Box}
This is my
\LaTeX\ box.
\end{mybox}
302
Definition in the preamble:
\newtcblisting[auto counter]{mycbox}[1]{%
colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries,
title=Listing \thetcbcounter: #1}
\renewtcblisting[hinit optionsi]{hnamei}[hnumberi][hdefaulti]{hoptionsi}
Operates like \newtcblistingÕ P. 302 , but based on \renewenvironment instead of
\newenvironment. An existing environment is redefined.
303
\newtcbinputlisting[hinit optionsi]{\hnamei}[hnumberi][hdefaulti]{hoptionsi}
Creates a new macro \hnamei based on \tcbinputlistingÕ P. 301 . Basically,
\newtcbinputlisting operates like \newcommand. The new macro \hnamei option-
ally takes hnumberi arguments, where hdefaulti is the default value for the optional first
argument. The hoptionsi are given to the underlying tcbinputlisting. The hinit optionsi
allow setting up automatic numbering, see Section 5 from page 108.
\renewtcbinputlisting[hinit optionsi]{\hnamei}[hnumberi][hdefaulti]{hoptionsi}
Operates like \newtcbinputlisting, but based on \renewcommand instead of \newcommand.
An existing macro is redefined.
304
15.3 Option Keys of the listings Library
LIB
/tcb/listing options=hkey listi (no default, initially style=tcblatex)
Sets the options from the package listings [6] which are used during typesetting of the
listing. For LATEX listings, there is a predefined listings style named tcblatex which can
be used.
\begin{tcblisting}{colback=red!5!white,colframe=red!25,left=6mm,
listing options={style=tcblatex,numbers=left,numberstyle=\tiny\color{red!75!black}}}
This is a \LaTeX\ example which displays the text as source code
and in compiled form. Additionally, we use line numbers here.
\end{tcblisting}
This is a LATEX example which displays the text as source code and in compiled form.
Additionally, we use line numbers here.
A l l \ t e x t i t { l i s t i n g s } o p t i o n s removed .
\begin{tcblisting}{colback=red!5!white,colframe=red!75!black,
listing style=tcblatex}
Here, we use the predefined style.
\end{tcblisting}
305
/tcb/listing inputencoding=hencodingi (no default, initially \inputencodingname)
Sets the input encoding value for the predefined listing style tcblatex and
tcbdocumentation from the library documentation . The initial value is derived
LIB
from the package inputenc if used.
/tcb/listing remove caption=true|false (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 verti-
cal space. If set to false, the listings package code is kept unchanged. Note that listings
outside tcblistingÕ P. 299 and \tcbinputlistingÕ P. 301 are always processed normally.
Typically, a user is not expected to use this key at all.
/tcb/every listing line=htexti (no default, initially unset/empty)
Inserts some htexti to the begin of every line of a listing. Note that this a hack of the
listings package code. This may become unusable or superfluous in the future.
\newtcblisting{commandshell}{colback=black,colupper=white,colframe=yellow!75!black,
listing only,listing options={style=tcblatex,language=sh},
every listing line={\textcolor{red}{\small\ttfamily\bfseries root \$> }}}
\begin{commandshell}
ls -al
cd /usr/lib
\end{commandshell}
\newtcblisting{commandshell}{colback=black,colupper=white,colframe=yellow!75!black,
listing only,listing options={style=tcblatex,language=sh},hbox,
every listing line*={\textcolor{red}{\small\ttfamily\bfseries root \$> }}}
\begin{commandshell}
ls -al
cd /usr/lib
\end{commandshell}
306
15.4 Option Keys of the listingsutf8 Library
LIB
! The listingsutf8 library is not needed (and troublesome) when using XeLATEX.
The LIB
listingsutf8 library is an extension of the listings library, so all options from Sec-
LIB
LIB
tion 15.3 on page 305 are applicable.
/tcb/listing utf8=hone-byte-encodingi (style, no default, initially latin1)
Abbreviation for using /tcb/listing inputencoding P. 306 together with UTF-8 support
Õ
from the package listingsutf8 [10]. This option is available only for the library variant
listingsutf8 . The hone-byte-encodingi is one of the applicable encodings from [10], e. g.
LIB
LIB
listings with /tcb/listing inputencoding Õ P. 306 =utf8 and with specific manual hacks
LIB
307
15.5 Option Keys of the minted Library
LIB
/tcb/minted language=hprogramming languagei (no default, initially latex)
Sets a hprogramming languagei known to Pygments [14].
% \tcbuselibrary{skins}
\newtcblisting{myjava}{listing engine=minted,
minted style=colorful,
minted language=java,
minted options={fontsize=\small,breaklines,autogobble,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}
308
/tcb/minted style=hstylei (no default, initially unset)
Sets a hstylei known to Pygments [14]. This is independent from /tcb/minted
optionsÕ P. 308 . Note that styles are always applied globally; all following examples
will be set in the given hstylei until a new style is set. Also note that setting
\usemintedstyle{hstylei} only once per document is more economic, if all styles in a
document are the same. For examples of different styles, see /tcb/minted languageÕ P. 308
and /tcb/minted optionsÕ P. 308 .
See further options in Section 15.6 on the following page.
309
15.6 Common Option Keys of all Libraries
For the hoptionsi in tcblistingÕ P. 299 respectively \tcbinputlistingÕ P. 301 the following pgf
keys can be applied. The key tree path /tcb/ is not to be used inside these macros.
/tcb/listing engine=henginei (no default)
Sets the henginei which typesets the listings. Feasible values are
• listings, if library listings or listingsutf8 is loaded.
LIB
LIB
• minted, if library minted is loaded.
LIB
/tcb/listing file=hfile namei (no default, initially \jobname.listing)
Sets the hfile namei of the file which is used to save listings.
/tcb/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.
\begin{tcblisting}{colback=red!5!white,colframe=red!75!black,listing only}
This is a \LaTeX\ example.
\end{tcblisting}
310
/tcb/text only (no value)
Typesets the environment content as compiled text.
\begin{tcblisting}{colback=red!5!white,colframe=red!75!black,text only}
This is a \LaTeX\ example.
\end{tcblisting}
This is a \textbf{tcolorbox}.
This is a tcolorbox.
\begin{tcblisting}{comment only,
comment={This is a comment.},
colback=red!5!white,colframe=red!75!black}
This is a \textbf{tcolorbox}.
\end{tcblisting}
This is a comment.
311
N 2014-11-14 /tcb/tcbimage comment=hfilenamei (style, no default, initially unset)
Uses an image denoted by hfilenamei as comment for the listing. The image is included by
the \tcbincludegraphicsÕ P. 251 macro. The inclusion can be customized by /tcb/comment
styleÕ P. 314 .
LIB
% \tcbuselibrary{skins}
\begin{tcblisting}{colback=red!5!white,colframe=red!75!black,listing side comment,
righthand width=3cm,lower separated=false,
tcbimage comment={example-image-a.pdf},
comment style={size=fbox,colframe=blue,colback=blue!50,sharp corners,
drop fuzzy shadow}}
This is a \LaTeX\ example.
\end{tcblisting}
! The libraries skins and raster are needed to apply this option.
LIB
LIB
312
% \tcbuselibrary{skins,raster}
\begin{tcblisting}{colback=red!5!white,colframe=red!75!black,listing and comment,
righthand width=3cm,lower separated=false,middle=1mm,
pdf comment={tcolorbox-example.pdf},
comment style={raster columns=3,graphics pages={1,2,3},
colframe=blue,drop fuzzy shadow}}
This is a \LaTeX\ example.
\end{tcblisting}
3 Theorems
I
Theorem 3.1: Summation of Numbers
Here I am
For all natural number n it holds: 6 Breakable Boxes
I’m invisible until you find me.
Breakable box
n(n + 1)
n
X
i= . (3) Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit,
2
vestibulum ut, placerat ac, adipiscing vitae, felis. Curabitur dictum
i=1
Funny settings. gravida mauris. Nam arcu libero, nonummy eget, consectetuer id, vulpu-
tate a, magna. Donec vehicula augue eu neque. Pellentesque habitant
We have given Theorem 3.1 on page 2.
morbi tristique senectus et netus et malesuada fames ac turpis egestas.
Mauris ut leo. Cras viverra metus rhoncus sem. Nulla et lectus vestibu-
My title 3.2 Theorem (Summation of Numbers): For all natural number n it holds: lum urna fringilla ultrices. Phasellus eu tellus sit amet tortor gravida
This box is filled with an external image. placerat. Integer sapien est, iaculis in, pretium quis, viverra ac, nunc.
Title and interior are made partly transparent to show the image. Praesent eget sem vel leo ultrices bibendum. Aenean faucibus. Morbi
n(n + 1)
n
X
i= . (4) dolor nulla, malesuada eu, pulvinar at, mollis ac, nulla. Curabitur auc-
i=1
2 tor semper nulla. Donec varius orci eget risus. Duis nibh mi, congue
My title eu, accumsan eleifend, sagittis quis, diam. Duis eget orci sit amet orci
This box uses a boxed title. The box of the title can be formatted inde- dignissim rutrum.
pendently from the main box. Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi
auctor lorem non justo. Nam lacus libero, pretium at, lobortis vitae,
1 2 3
313
N 2014-11-14 /tcb/pdf extension=hextensioni (no default, initially pdf)
Sets the PDF file name extension for /tcb/pdf commentÕ P. 312 to hextensioni. Note that
hextensioni always overwrites any actual extension given inside /tcb/pdf commentÕ P. 312 .
N 2014-11-14 /tcb/comment style=hoptionsi (no default, initially empty)
Sets the hoptionsi for /tcb/tcbimage commentÕ P. 312 and /tcb/pdf commentÕ P. 312 . These
are tcolorbox options to customize the colored box drawn around the image(s), also image
options encapsulated by /tcb/graphics optionsÕ P. 254 , and tcbrasterÕ P. 279 options for
/tcb/pdf commentÕ P. 312 .
/tcb/listing and comment (no value)
Typesets the environment content as listing in the upper part and a given comment in the
lower part.
This is my comment.
314
/tcb/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 /tcb/listing and
textÕ P. 310 and /tcb/sidebysideÕ P. 116 .
315
/tcb/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 /tcb/listing and
commentÕ P. 314 and /tcb/sidebysideÕ P. 116 .
316
/tcb/listing above text (no value)
Typesets the environment content as listing in a tcolorbox and as compiled text outside
and below the box. The outside text is treated as lower part of the tcolorbox and can be
formatted with all lower part options. The distance between box and text is controlled by
/tcb/middleÕ P. 43 .
317
/tcb/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 lower part of the tcolorbox and can be
formatted with all lower part options. The distance between box and comment is controlled
by /tcb/middleÕ P. 43 .
A
N 2014-11-07 /tcb/listing above* comment (no value)
Widely equal to /tcb/listing above comment, but the outside comment is not formatted
with the lower part options. Also, it is not put into a minipage and it may span several
pages. The distance between box and comment is controlled by /tcb/afterÕ P. 78 .
/tcb/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 lower part of the tcolorbox and can be
formatted with all lower part options. The distance between box and comment is controlled
by /tcb/middleÕ P. 43 .
A
This is a \LaTeX\ example.
318
15.7 Option Keys for Processing and Full Document Examples
% \tcbuselibrary{breakable,skins,raster}
\tcbinputlisting{
enhanced jigsaw,breakable,pad at break*=2mm,height fixed for=first and middle,
lower separated=false,
leftlower=0pt,rightlower=0pt,middle=0pt,
colframe=red!50!black,colback=yellow!10!white,
listing and comment,
listing file={tcolorbox-example},
listing options=
{style=tcblatex,texcsstyle=*\color{red!70!black},firstline=20,lastline=85},
after upper={\par\bigskip\texttt{\ldots}\par},
pdf comment,
comment style={drop lifted shadow,graphics pages={1,...,4}},
}
\documentclass{article}
\usepackage{tikz,lipsum,lmodern}
\usepackage[most]{tcolorbox}
\begin{document}
%----------------------------------------------------------
\section{Colored boxes}
\begin{tcolorbox}[colback=red!5!white,colframe=red!75!black]
My box.
\end{tcolorbox}
\begin{tcolorbox}[colback=blue!5!white,colframe=blue!75!black,title=My title]
My box with my title.
\end{tcolorbox}
\begin{tcolorbox}[colback=green!5!white,colframe=green!75!black]
Upper part of my box.
\tcblower
319
Lower part of my box.
\end{tcolorbox}
\begin{tcolorbox}[colback=yellow!5!white,colframe=yellow!50!black,
colbacktitle=yellow!75!black,title=My title]
I can do this also with a title.
\tcblower
Lower part of my box.
\end{tcolorbox}
\begin{tcolorbox}[colback=yellow!10!white,colframe=red!75!black,lowerbox=invisible,
savelowerto=\jobname_ex.tex]
Now, we play hide and seek. Where is the lower part?
\tcblower
I'm invisible until you find me.
\end{tcolorbox}
\begin{tcolorbox}[colback=yellow!10!white,colframe=red!75!black,title=Here I am]
\input{\jobname_ex.tex}
\end{tcolorbox}
\begin{tcolorbox}[enhanced,sharp corners=uphill,
colback=blue!50!white,colframe=blue!25!black,coltext=yellow,
fontupper=\Large\bfseries,arc=6mm,boxrule=2mm,boxsep=5mm,
borderline={0.3mm}{0.3mm}{white}]
Funny settings.
\end{tcolorbox}
...
320
1 Colored boxes 2 LATEX-Examples
My box. This is a \LaTeX\ example:
\begin{equation}
My title \sum\limits_{i=1}ˆn i = \frac{n(n+1)}{2}.
\end{equation}
My box with my title.
This is a LATEX example:
Side by side
My title
This is a \LaTeX\ example: This is a LATEX example:
I can do this also with a title. \begin{equation}
\sum\limits_{i=1}ˆn i = n
X n(n + 1)
Lower part of my box. \frac{n(n+1)}{2}. i= . (2)
2
\end{equation} i=1
3 Theorems
Theorem 3.1: Summation of Numbers
Here I am
For all natural number n it holds:
I’m invisible until you find me.
n(n + 1)
n
X
i= . (3)
i=1
2
Funny settings.
We have given Theorem 3.1 on page 2.
My title 3.2 Theorem (Summation of Numbers): For all natural number n it holds:
This box is filled with an external image.
Title and interior are made partly transparent to show the image. n
X n(n + 1)
i= . (4)
i=1
2
My title
This box uses a boxed title. The box of the title can be formatted inde-
pendently from the main box.
1 2
4 Watermarks ultricies et, tellus. Donec aliquet, tortor sed accumsan bibendum, erat
II
ligula aliquet magna, vitae ornare odio metus a mi. Morbi ac orci et
Box with a watermark picture nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellen-
tesque a nulla. Cum sociis natoque penatibus et magnis dis parturient
Here, you see my nice box with a picture as a watermark. This picture montes, nascetur ridiculus mus. Aliquam tincidunt urna. Nulla ullam-
is automatically resized to fit the dimensions of my box. Instead of a corper vestibulum turpis. Pellentesque cursus luctus mauris.
picure, some text could be used or arbitrary graphical code. See the Nulla malesuada porttitor diam. Donec felis erat, congue non, volutpat
documentation for more options. at, tincidunt tristique, libero. Vivamus viverra fermentum felis. Donec
nonummy pellentesque ante. Phasellus adipiscing semper elit. Proin fer-
mentum massa ac quam. Sed diam turpis, molestie vitae, placerat a,
molestie nec, leo. Maecenas lacinia. Nam ipsum ligula, eleifend at, ac-
5 Boxes in boxes cumsan nec, suscipit a, ipsum. Morbi blandit ligula feugiat magna. Nunc
eleifend consequat lorem. Sed lacinia nulla vitae enim. Pellentesque tin-
Box
cidunt purus vel magna. Integer non enim. Praesent euismod nunc eu
purus. Donec bibendum quam in tellus. Nullam cursus pulvinar lectus.
Box inside box
Donec et mi. Nam vulputate metus eu enim. Vestibulum pellentesque
felis eu massa.
Box inside box inside box
Quisque ullamcorper placerat ipsum. Cras nibh. Morbi vel justo vi-
And now for something completely different: Boxes! tae lacus tincidunt ultrices. Lorem ipsum dolor sit amet, consectetuer
adipiscing elit. In hac habitasse platea dictumst. Integer tempus con-
This is another box. vallis augue. Etiam facilisis. Nunc elementum fermentum wisi. Aenean
placerat. Ut imperdiet, enim sed gravida sollicitudin, felis odio placerat
quam, ac pulvinar elit purus eget enim. Nunc vitae tortor. Proin tempus
nibh sit amet nisl. Vivamus quis tortor vitae risus porta vehicula.
Fusce mauris. Vestibulum luctus nibh at lectus. Sed bibendum, nulla a
I
faucibus semper, leo velit ultricies tellus, ac venenatis arcu wisi vel nisl.
Vestibulum diam. Aliquam pellentesque, augue quis sagittis posuere,
6 Breakable Boxes turpis lacus congue quam, in hendrerit risus eros eget felis. Maecenas
eget erat in sapien mattis porttitor. Vestibulum porttitor. Nulla facilisi.
Breakable box Sed a turpis eu lacus commodo facilisis. Morbi fringilla, wisi in dignissim
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, interdum, justo lectus sagittis dui, et vehicula libero dui cursus dui.
vestibulum ut, placerat ac, adipiscing vitae, felis. Curabitur dictum Mauris tempor ligula sed lacus. Duis cursus enim ut augue. Cras ac
gravida mauris. Nam arcu libero, nonummy eget, consectetuer id, vulpu- magna. Cras nulla. Nulla egestas. Curabitur a leo. Quisque egestas wisi
tate a, magna. Donec vehicula augue eu neque. Pellentesque habitant eget nunc. Nam feugiat lacus vel est. Curabitur consectetuer.
morbi tristique senectus et netus et malesuada fames ac turpis egestas. Suspendisse vel felis. Ut lorem lorem, interdum eu, tincidunt sit amet,
Mauris ut leo. Cras viverra metus rhoncus sem. Nulla et lectus vestibu- laoreet vitae, arcu. Aenean faucibus pede eu ante. Praesent enim elit,
lum urna fringilla ultrices. Phasellus eu tellus sit amet tortor gravida rutrum at, molestie non, nonummy vel, nisl. Ut lectus eros, malesuada sit
placerat. Integer sapien est, iaculis in, pretium quis, viverra ac, nunc. amet, fermentum eu, sodales cursus, magna. Donec eu purus. Quisque
Praesent eget sem vel leo ultrices bibendum. Aenean faucibus. Morbi vehicula, urna sed ultricies auctor, pede lorem egestas dui, et convallis
dolor nulla, malesuada eu, pulvinar at, mollis ac, nulla. Curabitur auc- elit erat sed nulla. Donec luctus. Curabitur et nunc. Aliquam dolor
tor semper nulla. Donec varius orci eget risus. Duis nibh mi, congue odio, commodo pretium, ultricies non, pharetra in, velit. Integer arcu
eu, accumsan eleifend, sagittis quis, diam. Duis eget orci sit amet orci est, nonummy in, fermentum faucibus, egestas vel, odio.
dignissim rutrum. Sed commodo posuere pede. Mauris ut est. Ut quis purus. Sed ac odio.
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi Sed vehicula hendrerit sem. Duis non odio. Morbi ut dui. Sed accumsan
auctor lorem non justo. Nam lacus libero, pretium at, lobortis vitae, risus eget odio. In hac habitasse platea dictumst. Pellentesque non elit.
3 4
321
N 2014-11-14 /tcb/no process (no default)
Removes all processing commands if set before.
N 2014-11-14 /tcb/process code=hcodei (no default, initially empty)
Adds hcodei which is executed during \tcbinputlisting Õ P. 301 and tcblistingÕ P. 299 . At
the time of executing the given hcodei, the listing is already written to /tcb/listing
fileÕ P. 310 , but the colored box is not constructed yet. Its intended use is to pro-
cess the listing somehow before displaying. The processing result can be used inside a
/tcb/commentÕ P. 311 . Several /tcb/process code options can be given which are pro-
cessed in the given order. Typically, hcodei is added by using the following styles /tcb/run
system command, /tcb/run pdflatex, etc.
To use the further options, the compiler has to be called with the -shell-escape permis-
!
sion to authorize potentially dangerous system calls. Be warned that this is a security risk.
Anyway, it’s more economic to compile examples independent from the main document
and to include them as shown in the previous pages.
The default /tcb/listing fileÕ P. 310 setting cannot be used to compile a listing,
! since the base name equals the \jobname and the included PDF files should be unique.
Therefore, to use /tcb/run pdflatex etc., the /tcb/listing fileÕ P. 310 has to be
set to a unique value. One may use /tcb/compilable listing for this purpose.
\begin{alertblock}{Integral}
\begin{equation}
322
\visible<3->{\int\limits_1^x \frac{1}{t}~dt}
\visible<4->{ = \ln(x).}
\end{equation}
\end{alertblock}
\end{frame}
\end{document}
\end{tcblisting}
\documentclass{beamer}
\usetheme{Warsaw}
\begin{document}
\begin{frame}{Beamer example}
\begin{block}{Hello World}
\begin{itemize}[<+->]
\item One
\item Two
\end{itemize}
\end{block}
\begin{alertblock}{Integral}
\begin{equation}
\visible<3->{\int\limits_1^x \frac{1}{t}~dt}
\visible<4->{ = \ln(x).}
\end{equation}
\end{alertblock}
\end{frame}
\end{document}
Integral Integral
(1) (1)
Integral Integral
Zx Zx
1 1
dt (1) dt = ln(x). (1)
t t
1 1
323
N 2014-11-14 /tcb/run xelatex=hargumentsi (style, no default, initially unset)
Issues a xelatex compilation of the listing with the given hargumentsi.
N 2014-11-14 /tcb/run lualatex=hargumentsi (style, no default, initially unset)
Issues a lualatex compilation of the listing with the given hargumentsi.
N 2014-11-14 /tcb/run makeindex=hargumentsi (style, no default, initially unset)
Issues a makeindex compilation of the listing with the given hargumentsi.
N 2014-11-14 /tcb/run bibtex=hargumentsi (style, no default, initially unset)
Issues a bibtex compilation of the listing with the given hargumentsi.
N 2014-11-14 /tcb/run biber=hargumentsi (style, no default, initially unset)
Issues a biber compilation of the listing with the given hargumentsi.
N 2014-11-14 /tcb/run arara=hargumentsi (style, no default, initially unset)
Issues an arara compilation of the listing with the given hargumentsi.
N 2014-11-14 /tcb/run latex=hargumentsi (style, no default, initially unset)
Issues a latex compilation of the listing with the given hargumentsi.
N 2014-11-14 /tcb/run dvips=hargumentsi (style, no default, initially unset)
Issues a dvips compilation of the listing with the given hargumentsi.
N 2014-11-14 /tcb/run ps2pdf=hargumentsi (style, no default, initially unset)
Issues a ps2pdf compilation of the listing with the given hargumentsi.
\begin{tcblisting}{enhanced jigsaw,
title={PSTricks with pdflatex},fonttitle=\bfseries,
colframe=red!50!black,colback=yellow!10!white,
listing options={style=tcblatex,texcsstyle=*\color{red!70!black}},
lower separated=false,middle=0pt,
listing side comment,righthand width=4cm,
compilable listing,
run latex,run dvips,run ps2pdf,
pdf comment,freeze pdf,
comment style={raster columns=1,
graphics options={viewport=0.5in 7.7in 3.5in 10.5in,clip}},
}
\documentclass{article}
\usepackage{pstricks,multido}
\begin{document}
\psset{unit=3}%
\multido{\nHue=0.01+0.01}{100}{%
\definecolor{MyColor}{hsb}{\nHue,1,1}%
\pscircle[linewidth=0.01,linecolor=MyColor]{\nHue}}
\end{document}
\end{tcblisting}
\documentclass{article}
\usepackage{pstricks,multido}
\begin{document}
\psset{unit=3}%
\multido{\nHue=0.01+0.01}{100}{%
\definecolor{MyColor}{hsb}{\nHue,1,1}%
\pscircle[linewidth=0.01,linecolor=MyColor]{\nHue}}
\end{document}
324
! pdf file is only refreshed, if the source for this file has changed.
For most applications, you will like to add /tcb/freeze pdf as option, since the included
...
listing file=myfile.tex,
freeze extension=-modified.pdf, % -> myfile-modified.pdf is observed
...
325
15.8 Creation of LATEX Tutorials
The following source code gives a guideline for the creation of LATEX tutorials. In the next section,
a framework for LATEX exercises is described. All examples shall be numbered optionally.
Firstly, some additional tcb keys are defined for the appearance. For the examples, three
environments texexp, texexptitled, and texexptitledspec are defined with automatic num-
bering.
• texexp is used for untitled examles,
• texexptitled is used for titled examles,
• texexptitledspec is used for titled examles with special treatment.
\newtcblisting{texexp}[1]{texexp,#1}
\newtcblisting[auto counter,number within=section]{texexptitled}[3][]{%
example={#2}{#3},#1}
\newtcolorbox[use counter from=texexptitled]{texexptitledspec}[3][]{%
example={#2}{#3},#1}
\begin{tcblisting}{texexp}
This is a \LaTeX\ example which displays the text as source code
and in compiled form.
\end{tcblisting}
This is a LATEX example which displays the text as source code and in compiled form.
326
\begin{texexp}{}
This is a \LaTeX\ example which displays the text as source code
and in compiled form.
\end{texexp}
This is a LATEX example which displays the text as source code and in compiled form.
This is a LATEX example which displays the text as source code and in compiled form.
\begin{texexp}{listing only}
This is a \LaTeX\ example which displays the text as source code only.
\end{texexp}
This is a \LaTeX\ example which displays the text as source code only.
\begin{texexp}{text only}
This is a \LaTeX\ example which displays the text in compiled form only.
\end{texexp}
This is a LATEX example which displays the text in compiled form only.
This is a LATEX example with a numbered heading line which can be referred to.
327
\begin{texexptitled}[listing only]{Another Example with a Heading}{heading2}
The keys can be used in combination. Here, an example with a heading line
and source code only is given.
\end{texexptitled}
Here, we see Example \ref{heading2}.
The keys can be used in combination. Here, an example with a heading line
and source code only is given.
This is another LATEX example with numbered heading line. But now, the box is a floating object.
The floating box of the last example is seen as Example 15.4 on page 328.
\begin{texexptitledspec}{Special application}{texexpbox1}
\begin{lstlisting}[style=tcblatex]
Some \LaTeX\ source code.
\end{lstlisting}
\tcblower
For special cases, the environment |texexptitledspec| with style
|example| can be used directly. As one can see, the upper and the lower
part of the box can be used uncoupled also.
\end{texexptitledspec}
For special cases, the environment texexptitledspec with style example can be used
directly. As one can see, the upper and the lower part of the box can be used uncoupled
also.
The following series of examples demonstrate the application of tcolorboxÕ P. 12 options for
diversification.
328
\begin{texexptitled}{How to use options (1):\par The basic example}{options1}
\begin{tikzpicture}
\path[fill=yellow!50!white] (0,0) circle (11mm);
\path[fill=white] (0,0) circle (9mm);
\foreach \w/\c in {90/red,210/green,330/blue}
{\path[shading=ball,ball color=\c] (\w:1cm) circle (7mm);}
\end{tikzpicture}
\end{texexptitled}
\begin{tikzpicture}
\path[fill=yellow!50!white] (0,0) circle (11mm);
\path[fill=white] (0,0) circle (9mm);
\foreach \w/\c in {90/red,210/green,330/blue}
{\path[shading=ball,ball color=\c] (\w:1cm) circle (7mm);}
\end{tikzpicture}
\begin{tikzpicture}
\path[fill=yellow!50!white] (0,0) circle (11mm);
\path[fill=white] (0,0) circle (9mm);
\foreach \w/\c in {90/red,210/green,330/blue}
{\path[shading=ball,ball color=\c] (\w:1cm) circle (7mm);}
\end{tikzpicture}
329
\begin{texexptitled}[tikz lower,bicolor,colbacklower=white]
{How to use options (3):\par Here, the |tikzpicture| is totally hidden.
The |bicolor| skin highlights the output.}{options3}
\path[fill=yellow!50!white] (0,0) circle (11mm);
\path[fill=white] (0,0) circle (9mm);
\foreach \w/\c in {90/red,210/green,330/blue}
{\path[shading=ball,ball color=\c] (\w:1cm) circle (7mm);}
\end{texexptitled}
\begin{tikzpicture}
\path[fill=yellow!50!white] (0,0) circle (11mm);
\path[fill=white] (0,0) circle (9mm);
\foreach \w/\c in {90/red,210/green,330/blue}
{\path[shading=ball,ball color=\c]
(\w:1cm) circle (7mm);}
\end{tikzpicture}
330
\begin{texexptitled}[center lower,listing outside text,righthand width=3.5cm]
{How to use options (5):\par Putting our picture outside is just
a matter of one word.}{options5}
\begin{tikzpicture}
\path[fill=yellow!50!white] (0,0) circle (11mm);
\path[fill=white] (0,0) circle (9mm);
\foreach \w/\c in {90/red,210/green,330/blue}
{\path[shading=ball,ball color=\c]
(\w:1cm) circle (7mm);}
\end{tikzpicture}
\end{texexptitled}
\begin{tikzpicture}
\path[fill=yellow!50!white] (0,0) circle (11mm);
\path[fill=white] (0,0) circle (9mm);
\foreach \w/\c in {90/red,210/green,330/blue}
{\path[shading=ball,ball color=\c]
(\w:1cm) circle (7mm);}
\end{tikzpicture}
\begin{tikzpicture}
\path[fill=yellow!50!white] (0,0) circle (11mm);
\path[fill=white] (0,0) circle (9mm);
\foreach \w/\c in {90/red,210/green,330/blue}
{\path[shading=ball,ball color=\c]
(\w:1cm) circle (7mm);}
\end{tikzpicture}
331
\begin{texexptitled}[beamer,center lower,text outside listing,lefthand width=3.5cm]
{How to use options (7):\par Our style is easily transformed into
a beamerish one.}{options7}
\begin{tikzpicture}
\path[fill=yellow!50!white] (0,0) circle (11mm);
\path[fill=white] (0,0) circle (9mm);
\foreach \w/\c in {90/red,210/green,330/blue}
{\path[shading=ball,ball color=\c]
(\w:1cm) circle (7mm);}
\end{tikzpicture}
\end{texexptitled}
\begin{tikzpicture}
\path[fill=yellow!50!white] (0,0) circle (11mm);
\path[fill=white] (0,0) circle (9mm);
\foreach \w/\c in {90/red,210/green,330/blue}
{\path[shading=ball,ball color=\c]
(\w:1cm) circle (7mm);}
\end{tikzpicture}
332
15.9 Creation of LATEX Exercises
In the following, a guideline is given for the creation of LATEX exercises with solutions. These
solutions are saved to disk for application at a place of choice. Therefore, all used exercises are
logged to a file \jobname.records for automatic processing. The solution contents themselves
are saved to a subdirectory named solutions. Also see Section 8 on page 128.
• Before the first exercise is given, \tcbstartrecordingÕ P. 128 has to be called to start
recording.
• The solution is given as content of a tcboutputlistingÕ P. 301 environment. Note, that you
can use this content also inside the exercise with \tcbuselistingtextÕ P. 301 in compiled
form.
• After the last exercise is given (and before using the solutions), \tcbstoprecordingÕ P. 128
has to be called to stop recording.
• The solutions are loaded by \tcbinputrecordsÕ P. 128 .
Inside the exercise text, there may be text parts which are needed as LATEX source code and as
compiled text as well. These parts can be saved by tcbwritetempÕ P. 126 and used in compiled
form by \tcbusetempÕ P. 126 or as source code by \tcbusetemplistingÕ P. 301 .
At first, we generate some a common style for the exercises and the solutions. Further, since
exercises and solutions should be numbered, we force to use a label hmarkeri. Automatically,
the label exe:hmarkeri is used to mark the exercise and the label sol:hmarkeri is used to mark
the solution.
\tcbset{texercisestyle/.style={arc=0.5mm, colframe=blue!25!yellow!90!white,
colback=blue!25!yellow!5!white, coltitle=blue!25!yellow!40!black,
fonttitle=\small\sffamily\bfseries, fontupper=\small, fontlower=\small,
listing options={style=tcblatex,texcsstyle=*\color{red!40!black}},
}}
With these preparations, the kernel environment texercise for our exercises is created quickly:
333
The following examples demonstrate the application.
\tcbstartrecording
\begin{texercise}{tabular_example}
\textit{Create the following table:}\par\smallskip%
\begin{tcboutputlisting}
\begin{tabular}{|p{3cm}|p{3cm}|p{3cm}|p{3cm}|}\hline
\multicolumn{4}{|c|}{\bfseries\itshape Das alte Italien}\\\hline
\multicolumn{2}{|c|}{\bfseries Antike} &
\multicolumn{2}{c|}{\bfseries Mittelalter}\\\hline
\multicolumn{1}{|c|}{\itshape Republik}&
\multicolumn{1}{c|}{\itshape Kaiserreich}&
\multicolumn{1}{c|}{\itshape Franken}&
\multicolumn{1}{c|}{\itshape Teilstaaten}\\\hline
In den Zeiten der r\"{o}mischen Republik standen dem Staat jeweils zwei
Konsuln vor, deren Machtbefugnisse identisch waren. &
Das r\"{o}mische Kaiserreich wurde von einem Alleinherrscher, dem Kaiser,
regiert.
& In der V\"{o}lkerwanderungszeit \"{u}bernahmen die Goten und sp\"{a}ter die
Franken die Vorherrschaft.
& Im sp\"{a}teren Mittelalter regierten F\"{u}rsten einen Fleckenteppich
von Einzelstaaten.\\\hline
\end{tabular}
\end{tcboutputlisting}
\tcbuselistingtext%
\end{texercise}
334
\begin{texercise}{macro_oneparam}
\begin{tcboutputlisting}
\newcommand{\headingline}[1]{%
\begin{center}\Large\bfseries #1\end{center}}
\end{tcboutputlisting}
\tcbuselistingtext%
\begin{texercise}{macro_twoparam}
\begin{tcboutputlisting}
\newcommand{\minitable}[2]{%
\begin{center}\begin{tabular}{p{10cm}}\hline%
\multicolumn{1}{c}{\bfseries#1}\\\hline%
#2\\\hline%
\end{tabular}\end{center}}
\end{tcboutputlisting}
\tcbuselistingtext%
Create a new macro \verb+\minitable+ which produces the
following output:\par\smallskip
\begin{tcbwritetemp}
\minitable{My heading}{In this tiny tabular, there is only a heading
and some text below which has a width of ten centimeters.}
\end{tcbwritetemp}
\tcbusetemplisting\par\smallskip\tcbusetemp%
\end{texercise}
335
\begin{texercise}{macro_threeparam}
\begin{tcboutputlisting}
\newcommand{\synop}[3]{%
\begin{tabular}{@{}p{(\linewidth-\tabcolsep*2-\arrayrulewidth)/2}|%
p{(\linewidth-\tabcolsep*2-\arrayrulewidth)/2}@{}}\hline
\multicolumn{2}{c}{\bfseries #1}\\\hline
\multicolumn{1}{c|}{\itshape English}&
\multicolumn{1}{c}{\itshape German}\\\hline
#2 & #3
\end{tabular}}
\end{tcboutputlisting}
\tcbuselistingtext%
Create a new macro \verb+\synop+ which typesets a synoptic text according
to the following example. Base your macro on a tabular which takes the
total line width.\par\smallskip
\begin{tcbwritetemp}
\synop{Neil Armstrong}%
{That's one small step for a man, one giant leap for mankind.}%
{Das ist ein kleiner Schritt f\"{u}r einen Mann,
ein riesiger Sprung f\"{u}r die Menschheit.}
\end{tcbwritetemp}
\tcbusetemplisting\par\smallskip\tcbusetemp%
\end{texercise}
Create a new macro \synop which typesets a synoptic text according to the following
example. Base your macro on a tabular which takes the total line width.
\synop{Neil Armstrong}%
{That's one small step for a man, one giant leap for mankind.}%
{Das ist ein kleiner Schritt f\"{u}r einen Mann,
ein riesiger Sprung f\"{u}r die Menschheit.}
Neil Armstrong
English German
That’s one small step for a man, one giant Das ist ein kleiner Schritt für einen Mann,
leap for mankind. ein riesiger Sprung für die Menschheit.
\tcbstoprecording
\tcblistof[\subsection]{exam}{List of Exercises%
\label{listofexercises}}
336
15.11 Solutions for the given LATEX Exercises
For all solutions, a macro \processsol was written to the file \jobname.records. Now, we
need a definition for this macro to use the solutions.
% \usepackage{hyperref} % for phantomlabel
\newtcbinputlisting{\processsol}[2]{%
texercisestyle,
listing only,
listing file={#1},
phantomlabel={sol:#2},%
title={Solution for Exercise \ref{exe:#2} on page \pageref{exe:#2}},
}
\tcbinputrecords
\begin{tabular}{|p{3cm}|p{3cm}|p{3cm}|p{3cm}|}\hline
\multicolumn{4}{|c|}{\bfseries\itshape Das alte Italien}\\\hline
\multicolumn{2}{|c|}{\bfseries Antike} &
\multicolumn{2}{c|}{\bfseries Mittelalter}\\\hline
\multicolumn{1}{|c|}{\itshape Republik}&
\multicolumn{1}{c|}{\itshape Kaiserreich}&
\multicolumn{1}{c|}{\itshape Franken}&
\multicolumn{1}{c|}{\itshape Teilstaaten}\\\hline
In den Zeiten der r\"{o}mischen Republik standen dem Staat jeweils zwei
Konsuln vor, deren Machtbefugnisse identisch waren. &
Das r\"{o}mische Kaiserreich wurde von einem Alleinherrscher, dem Kaiser,
regiert.
& In der V\"{o}lkerwanderungszeit \"{u}bernahmen die Goten und sp\"{a}ter die
Franken die Vorherrschaft.
& Im sp\"{a}teren Mittelalter regierten F\"{u}rsten einen Fleckenteppich
von Einzelstaaten.\\\hline
\end{tabular}
\newcommand{\headingline}[1]{%
\begin{center}\Large\bfseries #1\end{center}}
\newcommand{\minitable}[2]{%
\begin{center}\begin{tabular}{p{10cm}}\hline%
\multicolumn{1}{c}{\bfseries#1}\\\hline%
#2\\\hline%
\end{tabular}\end{center}}
337
Solution for Exercise 15.4 on page 336
\newcommand{\synop}[3]{%
\begin{tabular}{@{}p{(\linewidth-\tabcolsep*2-\arrayrulewidth)/2}|%
p{(\linewidth-\tabcolsep*2-\arrayrulewidth)/2}@{}}\hline
\multicolumn{2}{c}{\bfseries #1}\\\hline
\multicolumn{1}{c|}{\itshape English}&
\multicolumn{1}{c}{\itshape German}\\\hline
#2 & #3
\end{tabular}}
338
16 Library theorems
LIB
The library is loaded by a package option or inside the preamble by:
\tcbuselibrary{theorems}
This is the text of the theorem. The counter is automatically assigned and, in this exam-
ple, prefixed with the section number. This theorem is numbered with 16.1, it is given on
page 339, and it is titled «This is my title».
\begin{mytheo}[label=myownlabel]{This is my title}{}
The label parameter can be left empty without \LaTeX\ error.
Or you may use an own label to reference Theorem \ref{myownlabel}.
\end{mytheo}
The label parameter can be left empty without LATEX error. Or you may use an own label
to reference Theorem 16.2.
339
\begin{mytheo}{}{}
The title can also be left empty without problem. Note that the ':'
vanished magically.
\end{mytheo}
My Theorem 16.3
The title can also be left empty without problem. Note that the ’:’ vanished magically.
\begin{mytheo*}{Unnumbered Theorem}
This theorem is not numbered.
\end{mytheo*}
\begin{mytheo*}{}
This theorem has no number and no title.
\end{mytheo*}
My Theorem
! hoptionsi list.
To switch off the nameref feature permanently, add nameref/.style={} inside the
deprecated
The hdisplay namei is used in the title line with a number, e. g. «Theorem 5.1». The
hoptionsi are given to the underlying tcolorbox to control the appearance. The hcounteri
is used for automatic numbering. The new environment hnamei takes one optional and two
mandatory parameters. The optional parameter supplements the options and should be
used only in rare cases. The first mandatory parameter is the title text for the theorem
and the second mandatory parameter is a hmarkeri. The theorem is automatically labeled
with hprefixihseparatorihmarkeri where hseparatori is predefined as ’:’, see /tcb/label
separatorÕ P. 346 .
340
\tcboxmath[hoptionsi]{hmathematical box contenti}
Creates a tcolorboxÕ P. 12 which is fitted to the width of the given hmathematical box
contenti. This box is intended to be applied as part of a larger formula and may be used
as replacement for the \boxed macro of amsmath.
\begin{equation}
\tcbset{fonttitle=\scriptsize}
\tcboxmath[colback=LightBlue!25!white,colframe=blue]{ a^2 = 16 }
\quad \Rightarrow \quad
\tcboxmath[colback=Salmon!25!white,colframe=red,title=Implication]%
{ a = 4 ~\vee~ a=-4. }
\end{equation}
Implication
a2 = 16 ⇒ a = 4 ∨ a = −4. (3)
\begin{align}
\tcbhighmath{\sum\limits_{n=1}^{\infty} \frac{1}{n}} &= \infty.\\
\int x^2 ~\text{d}x &= \frac13 x^3 + c.
\end{align}
\begin{tcolorbox}[ams align,myformula]
\tcbhighmath{\sum\limits_{n=1}^{\infty} \frac{1}{n}} &= \infty.\\
\int x^2 ~\text{d}x &= \frac13 x^3 + c.
\end{tcolorbox}
X
∞
1
= ∞. (4)
n
n=1
Z
1 3
x2 dx = x + c. (5)
3
X
∞
1
= ∞. (6)
n
n=1
Z
1 3
x2 dx = x + c. (7)
3
341
\tcbhighmathÕ P. 341 can be used in symbiosis with the empheq package which allows to
specify own boxing commands to mark multiline formulas.
% \usepackage{empheq}
\begin{empheq}[box=\tcbhighmath]{align}
a&=\sin(z)\\
E&=mc^2 + \int_a^b x\, dx
\end{empheq}
\begin{empheq}[box=\tcbhighmath]{align}
a&=\sin(z)\\
E&=mc^2 + \int_a^b x\, dx
\end{empheq}
a = sin(z) (8)
Z b
E = mc2 + x dx (9)
a
a = sin(z) (10)
Z b
E = mc2 + x dx (11)
a
Besides \tcbhighmathÕ P. 341 , one can easily define an independent new box based on
\tcboxÕ P. 14 which acts like \tcbhighmathÕ P. 341 :
% \usepackage{empheq}
\newtcbox{\otherbox}[1][]{nobeforeafter,math upper,tcbox raise base,
enhanced,frame hidden,boxrule=0pt,interior style={top color=green!10!white,
bottom color=green!10!white,middle color=green!50!yellow},
fuzzy halo=1pt with green,#1}
\begin{empheq}[box=\otherbox]{align}
a&=\sin(z)\\
E&=mc^2 + \int_a^b x\, dx
\end{empheq}
\begin{equation}
\tcbhighmath{E} = \otherbox{mc^2}
\end{equation}
a = sin(z) (12)
Z b
E = mc2 + x dx (13)
a
E = mc2 (14)
342
16.2 Option Keys of the Library
/tcb/separator sign=hsigni (no default, initially :)
The given hsigni is used inside the title text of a theorem as separater between display name
combined with number and the specific title text. It is omitted, if there is no specific title
text.
% \usepackage{amssymb}
\newtcbtheorem[use counter from=mytheo]{sometheorem}{Theorem}%
{colback=white,colframe=red!50!black,fonttitle=\bfseries,
separator sign={\ $\blacktriangleright$}}{theo}
\begin{sometheorem}{My example}{}
My theorem text.
\end{sometheorem}
My theorem text.
My theorem text.
My theorem text.
343
/tcb/description delimiters={hlefti}{hrighti} (no default, initially empty)
The given hlefti and hrighti delimiter signs are used to frame the descriptive title text of a
theorem.
\newtcbtheorem[use counter from=mytheo]{sometheorem}{Theorem}%
{colback=white,colframe=red!50!black,fonttitle=\bfseries,
description delimiters={\flqq}{\frqq}}{theo}
\begin{sometheorem}{My example}{}
My theorem text.
\end{sometheorem}
My theorem text.
My theorem text.
My theorem text.
344
/tcb/description font=htexti (default empty, initially empty)
Sets htexti (e. g. font settings) before the descriptive title text deviating from
/tcb/fonttitleÕ P. 29 . The htexti is removed, if description font is used without
value.
\newtcbtheorem[use counter from=mytheo]{sometheorem}{Theorem}%
{colback=white,colframe=red!50!black,fonttitle=\bfseries,
description delimiters={\glqq}{\grqq},
description font=\mdseries\itshape}{theo}
\begin{sometheorem}{My example}{}
My theorem text.
\end{sometheorem}
My theorem text.
My theorem text.
My theorem text.
345
/tcb/terminator sign colon (style, no value, initially set)
Sets /tcb/terminator signÕ P. 345 to the colon : sign.
My theorem text.
My theorem text.
My theorem text.
346
N 2018-01-12 /tcb/theorem full label supplement={hstylei} (no default, initially empty)
The given hstylei is used in connection with labels created with environments which are
defined themselves by \newtcbtheoremÕ P. 339 . This hstylei uses one argument which is
automatically set to the full label marker of the environment, i.e. a text consisting of
hprefixi (defined by \newtcbtheoremÕ P. 339 ), /tcb/label separatorÕ P. 346 , and hmarkeri
(defined by an actual theorem environment).
My theorem text.
A second usage of /tcb/theorem full label supplement overwrites the first setting.
N 2018-01-12 /tcb/theorem label supplement={hstylei} (no default, initially empty)
The given hstylei is used in connection with labels created with environments which are
defined themselves by \newtcbtheoremÕ P. 339 . This hstylei uses one argument which is
automatically set to the label hmarkeri defined by an actual theorem environment.
A second usage of /tcb/theorem label supplement overwrites the first setting, but
/tcb/theorem full label supplement and /tcb/theorem label supplement can be
used independently.
My theorem text.
347
/tcb/theorem name and number (style, no value, initially set)
Prints theorem name followed by theorem number inside the title.
My theorem text.
My theorem text.
Theorem: My example
My theorem text.
16.20
348
/tcb/theorem={hdisplay namei}{hcounteri}{htitlei}{hmarkeri} (no default)
This key is internally used by \tcbmaketheoremÕ P. 340 , but can be used directly in a
tcolorbox for a more flexible approach. The hdisplay namei is used together with the
increased hcounteri value and the htitlei for the title line of the box. Additionally, a \label
with the given hmarkeri is created.
% \newcounter{texercise}% preamble
\begin{tcolorbox}[colback=green!10,colframe=green!50!black,arc=4mm,
theorem={Test}{texercise}{Direct usage}{myMarker}]
Here, we see the test \ref{myMarker}.
\end{tcolorbox}
For a common appearance inside the document, the key theorem should not be used directly
as in the example above, but as part of a new environment created by hand or using
\tcbmaketheoremÕ P. 340 or using its successor \newtcbtheoremÕ P. 339 .
/tcb/highlight math (style, no value)
Predefined style which is used for \tcbhighmathÕ P. 341 . It can be changed comfortable with
/tcb/highlight math style.
/tcb/highlight math style=hstyle definitioni (style, no default)
Changes the definition for /tcb/highlight math to the given hstyle definitioni. See
\tcbhighmathÕ P. 341 for another example.
% \tcbuselibrary{skins}
\tcbset{highlight math style={enhanced,%<-- needed for the 'remember' options
colframe=red,colback=red!10!white,boxsep=0pt}}
\begin{align*}
\tcbhighmath[remember as=fx]{f(x)}
&= \int\limits_{1}^{x} \frac{1}{t^2}~dt
= \left[ -\frac{1}{t} \right]_{1}^{x}\\
&= -\frac{1}{x} + \frac{1}{1}\\
&=
\tcbhighmath[remember,overlay={%
\draw[blue,very thick,->] (fx.south) to[bend right] ([yshift=2mm]frame.west);}]
{1-\frac{1}{x}.}
\end{align*}
Zx h ix
1 1
f (x) = dt = −
t2 t 1
1
1 1
=− +
x 1
1
= 1− .
x
349
/tcb/math upper (style, no value)
Sets the upper part to mathematical mode with font \displaystyle.
/tcb/math lower (style, no value)
Sets the lower part to mathematical mode with font \displaystyle.
/tcb/math (style, no value)
Sets the upper part and lower part to mathematical mode with font \displaystyle.
\begin{tcolorbox}[math,colback=yellow!10!white,colframe=red!50!black]
\sum\limits_{n=1}^{\infty} \frac{1}{n} = \infty.
\end{tcolorbox}
X
∞
1
= ∞.
n
n=1
The following styles are only tested to work with the original amsmath environments. If
! e.g. the equation environment is redefined as gather, then /tcb/ams equation should /
could not be used. Obviously, you are encouraged to use /tcb/ams gatherÕ P. 352 in this
case.
U 2014-10-30 /tcb/ams equation upper (style, no value)
Adds an amsmath equation environment to the start and end of the upper part.
U 2014-10-30 /tcb/ams equation lower (style, no value)
Adds an amsmath equation environment to the start and end of the lower part.
U 2014-10-30 /tcb/ams equation (style, no value)
Adds an amsmath equation environment to the start and end of the upper and lower part.
\begin{tcolorbox}[ams equation,colback=yellow!10!white,colframe=red!50!black]
\sum\limits_{n=1}^{\infty} \frac{1}{n} = \infty.
\end{tcolorbox}
X
∞
1
= ∞. (15)
n
n=1
\begin{tcolorbox}[ams equation*,colback=yellow!10!white,colframe=red!50!black]
\sum\limits_{n=1}^{\infty} \frac{1}{n} = \infty.
\end{tcolorbox}
X
∞
1
= ∞.
n
n=1
350
/tcb/ams align upper (style, no value)
Adds an amsmath align environment to the start and end of the upper part.
/tcb/ams align lower (style, no value)
Adds an amsmath align environment to the start and end of the lower part.
/tcb/ams align (style, no value)
Adds an amsmath align environment to the start and end of the upper and lower part.
\begin{tcolorbox}[ams align,colback=yellow!10!white,colframe=red!50!black]
\sum\limits_{n=1}^{\infty} \frac{1}{n} &= \infty.\\
\int x^2 ~\text{d}x &= \frac13 x^3 + c.
\end{tcolorbox}
X
∞
1
= ∞. (16)
n
n=1
Z
1 3
x2 dx = x + c. (17)
3
\begin{tcolorbox}[ams align*,colback=yellow!10!white,colframe=red!50!black]
\sum\limits_{n=1}^{\infty} \frac{1}{n} &= \infty.\\
\int x^2 ~\text{d}x &= \frac13 x^3 + c.
\end{tcolorbox}
X
∞
1
= ∞.
n
n=1
Z
1 3
x2 dx = x + c.
3
351
/tcb/ams gather upper (style, no value)
Adds an amsmath gather environment to the start and end of the upper part.
/tcb/ams gather lower (style, no value)
Adds an amsmath gather environment to the start and end of the lower part.
/tcb/ams gather (style, no value)
Adds an amsmath gather environment to the start and end of the upper and lower part.
\begin{tcolorbox}[ams gather,colback=yellow!10!white,colframe=red!50!black]
\sum\limits_{n=1}^{\infty} \frac{1}{n} = \infty.\\
\int x^2 ~\text{d}x = \frac13 x^3 + c.
\end{tcolorbox}
X
∞
1
= ∞. (18)
n
n=1
Z
1 3
x2 dx = x + c. (19)
3
\begin{tcolorbox}[ams gather*,colback=yellow!10!white,colframe=red!50!black]
\sum\limits_{n=1}^{\infty} \frac{1}{n} = \infty.\\
\int x^2 ~\text{d}x = \frac13 x^3 + c.
\end{tcolorbox}
X
∞
1
= ∞.
n
n=1
Z
1 3
x2 dx = x + c.
3
352
/tcb/ams nodisplayskip upper (style, no value)
Neutralizes the \abovedisplayskip of a following align or gather environment for the
upper part. Note that the text content has to start with such a formula.
/tcb/ams nodisplayskip lower (style, no value)
Neutralizes the \abovedisplayskip of a following align or gather environment for the
lower part. Note that the text content has to start with such a formula.
/tcb/ams nodisplayskip (style, no value)
Neutralizes the \abovedisplayskip of a following align or gather environment for the
upper part and lower part. Note that the text content has to start with such a formula.
\begin{tcolorbox}[ams nodisplayskip,colback=yellow!10!white,colframe=red!50!black]
\begin{gather}
\sum\limits_{n=1}^{\infty} \frac{1}{n} = \infty.\\
\int x^2 ~\text{d}x = \frac13 x^3 + c.
\end{gather}
And now for something completely different.
\end{tcolorbox}
X
∞
1
= ∞. (20)
n
n=1
Z
1 3
x2 dx = x + c. (21)
3
And now for something completely different.
\newtcolorbox{mymath}{ams gather*,colback=yellow!10!white,colframe=red!50!black}
\begin{mymath}
\sum\limits_{n=1}^{\infty} \frac{1}{n} = \infty.\\
\int x^2 ~\text{d}x = \frac13 x^3 + c.
\end{mymath}
X
∞
1
= ∞.
n
n=1
Z
1 3
x2 dx = x + c.
3
All described options like /tcb/ams gather upperÕ P. 352 , /tcb/ams gather
lower Õ P. 352 , /tcb/ams gather Õ P. 352 are (partially) setting (overwritting) the
keys /tcb/before upperÕ P. 65 , /tcb/after upperÕ P. 65 , /tcb/before lowerÕ P. 66 ,
! /tcb/after lowerÕ P. 66 .
Therefore, e. g. \tcbset{ams gather,before upper={\text{Pythagoras:}}} produces
an invalid result. For this case, you are invited to use
\tcbset{ams gather,before upper app={\text{Pythagoras:}}},
see /tcb/before upper appÕ P. 424 .
353
/tcb/theorem style=hnamei (no default, initially standard)
Applies a predefined style hnamei to the theorem environment. Some of the feasible hnamei
values resemble style names from the packages theorem and ntheorem to give convenient
access to known patterns.
This is my theorem.
a2 + b2 = c2 .
• change standard
This is my theorem.
a2 + b2 = c2 .
• plain
\begin{theorem}[theorem style=plain]{plain}{}
This is my theorem. \begin{equation*} a^2 + b^2 = c^2. \end{equation*}
\end{theorem}
a2 + b2 = c2 .
354
• break
\begin{theorem}[theorem style=break]{break}{}
This is my theorem. \begin{equation*} a^2 + b^2 = c^2. \end{equation*}
\end{theorem}
• plain apart
This is my theorem.
a2 + b2 = c2 .
• change
\begin{theorem}[theorem style=change]{change}{}
This is my theorem. \begin{equation*} a^2 + b^2 = c^2. \end{equation*}
\end{theorem}
a2 + b2 = c2 .
• change break
• change apart
This is my theorem.
a2 + b2 = c2 .
355
• margin
\begin{theorem}[theorem style=margin,left=10mm]{margin}{}
This is my theorem. \begin{equation*} a^2 + b^2 = c^2. \end{equation*}
\end{theorem}
\begin{theorem}[theorem style=margin,left=10mm,oversize]{margin}{}
This is my theorem. \begin{equation*} a^2 + b^2 = c^2. \end{equation*}
\end{theorem}
a2 + b2 = c2 .
a2 + b2 = c2 .
• margin break
• margin apart
This is my theorem.
a2 + b2 = c2 .
This is my theorem.
a2 + b2 = c2 .
356
16.3 Examples for Definitions and Theorems
The following theorem is numbered as Theorem 16.3.1 and referenced with the marker
theo:diffbarstetig.
357
The following definition is numbered as \Cref{def:diffbarkeit} and
referenced with the marker \texttt{def:diffbarkeit}.\bigskip
\begin{Definition}{Differenzierbarkeit}{diffbarkeit}
Eine Funktion $f:~I\to\mathbb{R}$ auf einem Intervall $I$ hei\ss{}t in
$x_0\in I$ differenzierbar oder linear approximierbar,
wenn der Grenzwert
\begin{equation*}
\lim\limits_{x\to x_0}\frac{f(x)-f(x_0)}{x-x_0}=
\lim\limits_{h\to 0}\frac{f(x_0+h)-f(x_0)}{h}
\end{equation*}
existiert. Bei Existenz hei\ss{}t dieser Grenzwert Ableitung
oder Differentialquotient von $f$ in $x_0$ und man
schreibt f\"{u}r ihn
\begin{equation*}
f'(x_0)\quad\text{oder}\quad\frac{df}{dx}(x_0).
\end{equation*}
\end{Definition}
The following definition is numbered as Definition 16.3.2 and referenced with the marker def:diffbarkeit.
\begin{Corollary}{Nullstellenexistenz}{nullstellen}
Ist $f:[a,b]\to\mathbb{R}$ stetig und haben $f(a)$ und $f(b)$ entgegengesetzte
Vorzeichen, also $f(a)f(b)<0$, so besitzt $f$ eine Nullstelle $x_0\in]a,b[$,
also $f(x_0)=0$.
\end{Corollary}
The following corollary is numbered as Corollary 16.3.3 and referenced with the marker cor:nullstellen.
Ist f : [a, b] → R stetig und haben f (a) und f (b) entgegengesetzte Vorzeichen, also f (a)f (b) < 0,
so besitzt f eine Nullstelle x0 ∈]a, b[, also f (x0 ) = 0.
358
\begin{Theorem}[boxrule=2mm,toptitle=-1.5mm,bottomtitle=-1.5mm]{%
Hinreichende Bedingung f\"{u}r Wendepunkte}{wendehinreichend}%
$f$ sei eine auf einem Intervall $]a,b[$ dreimal stetig differenzierbare Funktion.
Ist $f''(x_0)=0$ in $x_0\in]a,b[$ und $f'''(x_0)\ne 0$, so ist
$(x_0,f(x_0))$ ein Wendepunkt von $f$.
\end{Theorem}
f sei eine auf einem Intervall ]a, b[ dreimal stetig differenzierbare Funktion. Ist f 00 (x0 ) = 0 in
x0 ∈]a, b[ und f 000 (x0 ) 6= 0, so ist (x0 , f (x0 )) ein Wendepunkt von f .
% \usepackage{varioref}
% \usepackage{cleveref}
% \tcbuselibrary{skins}
\newtcbtheorem[use counter from=Definition]{YetAnotherTheorem}{Theorem}%
{theorem style=plain apart,label type=theorem,enhanced,frame hidden,
boxrule=2mm,titlerule=0mm,toptitle=1mm,bottomtitle=1mm,
fonttitle=\bfseries\large,fontupper=\normalsize,
coltitle=green!35!black,colbacktitle=green!15!white,
colback=green!50!yellow!15!white,borderline={1pt}{0pt}{green!25!blue},
}{theo}
\medskip
Here, |cleveref| support is used to reference \Cref{theo:meanvaluetheorem}
on \Cpageref{theo:meanvaluetheorem}. This \namecref{theo:meanvaluetheorem}
can also be referenced by |\Vref| resulting in \Vref{theo:meanvaluetheorem}.
Es sei n ∈ N, D ⊆ Rn eine offene Menge und f ∈ C 1 (D, R). Dann gibt es auf
jeder Strecke [x0 , x] ⊂ D einen Punkt ξ ∈ [x0 , x], so dass gilt
Here, cleveref support is used to reference Theorem 16.3.5 on Page 359. This theorem can also be
referenced by \Vref resulting in Theorem 16.3.5.
! Note that /tcb/label typeÕ P. 98 was used in the example above to feed cleveref [5]
with the needed name information.
359
Here, using |\Vref| resulting in \Vref{theo:meanvaluetheorem} is more interesting\ldots
Here, using \Vref resulting in Theorem 16.3.5 on the preceding page is more interesting. . .
% \tcbuselibrary{skins}
\newtcbtheorem[use counter from=Definition]{YetAnotherTheorem}{Theorem}%
{theorem style=change apart,enhanced,arc=0mm,outer arc=0mm,
boxrule=0mm,toprule=1mm,bottomrule=1mm,left=1mm,right=1mm,
titlerule=0mm,toptitle=0mm,bottomtitle=1mm,top=0mm,
colframe=red!50!black,colback=red!5!white,coltitle=red!50!black,
title style={top color=yellow!50!white,bottom color=red!5!white,
middle color=yellow!50!white},
fonttitle=\bfseries\sffamily\normalsize,fontupper=\normalsize\itshape,
}{theo}
% \usepackage{varwidth} \tcbuselibrary{skins}
\newtcbtheorem[use counter from=Definition]{YetAnotherTheorem}{Theorem}%
{enhanced,frame empty,interior empty,colframe=ForestGreen!50!white,
coltitle=ForestGreen!50!black,fonttitle=\bfseries,colbacktitle=ForestGreen!15!white,
borderline={0.5mm}{0mm}{ForestGreen!15!white},
borderline={0.5mm}{0mm}{ForestGreen!50!white,dashed},
attach boxed title to top center={yshift=-2mm},
boxed title style={boxrule=0.4pt},varwidth boxed title}{theo}
360
You need more attention for your theorems? Here, you are . . .
% tcbuselibrary{skins} % preamble
\begin{Theorem}[enhanced,
fuzzy halo=3mm with yellow,
fuzzy halo=2mm with red,
fuzzy halo=1mm with yellow,
watermark color=red!35!white,
watermark text={Overacting\\Fundamental Theorem}]%
{Fundamental Theorem of Theorems}{fundamental}%
\lipsum[1-2]
\end{Theorem}
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, placerat
ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero, nonummy eget,
consectetuer id, vulputate a, magna. Donec vehicula augue eu neque. Pellentesque habitant morbi
tristique senectus et netus et malesuada fames ac turpis egestas. Mauris ut leo. Cras viverra metus
rhoncus sem. Nulla et lectus vestibulum urna fringilla ultrices. Phasellus eu tellus sit amet tortor
Overacting
gravida placerat. Integer sapien est, iaculis in, pretium quis, viverra ac, nunc. Praesent eget sem
vel leo ultrices bibendum. Aenean faucibus. Morbi dolor nulla, malesuada eu, pulvinar at, mollis
ac, nulla. Curabitur auctor semper nulla. Donec varius orci eget risus. Duis nibh mi, congue eu,
accumsan eleifend, sagittis quis, diam. Duis eget orci sit amet orci dignissim rutrum.
Fundamental Theorem
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem non justo.
Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet, tortor sed accum-
san bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi. Morbi ac orci et nisl
hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque a nulla. Cum sociis natoque
penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam tincidunt urna. Nulla
ullamcorper vestibulum turpis. Pellentesque cursus luctus mauris.
% \tcbuselibrary{skins}
\newtcbtheorem[use counter from=Definition]{YetAnotherTheorem}{Theorem}%
{theorem style=plain,enhanced,colframe=blue!50!black,colback=yellow!20!white,
coltitle=red!50!black,fonttitle=\upshape\bfseries,fontupper=\itshape,
drop fuzzy shadow=blue!50!black!50!white,boxrule=0.4pt}{theo}
361
16.4 Using other theorem environments with tcolorbox
Instead of creating theorem environments with the methods described before, environments from
other packages can be boxed with a tcolorbox.
Environments may be created e.g. by methods from the theorem package or the amsthm package.
\tcolorboxenvironmentÕ P. 17 can be used to put a box around these environments.
\tcolorboxenvironment{lem}{
enhanced jigsaw,colframe=cyan,interior hidden,
breakable,before skip=10pt,after skip=10pt }
\begin{lem}
\lipsum[2]
\end{lem}
\lipsum[3]
\begin{proof}
\lipsum*[4]
\end{proof}
Lemma 1. Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem
non justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet, tortor
sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi. Morbi ac orci
et nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque a nulla. Cum sociis
natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam tincidunt
urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus luctus mauris.
Nulla malesuada porttitor diam. Donec felis erat, congue non, volutpat at, tincidunt tristique, libero.
Vivamus viverra fermentum felis. Donec nonummy pellentesque ante. Phasellus adipiscing semper elit.
Proin fermentum massa ac quam. Sed diam turpis, molestie vitae, placerat a, molestie nec, leo. Maecenas
lacinia. Nam ipsum ligula, eleifend at, accumsan nec, suscipit a, ipsum. Morbi blandit ligula feugiat
magna. Nunc eleifend consequat lorem. Sed lacinia nulla vitae enim. Pellentesque tincidunt purus vel
magna. Integer non enim. Praesent euismod nunc eu purus. Donec bibendum quam in tellus. Nullam
cursus pulvinar lectus. Donec et mi. Nam vulputate metus eu enim. Vestibulum pellentesque felis eu
massa.
Proof. Quisque ullamcorper placerat ipsum. Cras nibh. Morbi vel justo vitae lacus tincidunt ultrices.
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. In hac habitasse platea dictumst. Integer
tempus convallis augue. Etiam facilisis. Nunc elementum fermentum wisi. Aenean placerat. Ut
imperdiet, enim sed gravida sollicitudin, felis odio placerat quam, ac pulvinar elit purus eget enim.
Nunc vitae tortor. Proin tempus nibh sit amet nisl. Vivamus quis tortor vitae risus porta vehicula.
362
17 Library breakable
LIB
The library is loaded by a package option or inside the preamble by:
\tcbuselibrary{breakable}
The library breakable supports the automatic breaking of a tcolorbox. This feature is
LIB
363
In principle, all boxes of the break sequence share the same geometric parameters. The differences
are:
• The given /tcb/beforeÕ P. 78 and /tcb/afterÕ P. 78 values are used only before the first
and after the last part of the break sequence.
• A special behavior between the parts of the break sequence can be given by /tcb/toprule
at breakÕ P. 369 , /tcb/bottomrule at breakÕ P. 369 , /tcb/enlarge top at break
byÕ P. 83 , and /tcb/enlarge bottom at break by Õ P. 83 .
• The /tcb/skinÕ P. 134 decides how the first, middle, and last part look like. Actually,
every part type has its own skin given by the options /tcb/skin firstÕ P. 134 , /tcb/skin
middleÕ P. 134 , and /tcb/skin lastÕ P. 134 . Typically, these options are set automatically
by the main skin, see Subsection 17.8 from page 378.
• The maximal total height of the upper and of the lower part of normal breakable
tcolorboxes is about 65536pt (ca. 2300cm) apiece. If such a part gets longer, the output
will get buggy without warning. For very oversized boxes which are longer than 65536pt,
use the unlimited value for /tcb/breakableÕ P. 365 . With the unlimited setting, the
applied algorithm has (virtually) no height limit for boxes, but very likely the compiler
memory will have to be increased for boxes longer than 300 pages (depending on compiler
settings and box content). But it is recommended to use unlimited for critical large boxes
only.
• You can nest an unbreakable tcolorbox inside another tcolorbox, even inside a break-
able one. But you cannot not nest a breakable box inside a breakable box. The
/tcb/breakableÕ P. 365 key for a nested box is ignored automatically3 , i. e. inner boxes
are always unbreakable.
After all, in the unlikely case you really want to have the nested box to be breakable, use
/tcb/enforce breakableÕ P. 366 for the nested box4 . But, a breakable box inside a
breakable box will usually give a mess.
• If your text content contains some text color changing commands, your color will not
survive the break to the next box. But, with the fontspec package and xelatex or
lualatex, you can use \addfontfeatures{Color=mycolor} to add a font color which
survives the break.
N 2014-10-30
• The perpage option of the 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).
N 2016-02-15
• Making a box /tcb/breakableÕ P. 365 which actually is not broken creates a box which acts
almost like an unbreakable box. Visual differences are kept as indiscernible as possible,
but can appear with certain /tcb/beforeÕ P. 78 and /tcb/afterÕ P. 78 settings, especially,
if there is an automatic page break before the box.
N 2016-05-25
• LuaTEX version 0.95 changes the behaviour of the basic \vsplit (a bug?!) resulting in
badly broken boxes. Thanks to Jeremy Engel, the breakable library contains a patch
LIB
3
Until tcolorbox 3.04, the /tcb/breakableÕ P. 365 key was not ignored for nested boxes.
4
/tcb/enforce breakableÕ P. 366 acts like /tcb/breakableÕ P. 365 until tcolorbox 3.04.
364
17.3 Main Option Keys
U 2017-02-01 /tcb/breakable=true|false|unlimited (default true, initially false)
Allows the tcolorbox to be breakable. If the box is larger than the available space at the
current page, the box is automatically broken and continued to the next next page. All
sorts of tcolorbox can be made breakable. It depends on the skin how the breaking looks
like. If you do not know better, use /tcb/enhancedÕ P. 206 for breaking a box. The parts
of the break sequence are numbered by the counter tcbbreakpart.
• false: Sets the tcolorbox to be unbreakable.
• true: Breaks the tcolorbox from one page to another. The maximal total height of
the upper and of the lower part is about 65536pt (ca. 2300cm or ca. 90 pages) apiece.
1
• unlimited: Experimental code for unlimited total height of breakable boxes. For
boxes longer than 300 pages (or even shorter ones) the compiler memory will have to
be increased.
% \usepackage{lipsum} % preamble
\tcbset{enhanced jigsaw,colback=red!5!white,colframe=red!75!black,
watermark color=yellow!25!white,watermark text=\arabic{tcbbreakpart},
fonttitle=\bfseries}
My breakable box
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut,
placerat ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero,
nonummy eget, consectetuer id, vulputate a, magna. Donec vehicula augue eu neque.
Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis
egestas. Mauris ut leo. Cras viverra metus rhoncus sem. Nulla et lectus vestibulum urna
fringilla ultrices. Phasellus eu tellus sit amet tortor gravida placerat. Integer sapien est,
iaculis in, pretium quis, viverra ac, nunc. Praesent eget sem vel leo ultrices bibendum.
Aenean faucibus. Morbi dolor nulla, malesuada eu, pulvinar at, mollis ac, nulla. Curabitur
auctor semper nulla. Donec varius orci eget risus. Duis nibh mi, congue eu, accumsan
eleifend, sagittis quis, diam. Duis eget orci sit amet orci dignissim rutrum.
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem
non justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet,
tortor sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi.
Morbi ac orci et nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque
a nulla. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus
mus. Aliquam tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus
luctus mauris.
Nulla malesuada porttitor diam. Donec felis erat, congue non, volutpat at, tincidunt
tristique, libero. Vivamus viverra fermentum felis. Donec nonummy pellentesque ante.
Phasellus adipiscing semper elit. Proin fermentum massa ac quam. Sed diam turpis,
molestie vitae, placerat a, molestie nec, leo. Maecenas lacinia. Nam ipsum ligula, eleifend
at, accumsan nec, suscipit a, ipsum. Morbi blandit ligula feugiat magna. Nunc eleifend
consequat lorem. Sed lacinia nulla vitae enim. Pellentesque tincidunt purus vel magna.
Integer non enim. Praesent euismod nunc eu purus. Donec bibendum quam in tellus.
Nullam cursus pulvinar lectus. Donec et mi. Nam vulputate metus eu enim. Vestibulum
pellentesque felis eu massa.
Quisque ullamcorper placerat ipsum. Cras nibh. Morbi vel justo vitae lacus tincidunt
ultrices. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. In hac habitasse platea
365
2
dictumst. Integer tempus convallis augue. Etiam facilisis. Nunc elementum fermentum
wisi. Aenean placerat. Ut imperdiet, enim sed gravida sollicitudin, felis odio placerat
quam, ac pulvinar elit purus eget enim. Nunc vitae tortor. Proin tempus nibh sit amet
nisl. Vivamus quis tortor vitae risus porta vehicula.
Fusce mauris. Vestibulum luctus nibh at lectus. Sed bibendum, nulla a faucibus semper,
leo velit ultricies tellus, ac venenatis arcu wisi vel nisl. Vestibulum diam. Aliquam
pellentesque, augue quis sagittis posuere, turpis lacus congue quam, in hendrerit risus
eros eget felis. Maecenas eget erat in sapien mattis porttitor. Vestibulum porttitor.
Nulla facilisi. Sed a turpis eu lacus commodo facilisis. Morbi fringilla, wisi in dignissim
interdum, justo lectus sagittis dui, et vehicula libero dui cursus dui. Mauris tempor
ligula sed lacus. Duis cursus enim ut augue. Cras ac magna. Cras nulla. Nulla egestas.
Curabitur a leo. Quisque egestas wisi eget nunc. Nam feugiat lacus vel est. Curabitur
consectetuer.
Suspendisse vel felis. Ut lorem lorem, interdum eu, tincidunt sit amet, laoreet vitae, arcu.
Aenean faucibus pede eu ante. Praesent enim elit, rutrum at, molestie non, nonummy vel,
nisl. Ut lectus eros, malesuada sit amet, fermentum eu, sodales cursus, magna. Donec eu
purus. Quisque vehicula, urna sed ultricies auctor, pede lorem egestas dui, et convallis elit
erat sed nulla. Donec luctus. Curabitur et nunc. Aliquam dolor odio, commodo pretium,
ultricies non, pharetra in, velit. Integer arcu est, nonummy in, fermentum faucibus,
egestas vel, odio.
366
U 2017-07-05 /tcb/break at=hlengthi/hlengthi/.../hlengthi (no default, initially 0pt)
Defines break points at the given hlengthi values. The first hlengthi defines the (maximal)
height of the first partial box, the second hlengthi defines the (maximal) height of the second
partial box, and so on. The last hlengthi value is applied to all following partial boxes if
any.
• Setting a hlengthi to 0pt means that the naturally available space is used for breaking.
• Setting a hlengthi to a negative value means that the sum of this negative value and
the naturally available space is used for breaking (boxes will shrink in height). That
that before version 4.10 negative values were treated like 0pt.
% \usepackage{multicol,lipsum}
\begin{multicols}{3}\footnotesize
Breakable boxes inside a |multicols| environment need special attendance.
They are broken by default at |\textheight|.
The |break at| option can be used to insert better break points by hand.
\begin{tcolorbox}[enhanced jigsaw,size=small,vfill before first,
colframe=red,colback=yellow!10!white,before title=\raggedright,
title={Broken box inside a |multicols| environment},fonttitle=\bfseries,
enforce breakable,% use only breakable in the real world!
pad at break=1mm,break at=3cm/6.3cm ]
\lipsum[1]
\end{tcolorbox}
\refKey{/tcb/height fixed for} may also be considered for |multicols| environments.
\end{multicols}
Breakable boxes inside a tum gravida mauris. Nam viverra ac, nunc. Prae-
multicols environment need arcu libero, nonummy eget, sent eget sem vel leo ultri-
special attendance. They consectetuer id, vulputate ces bibendum. Aenean fau-
are broken by default at a, magna. Donec vehicula cibus. Morbi dolor nulla,
\textheight. The break at augue eu neque. Pellen- malesuada eu, pulvinar at,
option can be used to insert tesque habitant morbi tris- mollis ac, nulla. Curabitur
better break points by hand. tique senectus et netus et auctor semper nulla. Donec
malesuada fames ac turpis varius orci eget risus. Duis
egestas. Mauris ut leo. nibh mi, congue eu, accum-
Broken box inside a Cras viverra metus rhon- san eleifend, sagittis quis,
multicols environment cus sem. Nulla et lectus diam. Duis eget orci sit amet
Lorem ipsum dolor sit amet, vestibulum urna fringilla ul- orci dignissim rutrum.
consectetuer adipiscing elit. trices. Phasellus eu tel-
/tcb/height fixed forÕ P. 370
Ut purus elit, vestibulum ut, lus sit amet tortor gravida
may also be considered for
placerat ac, adipiscing vi- placerat. Integer sapien
multicols environments.
tae, felis. Curabitur dic- est, iaculis in, pretium quis,
\begin{tcolorbox}[breakable,enlargepage=0mm/\baselineskip/2\baselineskip/0mm,...
The example code enlarged the second partial box by one line, the third partial box by two
lines, and all following parts are not enlarged.
If an automated page break occures before the first partial box, the page enlargement
is applied to the page before the first partial box and again to the page of the first
! partial box. Insert a manual break to prevent this.
In general, enlargepage should be used at the final stage of a document for fine-tuning
only.
367
/tcb/enlargepage flexible=hlengthi (no default, initially 0pt)
This allows an automated page enlargement for up to hlengthi. The algorithm can use this
to avoid breaking a box, if there is anough room after enlargement. Also, the last partial
box of a break sequence may be enlarged to avoid further breaking.
Note that this potential enlargement is additive to settings of /tcb/enlargepageÕ P. 367 .
But /tcb/enlargepage flexible overwrites settings of /tcb/pad before break*Õ P. 369
or /tcb/pad at break*Õ P. 369 .
% The following setting hinders orphan lines for the last partial box
\tcbset{enlargepage flexible=\baselineskip}
368
17.4 Option Keys for the Break Appearance
/tcb/toprule at break=hlengthi (no default, initially 0.5mm)
Sets the line width of the top rule to hlengthi if the box is /tcb/breakableÕ P. 365 .
In this case, it is applied to middle and last parts in a break sequence. Note that
/tcb/topruleÕ P. 35 overwrites this value if used afterwards.
/tcb/bottomrule at break=hlengthi (no default, initially 0.5mm)
Sets the line width of the bottom rule to hlengthi if the box is /tcb/breakableÕ P. 365 .
In this case, it is applied to first and middle parts in a break sequence. Note that
/tcb/bottomruleÕ P. 35 overwrites this value if used afterwards.
/tcb/topsep at break=hlengthi (no default, initially 0mm)
Additional vertical space of hlengthi which is added at the top of middle and last parts in a
break sequence. In general, it is not advisable to change this value if these parts start with
a rule or a title.
/tcb/bottomsep at break=hlengthi (no default, initially 0mm)
Additional vertical space of hlengthi which is added at the bottom of first and middle parts
in a break sequence. In general, it is not advisable to change this value if these parts end
with a rule.
/tcb/pad before break=hlengthi (style, no default, initially 3.5mm)
Sets the total amount of vertical space after the text content and before the break point
to hlengthi. This style sets /tcb/toprule at break to 0pt and changes /tcb/topsep at
break as required. In general, it is not advisable to change this value if the middle and last
parts in a break sequence start with a rule or a title.
/tcb/pad before break*=hlengthi (style, no default)
Sets /tcb/pad before break to hlengthi and /tcb/enlargepage flexibleÕ P. 368 to an
appropriate value such that empty closing frames are avoided.
/tcb/pad after break=hlengthi (style, no default, initially 3.5mm)
Sets the total amount of vertical space after the break point and before the text content to
hlengthi. This style sets /tcb/bottomrule at break to 0pt and changes /tcb/bottomsep
at break as required. In general, it is not advisable to change this value if the first and
middle parts in a break sequence end with a rule.
/tcb/pad at break=hlengthi (style, no default, initially 3.5mm)
Abbreviation for setting hlengthi to /tcb/pad before break and /tcb/pad after break.
/tcb/pad at break*=hlengthi (style, no default)
Sets /tcb/pad at break to hlengthi and /tcb/enlargepage flexibleÕ P. 368 to an appro-
priate value such that empty closing frames are avoided.
% \usepackage{lipsum} % preamble
\tcbset{colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries}
For this box, the pad space at the break point is set to 0mm
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut,
placerat ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero,
nonummy eget, consectetuer id, vulputate a, magna. Donec vehicula augue eu neque.
369
Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis
egestas. Mauris ut leo. Cras viverra metus rhoncus sem. Nulla et lectus vestibulum urna
fringilla ultrices. Phasellus eu tellus sit amet tortor gravida placerat. Integer sapien est,
iaculis in, pretium quis, viverra ac, nunc. Praesent eget sem vel leo ultrices bibendum.
Aenean faucibus. Morbi dolor nulla, malesuada eu, pulvinar at, mollis ac, nulla. Curabitur
auctor semper nulla. Donec varius orci eget risus. Duis nibh mi, congue eu, accumsan
eleifend, sagittis quis, diam. Duis eget orci sit amet orci dignissim rutrum.
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem
non justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet,
tortor sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi.
Morbi ac orci et nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque
a nulla. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus
mus. Aliquam tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus
luctus mauris.
! /tcb/pad at breakÕ P. 369 or /tcb/pad at break*Õ P. 369 should be used as very last op-
tion in an option list, because they adapt other settings.
! Also see /tcb/enlarge top at break byÕ P. 83 and /tcb/enlarge bottom at break
byÕ P. 83 .
If the box keeps unbroken, this option is not applied. See /tcb/heightÕ P. 53 for
! setting a fixed height for unbroken boxes. See /tcb/height fillÕ P. 56 for giving
unbroken boxes maximum height.
370
17.5 Extra Options for Partial Boxes
371
N 2018-07-26 /tcb/extras title after break={hoptionsi} (no default, initially unset)
If the box has a /tcb/title after breakÕ P. 366 , then the hoptionsi are added for all
titles after the first break, i.e. all middle and last. The color, font, and alignment
of titles after break can be adapted choosing hoptionsi, e.g. by /tcb/coltitleÕ P. 28 ,
/tcb/fonttitleÕ P. 29 , /tcb/halign titleÕ P. 32 . Note that /tcb/colbacktitleÕ P. 27 has
to be placed into /tcb/extras middle and lastÕ P. 371 .
N 2018-07-26 /tcb/no extras title after break (style, no default, initially set)
Removes the title after break extras if set before.
372
% \usepackage{lipsum,multicol}
% \usetikzlibrary{decorations.pathmorphing}
% \tcbuselibrary{skins}
\newtcolorbox{mybox}[1][]{
tile,
colback=green!7,coltitle=blue!50!black,colbacktitle=blue!5,
center title,
toprule=1.25mm,bottomrule=1.25mm,
extras unbroken and first={
borderline north={0.25mm}{0.5mm}{blue,decoration={zigzag,amplitude=0.5mm},decorate}},
extras unbroken and last={
borderline south={0.25mm}{0.5mm}{blue,decoration={zigzag,amplitude=0.5mm},decorate}},
#1
}
\begin{multicols}{3}
\begin{mybox}[title=My broken box,
enforce breakable,% use only breakable in the real world!
break at=4.2cm,pad at break=2mm,
height fixed for=first and middle, ]
\lipsum[2]
\end{mybox}
\end{multicols}
My unbroken box
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, placerat
ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero, nonummy eget,
consectetuer id, vulputate a, magna. Donec vehicula augue eu neque. Pellentesque habitant morbi
tristique senectus et netus et malesuada fames ac turpis egestas. Mauris ut leo. Cras viverra metus
rhoncus sem. Nulla et lectus vestibulum urna fringilla ultrices. Phasellus eu tellus sit amet tortor
gravida placerat. Integer sapien est, iaculis in, pretium quis, viverra ac, nunc. Praesent eget sem
vel leo ultrices bibendum. Aenean faucibus. Morbi dolor nulla, malesuada eu, pulvinar at, mollis
ac, nulla. Curabitur auctor semper nulla. Donec varius orci eget risus. Duis nibh mi, congue eu,
accumsan eleifend, sagittis quis, diam. Duis eget orci sit amet orci dignissim rutrum.
373
17.6 Breakable boxes and the multicol package
With version 4.10, the algorithm for detecting the available height for a tcolorbox inside
! a multicol environment was improved with help of Frank Mittelbach. This change may
impact existing user code which may have to be adapted.
Unbreakable tcolorboxes can be used with- for a breakable box cannot be done by the
out special care inside a multicols environ- balancing routine of multicols. By de-
ment from the multicol package [9]. fault, boxes will break at maximum col-
Since version 3.10, a breakable tcolorbox umn height. To get pleasant results, use
detects, if it is used inside a multicols the /tcb/break atÕ P. 367 and /tcb/height
environment. But choosing break points fixed forÕ P. 370 options.
% \usepackage{lipsum,multicol} % preamble
\footnotesize
\begin{multicols}{2}
\lipsum[1]
\begin{tcolorbox}[enhanced jigsaw,breakable,size=title,
colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries,
title=My breakable box,pad at break=1mm, break at=-\baselineskip/0pt ]
\lipsum[2-4]
\end{tcolorbox}
\lipsum[4]
\end{multicols}
Lorem ipsum dolor sit amet, consectetuer adipiscing pellentesque ante. Phasellus adipiscing semper elit.
elit. Ut purus elit, vestibulum ut, placerat ac, adipisc- Proin fermentum massa ac quam. Sed diam turpis,
ing vitae, felis. Curabitur dictum gravida mauris. Nam molestie vitae, placerat a, molestie nec, leo. Maece-
arcu libero, nonummy eget, consectetuer id, vulputate nas lacinia. Nam ipsum ligula, eleifend at, accum-
a, magna. Donec vehicula augue eu neque. Pellentesque san nec, suscipit a, ipsum. Morbi blandit ligula feu-
habitant morbi tristique senectus et netus et malesuada giat magna. Nunc eleifend consequat lorem. Sed
fames ac turpis egestas. Mauris ut leo. Cras viverra lacinia nulla vitae enim. Pellentesque tincidunt pu-
metus rhoncus sem. Nulla et lectus vestibulum urna rus vel magna. Integer non enim. Praesent euis-
fringilla ultrices. Phasellus eu tellus sit amet tortor mod nunc eu purus. Donec bibendum quam in
gravida placerat. Integer sapien est, iaculis in, pretium tellus. Nullam cursus pulvinar lectus. Donec et
quis, viverra ac, nunc. Praesent eget sem vel leo ultrices mi. Nam vulputate metus eu enim. Vestibulum
bibendum. Aenean faucibus. Morbi dolor nulla, male- pellentesque felis eu massa.
suada eu, pulvinar at, mollis ac, nulla. Curabitur auctor Quisque ullamcorper placerat ipsum. Cras nibh.
semper nulla. Donec varius orci eget risus. Duis nibh Morbi vel justo vitae lacus tincidunt ultrices.
mi, congue eu, accumsan eleifend, sagittis quis, diam. Lorem ipsum dolor sit amet, consectetuer adipisc-
Duis eget orci sit amet orci dignissim rutrum. ing elit. In hac habitasse platea dictumst. Integer
tempus convallis augue. Etiam facilisis. Nunc el-
ementum fermentum wisi. Aenean placerat. Ut
My breakable box
imperdiet, enim sed gravida sollicitudin, felis odio
Nam dui ligula, fringilla a, euismod sodales, sollici- placerat quam, ac pulvinar elit purus eget enim.
tudin vel, wisi. Morbi auctor lorem non justo. Nam Nunc vitae tortor. Proin tempus nibh sit amet nisl.
lacus libero, pretium at, lobortis vitae, ultricies et, Vivamus quis tortor vitae risus porta vehicula.
tellus. Donec aliquet, tortor sed accumsan biben-
dum, erat ligula aliquet magna, vitae ornare odio
Quisque ullamcorper placerat ipsum. Cras nibh. Morbi
metus a mi. Morbi ac orci et nisl hendrerit mollis.
vel justo vitae lacus tincidunt ultrices. Lorem ipsum
Suspendisse ut massa. Cras nec ante. Pellentesque
dolor sit amet, consectetuer adipiscing elit. In hac
a nulla. Cum sociis natoque penatibus et magnis
habitasse platea dictumst. Integer tempus convallis au-
dis parturient montes, nascetur ridiculus mus. Ali-
gue. Etiam facilisis. Nunc elementum fermentum wisi.
quam tincidunt urna. Nulla ullamcorper vestibu-
Aenean placerat. Ut imperdiet, enim sed gravida sollic-
lum turpis. Pellentesque cursus luctus mauris.
itudin, felis odio placerat quam, ac pulvinar elit purus
Nulla malesuada porttitor diam. Donec felis erat,
eget enim. Nunc vitae tortor. Proin tempus nibh sit
congue non, volutpat at, tincidunt tristique, libero.
amet nisl. Vivamus quis tortor vitae risus porta vehic-
Vivamus viverra fermentum felis. Donec nonummy
ula.
374
This example is already set inside a multicols en- adipiscing semper elit. Proin fermentum massa
vironment. This time, a middle part has full column ac quam. Sed diam turpis, molestie vitae, plac-
height (here \textheight). /tcb/height fixed erat a, molestie nec, leo. Maecenas lacinia.
forÕ P. 370 is used to spread this box part over the Nam ipsum ligula, eleifend at, accumsan nec,
full height to align with neighboring columns. suscipit a, ipsum. Morbi blandit ligula feugiat
magna. Nunc eleifend consequat lorem. Sed
% \usepackage{lipsum,multicol} lacinia nulla vitae enim. Pellentesque tincidunt
\lipsum[1] purus vel magna. Integer non enim. Prae-
\begin{tcolorbox}[enhanced jigsaw, sent euismod nunc eu purus. Donec bibendum
breakable, quam in tellus. Nullam cursus pulvinar lectus.
size=title, Donec et mi. Nam vulputate metus eu enim.
colback=red!5!white, Vestibulum pellentesque felis eu massa.
colframe=red!75!black,
Quisque ullamcorper placerat ipsum. Cras
fonttitle=\bfseries,
nibh. Morbi vel justo vitae lacus tincidunt
title=My breakable box,
pad at break=2mm, ultrices. Lorem ipsum dolor sit amet, con-
break at=-\baselineskip/0pt, sectetuer adipiscing elit. In hac habitasse
height fixed for=middle ] platea dictumst. Integer tempus convallis au-
\lipsum[2-7] gue. Etiam facilisis. Nunc elementum fer-
\end{tcolorbox} mentum wisi. Aenean placerat. Ut imperdiet,
\lipsum[8] enim sed gravida sollicitudin, felis odio placerat
quam, ac pulvinar elit purus eget enim. Nunc
vitae tortor. Proin tempus nibh sit amet nisl.
Lorem ipsum dolor sit amet, consectetuer adipiscing Vivamus quis tortor vitae risus porta vehicula.
elit. Ut purus elit, vestibulum ut, placerat ac, adip- Fusce mauris. Vestibulum luctus nibh at lec-
iscing vitae, felis. Curabitur dictum gravida mau- tus. Sed bibendum, nulla a faucibus semper,
ris. Nam arcu libero, nonummy eget, consectetuer leo velit ultricies tellus, ac venenatis arcu wisi
id, vulputate a, magna. Donec vehicula augue eu vel nisl. Vestibulum diam. Aliquam pellen-
neque. Pellentesque habitant morbi tristique senec- tesque, augue quis sagittis posuere, turpis la-
tus et netus et malesuada fames ac turpis egestas. cus congue quam, in hendrerit risus eros eget
Mauris ut leo. Cras viverra metus rhoncus sem. felis. Maecenas eget erat in sapien mattis port-
Nulla et lectus vestibulum urna fringilla ultrices. titor. Vestibulum porttitor. Nulla facilisi. Sed
Phasellus eu tellus sit amet tortor gravida placerat. a turpis eu lacus commodo facilisis. Morbi
Integer sapien est, iaculis in, pretium quis, viverra fringilla, wisi in dignissim interdum, justo lec-
ac, nunc. Praesent eget sem vel leo ultrices biben- tus sagittis dui, et vehicula libero dui cursus
dum. Aenean faucibus. Morbi dolor nulla, male- dui. Mauris tempor ligula sed lacus. Duis cur-
suada eu, pulvinar at, mollis ac, nulla. Curabitur sus enim ut augue. Cras ac magna. Cras nulla.
auctor semper nulla. Donec varius orci eget risus. Nulla egestas. Curabitur a leo. Quisque eges-
Duis nibh mi, congue eu, accumsan eleifend, sagit- tas wisi eget nunc. Nam feugiat lacus vel est.
tis quis, diam. Duis eget orci sit amet orci dignissim Curabitur consectetuer.
rutrum. Suspendisse vel felis. Ut lorem lorem, inter-
dum eu, tincidunt sit amet, laoreet vitae, arcu.
My breakable box Aenean faucibus pede eu ante. Praesent enim
Nam dui ligula, fringilla a, euismod sodales, elit, rutrum at, molestie non, nonummy vel,
sollicitudin vel, wisi. Morbi auctor lorem non nisl. Ut lectus eros, malesuada sit amet, fer-
justo. Nam lacus libero, pretium at, lobortis mentum eu, sodales cursus, magna. Donec eu
vitae, ultricies et, tellus. Donec aliquet, tor- purus. Quisque vehicula, urna sed ultricies auc-
tor sed accumsan bibendum, erat ligula ali- tor, pede lorem egestas dui, et convallis elit
quet magna, vitae ornare odio metus a mi. erat sed nulla. Donec luctus. Curabitur et
Morbi ac orci et nisl hendrerit mollis. Sus- nunc. Aliquam dolor odio, commodo pretium,
pendisse ut massa. Cras nec ante. Pellentesque ultricies non, pharetra in, velit. Integer arcu
a nulla. Cum sociis natoque penatibus et mag- est, nonummy in, fermentum faucibus, egestas
nis dis parturient montes, nascetur ridiculus vel, odio.
mus. Aliquam tincidunt urna. Nulla ullam- Sed commodo posuere pede. Mauris ut est. Ut
corper vestibulum turpis. Pellentesque cursus quis purus. Sed ac odio. Sed vehicula hendrerit
luctus mauris. sem. Duis non odio. Morbi ut dui. Sed accum-
Nulla malesuada porttitor diam. Donec felis san risus eget odio. In hac habitasse platea dic-
erat, congue non, volutpat at, tincidunt tris- tumst. Pellentesque non elit. Fusce sed justo
tique, libero. Vivamus viverra fermentum felis. eu urna porta tincidunt. Mauris felis odio, sol-
Donec nonummy pellentesque ante. Phasellus licitudin sed, volutpat a, ornare ac, erat. Morbi
375
quis dolor. Donec pellentesque, erat ac sagittis odio elit, dictum in, hendrerit sit amet, egestas sed,
semper, nunc dui lobortis purus, quis congue leo. Praesent feugiat sapien aliquet odio. Integer
purus metus ultricies tellus. Proin et quam. vitae justo. Aliquam vestibulum fringilla lorem.
Class aptent taciti sociosqu ad litora torquent Sed neque lectus, consectetuer at, consectetuer sed,
per conubia nostra, per inceptos hymenaeos. eleifend ac, lectus. Nulla facilisi. Pellentesque eget
Praesent sapien turpis, fermentum vel, eleifend lectus. Proin eu metus. Sed porttitor. In hac
faucibus, vehicula eu, lacus. habitasse platea dictumst. Suspendisse eu lectus.
Ut mi mi, lacinia sit amet, placerat et, mollis vi-
tae, dui. Sed ante tellus, tristique ut, iaculis eu,
Pellentesque habitant morbi tristique senectus et malesuada ac, dui. Mauris nibh leo, facilisis non,
netus et malesuada fames ac turpis egestas. Donec adipiscing quis, ultrices a, dui.
The following example has a \tcolorbox which fills the \multicols environment completely.
Here, /tcb/height fixed forÕ P. 370 is used to give all three columns the full height. Note that
the appropriate /tcb/break atÕ P. 367 value is not computed automatically but set manually.
% \usepackage{lipsum,multicol} % preamble
\small
\begin{multicols}{3}
\begin{tcolorbox}[enhanced jigsaw,breakable,size=small,
colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries,
title=My breakable box,pad at break=2mm,drop fuzzy shadow,
height fixed for=all, break at=11.4cm ]
\lipsum[1-3]
\end{tcolorbox}
\end{multicols}
376
17.7 Break Point Insertion
N 2017-07-05 \tcbbreak
A breakable box is not broken, if there is enough space on the current page or column.
Therefore, typical penalty insertion with \break, \pagebreak, \columnbreak, . . . may only
work as expected, if the box is broken at least into two parts without inserting the penalties.
To force a page or column break, \tcbbreak starts a new paragraph and inserts an insane
tall rule which causes a break and which is immediately discarded. You may ignore this
technical information and just use it as you would use \pagebreak.
For an unbreakable box, \tcbbreak is identical to insert \par, i.e. it just starts a new
paragraph.
Also see /tcb/break atÕ P. 367 for defining height dependend breaks.
% \usepackage{lipsum,multicol} % preamble
\begin{multicols}{3}
\begin{tcolorbox}[breakable,enhanced jigsaw,size=small,
colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries,
title=Break into parts
]
First part\tcbbreak
Second part\tcbbreak
Third part
\end{tcolorbox}
\end{multicols}
\begin{multicols}{3}
\begin{tcolorbox}[enhanced jigsaw,size=small,
colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries,
title=You shall not break
]
First part\tcbbreak
Second part\tcbbreak
Third part
\end{tcolorbox}
\end{multicols}
377
17.8 Break Sequence for the Skins
The following diagrams document the break sequence for different skins. Depending on the main
skin of a tcolorbox, the actual skins of the break sequence parts are displayed.
skin=standard
skin=standard
skin=standard jigsaw
skin=standard jigsaw
skin=spartan
skin=spartan
378
Unbroken Box Broken Boxes
skin=enhanced first
skin=enhancedfirst
unbroken middle
skin=enhancedmiddle
last
skin=enhancedlast
unbroken middle
skin=enhancedmiddle
last
skin=enhancedmiddle
unbroken middle
skin=enhancedmiddle
last
skin=enhancedmiddle
unbroken middle
skin=enhancedmiddle
last
skin=enhancedlast
379
Unbroken Box Broken Boxes
skin=enhanced jigsaw first
skin=enhancedfirst jigsaw
unbroken middle
skin=enhancedmiddle jigsaw
last
skin=enhancedlast jigsaw
unbroken middle
skin=enhancedmiddle jigsaw
last
skin=enhancedmiddle jigsaw
unbroken middle
skin=enhancedmiddle jigsaw
last
skin=enhancedmiddle jigsaw
unbroken middle
skin=enhancedmiddle jigsaw
last
skin=enhancedlast jigsaw
380
Unbroken Box Broken Boxes
skin=empty first
skin=emptyfirst
unbroken middle
skin=emptymiddle
last
skin=emptylast
unbroken middle
skin=emptymiddle
last
skin=emptymiddle
unbroken middle
skin=emptymiddle
last
skin=emptymiddle
unbroken middle
skin=emptymiddle
last
skin=emptylast
381
Unbroken Box Broken Boxes
skin=bicolor first
skin=bicolorfirst
unbroken middle
skin=bicolormiddle
last
skin=bicolorlast
unbroken middle
skin=bicolormiddle
last
skin=bicolormiddle
unbroken middle
skin=bicolormiddle
last
skin=bicolormiddle
unbroken middle
skin=bicolormiddle
last
skin=bicolorlast
382
Unbroken Box Broken Boxes
skin=tile
first
skin=tilefirst
unbroken middle
skin=tilemiddle
last
skin=tilelast
unbroken middle
skin=tilemiddle
last
skin=tilemiddle
unbroken middle
skin=tilemiddle
last
skin=tilemiddle
unbroken middle
skin=tilemiddle
last
skin=tilelast
383
Unbroken Box Broken Boxes
skin=beamer first
skin=beamerfirst
unbroken middle
skin=beamermiddle
last
skin=beamerlast
unbroken middle
skin=beamermiddle
last
skin=beamermiddle
unbroken middle
skin=beamermiddle
last
skin=beamermiddle
unbroken middle
skin=beamermiddle
last
skin=beamerlast
384
Unbroken Box Broken Boxes
skin=widget first
skin=widgetfirst
unbroken middle
skin=widgetmiddle
last
skin=widgetlast
unbroken middle
skin=widgetmiddle
last
skin=widgetmiddle
unbroken middle
skin=widgetmiddle
last
skin=widgetmiddle
unbroken middle
skin=widgetmiddle
last
skin=widgetlast
frame: w=199.16928pt, h=108.12054pt frame: w=199.16928pt, h=39.83368pt
title: w=167.87134pt, h=7.65457pt title: w=167.87134pt, h=7.65457pt
Unbroken Box Broken Boxes
upper: w=167.87134pt, h=5.14912pt
skin=draft skin=draft
interior: w=196.32404pt, h=22.22072pt
frame: w=199.16928pt, h=28.45274pt
upper: w=167.87134pt, h=73.43599pt upper: w=167.87134pt, h=8.5359pt
skin=draft
interior: w=196.32404pt, h=25.6075pt
frame: w=199.16928pt, h=28.45274pt
upper: w=167.87134pt, h=8.5359pt
interior: w=196.32404pt, h=90.50758pt
skin=draft
interior: w=196.32404pt, h=25.6075pt
385
Unbroken Box Broken Boxes
skin=freelance first
skin=freelancefirst
unbroken middle
skin=freelancemiddle
last
skin=freelancelast
unbroken middle
skin=freelancemiddle
last
skin=freelancemiddle
unbroken middle
skin=freelancemiddle
last
skin=freelancemiddle
unbroken middle
skin=freelancemiddle
last
skin=freelancelast
386
17.9 Break by Hand (Faked Break)
LIB
\tcbset{enhanced,equal height group=fakedbreak,
colback=LightGreen,colframe=DarkGreen,
width=(\linewidth-6mm)/3,nobeforeafter,
left=1mm,right=1mm,top=1mm,bottom=1mm,middle=1mm}
%
\begin{tcolorbox}[title=My broken box,skin=enhancedfirst]
This is a box which breaks from one column to another
\end{tcolorbox}\hfill
\begin{tcolorbox}[skin=enhancedmiddle]
column. I am sorry to say that this is a trick.
Nevertheless, you may use this trick for your
\end{tcolorbox}\hfill
\begin{tcolorbox}[skin=enhancedlast]
own purposes.
\end{tcolorbox}
387
18 Library magazine
LIB
1
The main purpose of this library is to store a tcolorbox Example Article
into an array of box registers for later usage.
This is an example for an arti-
If the tcolorbox is not breakable, there is not much add- cle which starts right here and is
on compared to usual TEX/LATEX box storage and usage continued to the following pages.
The body text for the article is
(and you do not really need this library for that use case).
written inside a single tcolorbox.
For a breakable tcolorbox, this library allows to capture This box is split into parts us-
all partial boxes into a sequence of registers. The partial ing the tools from this section,
boxes can be used anywhere in arbitrary order. — continued on page 391 —
The name of this library indicates magazine in the sense of storage, but also in the sense of a
journal where an article often is continued on page x. An example for this kind of application is
given throughout this section starting on the right hand side. The creation of this library was
motivated by Ulrike Fischer and Steven B. Segletes.
The library is loaded by a package option or inside the preamble by:
\tcbuselibrary{magazine}
This also loads the library breakable , see Section 17 on page 363.
LIB
The box register operations of this library are global. TEX grouping will not clear the
! registers when leaving the current group. Also be aware that extensive use of large box
arrays may eat up TEX’s available memory and registers.
N 2015-07-13 \newboxarray{hnamei}
This creates a new box array called hnamei. There already is a box array available with
name default which can be used directly. Note that the creation is a global operation.
\newboxarray{myarray}
N 2015-07-13 \boxarrayreset[hnamei]
Resets the size counter of a box array hnamei to zero. If hnamei is not provided, default
is used as name. Use this or /tcb/reset box array before you apply /tcb/store to box
arrayÕ P. 389 . Otherwise, all boxes would be appended to the already existing boxes. This
command does not clear box registers.
\tcbset{
reset box array, % resets 'default'
reset box array=myarray, % resets 'myarray'
}
388
N 2015-07-13 \boxarrayclear[hnamei]
Works like \boxarrayresetÕ P. 388 to reset the size counter of a box array hnamei to
zero. Additionally, all allocated box registers of the box array are cleared of their con-
tent. Note that the allocated box registers stay allocated. So, this may be useful to clear
memory, but not to free registers for other applications. If \consumeboxarrayÕ P. 392 or
\consumetcboxarrayÕ P. 392 was used to apply the stored boxes, there is no advantage in
using \boxarrayclear.
% \usepackage{lipsum}
\begin{tcolorbox}[enhanced jigsaw,size=fbox,width=4cm,
colback=yellow!10,colframe=yellow!10!black,
enforce breakable,% use only breakable in the real world!
break at=7cm/4cm,
height fixed for=all,
watermark text=\arabic{tcbbreakpart},
reset box array,
store to box array
]
\lipsum[1]
\end{tcolorbox}
\useboxarray{1}\hfill
\begin{tabular}[b]{cc}
\multicolumn{2}{c}{\includegraphics[width=7cm]{Basilica_5.png}}\\
\useboxarray{2} & \useboxarray{3}
\end{tabular}
1 23
erat ac, adipiscing vi-
tae, felis. Curabitur
dictum gravida mauris.
Nam arcu libero, non-
ummy eget, consectetuer cus sem. Nulla et lectus lor nulla, malesuada eu,
id, vulputate a, magna. vestibulum urna fringilla pulvinar at, mollis ac,
Donec vehicula augue eu ultrices. Phasellus eu tel- nulla. Curabitur auctor
neque. Pellentesque habi- lus sit amet tortor gravida semper nulla. Donec var-
tant morbi tristique senec- placerat. Integer sapien ius orci eget risus. Duis
tus et netus et male- est, iaculis in, pretium nibh mi, congue eu, ac-
suada fames ac turpis eges- quis, viverra ac, nunc. cumsan eleifend, sagittis
tas. Mauris ut leo. Praesent eget sem vel leo quis, diam. Duis eget
Cras viverra metus rhon- ultrices bibendum. Ae- orci sit amet orci dignissim
nean faucibus. Morbi do- rutrum.
389
If the first box part should fill the rest of the available space of the current page, you can use
\pagegoal-\pagetotal minus some distance for the first element of /tcb/break atÕ P. 367 .
You may want to have some additional distance to the preceeding text.
% \usepackage{lipsum}
\begin{tcolorbox}[enhanced,breakable,
reset box array,
store to box array,
break at=\pagegoal-\pagetotal-5mm/0pt,
height fixed for=first and middle]
\lipsum[1-15]
\end{tcolorbox}%
%
\consumetcboxarray{1}{blanker,before=\par\vfill\noindent}
\begin{tcolorbox}[blanker,width=4cm,
fontupper=\footnotesize,
enforce breakable,% use only breakable in the real world!
break at=4cm,
height fixed for=all,
watermark text=\arabic{tcbbreakpart},
reset box array,
store to box array
]
\includegraphics[width=\linewidth]{Basilica_5.png}\par
\lipsum[1-2]
\end{tcolorbox}
5 6 1
cus libero, pretium at, lobor- Cum sociis natoque penat-
tis vitae, ultricies et, tel- ibus et magnis dis parturi-
lus. Donec aliquet, tor- ent montes, nascetur ridicu-
tor sed accumsan bibendum, lus mus. Aliquam tincidunt
erat ligula aliquet magna, urna. Nulla ullamcorper Lorem ipsum dolor sit amet,
vitae ornare odio metus a vestibulum turpis. Pellen- consectetuer adipiscing elit.
mi. Morbi ac orci et tesque cursus luctus mauris. Ut purus elit, vestibulum ut,
nisl hendrerit mollis. Sus- placerat ac, adipiscing vi-
pendisse ut massa. Cras nec tae, felis. Curabitur dic-
tum gravida mauris. Nam
arcu libero, nonummy eget, vestibulum urna fringilla ul- mollis ac, nulla. Curabitur
2 3 4
consectetuer id, vulputate trices. Phasellus eu tel- auctor semper nulla. Donec
a, magna. Donec vehicula lus sit amet tortor gravida varius orci eget risus. Duis
augue eu neque. Pellen- placerat. Integer sapien nibh mi, congue eu, accum-
tesque habitant morbi tris- est, iaculis in, pretium quis, san eleifend, sagittis quis,
tique senectus et netus et viverra ac, nunc. Prae- diam. Duis eget orci sit
malesuada fames ac turpis sent eget sem vel leo ultri- amet orci dignissim rutrum.
egestas. Mauris ut leo. ces bibendum. Aenean fau- Nam dui ligula, fringilla a,
Cras viverra metus rhon- cibus. Morbi dolor nulla, euismod sodales, sollicitudin
cus sem. Nulla et lectus malesuada eu, pulvinar at, vel, wisi. Morbi auctor
390
N 2015-07-13 /tcb/reset and store to box array=hnamei (style, default default, initially unset)
Combination of /tcb/reset box arrayÕ P. 388 and /tcb/store to box arrayÕ P. 389 .
N 2015-07-13 /tcb/do not store to box array (style, no default, initially set)
Disables the /tcb/store to box arrayÕ P. 389 option, if set before.
N 2015-07-13 \begin{boxarraystore}{hnamei}
henvironment contenti
\end{boxarraystore}
Stores the environment content into a box array hnamei. This corresponds to the
standard LATEX environment lrbox, but the storage operation is global. As long as
\boxarrayresetÕ P. 388 is not used, every new boxarraystore adds a further box to the
array.
\boxarrayreset
\begin{boxarraystore}{default}\fbox{Mary}\end{boxarraystore}
\begin{boxarraystore}{default}\fbox{Had}\end{boxarraystore}
\begin{boxarraystore}{default}\fbox{a}\end{boxarraystore}
\begin{boxarraystore}{default}\fbox{Little}\end{boxarraystore}
\begin{boxarraystore}{default}\fbox{Lamb}\end{boxarraystore}
\useboxarray{5}\useboxarray{4}\useboxarray{3}\useboxarray{2}\useboxarray{1}\hfill
\useboxarray{1}\useboxarray{5}
2
18.3 Retrieving Content
N 2015-07-13 \boxarraygetsize[hnamei]{hmacroi}
Stores the current size of a box array hnamei into — continued from page 388 —
a given hmacroi. If no hnamei is given, the already namely /tcb/reset and store to
existing default box array is used. box arrayÕ P. 391 with a new box ar-
ray myarticle which was created by
\boxarraygetsize{\mysize} \newboxarray{myarticle}.
Current size of the default box array: The resulting parts are dis-
\mysize. tributed throughout this Sec-
tion 18 on page 388 using
Current size of the default box array: 5. \consumetcboxarrayÕ P. 392 at
— continued on page 392 —
N 2015-07-13 \useboxarray[hnamei]{hindexi}
Typesets the box with the given hindexi number from the box array hnamei. If no hnamei
is given, the already existing default box array is used. It is considered an error, if a not
existing box array hnamei is used. It is silently ignored, if the hindexi is out of range. Note
that \useboxarray corresponds to the standard \usebox macro, respectively, \copy.
\boxarraygetsize{\mysize}
\foreach \n in {1,...,\mysize} { \useboxarray{\n} }
391
N 2015-07-13 \usetcboxarray[hnamei]{hindexi}{hoptionsi}
Typesets the box with the given hindexi number from the box array hnamei using
\useboxarrayÕ P. 391 as content of a \tcboxÕ P. 14 . If no hnamei is given, the already ex-
isting default box array is used. It is considered an error, if a not existing box array
hnamei is used. It is silently ignored, if the hindexi is out of range. The \tcboxÕ P. 14 can
be customized by tcolorbox hoptionsi.
\boxarraygetsize{\mysize}
\foreach \n in {1,...,\mysize} { \usetcboxarray{\n}{on line,colframe=yellow,
colback=yellow!10} }
N 2015-07-13 \consumeboxarray[hnamei]{hindexi}
Typesets the box with the given hindexi number from the box array hnamei. If no hnamei
is given, the already existing default box array is used. It is considered an error, if a
not existing box array hnamei is used. It is silently ignored, if the hindexi is out of range.
In contrast to \useboxarrayÕ P. 391 , \consumeboxarray corresponds to the standard \box
macro, i.e. after typesetting the box register is cleared and cannot be used again.
\boxarraygetsize{\mysize}
First run: \foreach \n in {1,...,\mysize} { \consumeboxarray{\n} }
\par
Second run: \foreach \n in {1,...,\mysize} { \consumeboxarray{\n} }
3
First run: Mary Had a Little Lamb
Second run:
N 2015-07-13 \consumetcboxarray[hnamei]{hindexi}{hoptionsi}
Typesets the box with the given hindexi number — continued from page 391 —
from the box array hnamei using \consumeboxarray the appropriate places you see. The
as content of a \tcboxÕ P. 14 . If no hnamei is given, linking texts like continued on page x
the already existing default box array is used. It are created by /tcb/finishÕ P. 197
commands for the embedding
is considered an error, if a not existing box array
\tcboxÕ P. 14 . To label the box
hnamei is used. It is silently ignored, if the hindexi parts, /tcb/phantomlabelÕ P. 98 is
is out of range. The \tcboxÕ P. 14 can be customized used.
by tcolorbox hoptionsi. After typesetting the box These quite small partial boxes are
register is cleared and cannot be used again. — continued on page 395 —
392
% \usepackage{lipsum}
\begin{tcolorbox}[enhanced jigsaw,size=fbox,width=6cm,
colback=yellow!10,colframe=yellow!10!black,
enforce breakable,% use only breakable in the real world!
break at=5cm,
watermark text=\arabic{tcbbreakpart},
reset and store to box array
]
\lipsum[1]
\end{tcolorbox}
1
adipiscing elit. Ut purus elit, vestibu-
lus sit amet tortor gravida placerat. In- lum ut, placerat ac, adipiscing vitae, fe-
2
teger sapien est, iaculis in, pretium quis, lis. Curabitur dictum gravida mauris.
viverra ac, nunc. Praesent eget sem vel Nam arcu libero, nonummy eget, con-
leo ultrices bibendum. Aenean faucibus. sectetuer id, vulputate a, magna. Donec
Morbi dolor nulla, malesuada eu, pulv- vehicula augue eu neque. Pellentesque
inar at, mollis ac, nulla. Curabitur auc- habitant morbi tristique senectus et ne-
tor semper nulla. Donec varius orci eget tus et malesuada fames ac turpis eges-
risus. Duis nibh mi, congue eu, accumsan tas. Mauris ut leo. Cras viverra metus
eleifend, sagittis quis, diam. Duis eget rhoncus sem. Nulla et lectus vestibulum
orci sit amet orci dignissim rutrum. urna fringilla ultrices. Phasellus eu tel-
N 2015-07-13 \boxarraygetbox[hnamei]{hmacroi}{hindexi}
Assigns the box with the given hindexi number from the box array hnamei to a hmacroi.
If no hnamei is given, the already existing default box array is used. It is considered an
error, if a not existing box array hnamei is used. If the hindexi is out of range, the hmacroi
will be undefined.
\tcbox[size=small,colframe=blue!20,colback=yellow!5,on line,
reset and store to box array]{Test}
\boxarraygetbox{\mybox}{1}
Box width: \the\wd\mybox
\quad\usebox{\mybox}
Array size: 1
Box width: 30.35799pt Test
N 2017-06-27 \ifboxarrayempty[hnamei]{hindexi}{htruei}{hfalsei}
Tests the box with the given hindexi number from the box array hnamei for emptiness be
empty and executes htruei if it is empty, and hfalsei otherwise. If no hnamei is given, the
already existing default box array is used. It is considered an error, if a not existing box
array hnamei is used.
\tcbox[size=small,colframe=blue!20,colback=yellow!5,on line,
reset and store to box array]{Test}
393
18.4 Box Dimensions
N 2015-07-13 \boxarraygetwidth[hnamei]{hmacroi}{hindexi}
Assigns the width of the box with the given hindexi number from the box array hnamei
to a hmacroi. If no hnamei is given, the already existing default box array is used. It
is considered an error, if a not existing box array hnamei is used. If the hindexi is out of
range, the hmacroi will be set to 0pt.
\tcbox[size=small,colframe=blue!20,colback=yellow!5,on line,
reset and store to box array]{Test}
\begin{tabular}{ll}
\useboxarray{1} & width of box 1: \boxarraygetwidth{\mylen}{1} \mylen\\
\useboxarray{2} & width of box 2: \boxarraygetwidth{\mylen}{2} \mylen
\end{tabular}
N 2015-07-13 \boxarraygetheight[hnamei]{hmacroi}{hindexi}
Assigns the height of the box with the given hindexi number from the box array hnamei
to a hmacroi. If no hnamei is given, the already existing default box array is used. It
is considered an error, if a not existing box array hnamei is used. If the hindexi is out of
range, the hmacroi will be set to 0pt.
\tcbox[size=small,colframe=blue!20,colback=yellow!5,on line,
reset and store to box array]{Test}
\begin{tabular}{ll}
\useboxarray{1} & height of box 1: \boxarraygetheight{\mylen}{1} \mylen\\
\useboxarray{2} & height of box 2: \boxarraygetheight{\mylen}{2} \mylen
\end{tabular}
N 2015-07-13 \boxarraygetdepth[hnamei]{hmacroi}{hindexi}
Assigns the depth of the box with the given hindexi number from the box array hnamei
to a hmacroi. If no hnamei is given, the already existing default box array is used. It
is considered an error, if a not existing box array hnamei is used. If the hindexi is out of
range, the hmacroi will be set to 0pt.
\tcbox[size=small,colframe=blue!20,colback=yellow!5,on line,
reset and store to box array]{Test}
\begin{tabular}{ll}
\useboxarray{1} & depth of box 1: \boxarraygetdepth{\mylen}{1} \mylen\\
\useboxarray{2} & depth of box 2: \boxarraygetdepth{\mylen}{2} \mylen
\end{tabular}
394
4
N 2015-07-13 \boxarraygettotalheight[hnamei]{hmacroi}{hindexi}
Assigns the total height of the box with the given — continued from page 392 —
hindexi number from the box array hnamei to a for demonstration purposes. With
hmacroi. If no hnamei is given, the already exist- the tools of this section, a magazine
ing default box array is used. It is considered an type document could be created, but
error, if a not existing box array hnamei is used. If this still needs a lot of manual con-
trol.
the hindexi is out of range, the hmacroi will be set
to 0pt.
\boxarrayreset
\tcbox[size=small,colframe=blue!20,colback=yellow!5,on line,
store to box array]{Test}
\begin{tabular}{ll}
\useboxarray{1} & total height of box 1: \boxarraygettotalheight{\mylen}{1} \mylen\\
\useboxarray{2} & total height of box 2: \boxarraygettotalheight{\mylen}{2} \mylen
\end{tabular}
395
18.5 Leaflet Example
The following full application example can be used to create leaflets. Obviously, the code can
be adapted and customized in many ways.
\documentclass[a4paper,landscape]{article}
\usepackage[noheadfoot,margin=0pt]{geometry}
\usepackage[skins,raster,magazine]{tcolorbox}
\usepackage{lipsum}
\newenvironment{leaflet}[1][]{%
\begin{tcolorbox}[nobeforeafter,empty,colback=white,
sharp corners,size=minimal,left=10mm,right=10mm,top=10mm,bottom=10mm,
width=\textwidth/3,
breakable,
break at=\textheight,
height fixed for=all,
reset box array,
store to box array,#1]}
{\end{tcolorbox}%
\begin{tcbitemize}[raster columns=3,raster equal skip=0pt,blankest]
\tcbitem\consumeboxarray{5}
\tcbitem\consumeboxarray{6}
\tcbitem\consumeboxarray{1}
\tcbitem\consumeboxarray{2}
\tcbitem\consumeboxarray{3}
\tcbitem\consumeboxarray{4}
\end{tcbitemize}%
}
\pagestyle{empty}
\begin{document}
\begin{leaflet}[underlay={\node[above=5mm,font=\footnotesize]
at (frame.south) {- \arabic{tcbbreakpart} -};}]
\includegraphics[width=\linewidth]{Basilica_5.png}
\begin{center}
\bfseries\LARGE Example
\end{center}
\section{Introduction}
\lipsum[1]
\section{Main Part A}
\lipsum[2-8]
\section{Main Part B}
\lipsum[9-15]
\section{Conclusion}
\lipsum[16-18]
\end{leaflet}
\end{document}
396
cursus sodales, augue est scelerisque sapien, vene- tum nunc. In wisi nisl, malesuada at, dignissim sit
natis congue nulla arcu et pede. Ut suscipit enim amet, lobortis in, odio. Aenean consequat arcu a
vel sapien. Donec congue. Maecenas urna mi, sus- ante. Pellentesque porta elit sit amet orci. Etiam
cipit in, placerat ut, vestibulum ut, massa. Fusce at turpis nec elit ultricies imperdiet. Nulla facil-
ultrices nulla et nisl. isi. In hac habitasse platea dictumst. Suspendisse
Etiam ac leo a risus tristique nonummy. Donec dig- viverra aliquam risus. Nullam pede justo, molestie
nissim tincidunt nulla. Vestibulum rhoncus molestie nonummy, scelerisque eu, facilisis vel, arcu.
odio. Sed lobortis, justo et pretium lobortis, mauris Curabitur tellus magna, porttitor a, commodo a,
turpis condimentum augue, nec ultricies nibh arcu commodo in, tortor. Donec interdum. Praesent
pretium enim. Nunc purus neque, placerat id, im- scelerisque. Maecenas posuere sodales odio. Viva-
perdiet sed, pellentesque nec, nisl. Vestibulum im- mus metus lacus, varius quis, imperdiet quis, rhon-
Example
perdiet neque non sem accumsan laoreet. In hac cus a, turpis. Etiam ligula arcu, elementum a, vene-
habitasse platea dictumst. Etiam condimentum fa- natis quis, sollicitudin sed, metus. Donec nunc pede, 1 Introduction
cilisis libero. Suspendisse in elit quis nisl aliquam tincidunt in, venenatis vitae, faucibus vel, nibh. Pel-
dapibus. Pellentesque auctor sapien. Sed egestas lentesque wisi. Nullam malesuada. Morbi ut tel- Lorem ipsum dolor sit amet, consectetuer adipiscing
sapien nec lectus. Pellentesque vel dui vel neque lus ut pede tincidunt porta. Lorem ipsum dolor sit elit. Ut purus elit, vestibulum ut, placerat ac, adip-
bibendum viverra. Aliquam porttitor nisl nec pede. amet, consectetuer adipiscing elit. Etiam congue iscing vitae, felis. Curabitur dictum gravida mau-
Proin mattis libero vel turpis. Donec rutrum mau- neque id dolor. ris. Nam arcu libero, nonummy eget, consectetuer
ris et libero. Proin euismod porta felis. Nam lobor- Donec et nisl at wisi luctus bibendum. Nam inter- id, vulputate a, magna. Donec vehicula augue eu
tis, metus quis elementum commodo, nunc lectus dum tellus ac libero. Sed sem justo, laoreet vitae, neque. Pellentesque habitant morbi tristique senec-
elementum mauris, eget vulputate ligula tellus eu fringilla at, adipiscing ut, nibh. Maecenas non sem tus et netus et malesuada fames ac turpis egestas.
neque. Vivamus eu dolor. quis tortor eleifend fermentum. Etiam id tortor ac Mauris ut leo. Cras viverra metus rhoncus sem.
Nulla in ipsum. Praesent eros nulla, congue vitae, mauris porta vulputate. Integer porta neque vitae Nulla et lectus vestibulum urna fringilla ultrices.
euismod ut, commodo a, wisi. Pellentesque habi- massa. Maecenas tempus libero a libero posuere Phasellus eu tellus sit amet tortor gravida placerat.
tant morbi tristique senectus et netus et malesuada dictum. Vestibulum ante ipsum primis in faucibus Integer sapien est, iaculis in, pretium quis, viverra
fames ac turpis egestas. Aenean nonummy magna orci luctus et ultrices posuere cubilia Curae; Aenean ac, nunc. Praesent eget sem vel leo ultrices biben-
non leo. Sed felis erat, ullamcorper in, dictum non, quis mauris sed elit commodo placerat. Class aptent dum. Aenean faucibus. Morbi dolor nulla, male-
ultricies ut, lectus. Proin vel arcu a odio lobortis taciti sociosqu ad litora torquent per conubia nos- suada eu, pulvinar at, mollis ac, nulla. Curabitur
euismod. Vestibulum ante ipsum primis in faucibus tra, per inceptos hymenaeos. Vivamus rhoncus tin- auctor semper nulla. Donec varius orci eget risus.
orci luctus et ultrices posuere cubilia Curae; Proin cidunt libero. Etiam elementum pretium justo. Vi- Duis nibh mi, congue eu, accumsan eleifend, sagit-
ut est. Aliquam odio. Pellentesque massa turpis, vamus est. Morbi a tellus eget pede tristique com- tis quis, diam. Duis eget orci sit amet orci dignissim
cursus eu, euismod nec, tempor congue, nulla. Duis modo. Nulla nisl. Vestibulum sed nisl eu sapien rutrum.
viverra gravida mauris. Cras tincidunt. Curabitur cursus rutrum.
eros ligula, varius ut, pulvinar in, cursus faucibus,
augue. 2 Main Part A
Nam dui ligula, fringilla a, euismod sodales, sollici-
4 Conclusion tudin vel, wisi. Morbi auctor lorem non justo. Nam
lacus libero, pretium at, lobortis vitae, ultricies et,
Nulla mattis luctus nulla. Duis commodo velit tellus. Donec aliquet, tortor sed accumsan biben-
at leo. Aliquam vulputate magna et leo. Nam dum, erat ligula aliquet magna, vitae ornare odio
vestibulum ullamcorper leo. Vestibulum condimen- metus a mi. Morbi ac orci et nisl hendrerit mollis.
tum rutrum mauris. Donec id mauris. Morbi mo- Suspendisse ut massa. Cras nec ante. Pellentesque
lestie justo et pede. Vivamus eget turpis sed nisl a nulla. Cum sociis natoque penatibus et magnis
cursus tempor. Curabitur mollis sapien condimen- dis parturient montes, nascetur ridiculus mus. Ali-
quam tincidunt urna. Nulla ullamcorper vestibulum malesuada sit amet, fermentum eu, sodales cursus, luctus et ultrices posuere cubilia Curae; Pellentesque
turpis. Pellentesque cursus luctus mauris. magna. Donec eu purus. Quisque vehicula, urna sit amet pede ac sem eleifend consectetuer. Nullam
Nulla malesuada porttitor diam. Donec felis erat, sed ultricies auctor, pede lorem egestas dui, et con- elementum, urna vel imperdiet sodales, elit ipsum
congue non, volutpat at, tincidunt tristique, libero. vallis elit erat sed nulla. Donec luctus. Curabitur pharetra ligula, ac pretium ante justo a nulla. Cur-
Vivamus viverra fermentum felis. Donec nonummy et nunc. Aliquam dolor odio, commodo pretium, abitur tristique arcu eu metus. Vestibulum lectus.
pellentesque ante. Phasellus adipiscing semper elit. ultricies non, pharetra in, velit. Integer arcu est, Proin mauris. Proin eu nunc eu urna hendrerit fau-
Proin fermentum massa ac quam. Sed diam turpis, nonummy in, fermentum faucibus, egestas vel, odio. cibus. Aliquam auctor, pede consequat laoreet var-
molestie vitae, placerat a, molestie nec, leo. Maece- Sed commodo posuere pede. Mauris ut est. Ut ius, eros tellus scelerisque quam, pellentesque hen-
nas lacinia. Nam ipsum ligula, eleifend at, accumsan quis purus. Sed ac odio. Sed vehicula hendrerit drerit ipsum dolor sed augue. Nulla nec lacus.
nec, suscipit a, ipsum. Morbi blandit ligula feugiat sem. Duis non odio. Morbi ut dui. Sed accum- Suspendisse vitae elit. Aliquam arcu neque, ornare
magna. Nunc eleifend consequat lorem. Sed lacinia san risus eget odio. In hac habitasse platea dic- in, ullamcorper quis, commodo eu, libero. Fusce
nulla vitae enim. Pellentesque tincidunt purus vel tumst. Pellentesque non elit. Fusce sed justo eu sagittis erat at erat tristique mollis. Maecenas
magna. Integer non enim. Praesent euismod nunc urna porta tincidunt. Mauris felis odio, sollicitudin sapien libero, molestie et, lobortis in, sodales eget,
eu purus. Donec bibendum quam in tellus. Nullam sed, volutpat a, ornare ac, erat. Morbi quis dolor. dui. Morbi ultrices rutrum lorem. Nam elementum
cursus pulvinar lectus. Donec et mi. Nam vulpu- Donec pellentesque, erat ac sagittis semper, nunc ullamcorper leo. Morbi dui. Aliquam sagittis. Nunc
tate metus eu enim. Vestibulum pellentesque felis dui lobortis purus, quis congue purus metus ultricies placerat. Pellentesque tristique sodales est. Maece-
eu massa. tellus. Proin et quam. Class aptent taciti sociosqu nas imperdiet lacinia velit. Cras non urna. Morbi
Quisque ullamcorper placerat ipsum. Cras nibh. ad litora torquent per conubia nostra, per inceptos eros pede, suscipit ac, varius vel, egestas non, eros.
Morbi vel justo vitae lacus tincidunt ultrices. Lorem hymenaeos. Praesent sapien turpis, fermentum vel, Praesent malesuada, diam id pretium elementum,
ipsum dolor sit amet, consectetuer adipiscing elit. In eleifend faucibus, vehicula eu, lacus. eros sem dictum tortor, vel consectetuer odio sem
hac habitasse platea dictumst. Integer tempus con- Pellentesque habitant morbi tristique senectus et ne- sed wisi.
vallis augue. Etiam facilisis. Nunc elementum fer- tus et malesuada fames ac turpis egestas. Donec Sed feugiat. Cum sociis natoque penatibus et mag-
mentum wisi. Aenean placerat. Ut imperdiet, enim odio elit, dictum in, hendrerit sit amet, egestas sed, nis dis parturient montes, nascetur ridiculus mus.
sed gravida sollicitudin, felis odio placerat quam, ac leo. Praesent feugiat sapien aliquet odio. Inte- Ut pellentesque augue sed urna. Vestibulum diam
pulvinar elit purus eget enim. Nunc vitae tortor. ger vitae justo. Aliquam vestibulum fringilla lorem. eros, fringilla et, consectetuer eu, nonummy id,
Proin tempus nibh sit amet nisl. Vivamus quis tor- Sed neque lectus, consectetuer at, consectetuer sed, sapien. Nullam at lectus. In sagittis ultrices mau-
tor vitae risus porta vehicula. eleifend ac, lectus. Nulla facilisi. Pellentesque eget ris. Curabitur malesuada erat sit amet massa. Fusce
Fusce mauris. Vestibulum luctus nibh at lectus. Sed lectus. Proin eu metus. Sed porttitor. In hac blandit. Aliquam erat volutpat. Aliquam euismod.
bibendum, nulla a faucibus semper, leo velit ultricies habitasse platea dictumst. Suspendisse eu lectus. Aenean vel lectus. Nunc imperdiet justo nec dolor.
tellus, ac venenatis arcu wisi vel nisl. Vestibulum Ut mi mi, lacinia sit amet, placerat et, mollis vi- Etiam euismod. Fusce facilisis lacinia dui. Sus-
diam. Aliquam pellentesque, augue quis sagittis po- tae, dui. Sed ante tellus, tristique ut, iaculis eu, pendisse potenti. In mi erat, cursus id, non-
suere, turpis lacus congue quam, in hendrerit risus malesuada ac, dui. Mauris nibh leo, facilisis non, ummy sed, ullamcorper eget, sapien. Praesent
eros eget felis. Maecenas eget erat in sapien mattis adipiscing quis, ultrices a, dui. pretium, magna in eleifend egestas, pede pede
porttitor. Vestibulum porttitor. Nulla facilisi. Sed pretium lorem, quis consectetuer tortor sapien fa-
a turpis eu lacus commodo facilisis. Morbi fringilla, cilisis magna. Mauris quis magna varius nulla
wisi in dignissim interdum, justo lectus sagittis dui, 3 Main Part B scelerisque imperdiet. Aliquam non quam. Aliquam
et vehicula libero dui cursus dui. Mauris tempor porttitor quam a lacus. Praesent vel arcu ut tortor
Morbi luctus, wisi viverra faucibus pretium, nibh est
ligula sed lacus. Duis cursus enim ut augue. Cras cursus volutpat. In vitae pede quis diam bibendum
placerat odio, nec commodo wisi enim eget quam.
ac magna. Cras nulla. Nulla egestas. Curabitur a placerat. Fusce elementum convallis neque. Sed do-
Quisque libero justo, consectetuer a, feugiat vitae,
leo. Quisque egestas wisi eget nunc. Nam feugiat lor orci, scelerisque ac, dapibus nec, ultricies ut, mi.
porttitor eu, libero. Suspendisse sed mauris vitae
lacus vel est. Curabitur consectetuer. Duis nec dui quis leo sagittis commodo.
elit sollicitudin malesuada. Maecenas ultricies eros
Suspendisse vel felis. Ut lorem lorem, interdum eu, Aliquam lectus. Vivamus leo. Quisque ornare tel-
sit amet ante. Ut venenatis velit. Maecenas sed mi
tincidunt sit amet, laoreet vitae, arcu. Aenean fau- lus ullamcorper nulla. Mauris porttitor pharetra
eget dui varius euismod. Phasellus aliquet volutpat
cibus pede eu ante. Praesent enim elit, rutrum at, tortor. Sed fringilla justo sed mauris. Mauris tel-
odio. Vestibulum ante ipsum primis in faucibus orci
molestie non, nonummy vel, nisl. Ut lectus eros, lus. Sed non leo. Nullam elementum, magna in
-2- -3- -4-
397
19 Library poster
LIB
The main purpose of this library is to support creation of single page posters with tcolorboxes.
A tcbposterÕ P. 399 is a tikzpicture where tcolorboxes can be placed in a column oriented
manner using \posterboxÕ P. 404 commands. This base concept is more or less copied from the
great baposter package.
The raster library, see Section 14 on page 277, can produce similar looking results and may
LIB
flow (box flow) is a merely endless ribbon which gets broken into lines (and paragraphs)
and the lines are broken into pages. raster shapes the boxes to convenient sizes to fill
LIB
lines and pages in a pleasant way.
• The tcbposter library supports a quite free placement of boxes inside a page. Basically,
LIB
boxes are placed like nodes are placed inside a tikzpicture. In contrast to raster , this
LIB
is a single page and not a flow of pages. The poster is divided into columns and rows.
There is a more or less gentle force to use the columns (or spans of columns) for positioning
and sizing while the row placement is completely optional.
The creation of this library was motivated by Ignasi.
Inside a tikzpicture there should be no embedded tikzpictures. This rule is violated
! by the poster library. Be aware that there may be some unwanted interactions between
LIB
the main tikzpicture and the embedded ones inside the tcolorboxes.
\tcbuselibrary{poster}
This also loads the libraries skins , see Section 10 on page 148, breakable , see Section 17 on
LIB
LIB
page 363, magazine , see Section 18 on page 388, and fitting , see Section 20 on page 411.
LIB
LIB
19.1 Overview
You get the best overview of the poster library and its facilities, if you look at the
LIB
398
19.2 Main Poster Environment
N 2017-07-03 \begin{tcbposter}[hoptionsi]
henvironment contenti
\end{tcbposter}
This creates a tikzpicture environment with suitable additional settings defined by the
given hoptionsi. Basically, \posterboxÕ P. 404 and posterboxenvÕ P. 404 are used to place
tcolorboxes as nodes into the environment, but additional TikZ code can also be used.
As hoptionsi all /tcb/posterset/ keys may be applied, namely:
• /tcb/posterset/posterÕ P. 401 : poster settings like columns, rows, sizes. . .
• /tcb/posterset/coverageÕ P. 402 and /tcb/posterset/no coverageÕ P. 402 : settings
for a surrounding tcolorbox for background and margins.
• /tcb/posterset/boxesÕ P. 403 : style of the tcolorboxes used for the poster.
• /tcb/posterset/fontsizeÕ P. 403 : scaling of used fonts.
\begin{tcbposter}[
poster = {showframe,height=10cm,spacing=2mm},
boxes = {beamer,colframe=blue!50!black,colback=blue!50,colupper=yellow!50},
]
\posterbox{name=A,column=3,row=2}{My first box}
\posterbox[adjusted title=Second box]
{name=B,column=2,span=2,below=A}{My second box}
\posterbox[adjusted title=Third box]
{name=C,column=2,between=B and bottom}{My third box}
\end{tcbposter}
col1 col2 col3
row1
row2
My first box
My second box
B
Third box
399
Inside tcbposterÕ P. 399 , there are several predefined TikZ nodes. These nodes share a common
/tcb/poster/prefixÕ P. 401 which is TCBPOSTER@ by default. This prefix is used to discriminate
the poster nodes from local nodes of any embedded tikzpicture environment. You will never
need this prefix using \posterboxÕ P. 404 and its placement options, but if you want to refer to
a predefined node using pure TikZ code. The predefined nodes (shown without prefix) are:
• poster: defines the bounding box of the poster (without the coverage).
• top: top position plus row spacing
• bottom: bottom position minus row spacing
• middle: vertical middle position
• col1, col2, . . . : bounding box of column 1, column 2, . . .
• row1, row2, . . . : bounding box of row 1, row 2, . . .
Further nodes are defined using the /tcb/posterloc/nameÕ P. 405 option.
Never use a tcbposterÕ P. 399 inside a tcbposterÕ P. 399 . But, if you do anyway, use a
! different /tcb/poster/prefixÕ P. 401 for the embedded poster or you surely get a total
mess.
There are several properties inside a tcbposterÕ P. 399 which may be useful for advanced code
(skip the following on first reading):
• \tcbposterwidth: Width of the poster (without margins).
• \tcbposterheight: Height of the poster (without margins).
• \tcbpostercolspacing: Column distance.
• \tcbposterrowspacing: Row distance.
• \tcbpostercolumns: Column quantity.
• \tcbposterrows: Row quantity.
• \tcbpostercolwidth: Width of a column.
• \tcbposterrowheight: Height of a row.
N 2017-07-03 \tcbposterset{hoptionsi}
Sets options for every following tcbposterÕ P. 399 inside the current TEX group. For exam-
ple, the numbers for rows and columns may be defined for the whole document by this:
\tcbposterset{poster={columns=2,rows=3}}
400
19.3 Poster Settings
\tcbposterset{poster={width=20cm,height=15cm}}
\begin{tcbposter}[
poster = {showframe,columns=5,rows=2,spacing=1mm,height=4cm},
]
\end{tcbposter}
col1 col2 col3 col4 col5
row1
row2
library. This encompasses predefined nodes like top, bottom, . . . , and nodes defined by
using /tcb/posterloc/nameÕ P. 405 . Also, see Section 19.2 on page 399. For a typical
poster, this value can stay as it is.
401
19.4 Coverage
an optional coverage for the poster which is a surrounding tcolorbox with the given hoption
listi. Here, margins and background settings for the poster can be given. The coverage has
several default tcolorbox settings suitable for the purpose:
\begin{tcbposter}[
poster = {showframe,spacing=1mm},
coverage = {height=5cm,
interior style={top color=yellow,bottom color=yellow!50!red},
watermark text={My Poster},watermark color=white,
},
]
\end{tcbposter}
My Poster
row2
row3
row4
• For a typical poster, the option /tcb/spreadÕ P. 88 will use the whole page for the
poster coverage.
• Poster margins can be adapted by /tcb/leftÕ P. 39 , /tcb/rightÕ P. 40 , /tcb/topÕ P. 42 ,
/tcb/bottomÕ P. 43 .
• Poster background can be changed by /tcb/colbackÕ P. 27 , /tcb/interior
styleÕ P. 149 , /tcb/interior style imageÕ P. 150 , etc.
N 2017-07-03 /tcb/posterset/no coverage (style, no value, initially set)
Removes the surrounding tcolorbox completely.
402
19.5 Common Box Settings
to set up the style of the tcolorboxes inside the poster. The hoption listi can contain any
tcolorbox option, but box size options are not assumed to be useful here, because the size
will be determined by the placement options.
\begin{tcbposter}[
poster = {spacing=2mm,columns=3,rows=2},
coverage = {height=5cm,
interior style={top color=yellow,bottom color=yellow!50!red},
},
boxes = {sharp corners=downhill,arc=3mm,boxrule=1mm,
colback=white,colframe=cyan,
title style={left color=black,right color=cyan},
fonttitle=\bfseries\scshape}
]
\posterbox[adjusted title=First]{column=1,row=1,span=2}{First box}
\posterbox[adjusted title=Second]{column=1,row=2,span=2}{Second box}
\posterbox[adjusted title=Third]{column=3,row=1,rowspan=2}{Third box}
\end{tcbposter}
First Third
Second
Second box
\begin{tcbposter}[
poster = {spacing=2mm,columns=3,rows=2},
coverage = {height=5cm,
interior style={top color=yellow,bottom color=yellow!50!red},
},
fontsize = 15pt, % <--- \normalsize is now 15pt
]
...
403
19.7 Box Placement
\begin{tcbposter}[
poster = {showframe,height=4cm,spacing=2mm,rows=2},
boxes = {beamer,colframe=blue!50!black,colback=blue!50,colupper=yellow!50},
]
\posterbox[title=My title]{name=A,column=2,row=2}{My first box}
\end{tcbposter}
col1 col2 col3
row1
row2 My title
A
My first box
N 2017-07-03 \begin{posterboxenv}[hoptionsi]{hplacementi}
henvironment contenti
\end{posterboxenv}
This is the environment version of \posterbox, i.e. inside a tcbposterÕ P. 399 environment,
this places a tcolorbox with additional tcolorbox hoptionsi and the given henvironment
contenti at a place determined by hplacementi. In contrast to \posterbox, the henvironment
contenti is allowed to contain verbatim material. Note that the implementation of
\posterbox is more efficient than the implementation of posterboxenv.
\begin{tcbposter}[
poster = {showframe,height=4cm,spacing=2mm,rows=2},
boxes = {size=small,beamer,
colframe=blue!50!black,colback=blue!50,colupper=yellow!50},
]
\begin{posterboxenv}[title=My title]{name=A,column=2,between=top and bottom}
My first box.
\begin{tcblisting}{size=small,colback=yellow!10}
My \textbf{first}
poster listing.
\end{tcblisting}
\end{posterboxenv}
\end{tcbposter}
col1 col2 col3
row1 My title
My first box.
My \textbf{first}
poster listing.
row2
A
My first poster listing.
404
N 2017-07-03 /tcb/posterloc/name=hnamei (no default, initially @)
Sets hnamei as reference for the current \posterboxÕ P. 404 or posterboxenvÕ P. 404 . A TikZ
shape name is constructed automatically as combination of /tcb/poster/prefixÕ P. 401 and
hnamei.
\begin{tcbposter}[
poster = {showframe,height=2.5cm,spacing=2mm,rows=2},
boxes = {beamer,colframe=blue!50!black,colback=blue!50,colupper=yellow!50},
]
\posterbox{name=A,column=2,row=2}{My first box}
\node[below right=4mm,fill=yellow] (X) at ([email protected] west) {Example A};
\draw[blue,very thick,->] (X) |- (TCBPOSTER@A);
\end{tcbposter}
col1 col2 col3
row1
Example A
row2
My first box
A
\begin{tcbposter}[
poster = {showframe,height=2.5cm,spacing=2mm,rows=2},
boxes = {beamer,colframe=blue!50!black,colback=blue!50,colupper=yellow!50},
]
\posterbox{row=1,column=2,span=2}{First box}
\posterbox{row=2,column=2,span=0.8}{Second box}
\end{tcbposter}
col1 col2 col3
row1
First box
row2
Second box
\begin{tcbposter}[
poster = {showframe,height=2.5cm,spacing=2mm,rows=2},
boxes = {beamer,colframe=blue!50!black,colback=blue!50,colupper=yellow!50},
]
\posterbox{row=1,column*=2,span=2}{First box}
\posterbox{row=2,column*=2,span=0.8}{Second box}
\end{tcbposter}
col1 col2 col3
row1
First box
row2
Second box
405
N 2017-07-03 /tcb/posterloc/span=hnumberi (no default, initially 1)
Sets the width of the current box to span hnumberi columns. hnumberi is also al-
lowed to be a real number like 0.5 or 1.7. See /tcb/posterloc/columnÕ P. 405 and
/tcb/posterloc/column*Õ P. 405 for examples.
N 2017-07-03 /tcb/posterloc/row=hnumberi (no default, initially unset)
If this option is applied, the box is placed at the row denoted by hnumberi. Also, the height
is set as fixed according to /tcb/posterloc/rowspan.
\begin{tcbposter}[
poster = {showframe,height=2.5cm,spacing=2mm,rows=2},
boxes = {beamer,colframe=blue!50!black,colback=blue!50,colupper=yellow!50},
]
\posterbox{row=1,column=1}{First box}
\posterbox{row=1,column=2,rowspan=2}{Second box}
\posterbox[natural height]{row=1,column=3}{Third box}
\end{tcbposter}
col1 col2 col3
row1
First box Second box Third box
row2
row2
406
N 2017-07-03 /tcb/posterloc/below=hnamei (no default, initially top)
The box is placed below another box with the given hnamei. Also, hnamei can be a
predefined node, see Section 19.2 on page 399.
\begin{tcbposter}[
poster = {showframe,height=3cm,spacing=2mm,rows=2},
boxes = {beamer,colframe=blue!50!black,colback=blue!50,colupper=yellow!50},
]
\posterbox{name=A,column=1,below=top}{First box}
\posterbox{name=B,column=1,below=A}{Second box}
\posterbox{name=C,column=2,below=B}{Third box}
\posterbox{name=D,column=3,below=row1}{Fourth box}
\end{tcbposter}
col1 col2 col3
row1
First box A
Second boxB
row2
Fourth box D
Third box C
\begin{tcbposter}[
poster = {showframe,height=3cm,spacing=2mm,rows=2},
boxes = {beamer,colframe=blue!50!black,colback=blue!50,colupper=yellow!50},
]
\posterbox{name=A,column=1,above=bottom}{First box}
\posterbox{name=B,column=1,above=A}{Second box}
\posterbox{name=C,column=2,above=B}{Third box}
\posterbox{name=D,column=3,above=row2}{Fourth box}
\end{tcbposter}
col1 col2 col3
row1
Third box C
Fourth box D
Second boxB
row2
First box A
407
N 2017-07-03 /tcb/posterloc/at=hnamei (no default, initially unset)
The box is placed at the position with the given hnamei. This is quite likely a predefined
node, see Section 19.2 on page 399.
\begin{tcbposter}[
poster = {showframe,height=3cm,spacing=2mm,rows=2},
boxes = {beamer,colframe=blue!50!black,colback=blue!50,colupper=yellow!50},
]
\posterbox{name=A,column=1,at=middle}{First box}
\posterbox{name=B,column=2,at=row1}{Second box}
\end{tcbposter}
col1 col2 col3
row1
Second boxB
row2
First box A
\begin{tcbposter}[
poster = {showframe,height=3cm,spacing=2mm,rows=2},
boxes = {beamer,colframe=blue!50!black,colback=blue!50,colupper=yellow!50},
]
\posterbox{name=A,column=1,below=top}{First box}
\posterbox{name=B,column=1,between=A and bottom}{Second box}
\posterbox{name=C,column=2,above=bottom}{Third box}
\posterbox{name=D,column=2,between=top and C,span=2}{Fourth box}
\posterbox{name=E,column=3,between=D and bottom}{Fifth box}
\end{tcbposter}
col1 col2 col3
row1
First box A Fourth box
D
Second box
row2
B
Third box C Fifth box E
408
N 2017-07-03 /tcb/posterloc/sequence=hsequencei (no default, initially unset)
The box is broken into partial boxes. These partial boxes are placed following the given
hsequencei of placements. The feasible syntax for the hsequencei is:
hcolumn ai between hname a1 i and hname a2 i then
hcolumn bi between hname b1 i and hname b2 i then
hcolumn ci between hname c1 i and hname c2 i then. . .
Obviously, this places the first part box at hcolumn ai between hname a2 i and hname a2 i.
The second box part is placed at hcolumn bi between hname b2 i and hname b2 i, and so on.
\begin{tcbposter}[
poster = {showframe,height=6cm,spacing=2mm,rows=2},
boxes = {beamer,colframe=blue!50!black,colback=blue!50,colupper=yellow!50},
]
\posterbox[adjusted title=A]{name=A,column=1,below=top,span=2}{First box}
\posterbox{name=B,column=2,above=bottom,span=2}{Second box}
\posterbox[adjusted title=C,colframe=red!50!black,colback=red!50]{
name=C, sequence=1 between A and bottom then
2 between A and B then
3 between top and B
}{\lipsum[2]}
\end{tcbposter}
col1 col2 col3
row1 A tesque a nulla. Cum
A sociis natoque penatibus
First box et magnis dis parturi-
ent montes, nascetur
C sed accumsan bibendum, ridiculus mus. Aliquam
tincidunt urna.
Nam dui ligula, fringilla
erat ligula aliquet magna, C3 Nulla
ullamcorper vestibulum
vitae ornare odio metus
a, euismod sodales, a mi. Morbi turpis. Pellentesque
row2
sollicitudin vel, wisi.
C2 ac orci et
nisl hendrerit mollis. cursus luctus mauris.
Morbi auctorC1lorem non Suspendisse ut massa.
justo. Nam lacus libero, Cras nec ante. Pellen-
pretium at, lobortis
vitae, ultricies et, tellus.
Donec aliquet, tortor Second box B
\begin{tcbposter}[
poster = {showframe,height=2.5cm,spacing=2mm,rows=2},
boxes = {beamer,colframe=blue!50!black,colback=blue!50,colupper=yellow!50},
]
\posterbox{name=A,column=1,below=top,span=2}{First box}
\posterbox[colframe=red!50!black,colback=red!50]{
name=B, sequence=1 between A and bottom then
2 between A and bottom then
3 between top and bottom
}{Second box followed by placeholder boxes}
\end{tcbposter}
col1 col2 col3
row1
First box A
409
N 2017-07-03 /tcb/posterloc/xshift=hlengthi (no default, initially 0pt)
Horizontal shift of a box by hlengthi.
\begin{tcbposter}[
poster = {showframe,height=3cm,spacing=2mm,rows=2},
boxes = {beamer,colframe=blue!50!black,colback=blue!50,colupper=yellow!50},
]
\posterbox{name=A,column=1,row=1,xshift=6mm}{First box}
\posterbox{name=B,column=2,row=2,xshift=-6mm}{Second box}
\end{tcbposter}
col1 col2 col3
row1
First box
A
row2
Second box
B
\begin{tcbposter}[
poster = {showframe,height=3cm,spacing=2mm,rows=2},
boxes = {beamer,colframe=blue!50!black,colback=blue!50,colupper=yellow!50},
]
\posterbox{name=A,column=1,row=1,yshift=-4mm}{First box}
\posterbox{name=B,column=2,row=2,yshift=4mm}{Second box}
\end{tcbposter}
col1 col2 col3
row1
First box
A
Second box
row2
B
410
20 Library fitting
LIB
The library is loaded by a package option or inside the preamble by:
\tcbuselibrary{fitting}
% \usepackage{lipsum} \tcbuselibrary{raster}
\tcbset{colframe=blue!50!black,colback=red!10!white,
boxsep=0pt,top=1mm,bottom=1mm,left=1mm,right=1mm,
fit algorithm=hybrid*,raster equal skip=1mm}
\begin{tcbraster}[raster columns=3,raster valign=bottom]
\tcboxfit[height=8cm]{\lipsum[1]}
\tcboxfit[height=4cm]{\lipsum[1]}
\tcboxfit[height=2cm]{\lipsum[1]}
\end{tcbraster}
\begin{tcbraster}[colback=green!10!white,boxsep=1mm]
\tcboxfit[height=4cm]{\lipsum[2]}
\tcboxfit[height=4cm,title=With a title]{\lipsum[2]}
\end{tcbraster}
tor semper nulla. Donec varius orci in, pretium quis, viverra ac, nunc. Praesent
eget sem vel leo ultrices bibendum. Aenean
tum gravida mauris. Nam arcu libero, nonummy eget, consectetuer
id, vulputate a, magna. Donec vehicula augue eu neque. Pellen-
dignissim rutrum.
sagittis quis, diam. Duis eget orci sit amet varius orci eget risus. Duis nibh mi, congue eu, accumsan eleifend,
orci dignissim rutrum. sagittis quis, diam. Duis eget orci sit amet orci dignissim rutrum.
411
! See Section 22.6 on page 445 for more elaborate methods to create new commands.
\newtcboxfit[hinit optionsi]{\hnamei}[hnumberi][hdefaulti]{hoptionsi}
Creates a new macro \hnamei based on \tcboxfitÕ P. 411 . Basically, \newtcboxfit oper-
ates like \newcommand. The new macro \hnamei optionally takes hnumberi+1 arguments,
where hdefaulti is the default value for the optional first argument. The hoptionsi are given
to the underlying tcboxfit. The hinit optionsi allow setting up automatic numbering, see
Section 5 from page 108.
\newtcboxfit{\mybox}{colback=red!5!white, This is my
colframe=red!75!black,width=4cm,
own box.
height=1.5cm,halign=center}
Second box
First box
with more text
% \usepackage{lipsum}
\newtcboxfit{\mybox}[2]{colback=red!5!white,
colframe=red!75!black,fonttitle=\bfseries,
Third box with text
boxsep=1mm,left=0mm,right=0mm,top=0mm,
bottom=0mm,halign=center,valign=center,
nobeforeafter,width=#1,height=#2}
Lorem ipsum dolor sit amet, consectetuer adipiscing
elit. Ut purus elit, vestibulum ut, placerat ac, adipiscing
\mybox{2.5cm}{1cm}{First box}%
vitae, felis. Curabitur dictum gravida mauris. Nam
arcu libero, nonummy eget, consectetuer id, vulputate
a, magna. Donec vehicula augue eu neque. Pellentesque
\mybox{2.5cm}{1cm}{Second box with more text}\\ habitant morbi tristique senectus et netus et malesuada
fames ac turpis egestas. Mauris ut leo. Cras viverra
\mybox{5cm}{2cm}{Third box with text}\\ metus rhoncus sem. Nulla et lectus vestibulum urna
fringilla ultrices. Phasellus eu tellus sit amet tortor
\mybox{5cm}{3cm}{\lipsum[1]}
gravida placerat. Integer sapien est, iaculis in, pretium
quis, viverra ac, nunc. Praesent eget sem vel leo
ultrices bibendum. Aenean faucibus. Morbi dolor nulla,
malesuada eu, pulvinar at, mollis ac, nulla. Curabitur
auctor semper nulla. Donec varius orci eget risus. Duis
nibh mi, congue eu, accumsan eleifend, sagittis quis,
diam. Duis eget orci sit amet orci dignissim rutrum.
colframe=red!75!black,
lus. Donec aliquet, tortor sed accumsan
bibendum, erat ligula aliquet magna, vi-
width=#2,height=#2/3*2,#1}
tae ornare odio metus a mi. Morbi ac
orci et nisl hendrerit mollis. Suspendisse
ut massa. Cras nec ante. Pellentesque
a nulla. Cum sociis natoque penatibus
et magnis dis parturient montes, nascetur
\mybox[colback=yellow]{5cm}% ridiculus mus. Aliquam tincidunt urna.
Nulla ullamcorper vestibulum turpis. Pel-
{\lipsum[2]} lentesque cursus luctus mauris.
\renewtcboxfit[hinit optionsi]{\hnamei}[hnumberi][hdefaulti]{hoptionsi}
Operates like \newtcboxfit, but based on \renewcommand instead of \newcommand. An
existing macro is redefined.
\tcbfontsize{hfactori}
Selects a font size inside a tcolorbox which is scaled with the given hfactori relative to
\tcbfitdim.
The font size for the content of a box with fixed width and fixed height can be adjusted auto-
matically. This is called the fitbox capture mode. Note that the fit control algorithm constructs
a series of versions for the box and selects the ’best’. Therefore, the compilation time is quite
longer than for a normal box. The algorithm will fail, if a different selected font size does not
change the overall size of the box content. The \tcboxfitÕ P. 411 macro uses this algorithm by
default.
!
The fit control keys are only applicable to unbreakable boxes without a lower part. The
box content should not change counters.
% \usepackage{lipsum}
% \tcbuselibrary{skins}
\newtcolorbox{fitting}[2][]{fit,height=#2,boxsep=1pt,valign=center,opacityupper=0.5,
top=0.4\tcbfitdim,bottom=0.4\tcbfitdim,left=0.75\tcbfitdim,right=0.75\tcbfitdim,
enhanced,watermark text={\tcbfitsteps},colframe=blue!75!black,colback=white,#1}
\begin{fitting}{4cm}
\lipsum[1]
\end{fitting}
\begin{fitting}{2cm}
\lipsum[2]
\end{fitting}
\begin{fitting}{1cm}
\lipsum[3]
\end{fitting}
77
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, placerat
ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero, nonummy eget,
consectetuer id, vulputate a, magna. Donec vehicula augue eu neque. Pellentesque habitant morbi
tristique senectus et netus et malesuada fames ac turpis egestas. Mauris ut leo. Cras viverra metus
rhoncus sem. Nulla et lectus vestibulum urna fringilla ultrices. Phasellus eu tellus sit amet tortor
gravida placerat. Integer sapien est, iaculis in, pretium quis, viverra ac, nunc. Praesent eget sem
vel leo ultrices bibendum. Aenean faucibus. Morbi dolor nulla, malesuada eu, pulvinar at, mollis
ac, nulla. Curabitur auctor semper nulla. Donec varius orci eget risus. Duis nibh mi, congue eu,
accumsan eleifend, sagittis quis, diam. Duis eget orci sit amet orci dignissim rutrum.
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem non justo. Nam lacus
libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet, tortor sed accumsan bibendum, erat ligula
aliquet magna, vitae ornare odio metus a mi. Morbi ac orci et nisl hendrerit mollis. Suspendisse ut massa.
Cras nec ante. Pellentesque a nulla. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur
ridiculus mus. Aliquam tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus luctus mauris.
9
Nulla malesuada porttitor diam. Donec felis erat, congue non, volutpat at, tincidunt tristique, libero. Vivamus viverra fermentum felis. Donec nonummy pellentesque ante. Phasellus
adipiscing semper elit. Proin fermentum massa ac quam. Sed diam turpis, molestie vitae, placerat a, molestie nec, leo. Maecenas lacinia. Nam ipsum ligula, eleifend at, accumsan
nec, suscipit a, ipsum. Morbi blandit ligula feugiat magna. Nunc eleifend consequat lorem. Sed lacinia nulla vitae enim. Pellentesque tincidunt purus vel magna. Integer non enim.
Praesent euismod nunc eu purus. Donec bibendum quam in tellus. Nullam cursus pulvinar lectus. Donec et mi. Nam vulputate metus eu enim. Vestibulum pellentesque felis eu
massa.
413
/tcb/fit to=hwidthi and hheighti (style, initially unset)
Shortcut for using /tcb/fitÕ P. 413 and setting the hwidthi and hheighti values separately.
\tcbset{colback=red!5!white,colframe=red!75!black}
This box con-
\begin{tcolorbox}[fit to=3cm and 2cm] tent is fitted
This box content is fitted to the given to the given
dimensions. dimensions.
\end{tcolorbox}
\tcbset{colback=red!5!white,colframe=red!75!black}
This box content is fitted to
\begin{tcolorbox}[fit to height=2cm] the given height.
This box content is fitted to the given
height.
\end{tcolorbox}
\tcbset{colback=red!5!white,colframe=red!75!black}
Too few words for
\begin{tcolorbox}[fit to=4cm and 2cm] the box.
Too few words for the box.
\end{tcolorbox}
% \usepackage{lipsum}
Lorem ipsum dolor sit amet, consectetuer
adipiscing elit. Ut purus elit, vestibulum ut,
\tcbset{colback=red!5!white,
placerat ac, adipiscing vitae, felis. Curabitur
dictum gravida mauris. Nam arcu libero,
nonummy eget, consectetuer id, vulputate a,
colframe=red!75!black,left=1mm, magna. Donec vehicula augue eu neque. Pel-
lentesque habitant morbi tristique senectus
right=1mm,boxsep=0mm} et netus et malesuada fames ac turpis eges-
tas. Mauris ut leo. Cras viverra metus rhon-
cus sem. Nulla et lectus vestibulum urna
fringilla ultrices. Phasellus eu tellus sit amet
\begin{tcolorbox}[fit to=5cm and 4cm,
tortor gravida placerat. Integer sapien est,
iaculis in, pretium quis, viverra ac, nunc.
fit skip=1.0 ]
Praesent eget sem vel leo ultrices bibendum.
Aenean faucibus. Morbi dolor nulla, male-
suada eu, pulvinar at, mollis ac, nulla. Cur-
\lipsum[1] abitur auctor semper nulla. Donec varius orci
eget risus. Duis nibh mi, congue eu, accum-
\end{tcolorbox} san eleifend, sagittis quis, diam. Duis eget
orci sit amet orci dignissim rutrum.
414
/tcb/fit fontsize macros (style, initially unset)
Redefines the standard LATEX font size macros \tiny, \scriptsize, \footnotesize,
\small, \normalsize, \large, \Large, \LARGE, \huge, and \Huge, to set font sizes relative
to the current \tcbfitdim. Note that the display skip values for mathematical formulas
are respected by the redefined macros.
\tcbset{colback=red!5!white,
colframe=red!75!black,left=1mm,
right=1mm,boxsep=0mm}
\let\realHuge=\Huge
The relative relative font size macros are
also usable without the fit algorithm.
\begin{tcolorbox}[fit basedim=7pt,
fontupper=\normalsize, Adapted Huge —
fit fontsize macros]
The relative relative font size macros Original Huge
are also usable without the
\textit{fit} algorithm.\par
{\Huge Adapted Huge} ---
{\realHuge Original Huge}
\end{tcolorbox}
Adapted title
Nam dui ligula, fringilla a, euismod so-
dales, sollicitudin vel, wisi. Morbi auc-
\tcbset{size=fbox,colback=red!5!white, tor lorem non justo. Nam lacus libero,
colframe=red!75!black} pretium at, lobortis vitae, ultricies et,
tellus. Donec aliquet, tortor sed accum-
san bibendum, erat ligula aliquet magna,
\tcboxfit[height=5cm, vitae ornare odio metus a mi. Morbi
fit fontsize macros, ac orci et nisl hendrerit mollis. Sus-
fonttitle=\normalsize\bfseries, pendisse ut massa. Cras nec ante. Pel-
lentesque a nulla. Cum sociis natoque pe-
title=Adapted title] natibus et magnis dis parturient montes,
{\lipsum[2]} nascetur ridiculus mus. Aliquam tin-
cidunt urna. Nulla ullamcorper vestibu-
lum turpis. Pellentesque cursus luctus
mauris.
415
/tcb/fit height plus=hdimensioni (no default, initially 0pt)
The box is allowed to enlarge the fixed height up to the given hdimensioni, before a font
size fit is applied. An optional /tcb/fit width plus is tried after the height adaption.
% \usepackage{lipsum}
\tcbset{colback=red!5!white,colframe=red!75!black,left=1mm,top=1mm,bottom=1mm,
right=1mm,boxsep=0mm,width=3cm,height=3cm,nobeforeafter}
\begin{tcolorbox}[fit]
This is a tcolorbox.
\end{tcolorbox}
\begin{tcolorbox}[fit,fit height plus=1cm]
This is a tcolorbox.
\end{tcolorbox}
\begin{tcolorbox}[fit]
\lipsum[2]
\end{tcolorbox}
\begin{tcolorbox}[fit,fit height plus=1cm]
\lipsum[2]
\end{tcolorbox}
box. box.
Morbi auctor lorem non justo.
Nam lacus libero, pretium at, bibendum, erat ligula aliquet
lobortis vitae, ultricies et, tellus. magna, vitae ornare odio me-
Donec aliquet, tortor sed accum- tus a mi. Morbi ac orci et
san bibendum, erat ligula aliquet nisl hendrerit mollis. Sus-
magna, vitae ornare odio metus a pendisse ut massa. Cras nec
mi. Morbi ac orci et nisl hendrerit ante. Pellentesque a nulla.
mollis. Suspendisse ut massa.
Cras nec ante. Pellentesque a
Cum sociis natoque penati-
nulla. Cum sociis natoque pe- bus et magnis dis parturi-
natibus et magnis dis parturient ent montes, nascetur ridiculus
montes, nascetur ridiculus mus. mus. Aliquam tincidunt urna.
Aliquam tincidunt urna. Nulla ul- Nulla ullamcorper vestibulum
lamcorper vestibulum turpis. Pel- turpis. Pellentesque cursus
lentesque cursus luctus mauris.
luctus mauris.
% \usepackage{lipsum}
\tcbset{colback=red!5!white,colframe=red!75!black,left=1mm,top=1mm,bottom=1mm,
right=1mm,boxsep=0mm,width=3cm,height=3cm,nobeforeafter}
\begin{tcolorbox}[fit]
This is a tcolorbox.
\end{tcolorbox}
\begin{tcolorbox}[fit,fit width plus=1cm]
This is a tcolorbox.
\end{tcolorbox}
\begin{tcolorbox}[fit]
\lipsum[2]
\end{tcolorbox}
\begin{tcolorbox}[fit,fit width plus=1cm]
\lipsum[2]
\end{tcolorbox}
box. box.
Morbi auctor lorem non justo.
tor lorem non justo. Nam lacus libero,
Nam lacus libero, pretium at,
lobortis vitae, ultricies et, tellus. pretium at, lobortis vitae, ultricies et,
Donec aliquet, tortor sed accum- tellus. Donec aliquet, tortor sed ac-
san bibendum, erat ligula aliquet cumsan bibendum, erat ligula aliquet
magna, vitae ornare odio metus a magna, vitae ornare odio metus a mi.
mi. Morbi ac orci et nisl hendrerit Morbi ac orci et nisl hendrerit mollis.
mollis. Suspendisse ut massa.
Suspendisse ut massa. Cras nec ante.
Cras nec ante. Pellentesque a
nulla. Cum sociis natoque pe- Pellentesque a nulla. Cum sociis na-
natibus et magnis dis parturient toque penatibus et magnis dis parturi-
montes, nascetur ridiculus mus. ent montes, nascetur ridiculus mus. Ali-
Aliquam tincidunt urna. Nulla ul- quam tincidunt urna. Nulla ullamcorper
lamcorper vestibulum turpis. Pel- vestibulum turpis. Pellentesque cursus
lentesque cursus luctus mauris.
luctus mauris.
416
Typically but not necessarily, the optional title of a tcolorbox is not part of the fit
operation. If a /tcb/fit width plus is applied, the title is also adapted to the new
! width. If counters are increased inside the title text, they may be increased more than
one time. To avoid this, you are encouraged to use /tcb/phantomÕ P. 98 or /tcb/step and
labelÕ P. 98 to set counters or use automatic numbering, see Subsection 5.1 from page 108.
% \usepackage{lipsum}
\tcbset{colback=red!5!white,colframe=red!75!black,left=1mm,top=1mm,bottom=1mm,
right=1mm,boxsep=0mm,height=4cm}
\begin{tcolorbox}[fit,width=\linewidth/2]
\lipsum[2]
\end{tcolorbox}\par
\begin{tcolorbox}[fit width from=\linewidth/2 to \linewidth]
\lipsum[2]
\end{tcolorbox}\par
417
/tcb/fit height from=hmini to hmaxi (style, no default)
Sets the box height to hmini and allows the height to grow up to hmaxi.
% \usepackage{lipsum}
\newtcolorbox{mybox}{colback=red!5!white,colframe=red!75!black,left=1mm,top=1mm,
bottom=1mm,right=1mm,boxsep=0mm,width=4cm,nobeforeafter,
fit height from=1cm 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}
418
/tcb/fit algorithm=hnamei (no default, initially fontsize)
Sets the algorithm for the fitting process after optionally width and height are adapted.
Feasible values for hnamei are:
• fontsize (initial): The algorithm is a bisection method that adapts the font size until
certain stop conditions are fulfilled. This is the most time-consuming method but it is
robust and gives pleasant results.
N 2014-10-29 • fontsize*: First, the fontsize algorithm is applied. If the font was scaled down and
the resulting height is too small, the box is squeezed to fit the area.
• areasize: The algorithm calculates the area size for the text without scaling the font.
The text box is shaped for the needed aspect ratio in one or two steps. Finally, it is
scaled down with a standard \resizebox macro.
N 2014-10-29 • areasize*: The areasize algorithm is applied, but if the content was scaled down
and the resulting height is too small, the box is squeezed to fit the area.
• hybrid: First, this algorithm estimates the needed font size in one or two steps. Then
an areasize fitting as above is a applied.
N 2014-10-29 • hybrid*: First, this algorithm estimates the needed font size in one or two steps. Then
an areasize* fitting as above is a applied.
! The aspect ratio is very likely to be horrible. You should not use this method
for final documents.
419
% \usepackage{lipsum}
\newtcboxfit{mybox}[1]{colback=red!5!white,colframe=red!75!black,left=1mm,top=1mm,
bottom=1mm,right=1mm,boxsep=0mm,width=3.5cm,height=7cm,nobeforeafter,
before upper=\textcolor{blue}{\rule{5mm}{5mm}}\ ,
enhanced,watermark text={\tcbfitsteps},
fonttitle=\bfseries,adjusted title=#1,fit algorithm=#1}
\mybox{fontsize}{\lipsum[2]}\hfill
\mybox{hybrid}{\lipsum[2]}\hfill
\mybox{areasize}{\lipsum[2]}\hfill
\mybox{squeeze}{\lipsum[2]}
6421
Nam lacus libero, pretium justo. Nam lacus libero, libero, pretium at,
at, lobortis vitae, ultricies pretium at, lobortis vitae, tis vitae, ultricies et, tel- lobortis vitae, ul-
tricies et, tellus.
et, tellus. Donec aliquet, ultricies et, tellus. Donec lus. Donec aliquet, tor- Donec aliquet, tortor
tortor sed accumsan biben- aliquet, tortor sed accum- tor sed accumsan bibendum, sed accumsan biben-
dum, erat ligula aliquet san bibendum, erat ligula erat ligula aliquet magna, vi- dum, erat ligula
aliquet magna, vitae
magna, vitae ornare odio aliquet magna, vitae ornare tae ornare odio metus a mi. ornare odio metus
metus a mi. Morbi ac orci odio metus a mi. Morbi ac Morbi ac orci et nisl hen- a mi. Morbi ac orci
et nisl hendrerit mollis. orci et nisl hendrerit mollis. drerit mollis. Suspendisse ut
et nisl hendrerit
Suspendisse ut massa. Cras mollis. Suspendisse
Suspendisse ut massa. Cras massa. Cras nec ante. Pel- ut massa. Cras nec
nec ante. Pellentesque a nec ante. Pellentesque a ante. Pellentesque
lentesque a nulla. Cum sociis
nulla. Cum sociis natoque nulla. Cum sociis natoque a nulla. Cum sociis
penatibus et magnis dis penatibus et magnis dis natoque penatibus et magnis natoque penatibus et
parturient montes, nascetur parturient montes, nasce- dis parturient montes, nasce- magnis dis parturi-
ent montes, nascetur
ridiculus mus. Aliquam tur ridiculus mus. Aliquam tur ridiculus mus. Aliquam ridiculus mus. Ali-
tincidunt urna. Nulla tincidunt urna. Nulla tincidunt urna. Nulla ul- quam tincidunt
ullamcorper vestibulum ullamcorper vestibulum lamcorper vestibulum turpis. urna. Nulla ullam-
corper vestibulum
turpis. Pellentesque cursus turpis. Pellentesque cursus Pellentesque cursus luctus turpis. Pellentesque
luctus mauris. luctus mauris. mauris. cursus luctus mauris.
% \usepackage{lipsum}
\newtcboxfit{mybox}[2]{colback=red!5!white,colframe=red!75!black,left=1mm,top=1mm,
size=tight,width=7.2cm,height=5cm,nobeforeafter,
before upper=\textcolor{blue}{\rule{5mm}{5mm}}\ ,
enhanced,fonttitle=\bfseries,adjusted title=#2,fit algorithm=#1}
hybrid (possible gap at end) hybrid* (no gap but possibly squeezed)
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
Ut purus elit, vestibulum ut, placerat ac, adipiscing vitae, Ut purus elit, vestibulum ut, placerat ac, adipiscing vitae,
felis. Curabitur dictum gravida mauris. Nam arcu libero, felis. Curabitur dictum gravida mauris. Nam arcu libero,
nonummy eget, consectetuer id, vulputate a, magna. Donec nonummy eget, consectetuer id, vulputate a, magna. Donec
vehicula augue eu neque. Pellentesque habitant morbi tris- vehicula augue eu neque. Pellentesque habitant morbi tris-
tique senectus et netus et malesuada fames ac turpis egestas. tique senectus et netus et malesuada fames ac turpis egestas.
Mauris ut leo. Cras viverra metus rhoncus sem. Nulla et Mauris ut leo. Cras viverra metus rhoncus sem. Nulla et
lectus vestibulum urna fringilla ultrices. Phasellus eu tellus lectus vestibulum urna fringilla ultrices. Phasellus eu tellus
sit amet tortor gravida placerat. Integer sapien est, iaculis sit amet tortor gravida placerat. Integer sapien est, iaculis
in, pretium quis, viverra ac, nunc. Praesent eget sem vel in, pretium quis, viverra ac, nunc. Praesent eget sem vel
leo ultrices bibendum. Aenean faucibus. Morbi dolor nulla, leo ultrices bibendum. Aenean faucibus. Morbi dolor nulla,
malesuada eu, pulvinar at, mollis ac, nulla. Curabitur auctor malesuada eu, pulvinar at, mollis ac, nulla. Curabitur auctor
semper nulla. Donec varius orci eget risus. Duis nibh mi, semper nulla. Donec varius orci eget risus. Duis nibh mi,
congue eu, accumsan eleifend, sagittis quis, diam. Duis eget congue eu, accumsan eleifend, sagittis quis, diam. Duis eget
orci sit amet orci dignissim rutrum. orci sit amet orci dignissim rutrum.
420
The following options set control parameters for the fit algorithm. Mainly, they apply
! to the fontsize variant, see /tcb/fit algorithmÕ P. 419 . The options should be seen as
experimental and are likely to change in future versions, if necessary.
421
21 Library hooks
LIB
The library is loaded by a package option or inside the preamble by:
\tcbuselibrary{hooks}
For the skin related options, the library skins has to be loaded separately.
LIB
21.1 Concept of Hooks
A hook is a placeholder in some LATEX code where additional code can be added. For example,
the LATEX macro \AtBeginDocument adds code to a hook which is placed at the beginning of
every document.
Several option keys of tcolorbox allow providing some code which is added to specific places
of a colored box. For example, /tcb/before upperÕ P. 65 places code before the content of the
upper part. A following usage of this key overwrites any prior settings.
The library hooks extends /tcb/before upperÕ P. 65 and several more existing keys to ’hook-
LIB
able’ versions, e. g. /tcb/before upper appÕ P. 424 and /tcb/before upper preÕ P. 424 . The
’hookable’ keys don’t overwrite prior settings but either append or prepend the newly given
code to the existing code.
The general naming convention (with some small exceptions) is:
• hoption keyi app: works like hoption keyi but appends its code to the existing code.
• hoption keyi pre: works like hoption keyi but prepends its code to the existing code.
If the original hoption keyi is used (again), all code will be overwritten. Therefore, the order of
the option key usage is crucial.
422
% \usepackage{array,tabularx}
\newcolumntype{Y}{>{\raggedleft\arraybackslash}X}% see tabularx
\tcbset{enhanced,fonttitle=\bfseries\large,fontupper=\normalsize\sffamily,
colback=yellow!10!white,colframe=red!50!black,colbacktitle=Salmon!30!white,
coltitle=black,center title,
tabularx={X||Y|Y|Y|Y||Y},% this sets 'before upper' and 'after upper'
before upper app={Group & One & Two & Three & Four & Sum\\\hline\hline} }
\begin{tcolorbox}[title=My table]
Red & 1000.00 & 2000.00 & 3000.00 & 4000.00 & 10000.00\\\hline
Green & 2000.00 & 3000.00 & 4000.00 & 5000.00 & 14000.00\\\hline
Blue & 3000.00 & 4000.00 & 5000.00 & 6000.00 & 18000.00\\\hline\hline
Sum & 6000.00 & 9000.00 & 12000.00 & 15000.00 & 42000.00
\end{tcolorbox}
My table
Group One Two Three Four Sum
Red 1000.00 2000.00 3000.00 4000.00 10000.00
Green 2000.00 3000.00 4000.00 5000.00 14000.00
Blue 3000.00 4000.00 5000.00 6000.00 18000.00
Sum 6000.00 9000.00 12000.00 15000.00 42000.00
423
21.2 Box Content Additions
The following option keys extend the options given in Subsection 4.11 from page 64.
/tcb/before title app=hcodei (no default)
Appends the given hcodei to /tcb/before titleÕ P. 64 after the color and font settings and
before the content of the title.
/tcb/before title pre=hcodei (no default)
Prepends the given hcodei to /tcb/before titleÕ P. 64 after the color and font settings
and before the content of the title.
/tcb/after title app=hcodei (no default)
Appends the given hcodei to /tcb/after titleÕ P. 64 after the content of the title.
/tcb/after title pre=hcodei (no default)
Prepends the given hcodei to /tcb/after titleÕ P. 64 after the content of the title.
/tcb/before upper app=hcodei (no default)
Appends the given hcodei to /tcb/before upper Õ P. 65 after the color and font settings and
before the content of the upper part.
/tcb/before upper pre=hcodei (no default)
Prepends the given hcodei to /tcb/before upperÕ P. 65 after the color and font settings
and before the content of the upper part.
/tcb/after upper app=hcodei (no default)
Appends the given hcodei to /tcb/after upper Õ P. 65 after the content of the upper part.
/tcb/after upper pre=hcodei (no default)
Prepends the given hcodei to /tcb/after upperÕ P. 65 after the content of the upper part.
% \tcbuselibrary{theorems}
\tcbset{ams align,% this sets 'before upper' and 'after upper'
colback=yellow!10!white,colframe=red!50!black,
before upper app={\frac{2}{\sqrt{2}}&=\sqrt{2}.\\},
after upper pre={\\\sin\left(\frac{\pi}{2}\right)&=1.},
}
\begin{tcolorbox}
\sum\limits_{n=1}^{\infty} \frac{1}{n} &= \infty.\\
\int x^2 ~\text{d}x &= \frac13 x^3 + c.
\end{tcolorbox}
2 √
√ = 2. (22)
2
X
∞
1
= ∞. (23)
n
n=1
Z
1 3
x2 dx = x + c. (24)
3
π
sin = 1. (25)
2
424
/tcb/before lower app=hcodei (no default)
Appends the given hcodei to /tcb/before lowerÕ P. 66 after the color and font settings and
before the content of the lower part.
/tcb/before lower pre=hcodei (no default)
Prepends the given hcodei to /tcb/before lowerÕ P. 66 after the color and font settings
and before the content of the lower part.
/tcb/after lower app=hcodei (no default)
Appends the given hcodei to /tcb/after lowerÕ P. 66 after the content of the lower part.
/tcb/after lower pre=hcodei (no default)
Prepends the given hcodei to /tcb/after lowerÕ P. 66 after the content of the lower part.
The following option keys extend the options given in Subsection 4.14 from page 78.
The ’hookable’ versions are usable inside the document. In the preamble, they can
! only be used after explicit setting of /tcb/beforeÕ P. 78 and /tcb/afterÕ P. 78 or by e. g.
/tcb/parskipÕ P. 78 .
\tcbset{colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries}
This is a tcolorbox.
425
21.4 Overlays
The following option keys extend the options given in Subsection 4.12 from page 71.
/tcb/overlay app=hgraphical codei (no default)
Appends the given hgraphical codei to /tcb/overlayÕ P. 71 .
% \usetikzlibrary{patterns} % preamble
% \tcbuselibrary{skins} % preamble
\tcbset{frogbox/.style={enhanced,colback=green!10,colframe=green!65!black,
enlarge top by=5.5mm,
overlay={\foreach \x in {2cm,3.5cm} {
\begin{scope}[shift={([xshift=\x]frame.north west)}]
\path[draw=green!65!black,fill=green!10,line width=1mm] (0,0) arc (0:180:5mm);
\path[fill=black] (-0.2,0) arc (0:180:1mm);
\end{scope}}}]}}
\tcbset{ribbon/.style={overlay app={%
\path[fill=blue!75!white,draw=blue,double=white!85!blue,
preaction={opacity=0.6,fill=blue!75!white},
line width=0.1mm,double distance=0.2mm,
pattern=fivepointed stars,pattern color=white!75!blue]
([xshift=-0.2mm,yshift=-1.02cm]frame.north east)
-- ++(-1,1) -- ++(-0.5,0) -- ++(1.5,-1.5) -- cycle;}}}
\begin{tcolorbox}[frogbox,title=My title]
This is a \textbf{tcolorbox}.
\end{tcolorbox}
\begin{tcolorbox}[frogbox,ribbon,title=My title]
This is a \textbf{tcolorbox}.\par
Here, we apply a second overlay.
\end{tcolorbox}
My title
This is a tcolorbox.
My title
This is a tcolorbox.
Here, we apply a second overlay.
426
/tcb/overlay middle app=hgraphical codei (no default)
Appends the given hgraphical codei to /tcb/overlay middleÕ P. 72 .
/tcb/overlay middle pre=hgraphical codei (no default)
Prepends the given hgraphical codei to /tcb/overlay middleÕ P. 72 .
/tcb/overlay last app=hgraphical codei (no default)
Appends the given hgraphical codei to /tcb/overlay lastÕ P. 72 .
/tcb/overlay last pre=hgraphical codei (no default)
Prepends the given hgraphical codei to /tcb/overlay lastÕ P. 72 .
/tcb/overlay broken app=hgraphical codei (no default)
Appends the given hgraphical codei to /tcb/overlay brokenÕ P. 72 .
/tcb/overlay broken pre=hgraphical codei (no default)
Prepends the given hgraphical codei to /tcb/overlay brokenÕ P. 72 .
/tcb/overlay unbroken and first app=hgraphical codei (no default)
Appends the given hgraphical codei to /tcb/overlay unbroken and firstÕ P. 72 .
/tcb/overlay unbroken and first pre=hgraphical codei (no default)
Prepends the given hgraphical codei to /tcb/overlay unbroken and firstÕ P. 72 .
427
21.5 Watermarks
The following option keys extend the options given in Subsection 10.3 from page 165.
! watermarks
Watermarks are special overlays. The hooks library allows the combination of several
LIB
and overlays.
\tcbset{colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries}
My title
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, plac-
erat ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero, nonummy
eget, consectetuer id, vulputate a, magna. Donec vehicula augue eu neque. Pellentesque habi-
tant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Mauris ut leo.
Cras viverra metus rhoncus sem. Nulla et lectus vestibulum urna fringilla ultrices. Phasellus
eu tellus sit amet tortor gravida placerat. Integer sapien est, iaculis in, pretium quis, viverra
ac, nunc. Praesent eget sem vel leo ultrices bibendum. Aenean faucibus. Morbi dolor nulla,
Basilica
malesuada eu, pulvinar at, mollis ac, nulla. Curabitur auctor semper nulla. Donec varius
orci eget risus. Duis nibh mi, congue eu, accumsan eleifend, sagittis quis, diam. Duis eget
orci sit amet orci dignissim rutrum.
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem non
justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet, tortor
sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi. Morbi ac
orci et nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque a nulla. Cum
sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam
tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus luctus mauris.
428
/tcb/watermark graphics app=hfile namei (no default)
Appends a /tcb/watermark graphicsÕ P. 166 referenced by hfile namei to the colored box.
/tcb/watermark graphics pre=hfile namei (no default)
Prepends a /tcb/watermark graphicsÕ P. 166 referenced by hfile namei to the colored box.
/tcb/watermark graphics app on=hparti is hfile namei (no default)
Appends a /tcb/watermark graphics onÕ P. 166 the named hparti of a break sequence.
The picture is referenced by hfile namei.
/tcb/watermark graphics pre on=hparti is hfile namei (no default)
Prepends a /tcb/watermark graphics onÕ P. 166 the named hparti of a break sequence.
The picture is referenced by hfile namei.
/tcb/watermark tikz app=hgraphical codei (no default)
Appends a /tcb/watermark tikzÕ P. 167 with the given tikz hgraphical codei to the colored
box.
/tcb/watermark tikz pre=hgraphical codei (no default)
Prepends a /tcb/watermark tikzÕ P. 167 with the given tikz hgraphical codei to the colored
box.
% \usepackage{tikz}
\tcbset{colback=red!5!white,colframe=red!75!black,fonttitle=\bfseries,
watermark color=Navy,watermark opacity=0.25,
smiley/.style={watermark tikz pre={%
\path[fill=yellow,draw=yellow!75!red] (0,0) circle (1cm);
\fill[red] (45:5mm) circle (1mm);
\fill[red] (135:5mm) circle (1mm);
\draw[line width=1mm,red] (215:5mm) arc (215:325:5mm);}}}
My title
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, plac-
erat ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero, nonummy
eget, consectetuer id, vulputate a, magna. Donec vehicula augue eu neque. Pellentesque habi-
tant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Mauris ut leo.
Cras viverra metus rhoncus sem. Nulla et lectus vestibulum urna fringilla ultrices. Phasellus
eu tellus sit amet tortor gravida placerat. Integer sapien est, iaculis in, pretium quis, viverra
ac, nunc. Praesent eget sem vel leo ultrices bibendum. Aenean faucibus. Morbi dolor nulla,
Watermark
malesuada eu, pulvinar at, mollis ac, nulla. Curabitur auctor semper nulla. Donec varius
orci eget risus. Duis nibh mi, congue eu, accumsan eleifend, sagittis quis, diam. Duis eget
orci sit amet orci dignissim rutrum.
Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem non
justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus. Donec aliquet, tortor
sed accumsan bibendum, erat ligula aliquet magna, vitae ornare odio metus a mi. Morbi ac
orci et nisl hendrerit mollis. Suspendisse ut massa. Cras nec ante. Pellentesque a nulla. Cum
sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam
tincidunt urna. Nulla ullamcorper vestibulum turpis. Pellentesque cursus luctus mauris.
429
21.6 Underlays
The following option keys extend the options given in Section 10.8 on page 195. There are no
app type keys since underlays are stackable by default.
/tcb/underlay pre=hgraphical codei (no default)
Prepends the given hgraphical codei to /tcb/underlayÕ P. 195 .
/tcb/underlay unbroken pre=hgraphical codei (no default)
Prepends the given hgraphical codei to /tcb/underlay unbrokenÕ P. 196 .
/tcb/underlay first pre=hgraphical codei (no default)
Prepends the given hgraphical codei to /tcb/underlay firstÕ P. 196 .
/tcb/underlay middle pre=hgraphical codei (no default)
Prepends the given hgraphical codei to /tcb/underlay middleÕ P. 196 .
/tcb/underlay last pre=hgraphical codei (no default)
Prepends the given hgraphical codei to /tcb/underlay lastÕ P. 196 .
/tcb/underlay boxed title pre=hgraphical codei (no default)
Prepends the given hgraphical codei to /tcb/underlay boxed titleÕ P. 196 .
/tcb/underlay broken pre=hgraphical codei (no default)
Prepends the given hgraphical codei to /tcb/underlay brokenÕ P. 196 .
/tcb/underlay unbroken and first pre=hgraphical codei (no default)
Prepends the given hgraphical codei to /tcb/underlay unbroken and first P. 196 .
Õ
430
21.7 Finishes
The following option keys extend the options given in Section 10.9 on page 197. There are no
app type keys since finishes are stackable by default.
/tcb/finish pre=hgraphical codei (no default)
Prepends the given hgraphical codei to /tcb/finishÕ P. 197 .
/tcb/finish unbroken pre=hgraphical codei (no default)
Prepends the given hgraphical codei to /tcb/finish unbrokenÕ P. 198 .
/tcb/finish first pre=hgraphical codei (no default)
Prepends the given hgraphical codei to /tcb/finish firstÕ P. 198 .
/tcb/finish middle pre=hgraphical codei (no default)
Prepends the given hgraphical codei to /tcb/finish middleÕ P. 198 .
/tcb/finish last pre=hgraphical codei (no default)
Prepends the given hgraphical codei to /tcb/finish lastÕ P. 198 .
/tcb/finish broken pre=hgraphical codei (no default)
Prepends the given hgraphical codei to /tcb/finish brokenÕ P. 198 .
/tcb/finish unbroken and first pre=hgraphical codei (no default)
Prepends the given hgraphical codei to /tcb/finish unbroken and firstÕ P. 198 .
/tcb/finish middle and last pre=hgraphical codei (no default)
Prepends the given hgraphical codei to /tcb/finish middle and lastÕ P. 198 .
/tcb/finish unbroken and last pre=hgraphical codei (no default)
Prepends the given hgraphical codei to /tcb/finish unbroken and lastÕ P. 198 .
N 2014-09-19 /tcb/finish first and middle pre=hgraphical codei (no default)
Prepends the given hgraphical codei to /tcb/finish first and middle Õ P. 198 .
The following option keys extend the options given in Subsection 9.2 from page 138.
/tcb/frame code app=hgraphical codei (no default)
Appends the given hgraphical codei to /tcb/frame codeÕ P. 138 .
/tcb/frame code pre=hgraphical codei (no default)
Prepends the given hgraphical codei to /tcb/frame codeÕ P. 138 .
/tcb/interior titled code app=hgraphical codei (no default)
Appends the given hgraphical codei to /tcb/interior titled codeÕ P. 138 .
431
\begin{tcolorbox}[title=My title,enhanced,colframe=Navy,
frame code app={\draw[yellow,line width=1cm] (
frame.south west)--(frame.north east);},
interior titled code app={\draw[red,line width=1cm]
(frame.north west)--(frame.south east);},
]
\lipsum[1]
\end{tcolorbox}
My title
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, plac-
erat ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Nam arcu libero, nonummy
eget, consectetuer id, vulputate a, magna. Donec vehicula augue eu neque. Pellentesque habi-
tant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Mauris ut leo.
Cras viverra metus rhoncus sem. Nulla et lectus vestibulum urna fringilla ultrices. Phasellus
eu tellus sit amet tortor gravida placerat. Integer sapien est, iaculis in, pretium quis, viverra
ac, nunc. Praesent eget sem vel leo ultrices bibendum. Aenean faucibus. Morbi dolor nulla,
malesuada eu, pulvinar at, mollis ac, nulla. Curabitur auctor semper nulla. Donec varius
orci eget risus. Duis nibh mi, congue eu, accumsan eleifend, sagittis quis, diam. Duis eget
orci sit amet orci dignissim rutrum.
432
21.9 Extras
The following option keys extend the options given in Section 17.5 on page 371. There are no
app type keys since extras are stackable by default.
N 2015-07-16 /tcb/extras pre={hoptionsi} (no default)
Prepends the given hoptionsi to /tcb/extrasÕ P. 371 .
N 2015-07-16 /tcb/extras unbroken pre={hoptionsi} (no default)
Prepends the given hoptionsi to /tcb/extras unbrokenÕ P. 371 .
N 2015-07-16 /tcb/extras first pre={hoptionsi} (no default)
Prepends the given hoptionsi to /tcb/extras firstÕ P. 371 .
N 2015-07-16 /tcb/extras middle pre={hoptionsi} (no default)
Prepends the given hoptionsi to /tcb/extras middleÕ P. 371 .
N 2015-07-16 /tcb/extras last pre={hoptionsi} (no default)
Prepends the given hoptionsi to /tcb/extras lastÕ P. 371 .
N 2015-07-16 /tcb/extras broken pre={hoptionsi} (no default)
Prepends the given hoptionsi to /tcb/extras brokenÕ P. 371 .
N 2015-07-16 /tcb/extras unbroken and first pre={hoptionsi} (no default)
Prepends the given hoptionsi to /tcb/extras unbroken and firstÕ P. 371 .
N 2015-07-16 /tcb/extras middle and last pre={hoptionsi} (no default)
Prepends the given hoptionsi to /tcb/extras middle and lastÕ P. 371 .
N 2015-07-16 /tcb/extras unbroken and last pre={hoptionsi} (no default)
Prepends the given hoptionsi to /tcb/extras unbroken and lastÕ P. 371 .
N 2015-07-16 /tcb/extras first and middle pre={hoptionsi} (no default)
Prepends the given hoptionsi to /tcb/extras first and middleÕ P. 371 .
433
22 Library xparse
LIB
The library is loaded by a package option or inside the preamble by:
\tcbuselibrary{xparse}
\DeclareTotalTCBox{\myverb}{ v }{verbatim,
colframe=red!75!black,colupper=blue}{#1}
\textbf is a \LaTeX command.
\myverb{\textbf} is a \myverb{\LaTeX} command.
\DeclareTColorBox{mybox}{ o }{colframe=red!75!black,
IfNoValueTF={#1}{colback=red!5!white}{enhanced,interior style image=#1}}
\begin{mybox}
This is a tcolorbox.
\end{mybox}
\begin{mybox}[goldshade.png]
This is a tcolorbox.
\end{mybox}
This is a tcolorbox.
This is a tcolorbox.
434
/tcb/IfValueTF={hargumenti}{htrue optionsi}{hfalse optionsi} (no default)
Wraps the \IfValueTF command of xparse for option setting. If the hargumenti has a
value, the htrue optionsi are set. Otherwise, the hfalse optionsi are set.
\DeclareTColorBox{mybox}{ o }{colframe=red!75!black,colback=red!5!white,
IfValueTF={#1}{title={\flqq #1\frqq},fonttitle=\bfseries}{}}
\begin{mybox}
This is a tcolorbox.
\end{mybox}
\begin{mybox}[My title]
This is a tcolorbox.
\end{mybox}
This is a tcolorbox.
«My title»
This is a tcolorbox.
\DeclareTColorBox{mybox}{ s }{colframe=red!75!black,
IfBooleanTF={#1}{colback=yellow!50!red}{colback=red!5!white}}
\begin{mybox}
This is a tcolorbox.
\end{mybox}
\begin{mybox}*
This is a tcolorbox.
\end{mybox}
This is a tcolorbox.
This is a tcolorbox.
435
22.2 Producing tcolorbox Environments and Commands
\DeclareTColorBox[hinit optionsi]{hnamei}{hspecificationi}{hoptionsi}
Creates a new environment hnamei based on tcolorboxÕ P. 12 .
Basically, \DeclareTColorBox operates like \DeclareDocumentEnvironment. This means,
the new environment hnamei is constructed with the given argument hspecificationi. The
hoptionsi are given to the underlying tcolorboxÕ P. 12 .
Note that /tcb/savedelimiterÕ P. 26 is set to the given hnamei automatically.
The hinit optionsi allow setting up automatic numbering, see Section 5 from page 108.
The new environment is always created, irrespective of an already existing environment
with the same name.
% counter from previous example
\DeclareTColorBox[use counter from=pabox]{mybox}{ O{red} m d"" !O{} }
{enhanced,colframe=#1!75!black,colback=#1!5!white,
fonttitle=\bfseries,title={\thetcbcounter~#2},
IfValueTF={#3}{watermark text={#3}}{},#4}
\begin{mybox}{My title}
This is a tcolorbox.
\end{mybox}
\begin{mybox}[blue]{My title}
This is a tcolorbox.
\end{mybox}
\begin{mybox}[yellow]{My title}[colbacktitle=yellow!50!white,coltitle=black]
This is a tcolorbox.
\end{mybox}
22.1 My title
This is a tcolorbox.
22.2 My title
This is a tcolorbox.
22.3 My title
This is a tcolorbox.
22.5 My title
436
\NewTColorBox[hinit optionsi]{hnamei}{hspecificationi}{hoptionsi}
Operates like \DeclareTColorBoxÕ P. 436 , but based on \NewDocumentEnvironment instead
of \DeclareDocumentEnvironment. An error is issued if hnamei has already been defined.
\RenewTColorBox[hinit optionsi]{hnamei}{hspecificationi}{hoptionsi}
Operates like \DeclareTColorBoxÕ P. 436 , but based on \RenewDocumentEnvironment in-
stead of \DeclareDocumentEnvironment. An existing environment is redefined.
\ProvideTColorBox[hinit optionsi]{hnamei}{hspecificationi}{hoptionsi}
Operates like \DeclareTColorBoxÕ P. 436 , but based on \ProvideDocumentEnvironment
instead of \DeclareDocumentEnvironment. The environment hnamei is only created if it
is not already defined.
437
\DeclareTotalTColorBox[hinit optionsi]{\hnamei}{hspecificationi}{hoptionsi}{hcontenti}
Creates a new command \hnamei based on tcolorboxÕ P. 12 . In contrast to
\DeclareTColorBox Õ P. 436 , also the hcontenti of the tcolorbox is specified.
Basically, \DeclareTotalTColorBox operates like \DeclareDocumentCommand. This
means, the new command \hnamei is constructed with the given argument hspecificationi.
The hoptionsi are given to the underlying tcolorboxÕ P. 12 which is filled with the specified
hcontenti.
Note that /tcb/savedelimiterÕ P. 26 is set to the given hnamei automatically.
The hinit optionsi allow setting up automatic numbering, see Section 5 from page 108.
The new command is always created, irrespective of an already existing command with the
same name.
\DeclareTotalTColorBox{\diabox}{ O{} v m }
{ bicolor,nobeforeafter,equal height group=diabox,width=5.7cm,
fonttitle=\bfseries\ttfamily,adjusted title={#2},center title,
colframe=blue!20!black,leftupper=0mm,rightupper=0mm,colback=black!75!white,#1}
{ \tikz\path[fill zoom image={#2}] (0,0) rectangle (\linewidth,4cm);%
\tcblower#3}
blueshade.png goldshade.png
\NewTotalTColorBox[hinit optionsi]{\hnamei}{hspecificationi}{hoptionsi}{hcontenti}
Operates like \DeclareTotalTColorBox, but based on \NewDocumentCommand instead of
\DeclareDocumentCommand. An error is issued if \hnamei has already been defined.
\RenewTotalTColorBox[hinit optionsi]{\hnamei}{hspecificationi}{hoptionsi}{hcontenti}
Operates like \DeclareTotalTColorBox, but based on \RenewDocumentCommand instead of
\DeclareDocumentCommand. An existing command is redefined.
\ProvideTotalTColorBox[hinit optionsi]{\hnamei}{hspecificationi}{hoptionsi}{hcontenti}
Operates like \DeclareTotalTColorBox, but based on \ProvideDocumentCommand instead
of \DeclareDocumentCommand. The command \hnamei is only created if it is not already
defined.
438
22.3 Producing tcbox Commands
\DeclareTCBox[hinit optionsi]{\hnamei}{hspecificationi}{hoptionsi}
Creates a new command \hnamei based on \tcboxÕ P. 14 . Basically, \DeclareTCBox op-
erates like \DeclareDocumentCommand. This means, the new command \hnamei is con-
structed with the given argument hspecificationi. The hoptionsi are given to the underlying
\tcboxÕ P. 14 .
Note that /tcb/savedelimiterÕ P. 26 is set to the given hnamei automatically.
The hinit optionsi allow setting up automatic numbering, see Section 5 from page 108.
The new command is always created, irrespective of an already existing command with the
same name.
% counter from previous example
\DeclareTCBox[use counter from=pabox]{\mybox}{ s m s }
{ nobeforeafter,colback=red!5!white,colframe=red!75!black,
title={#2 (Box \thetcbcounter)},fonttitle=\bfseries,
IfBooleanTF={#1}{enhanced,drop shadow}{},
IfBooleanTF={#3}{colbacktitle=red!50!white}{} }
\NewTCBox[hinit optionsi]{\hnamei}{hspecificationi}{hoptionsi}
Operates like \DeclareTCBox, but based on \NewDocumentCommand instead of
\DeclareDocumentCommand. An error is issued if \hnamei has already been defined.
\RenewTCBox[hinit optionsi]{\hnamei}{hspecificationi}{hoptionsi}
Operates like \DeclareTCBox, but based on \RenewDocumentCommand instead of
\DeclareDocumentCommand. An existing command is redefined.
\ProvideTCBox[hinit optionsi]{\hnamei}{hspecificationi}{hoptionsi}
Operates like \DeclareTCBox, but based on \ProvideDocumentCommand instead of
\DeclareDocumentCommand. The command \hnamei is only created if it is not already
defined.
439
\DeclareTotalTCBox[hinit optionsi]{\hnamei}{hspecificationi}{hoptionsi}{hcontenti}
Creates a new command \hnamei based on \tcboxÕ P. 14 . In contrast to
\DeclareTCBox Õ P. 439 , also the hcontenti of the tcbox is specified.
Basically, \DeclareTotalTCBox operates like \DeclareDocumentCommand. This means,
the new command \hnamei is constructed with the given argument hspecificationi. The
hoptionsi are given to the underlying \tcboxÕ P. 14 which is filled with the specified
hcontenti.
Note that /tcb/savedelimiterÕ P. 26 is set to the given hnamei automatically.
The hinit optionsi allow setting up automatic numbering, see Section 5 from page 108.
The new command is always created, irrespective of an already existing command with the
same name.
\DeclareTotalTCBox{\myverb}{ O{red} v !O{} }
{ fontupper=\ttfamily,nobeforeafter,tcbox raise base,arc=0pt,outer arc=0pt,
top=0pt,bottom=0pt,left=0mm,right=0mm,
leftrule=0pt,rightrule=0pt,toprule=0.3mm,bottomrule=0.3mm,boxsep=0.5mm,
colback=#1!10!white,colframe=#1!50!black,#3}{#2}
To set a word bold in \LaTeX , use \textbf{bold} . Alternatively, write {\bfseries bold} . In
\LaTeX , other font settings are done in the same way, e. g. \textit , \itshape
or \texttt , \ttfamily .
The next example uses \lstinline from the listings package to typeset the verbatim
content.
% \usepackage{listings} or \tcbuselibrary{listings}
\DeclareTotalTCBox{\commandbox}{ s v }
{verbatim,colupper=white,colback=black!75!white,colframe=black}
{\IfBooleanTF{#1}{\textcolor{red}{\ttfamily\bfseries > }}{}%
\lstinline[language=command.com,keywordstyle=\color{blue!35!white}\bfseries]^#2^}
440
\NewTotalTCBox[hinit optionsi]{\hnamei}{hspecificationi}{hoptionsi}{hcontenti}
Operates like \DeclareTotalTCBoxÕ P. 440 , but based on \NewDocumentCommand instead of
\DeclareDocumentCommand. An error is issued if \hnamei has already been defined.
\RenewTotalTCBox[hinit optionsi]{\hnamei}{hspecificationi}{hoptionsi}{hcontenti}
Operates like \DeclareTotalTCBoxÕ P. 440 , but based on \RenewDocumentCommand instead
of \DeclareDocumentCommand. An existing command is redefined.
\ProvideTotalTCBox[hinit optionsi]{\hnamei}{hspecificationi}{hoptionsi}{hcontenti}
Operates like \DeclareTotalTCBoxÕ P. 440 , but based on \ProvideDocumentCommand in-
stead of \DeclareDocumentCommand. The command \hnamei is only created if it is not
already defined.
\tcboxverb[hoptionsi]{hverbatim box contenti}
Creates a colored box based on \tcboxÕ P. 14 which is fitted to the width of the given
hverbatim box contenti. The underlying \tcboxÕ P. 14 is styled with /tcb/verbatimÕ P. 434
plus the given hoptionsi. The difference to \tcboxÕ P. 14 is that the hverbatim box contenti
is interpreted verbatim. Therefore, \tcboxverb acts similar to \verb.
\tcboxverb{\LaTeX}, \tcboxverb[colback=blue!10!white,colupper=blue]{\LaTeX},
\tcboxverb[blank,fuzzy halo]{\LaTeX}, \tcboxverb[beamer]{\LaTeX},
\tcboxverb[enhanced,skin=enhancedmiddle jigsaw,colframe=red]{\LaTeX}.
441
22.4 Producing tcblisting Environments
! Besides xparse , the following commands also need the listings library to be included.
LIB
LIB
\DeclareTCBListing[hinit optionsi]{hnamei}{hspecificationi}{hoptionsi}
Creates a new environment hnamei based on tcblistingÕ P. 299 .
Basically, \DeclareTCBListing operates like \DeclareDocumentEnvironment. This
means, the new environment hnamei is constructed with the given argument hspecificationi.
The hoptionsi are given to the underlying tcblistingÕ P. 299 .
Note that /tcb/savedelimiterÕ P. 26 is set to the given hnamei automatically.
The hinit optionsi allow setting up automatic numbering, see Section 5 from page 108.
The new environment is always created, irrespective of an already existing environment
with the same name.
\DeclareTCBListing{mybox}{ s O{} m }{%
colback=red!5!white,
colframe=red!75!black,
fonttitle=\bfseries,
IfBooleanTF={#1} Listing Box
{listing side text}
{text side listing}, This is my This is my
title=#3,#2} LATEX box. \LaTeX\ box.
\begin{mybox}{Listing Box}
This is my
Listing Box
\LaTeX\ box.
\end{mybox}
\bigskip This is my This is my
\LaTeX\ box. LATEX box.
\begin{mybox}*{Listing Box}
This is my
\LaTeX\ box. Listing Box
\end{mybox}
\bigskip This is my This is my
LATEX box. \LaTeX\ box.
\begin{mybox}[colback=yellow]
{Listing Box}
This is my
\LaTeX\ box.
\end{mybox}
\NewTCBListing[hinit optionsi]{hnamei}{hspecificationi}{hoptionsi}
Operates like \DeclareTCBListing, but based on \NewDocumentEnvironment instead of
\DeclareDocumentEnvironment. An error is issued if hnamei has already been defined.
\RenewTCBListing[hinit optionsi]{hnamei}{hspecificationi}{hoptionsi}
Operates like \DeclareTCBListing, but based on \RenewDocumentEnvironment instead of
\DeclareDocumentEnvironment. An existing environment is redefined.
\ProvideTCBListing[hinit optionsi]{hnamei}{hspecificationi}{hoptionsi}
Operates like \DeclareTCBListing, but based on \ProvideDocumentEnvironment instead
of \DeclareDocumentEnvironment. The environment hnamei is only created if it is not
already defined.
442
With date of 2018-05-12, the xparse [13] package changed the argument collection process.
Now, spaces are ignored which leads to a serious change for listing environments ending
with an optional argument like O{}. The former behaviour of respecting spaces can be
preserved by adding a «!». Note that the following code uses !O{} now.
! • For older xparse versions, the following code is correct when using O{}.
• For xparse of 2018-05-12, only the first two examples of the following code using
O{} are really «good» – all others do not work.
• For xparse of 2018-05-12, the following code is correct when using !O{}.
• In the future, xparse may return to the old behaviour for environments.
\begin{mybox}[colframe=red]
\good
\end{mybox}
\begin{mybox}[colframe=red]\good\end{mybox}
\begin{mybox}
\good
\end{mybox}
\begin{mybox} \good\end{mybox}
\begin{mybox}\bad!\end{mybox}
\begin{mybox}
[\good]
\end{mybox}
\begin{mybox} [\good]\end{mybox}
\begin{mybox}[\bad!]\end{mybox}
443
22.5 Producing tcbinputlisting Commands
LIB
\DeclareTCBInputListing[hinit optionsi]{\hnamei}{hspecificationi}{hoptionsi}
Creates a new command \hnamei based on \tcbinputlistingÕ P. 301 . Basically,
\DeclareTCBInputListing operates like \DeclareDocumentCommand. This means, the new
command \hnamei is constructed with the given argument hspecificationi. The hoptionsi
are given to the underlying \tcbinputlistingÕ P. 301 .
The hinit optionsi allow setting up automatic numbering, see Section 5 from page 108.
The new command is always created, irrespective of an already existing command with the
same name.
% counter from previous example
\DeclareTCBInputListing[use counter from=pabox]{\mylisting}{ O{} O{red} m }{%
listing file={#3},title=Listing~\thetcbcounter,
colback=#2!5!white,colframe=#2!50!black,colbacktitle=#2!75!black,
fonttitle=\bfseries,listing only,#1}
Listing 22.10
\NewTCBInputListing[hinit optionsi]{\hnamei}{hspecificationi}{hoptionsi}
Operates like \DeclareTCBInputListing, but based on \NewDocumentCommand instead of
\DeclareDocumentCommand. An error is issued if \hnamei has already been defined.
\RenewTCBInputListing[hinit optionsi]{\hnamei}{hspecificationi}{hoptionsi}
Operates like \DeclareTCBInputListing, but based on \RenewDocumentCommand instead
of \DeclareDocumentCommand. An existing command is redefined.
\ProvideTCBInputListing[hinit optionsi]{\hnamei}{hspecificationi}{hoptionsi}
Operates like \DeclareTCBInputListing, but based on \ProvideDocumentCommand instead
of \DeclareDocumentCommand. The command \hnamei is only created if it is not already
defined.
444
22.6 Producing tboxfit Commands
LIB
\DeclareTCBoxFit[hinit optionsi]{\hnamei}{hspecificationi}{hoptionsi}
Creates a new command \hnamei based on \tcboxfitÕ P. 411 . Basically, \DeclareTCBoxFit
operates like \DeclareDocumentCommand. This means, the new command \hnamei is con-
structed with the given argument hspecificationi. The hoptionsi are given to the underlying
\tcboxfitÕ P. 411 .
Note that /tcb/savedelimiterÕ P. 26 is set to the given hnamei automatically.
The hinit optionsi allow setting up automatic numbering, see Section 5 from page 108.
The new command is always created, irrespective of an already existing command with the
same name.
width=#2,height=#2/3*2,
IfValueTF={#3}{height=#3}{}, Nam dui ligula, fringilla a, euismod
#1} sodales, sollicitudin vel, wisi. Morbi
auctor lorem non justo. Nam la-
cus libero, pretium at, lobortis vitae,
ultricies et, tellus. Donec aliquet,
\mybox[colback=yellow]{5cm}% tortor sed accumsan bibendum, erat
ligula aliquet magna, vitae ornare
{\lipsum[2]} odio metus a mi. Morbi ac orci et
nisl hendrerit mollis. Suspendisse
ut massa. Cras nec ante. Pellen-
\NewTCBoxFit[hinit optionsi]{\hnamei}{hspecificationi}{hoptionsi}
Operates like \DeclareTCBoxFit, but based on \NewDocumentCommand instead of
\DeclareDocumentCommand. An error is issued if \hnamei has already been defined.
\RenewTCBoxFit[hinit optionsi]{\hnamei}{hspecificationi}{hoptionsi}
Operates like \DeclareTCBoxFit, but based on \RenewDocumentCommand instead of
\DeclareDocumentCommand. An existing command is redefined.
\ProvideTCBoxFit[hinit optionsi]{\hnamei}{hspecificationi}{hoptionsi}
Operates like \DeclareTCBoxFit, but based on \ProvideDocumentCommand instead of
\DeclareDocumentCommand. The command \hnamei is only created if it is not already
defined.
445
\DeclareTotalTCBoxFit[hinit optionsi]{\hnamei}{hspecificationi}{hoptionsi}{hcontenti}
Creates a new command \hnamei based on \tcboxfitÕ P. 411 . In contrast to
\DeclareTCBoxFit Õ P. 445 , also the hcontenti of the tcboxfit is specified.
Basically, \DeclareTotalTCBoxFit operates like \DeclareDocumentCommand. This means,
the new command \hnamei is constructed with the given argument hspecificationi. The
hoptionsi are given to the underlying \tcboxfitÕ P. 411 which is filled with the specified
hcontenti.
Note that /tcb/savedelimiterÕ P. 26 is set to the given hnamei automatically.
The hinit optionsi allow setting up automatic numbering, see Section 5 from page 108.
The new command is always created, irrespective of an already existing command with the
same name.
% \usepackage{lipsum}
I shall not repeat. I shall I shall not repeat. I shall not repeat.
I shall not repeat. I shall not repeat.
not repeat. I shall not re- I shall not repeat. I shall not repeat.
peat. I shall not repeat. I I shall not repeat. I shall not repeat.
I shall not repeat. I shall not repeat.
shall not repeat. I shall not I shall not repeat. I shall not repeat.
repeat. I shall not repeat. I I shall not repeat. I shall not repeat.
I shall not repeat. I shall not repeat.
shall not repeat. I shall not I shall not repeat. I shall not repeat.
repeat. I shall not repeat. I shall not repeat. I shall not repeat.
I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I
shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I
shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I
shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I
shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I
shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I
shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I
shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I
shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I
shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I
shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I
shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I
shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I
shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I
shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I
shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat. I
shall not repeat. I shall not repeat. I shall not repeat. I shall not repeat.
\NewTotalTCBoxFit[hinit optionsi]{\hnamei}{hspecificationi}{hoptionsi}{hcontenti}
Operates like \DeclareTotalTCBoxFit, but based on \NewDocumentCommand instead of
\DeclareDocumentCommand. An error is issued if \hnamei has already been defined.
\RenewTotalTCBoxFit[hinit optionsi]{\hnamei}{hspecificationi}{hoptionsi}{hcontenti}
Operates like \DeclareTotalTCBoxFit, but based on \RenewDocumentCommand instead of
\DeclareDocumentCommand. An existing command is redefined.
\ProvideTotalTCBoxFit[hinit optionsi]{\hnamei}{hspecificationi}{hoptionsi}{hcontenti}
Operates like \DeclareTotalTCBoxFit, but based on \ProvideDocumentCommand instead
of \DeclareDocumentCommand. The command \hnamei is only created if it is not already
defined.
446
23 Library external
LIB
The library is loaded by a package option or inside the preamble by:
\tcbuselibrary{external}
The purpose of this library is to support externalization of document snippets like graphics or
boxes which can be compiled stand-alone. These snippets are written to external files, compiled
and the resulting pdf files are included to the main document as images. The whole procedure
saves compilation time, if such a snippet is costly to compile but needs to compile just once or
very seldom.
There are very good alternatives to this library. One should consider the standalone package
or the TikZ externalization library instead. The external library is something in between
LIB
and can be seen as poor man variant of the TikZ externalization library.
The main differences between TikZ externalization and external are:
LIB
• TikZ external compiles the whole original document in a sophisticated way while
external uses only the preamble or a part of the preamble of the original document.
LIB
ronments. But these snippets have to be stand-alone without dependencies to the rest of
the document.
Why should somebody use external instead of the more powerful TikZ external? One
LIB
reason could be compilation speed, but the main reason for creating the library at all was that
TikZ external tends to choke on complicated documents where the sophisticated mechanism
stumbles. Since external does not use the original document body for compilation, this
LIB
cannot happen.
Source snippets are compiled, if their md5 checksum has changed. They are not compiled
!
automatically, if option settings are changed or anything outside the snippet is changed.
Use /tcb/external/force remakeÕ P. 448 to force compilation in this case or simply delete
the externalized pdf oder md5 files.
To use the externalization options, the compiler has to be called with the -shell-escape
! permission to authorize potentially dangerous system calls. Be warned that this is a
security risk.
447
23.1 Preparation of a Document for Externalization
The preamble of the main document has to contain the \tcbEXTERNALIZE command. Without
this command, no externalization operation will be executed.
N 2015-03-11 \tcbEXTERNALIZE
It is mandatory for externalization that this command is used once in the preamble of the
main document. Every setting before \tcbEXTERNALIZE will also be used for compiling
an external snippet. Every setting after \tcbEXTERNALIZE will be ignored for compiling
an external snippet. Place this command right before \begin{document}, if you are not
absolutely sure about another place.
The main document has to look like the following:
\tcbset{external/runner=myrunner.tex}
448
23.2 Marking Externalization Snippets
N 2015-03-11 \begin{tcbexternal}[hoptionsi]{hnamei}
henvironment contenti
\end{tcbexternal}
Marks the environment content as a snippet for externalization. Typically, the content is a
tikzpicture or something similar. It is important to note that the snippet should not have
any dependencies with the rest of the document, e.g. referencing counters or setting counters
is not possible. The hnamei is automatically prefixed with /tcb/external/prefix. In
combination, this has to be a unique file name. It is advised to not use spaces or umlauts
for the name. The hoptionsi are keys from the /tcb/external/ key tree.
\begin{tcbexternal}{example_tikzpicture}
\begin{tikzpicture}
\path[fill=yellow!50!white] (0,0) circle (11mm);
\path[fill=white] (0,0) circle (9mm);
\foreach \w/\c in {90/red,210/green,330/blue}
{\path[shading=ball,ball color=\c] (\w:1cm) circle (7mm);}
\end{tikzpicture}
\end{tcbexternal}
Externalized Box
This complete tcolorbox is externalized. One cannot use numbered boxes here. Note the
minipage option which tells the current line width to the external snippet.
449
\begin{tcolorbox}[nobeforeafter,enhanced,
fonttitle=\bfseries,title=Externalized Box,
colframe=blue!50!black,
interior style={fill overzoom image=blueshade.png}]
\begin{tcbexternal}[minipage]{example_tcolorbox2}
\color{white}%
The interior of the tcolorbox is externalized.
One can use numbered boxes without problems.
Note that the text color has to be set for the text manually
since it is converted into an image.
\end{tcbexternal}
\end{tcolorbox}
Externalized Box
The interior of the tcolorbox is externalized. One can use numbered boxes without problems.
Note that the text color has to be set for the text manually since it is converted into an image.
\begin{tcbexternal}[minipage]{example_tabularx}
\newcolumntype{Y}{>{\raggedleft\arraybackslash}X}%
\begin{tabularx}{\linewidth}{|l||Y|Y|Y|Y||Y|}\hline
Group & One & Two & Three & Four & Sum\\\hline\hline
Red & 1000.00 & 2000.00 & 3000.00 & 4000.00 & 10000.00\\\hline
Green & 2000.00 & 3000.00 & 4000.00 & 5000.00 & 14000.00\\\hline
Blue & 3000.00 & 4000.00 & 5000.00 & 6000.00 & 18000.00\\\hline\hline
Sum & 6000.00 & 9000.00 & 12000.00 & 15000.00 & 42000.00\\\hline
\end{tabularx}
\end{tcbexternal}
450
N 2015-03-11 \begin{extcolorbox}[hoptionsi]{hnamei}[htcolorbox optionsi]
henvironment contenti
\end{extcolorbox}
This is an externalized version of tcolorboxÕ P. 12 created using
\newtcbexternalizetcolorboxÕ P. 456 :
\newtcbexternalizetcolorbox{extcolorbox}{tcolorbox}{}{}
hoptionsi and hnamei are given to the underlying tcbexternalÕ P. 449 environment, while
htcolorbox optionsi are given to tcolorboxÕ P. 12 .
Note that you should not redefine /tcb/beforeÕ P. 78 and /tcb/afterÕ P. 78 inside
! the htcolorbox optionsi, since the externalized version would not be identical to the
non-externalized otherwise.
\begin{extcolorbox}[minipage]{example_extcolorbox}
[ enhanced,colframe=red!50!black,colback=yellow!10,
fonttitle=\bfseries,drop fuzzy shadow,
title=My external box ]
\begin{tcolorbox}[colframe=blue,colback=blue!5,before skip=6pt]
Inner box.
\end{tcolorbox}
\end{extcolorbox}
My external box
Inner box.
!
• Never externalize boxes which contain references to other things, e.g. using \ref
or \cite.
• Never externalize breakable boxes.
451
N 2015-03-11 \begin{extikzpicture}[hoptionsi]{hnamei}[htikz optionsi]
henvironment contenti
\end{extikzpicture}
This is an externalized version of tikzpicture created using
\newtcbexternalizeenvironmentÕ P. 456 :
\newtcbexternalizeenvironment{extikzpicture}{tikzpicture}{}{}{}
hoptionsi and hnamei are given to the underlying tcbexternalÕ P. 449 environment, while
htikz optionsi are given to tikzpicture.
\begin{center}
\begin{extikzpicture}[
preamble={\usepackage{pgfplots}}, % add package for external graph
input source on error=false, % do not load source on error
]{example_pgfplots}
\pgfplotsset{width=12cm}
\begin{axis}[3d box=background,grid=major,
xlabel=$x$, ylabel=$y$, zlabel=$z$, view/h=40,
mesh/interior colormap name=hot,
colormap/blackwhite,
z buffer=sort,domain=0:90,y domain=0:60,
zmin=0,zmax=2,z post scale=1.2,
]
\addplot3[surf,mesh/interior colormap name=blackwhite,
colormap/hot,] ( {cos(x)},{sin(x)}, {2*sin(y)} );
\addplot3[surf] ( {2*cos(x)*cos(y)},{2*sin(x)*cos(y)}, {2*sin(y)} );
\end{axis}
\end{extikzpicture}
\end{center}
1.5
1
z
0.5
0 2
0
1.5
0.5
1 1
x 1.5 0.5 y
2 0
452
N 2015-03-11 /tcb/externalize listing=hnamei (style, no default)
The text content of a tcblistingÕ P. 299 is externalized with the given hnamei. Note that
the listing part is not externalized.
\begin{tcblisting}{externalize listing=example_listing,
bicolor,colback=yellow!10,colframe=yellow!50!black,
colbacklower=white,center lower}
\begin{tikzpicture}
\path[fill=yellow!50!white] (0,0) circle (11mm);
\path[fill=white] (0,0) circle (9mm);
\foreach \w/\c in {90/red,210/green,330/blue}
{\path[shading=ball,ball color=\c] (\w:1cm) circle (7mm);}
\end{tikzpicture}
\end{tcblisting}
\begin{tikzpicture}
\path[fill=yellow!50!white] (0,0) circle (11mm);
\path[fill=white] (0,0) circle (9mm);
\foreach \w/\c in {90/red,210/green,330/blue}
{\path[shading=ball,ball color=\c] (\w:1cm) circle (7mm);}
\end{tikzpicture}
\begin{dispExample*}{sidebyside,externalize example=example_example}
\tikz\path[shading=ball,
ball color=red] circle (7mm);
\end{dispExample*}
\tikz\path[shading=ball,
ball color=red] circle (7mm);
453
23.3 Customization
\begin{tcbexternal}[minipage,runs=2]{example_raster}
\begin{tcbitemize}[raster equal height,
size=small,colframe=red!50!black,colback=red!10!white]
\tcbitem One
\tcbitem \Huge Two
\tcbitem Three
\tcbitem Four
\end{tcbitemize}
\end{tcbexternal}
One
Two
Three Four
454
N 2015-05-05 /tcb/external/preclass=hcodei (no default, initially unset)
The given hcodei is added before the snippet document. Typically, this means before
\documentclass. This is not used for compilation of the main document.
N 2015-05-05 /tcb/external/PassOptionsToPackage={hoptionsi}{hpackagei} (no default, initially unset)
The given hoptionsi are passed to the given hpackagei for the snippet document. This is a
shortcut for using /tcb/external/preclass with \PassOptionsToPackage. This not used
for compilation of the main document.
N 2015-05-05 /tcb/external/PassOptionsToClass={hoptionsi}{hclassi} (no default, initially unset)
The given hoptionsi are passed to the given hclassi for the snippet document. This is a
shortcut for using /tcb/external/preclass with \PassOptionsToClass. This not used
for compilation of the main document.
N 2015-05-05 /tcb/external/clear preclass (no value)
Removes all additional /tcb/external/preclass settings.
N 2015-03-11 /tcb/external/preamble=hcodei (no default, initially unset)
The given hcodei is added to the preamble of the snippet document. This is not used for
compilation of the main document.
N 2015-05-05 /tcb/external/preamble tcbset=hoptionsi (no default, initially unset)
The given hoptionsi are added as parameter for \tcbset Õ P. 13 to the preamble of the snippet
document. This are not used for compilation of the main document.
N 2015-03-16 /tcb/external/clear preamble (no value)
Removes all additional /tcb/external/preamble settings.
N 2015-03-11 \tcbifexternal{htruei}{hfalsei}
Expands to htruei, if executed during snippet compilation, and to hfalsei, if executed dur-
ing main document compilation. This can be used before \tcbEXTERNALIZEÕ P. 448 to give
different setting to snippet and main document.
\tcbifexternal{
\usepackage{onlyforexternal}
}{
\usepackage{onlyformain}
}
455
N 2015-03-11 \newtcbexternalizeenvironment{hnewenvi}{henvi}{hoptionsi}{hbegini}{hendi}
Creates a new environment hnewenvi which is based on tcbexternalÕ P. 449 . This envi-
roment takes at least one optional parameter and one mandatory parameter. These two
parameters are passed to tcbexternalÕ P. 449 . Further, the given hoptionsi are always added
to the option list of tcbexternalÕ P. 449 .
The environment content is externalized and the external snippet is surrounded by an
environment henvi. All further parameters of hnewenvi are given to henvi as parameters.
The included image is prepended by hbegini and appended by hendi.
extikzpictureÕ P. 452 is an example application for \newtcbexternalizeenvironment.
\newtcbexternalizeenvironment{extabular}{tabular}{}{\par\centering}{\par}
\begin{extabular}{example_tabular}{|l|p{6cm}|r|}\hline
A & B & C\\\hline
a & This table is externalized as snippet. Obviously,
this only makes sense for highly complex tables.
& b\\\hline
\end{extabular}
A B C
a This table is externalized as snippet. Ob- b
viously, this only makes sense for highly
complex tables.
N 2015-03-11 \renewtcbexternalizeenvironment{hnewenvi}{henvi}{hoptionsi}{hbegini}{hendi}
Identical to \newtcbexternalizeenvironment, but the environment hnewenvi is created
by \renewenvironment instead of \newenvironment.
N 2015-03-11 \newtcbexternalizetcolorbox{hnewenvi}{henvi}{hoptionsi}{hbegin end optionsi}
Creates a new environment hnewenvi which is based on tcbexternalÕ P. 449 . This envi-
roment takes at least one optional parameter and one mandatory parameter. These two
parameters are passed to tcbexternalÕ P. 449 . Further, the given hoptionsi are always added
to the option list of tcbexternalÕ P. 449 .
The environment content is externalized and the external snippet is surrounded by an
environment henvi. All further parameters of hnewenvi are given to henvi as parameters.
In contrast to \newtcbexternalizeenvironment, the environment henvi is intended
to be based on tcolorboxÕ P. 12 or tcblistingÕ P. 299 .
The hbegin end optionsi are options for settings the space before and after the included im-
age using /tcb/beforeÕ P. 78 , /tcb/before skipÕ P. 80 , /tcb/afterÕ P. 78 , or /tcb/after
skipÕ P. 80 .
Use the exact identical values for /tcb/beforeÕ P. 78 and /tcb/afterÕ P. 78 inside
! hbegin end optionsi as they where used for definition of henvi! Otherwise, externalized
and non-externalized version will have different spacings.
\newtcbexternalizetcolorbox{exmyownlisting}{myownlisting}{minipage}%
{before skip=6pt,after skip=6pt}% same values as for mylisting
456
\begin{exmyownlisting}{example_mylisting}% <- name for the external file
{My externalized example box}
This is my \LaTeX\ box.
\end{exmyownlisting}
457
23.4 Troubleshooting and FAQ
• I use the default settings, but the external subdirectory is not created.
Depending on operating system and compiler, an external subdirectory is automatically
created or not. If not, create such a directory manually or add the following to your
document5 :
\ShellEscape{mkdir external}
or
\ShellEscape{mkdir -p external}
\tcbset{external/PassOptionsToPackage={draft}{minted}}
– If minted is needed for the snippet code, caching can be switched off by adding the
following to your preamble:
\tcbset{external/PassOptionsToPackage={cache=false}{minted}}
Alternatively, the cachedir option of minted may be used to redirect the cache.
5
The shellesc package is loaded automatically by the library.
458
24 Library documentation
LIB
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 [22] documentation.
Typically, this library is assumed to be used in conjunction with the class ltxdoc or alike.
The library is loaded by a package option or inside the preamble by:
\tcbuselibrary{documentation}
This also loads the library listings , see Section 15 on page 298, the library
LIB skins , see
LIB
N 2014-09-19
Section 10 on page 148, the library xparse , see Section 22 on page 434, and a bunch of
LIB
packages, namely pifont, marvosym, makeidx, marginnote, refcount, and hyperref.
The package makeidx is loaded only, if \printindex is not already defined. Therefore,
! one can include an alternative to makeidx like imakeidx before the library documentation
is used.
\tcbuselibrary{listingsutf8,documentation}
\tcbuselibrary{documentation,minted}
\tcbset{listing engine=minted}
\begin{docCommand}[hoptionsi]{hnamei}{hparametersi}
hcommand descriptioni
\end{docCommand}
Documents a LATEX macro with given hnamei where hnamei is written without back-
slash. The given hoptionsi are set with \tcbsetÕ P. 13 . This macro takes manda-
tory or optional hparametersi. It is automatically indexed and can be referenced with
\refComÕ P. 466 {hnamei}.
\begin{docCommand}{foomakedocSubKey}{\marg{name}\marg{key path}}
Creates a new environment \meta{name} based on \refEnv{docKey} for the
documentation of keys with the given \meta{key path}.
\end{docCommand}
\foomakedocSubKey{hnamei}{hkey pathi}
Creates a new environment hnamei based on docKeyÕ P. 461 for the documentation of keys with
the given hkey pathi.
459
\begin{docCommand}[color definition=blue]{foomakedocSubKey*}%
{\marg{name}\marg{key path}}
Creates a new environment \meta{name} based on \refEnv{docKey} for the
documentation of keys with the given \meta{key path}.
\end{docCommand}
\foomakedocSubKey*{hnamei}{hkey pathi}
Creates a new environment hnamei based on docKeyÕ P. 461 for the documentation of keys with
the given hkey pathi.
\begin{docCommand*}[hoptionsi]{hnamei}{hparametersi}
hcommand descriptioni
\end{docCommand*}
Identical to docCommandÕ P. 459 , but without index entry.
\begin{docEnvironment}[hoptionsi]{hnamei}{hparametersi}
henvironment descriptioni
\end{docEnvironment}
Documents a LATEX environment with given hnamei. The given hoptionsi are set with
\tcbsetÕ P. 13 . This environment takes mandatory or optional hparametersi. It is automat-
ically indexed and can be referenced with \refEnvÕ P. 466 {hnamei}.
\begin{docEnvironment}{foocolorbox}{\oarg{options}}
This is the main environment to create an accentuated colored text box with
rounded corners and, optionally, two parts.
\end{docEnvironment}
\begin{foocolorbox}[hoptionsi]
henvironment descriptioni
\end{foocolorbox}
This is the main environment to create an accentuated colored text box with rounded corners
and, optionally, two parts.
\begin{docEnvironment}%
[doclang/environment content=My content text]%
{foocolorbox*}{\oarg{options}}
This is the main environment to create an accentuated colored text box with
rounded corners and, optionally, two parts.
\end{docEnvironment}
\begin{foocolorbox*}[hoptionsi]
hMy content texti
\end{foocolorbox*}
This is the main environment to create an accentuated colored text box with rounded corners
and, optionally, two parts.
\begin{docEnvironment*}[hoptionsi]{hnamei}{hparametersi}
henvironment descriptioni
\end{docEnvironment*}
Identical to docEnvironment, but without index entry.
460
U 2014-09-29 \begin{docKey}[hkey pathi][hoptionsi]{hnamei}{hparametersi}{hdescriptioni}
hkey descriptioni
\end{docKey}
Documents a key with given hnamei and an optional hkey pathi. The given hoptionsi
are set with \tcbsetÕ P. 13 . This key takes mandatory or optional hparametersi as value
with a short hdescriptioni. It is automatically indexed and can be referenced with
\refKeyÕ P. 467 {hnamei}.
\docValue*{hnamei}
Identical to \docValue, but without index entry.
U 2014-10-09 \docAuxCommand{hnamei}
Documents an auxiliary or minor LATEX macro with given hnamei where hnamei is written
without backslash. This macro is automatically indexed.
U 2014-10-09 \docAuxCommand*{hnamei}
Identical to \docAuxCommand, but without index entry.
\docAuxEnvironment{hnamei}
Documents an auxiliary or minor LATEX environment with given hnamei. This macro is
automatically indexed.
\docAuxEnvironment*[hkey pathi]{hnamei}
Identical to \docAuxEnvironment, but without index entry.
461
\docAuxKey[hkey pathi]{hnamei}
Documents an auxiliary key with given hnamei and an optional hkey pathi. It is automati-
cally indexed.
\docAuxKey*[hkey pathi]{hnamei}
Identical to \docAuxKey, but without index entry.
N 2015-01-08 \docCounter{hnamei}
Documents a counter with given hnamei. The counter is automatically indexed.
N 2015-01-08 \docCounter*{hnamei}
Identical to \docCounter, but without index entry.
N 2015-01-08 \docLength{hnamei}
Documents a counter with given hnamei. The counter is automatically indexed.
N 2015-01-08 \docLength*{hnamei}
Identical to \docLength, but without index entry.
\docColor{hnamei}
Documents a color with given hnamei. The color is automatically indexed.
\docColor*{hnamei}
Identical to \docColor, but without index entry.
462
\cs{hnamei}
Macro from ltxdoc [3] to typeset a command word hnamei where the backslash is prefixed.
The library overwrites the original macro.
This is a \cs{foocommand}.
This is a \foocommand.
\meta{htexti}
Macro from doc [8] to typeset a meta htexti. The library overwrites the original macro.
This is a \meta{text}.
This is a htexti.
\marg{htexti}
Macro from ltxdoc [3] to typeset a htexti with curly brackets as a mandatory argument.
The library overwrites the original macro.
\oarg{htexti}
Macro from ltxdoc [3] to typeset a htexti with square brackets as an optional argument.
The library overwrites the original macro.
\brackets{htexti}
Sets the given htexti with curly brackets.
463
U 2014-10-10 \begin{dispExample}
henvironment contenti
\end{dispExample}
Creates a colored box based on a tcolorboxÕ P. 12 . It displays the environment content
as source code in the upper part and as compiled text in the lower part of the box.
The appearance is controlled by /tcb/documentation listing styleÕ P. 469 and the style
/tcb/docexampleÕ P. 469 . It may be changed by redefining this style.
\begin{dispExample}
This is a \LaTeX\ example.
\end{dispExample}
U 2014-10-10 \begin{dispExample*}{hoptionsi}
henvironment contenti
\end{dispExample*}
The starred version of dispExample takes tcolorboxÕ P. 12 hoptionsi as parameter. These
hoptionsi are executed after /tcb/docexampleÕ P. 469 .
\begin{dispExample*}{sidebyside}
This is a \LaTeX\ example.
\end{dispExample*}
464
\begin{dispListing}
henvironment contenti
\end{dispListing}
Creates a colored box based on a tcolorboxÕ P. 12 . It displays the environment content as
source code. The appearance is controlled by /tcb/documentation listing styleÕ P. 469
and the style /tcb/docexampleÕ P. 469 . It may be changed by redefining this style.
\begin{dispListing}
This is a \LaTeX\ example.
\end{dispListing}
\begin{dispListing*}{hoptionsi}
henvironment contenti
\end{dispListing*}
The starred version of dispListing takes tcolorboxÕ P. 12 hoptionsi as parameter. These
hoptionsi are executed after /tcb/docexampleÕ P. 469 .
\begin{dispListing*}{title=My listing}
This is a \LaTeX\ example.
\end{dispListing*}
My listing
\begin{absquote}
henvironment contenti
\end{absquote}
Used to typeset an abstract as quoted and small text.
\begin{absquote}
|tcolorbox| provides an environment for colored and framed text boxes with a
heading line. Optionally, such a box can be split in an upper and a lower part.
\end{absquote}
465
\tcbmakedocSubKey{hnamei}{hkey pathi}
Creates a new environment hnamei based on docKeyÕ P. 461 for the documentation of keys
with the given hkey pathi as default. The new environment hnamei takes the same para-
meters as docKeyÕ P. 461 itself. A second starred environment hnamei is also created, which
is identical to hnamei but without index entry.
\tcbmakedocSubKey{docFooKey}{foo}
\refCom{hnamei}
References a documented LATEX macro with given hnamei where hnamei is written without
backslash. The page reference is suppressed if it links to the same page.
\refCom*{hnamei}
References a documented LATEX macro with given hnamei where hnamei is written without
backslash. There is no page reference.
\refEnv{hnamei}
References a documented LATEX environment with given hnamei. The page reference is
suppressed if it links to the same page.
\refEnv*{hnamei}
References a documented LATEX environment with given hnamei. There is no page reference.
466
\refKey{hnamei}
References a documented key with given hnamei where hnamei is the full path name of the
key. The page reference is suppressed if it links to the same page.
\refKey*{hnamei}
References a documented key with given hnamei where hnamei is the full path name of the
key. There is no page reference.
\refAux{hnamei}
References some auxiliary environment, key, value, or color. The hyperlink color is used,
but there is no real link.
Some pages back, one can see \refAux{/foo/footitle} as an example.
\refAuxcs{hnamei}
References some auxiliary macro hnamei where hnamei is written without backslash. The
hyperlink color is used, but there is no real link.
\colDef{htexti}
Sets htexti with the command color, see /tcb/color commandÕ P. 471 .
This is my \colDef{text}.
This is my text.
\colOpt{htexti}
Sets htexti with the option color, see /tcb/color optionÕ P. 471 .
This is my \colOpt{text}.
This is my text.
467
N 2014-09-19 \tcbdocmarginnote[hoptionsi]{htexti}
Creates a tcolorbox note with the given htexti inside the margin using the marginnote
package. The style of the tcolorbox is predefined and can be altered by /tcb/doc
marginnoteÕ P. 476 and the given hoptionsi.
Some text\tcbdocmarginnote{Note A}
which is commented by a note inside the margin.
Alternatively to |\tcbdocmarginnote|, you can always use
|\marginnote| with a |tcolorbox| directly.\par
This is further text%
\tcbdocmarginnote[colframe=blue!50!white,colback=blue!5!white]{Note B}
with another note.
Note A Some text which is commented by a note inside the margin. Alternatively to \tcbdocmarginnote,
you can always use \marginnote with a tcolorbox directly.
Note B This is further text with another note.
N 2014-09-19 \tcbdocnew{hdatei}
Auxiliary macro which typesets the /tcb/doclang/newÕ P. 472 text with the given hdatei.
It may be redefined for customization.
\tcbdocnew{1981-10-29}.
New: % Next one is displayed in the margin: New: 1981-10-29.
1978-02-09 \tcbdocmarginnote{\tcbdocnew{1978-02-09}}
N 2014-09-19 \tcbdocupdated{hdatei}
Auxiliary macro which typesets the /tcb/doclang/updatedÕ P. 472 text with the given
hdatei. It may be redefined for customization.
468
24.2 Option Keys of the Library
U 2015-03-16 /tcb/docexample (style, no value)
Sets the style for dispExampleÕ P. 464 and dispListingÕ P. 465 with the colors ExampleBack
and ExampleFrame. To change the appearance of the examples, this style can be redefined.
% Predefined style:
\tcbset{
docexample/.style={colframe=ExampleFrame,colback=ExampleBack,
before skip=\medskipamount,after skip=\medskipamount,
fontlower=\footnotesize}
}
The following two keys are deprecated and without function (v3.50 and above). Use
! /tcb/beforeÕ P. 78 and /tcb/afterÕ P. 78 with appropriate values instead. Also see
/tcb/docexample.
deprecated
Sets the hmacrosi which are executed before dispExampleÕ P. 464 and dispListingÕ P. 465
additional to /tcb/beforeÕ P. 78 .
/tcb/after example=hmacrosi (no default, initially empty)
deprecated
Sets the hmacrosi which are executed after dispExample and dispListingÕ P. 465
Õ P. 464
additional to /tcb/afterÕ P. 78 .
469
N 2017-04-25 /tcb/keywords bold=true|false (default true, initially true)
Keyword used in docEnvironmentÕ P. 460 , docCommandÕ P. 459 , etc. are printed boldface (or
not). Since the typewriter font is used, the effect may be invisible with Computer Modern
fonts or similar which do not have a bold variant. Note that references to keywords are not
printed boldface at all.
\LARGE
\docAuxCommand{fooaux}, \refCom{tcbset} \fooaux, \tcbsetÕ P. 13
\tcbset{keywords bold=false}
\docAuxCommand{fooaux}, \refCom{tcbset}
\fooaux, \tcbsetÕ P. 13
470
/tcb/index annotate=true|false (default true, initially true)
If set to true, the index entries are annotated with short descriptions given by
/tcb/doclang/environmentÕ P. 472 , /tcb/doclang/keyÕ P. 472 , and others.
/tcb/index colorize=true|false (default true, initially false)
If set to true, the index entries colorized according to the color settings given by /tcb/color
environment, /tcb/color key, and others.
/tcb/color command=hcolori (no default, initially Definition)
Sets the highlight color used by macro definitions.
/tcb/color environment=hcolori (no default, initially Definition)
Sets the highlight color used by environment definitions.
/tcb/color key=hcolori (no default, initially Definition)
Sets the highlight color used by key definitions.
/tcb/color value=hcolori (no default, initially Definition)
Sets the highlight color used by value definitions.
N 2015-01-08 /tcb/color counter=hcolori (no default, initially Definition)
Sets the highlight color used by counter definitions.
N 2015-01-08 /tcb/color length=hcolori (no default, initially Definition)
Sets the highlight color used by length definitions.
/tcb/color color=hcolori (no default, initially Definition)
Sets the highlight color used by color definitions.
/tcb/color definition=hcolori (no default, initially Definition)
Sets the highlight color for /tcb/color command, /tcb/color environment, /tcb/color
key, /tcb/color value, /tcb/color counter, /tcb/color length, and /tcb/color
color.
/tcb/color option=hcolori (no default, initially Option)
Sets the color used for optional arguments.
/tcb/color hyperlink=hcolori (no default, initially Hyperlink)
Sets the color for all hyper-links, i. e. all internal and external links.
471
The following keys are provided for language specific settings. The English language is prede-
fined.
/tcb/english language (style, no value)
Sets all language specific settings to English.
/tcb/doclang/color=htexti (no default, initially color)
Text used in the index for colors.
/tcb/doclang/colors=htexti (no default, initially Colors)
Heading text in the index for colors.
N 2015-01-08 /tcb/doclang/counter=htexti (no default, initially counter)
Text used in the index for counters.
N 2015-01-08 /tcb/doclang/counters=htexti (no default, initially Counters)
Heading text in the index for counters.
/tcb/doclang/environment=htexti (no default, initially environment)
Text used in the index for environments.
/tcb/doclang/environments=htexti (no default, initially Environments)
Heading text in the index for environments.
/tcb/doclang/environment content=htexti (no default, initially environment content)
Text used in docEnvironmentÕ P. 460 .
/tcb/doclang/index=htexti (no default, initially Index)
Heading text for the index.
/tcb/doclang/key=htexti (no default, initially key)
Text used in the index for keys.
/tcb/doclang/keys=htexti (no default, initially Keys)
Heading text used in the index for keys.
N 2015-01-08 /tcb/doclang/length=htexti (no default, initially length)
Text used in the index for lengths.
N 2015-01-08 /tcb/doclang/lengths=htexti (no default, initially Lengths)
Heading text in the index for lengths.
N 2014-09-19 /tcb/doclang/new=htexti (no default, initially New)
Announcement text for new content.
/tcb/doclang/pageshort=htexti (no default, initially P.)
Short text for page references.
N 2014-09-19 /tcb/doclang/updated=htexti (no default, initially Updated)
Announcement text for updated content.
/tcb/doclang/value=htexti (no default, initially value)
Text used in the index for values.
/tcb/doclang/values=htexti (no default, initially Values)
Heading text in the index for values.
472
/tcb/doc left=hlengthi (no default, initially 2em)
Sets the left hand offset of the documentation texts from docCommandÕ P. 459 ,
docEnvironmentÕ P. 460 , docKeyÕ P. 461 , etc, to hlengthi.
\begin{docCommand*}[doc right=2cm]{myCommandB}{\marg{argument}}
This is the documentation of \refCom{myCommandB} which takes one \meta{argument}.
\refCom{myCommandB} does some funny things with its \meta{argument}.
\end{docCommand*}
473
The head lines of the main documentation environments docCommandÕ P. 459 ,
docEnvironmentÕ P. 460 , docKeyÕ P. 461 , etc, are set inside tcolorboxes. Options to these
tcolorboxes can be given using the following keys.
/tcb/doc head command=hoptionsi (no default, initially empty)
Sets hoptionsi for the head line of docCommandÕ P. 459 and docCommand*Õ P. 460 .
\begin{docCommand*}{myCommandE}{\marg{argument}}
This is the documentation of \refCom{myCommandE} which takes one \meta{argument}.
\refCom{myCommandE} does some funny things with its \meta{argument}.
\end{docCommand*}
\begin{docEnvironment*}{myEnvironment}{\marg{argument}}
This is the documentation of \refEnv{myEnvironment} which
takes one \meta{argument}.
\end{docEnvironment*}
\begin{docKey*}{/foo/myKey}{}{no value}
This is the documentation of \refKey{/foo/myKey}.
\end{docKey*}
474
The description texts of the main documentation environments docCommandÕ P. 459 ,
docEnvironmentÕ P. 460 , docKeyÕ P. 461 , etc, are set in a compact form without indention
and parskip=0pt. This settings can overruled by using the following keys to insert code before
(or after) the description texts.
N 2015-10-09 /tcb/before doc body command=hcodei (no default, initially empty)
Executes hcodei before the description texts of docCommand Õ P. 459 and docCommand*Õ P. 460 .
\begin{docCommand*}{myCommandG}{\marg{argument}}
This is the documentation of \refCom{myCommandG} which takes one \meta{argument}.
\refCom{myCommandG} does some funny things with its \meta{argument}.
\end{docCommand*}
\begin{docCommand*}{myCommandH}{\marg{argument}}
This is the documentation of \refCom{myCommandH} which takes one \meta{argument}.
\refCom{myCommandH} does some funny things with its \meta{argument}.
\end{docCommand*}
475
/tcb/doc description=htexti (no default, initially empty)
Sets a (short!) additional description htexti for docCommandÕ P. 459 or docEnvironmentÕ P. 460 .
Such a description is mandatory for docKeyÕ P. 461 .
\tcbset{doc marginnote={colframe=blue!50!white,colback=blue!5!white}}%
This is some text\tcbdocmarginnote{Note A}
which is commented by a note inside the margin.
Note A This is some text which is commented by a note inside the margin.
\begin{docCommand}[doc new=2000-01-01]{foosomething}{\marg{text}}
Some command for something.
\end{docCommand}
The following colors are predefined. They are used as default colors in some library commands.
Option , Definition , ExampleFrame , ExampleBack , Hyperlink .
476
A Picture Credits
crinklepaper.png pink_marble.png
blueshade.png goldshade.png
477
References
478
[20] Thomas F. Sturm. Höhere Mathematik: Fortgeschrittene mathematische Methoden
(M.Eng.) Vorlesungs-Skriptum. Neubiberg: Universität der Bundeswehr München, 2010.
http://www.unibw.de/bw/sturm.
[21] Thomas F. Sturm. LATEX – Einführung in das Textsatzsystem. 10th edition. RRZN-
Handbücher. Hannover: Regionales Rechenzentrum für Niedersachsen (RRZN), Mar. 2014.
http://www.rrzn.uni-hannover.de/buch.html?&titel=latex.
[22] Till Tantau. The TikZ and PGF Packages. Manual for version 3.0.1a. Aug. 29, 2015.
http://mirrors.ctan.org/graphics/pgf/base/doc/pgfmanual.pdf.
479
Index
480
before skip key, 80 center key, 85
before title key, 64 center value, 30, 33, 79, 117, 286
before title app key, 424 center lower key, 32
before title pre key, 424 center seam value, 117
before upper key, 65 center title key, 32
before upper app key, 424 center upper key, 32
before upper pre key, 424 change value, 355
beforeafter skip key, 80 change apart value, 355
below key, 407 change break value, 355
between key, 408 change standard value, 354
bicolor key, 219 check odd page key, 101
bicolor Skin, 219 circular arc key, 37
bicolorfirst Skin, 221 clear preamble key, 455
bicolorlast Skin, 223 clear preclass key, 455
bicolormiddle Skin, 222 clip lower key, 176
blank key, 208 clip title key, 175
blanker key, 238 clip upper key, 175
blankest key, 239 clip watermark key, 171
blend before title key, 113 clipped value, 270
blend before title code key, 114 code key, 106
blend into key, 112 colback key, 27
bookmark key, 100 colbacklower key, 220
bookmark* key, 100 colbacktitle key, 27
borderline key, 177 \colDef, 467
borderline east key, 180 colframe key, 27
borderline horizontal key, 181 collower key, 28
borderline north key, 180 colon value, 113
borderline south key, 180 colon hang value, 113
borderline vertical key, 181 \colOpt, 467
borderline west key, 180 color key, 472
both value, 123 color color key, 471
bottom key, 43 color command key, 471
bottom value, 33, 79, 117, 286 color counter key, 471
bottom seam value, 117 color definition key, 471
bottomrule key, 35 color environment key, 471
bottomrule at break key, 369 color from key, 269
bottomsep at break key, 369 color hyperlink key, 471
bottomtitle key, 43 color key key, 471
box align key, 79 color length key, 471
\boxarrayclear, 389 color option key, 471
\boxarraygetbox, 393 color value key, 471
\boxarraygetdepth, 394 Colors
\boxarraygetheight, 394 Definition, 476
\boxarraygetsize, 391 ExampleBack, 476
\boxarraygettotalheight, 395 ExampleFrame, 476
\boxarraygetwidth, 394 foocolor, 462
\boxarrayreset, 388 Hyperlink, 476
boxarraystore environment, 391 Option, 476
boxed title size key, 158 colors key, 472
boxed title style key, 159 colspacing key, 401
boxes key, 403 coltext key, 28
boxrule key, 36 coltitle key, 28
boxsep key, 39 column key, 405
\brackets, 463 column* key, 405
break value, 355 columns key, 401
break at key, 367 colupper key, 28
breakable key, 9, 365 comment key, 311
broken value, 165–167 comment above listing key, 318
comment above* listing key, 318
capture key, 94
481
comment and listing key, 314 \docAuxCommand, 461
comment only key, 311 \docAuxCommand*, 461
comment outside listing key, 316 \docAuxEnvironment, 461
comment side listing key, 316 \docAuxEnvironment*, 461
comment style key, 314 \docAuxKey, 462
compilable listing key, 322 \docAuxKey*, 462
compiler key, 454 \docColor, 462
compress page key, 368 \docColor*, 462
\consumeboxarray, 392 docCommand environment, 459
\consumetcboxarray, 392 docCommand* environment, 460
copy value, 158 \docCounter, 462
counter key, 472 \docCounter*, 462
Counters docEnvironment environment, 460
foocounter, 462 docEnvironment* environment, 460
counters key, 472 docexample key, 469
coverage key, 402 docKey environment, 461
Crefname key, 111 docKey* environment, 461
crefname key, 111 \docLength, 462
\cs, 463 \docLength*, 462
documentation key, 10
dash value, 113 documentation listing options key, 469
dash hang value, 113 documentation listing style key, 469
\DeclareTCBInputListing, 444 documentation minted language key, 469
\DeclareTCBListing, 442 documentation minted options key, 469
\DeclareTCBox, 439 documentation minted style key, 469
\DeclareTCBoxFit, 445 \docValue, 461
\DeclareTColorBox, 436 \docValue*, 461
\DeclareTotalTCBox, 440 downhill value, 48, 49
\DeclareTotalTCBoxFit, 446 draft key, 248
\DeclareTotalTColorBox, 438 draft Skin, 248
Definition color, 476 draftmode key, 203
description color key, 344 draw method key, 270
description delimiters key, 344 drop fuzzy midday shadow key, 183
description delimiters none key, 344 drop fuzzy shadow key, 182
description delimiters parenthesis key, drop fuzzy shadow east key, 186
344 drop fuzzy shadow north key, 186
description font key, 345 drop fuzzy shadow northeast key, 186
description formatter key, 345 drop fuzzy shadow northwest key, 186
detach title key, 20 drop fuzzy shadow south key, 185
direct value, 270 drop fuzzy shadow southeast key, 185
dispExample environment, 464 drop fuzzy shadow southwest key, 185
dispExample* environment, 464 drop fuzzy shadow west key, 185
dispListing environment, 465 drop large lifted shadow key, 187
dispListing* environment, 465 drop lifted shadow key, 187
do not store to box array key, 391 drop midday shadow key, 182
doc value, 470 drop shadow key, 182
doc description key, 476 drop shadow east key, 185
doc head key, 474 drop shadow north key, 184
doc head command key, 474 drop shadow northeast key, 185
doc head environment key, 474 drop shadow northwest key, 184
doc head key key, 474 drop shadow south key, 184
doc into index key, 476 drop shadow southeast key, 184
doc left key, 473 drop shadow southwest key, 184
doc left indent key, 473 drop shadow west key, 184
doc marginnote key, 476 drop small lifted shadow key, 187
doc new key, 476
doc new and updated key, 476 east fading, 270
doc right key, 473 east value, 48, 49
doc right indent key, 473 east size key, 267
doc updated key, 476 east style key, 269
482
empty key, 237 tcblisting, 299
empty Skin, 237 tcboutputlisting, 301
empty value, 135, 136 tcboxeditemize, 282
emptyfirst Skin, 240 tcboxedraster, 281
emptylast Skin, 242 tcbposter, 399
emptymiddle Skin, 241 tcbraster, 279
enforce breakable key, 366 tcbverbatimwrite, 126
english language key, 472 tcbwritetemp, 126
enhanced key, 206 tcolorbox, 12
enhanced Skin, 206 environments key, 472
enhanced jigsaw key, 213 equal height group key, 61
enhanced jigsaw Skin, 213 evenpage value, 46, 86
enhanced standard key, 208 every box key, 91
enhanced standard jigsaw key, 213 every box on higher layers key, 92
enhancedfirst Skin, 210 every box on layer n key, 92
enhancedfirst jigsaw Skin, 214 every float key, 77
enhancedlast Skin, 212 every listing line key, 306
enhancedlast jigsaw Skin, 218 every listing line* key, 306
enhancedmiddle Skin, 211 ExampleBack color, 476
enhancedmiddle jigsaw Skin, 215 ExampleFrame color, 476
enlarge bottom at break by key, 83 extcolorbox environment, 451
enlarge bottom by key, 83 extend freelance key, 250
enlarge bottom finally by key, 82 extend freelancefirst key, 250
enlarge by key, 84 extend freelancelast key, 250
enlarge left by key, 83 extend freelancemiddle key, 250
enlarge right by key, 83 external key, 10, 105
enlarge top at break by key, 83 externalize key, 448
enlarge top by key, 83 externalize example key, 453
enlarge top initially by key, 82 externalize example! key, 453
enlargepage key, 367 externalize listing key, 453
enlargepage flexible key, 368 externalize listing! key, 453
environment key, 454, 472 extikzpicture environment, 452
environment content key, 472 extras key, 371
environment with percent key, 454 extras broken key, 371
Environments extras broken pre key, 433
absquote, 465 extras first key, 371
boxarraystore, 391 extras first and middle key, 371
dispExample, 464 extras first and middle pre key, 433
dispExample*, 464 extras first pre key, 433
dispListing, 465 extras last key, 371
dispListing*, 465 extras last pre key, 433
docCommand, 459 extras middle key, 371
docCommand*, 460 extras middle and last key, 371
docEnvironment, 460 extras middle and last pre key, 433
docEnvironment*, 460 extras middle pre key, 433
docKey, 461 extras pre key, 433
docKey*, 461 extras title after break key, 372
extcolorbox, 451 extras unbroken key, 371
extikzpicture, 452 extras unbroken and first key, 371
fooauxenv, 461 extras unbroken and first pre key, 433
foocolorbox, 460 extras unbroken and last key, 371
foocolorbox*, 460 extras unbroken and last pre key, 433
posterboxenv, 404 extras unbroken pre key, 433
tcbclipframe, 172 extrude bottom by key, 90
tcbclipinterior, 174 extrude by key, 90
tcbcliptitle, 174 extrude left by key, 89
tcbexternal, 449 extrude right by key, 89
tcbinvclipframe, 173 extrude top by key, 90
tcbitemize, 280
fade in key, 271
483
fade out key, 271 finish vignette key, 274
Fadings first value, 165–167, 370
east, 270 first and middle value, 165, 370
north, 270 fit key, 413
semi east, 270 fit algorithm key, 419
semi north, 270 fit basedim key, 414
semi south, 270 fit fontsize macros key, 415
semi west, 270 fit height from key, 418
south, 270 fit height plus key, 416
west, 270 fit maxfontdiff key, 421
false value, 78, 81, 288, 365 fit maxfontdiffgap key, 421
fbox value, 44 fit maxstep key, 421
figures value, 112 fit maxwidthdiff key, 421
fill downwards key, 87 fit maxwidthdiffgap key, 421
fill image opacity key, 262 fit skip key, 414
fill image options key, 262 fit to key, 414
fill image scale key, 262 fit to height key, 414
fill overzoom image key, 258 fit warning key, 421
fill overzoom image* key, 258 fit width from key, 417
fill overzoom picture key, 258 fit width plus key, 416
fill plain image key, 256 fitbox value, 94
fill plain image* key, 256 fitting key, 9
fill plain picture key, 256 fixed height key, 406
fill shrink image key, 260 flip title key, 156
fill shrink image* key, 260 float key, 76
fill shrink picture key, 260 float* key, 76
fill stretch image key, 257 floatplacement key, 76
fill stretch image* key, 257 flush center value, 30, 32
fill stretch picture key, 257 flush left key, 85
fill tile image key, 261 flush left value, 30, 32
fill tile image* key, 261 flush right key, 85
fill tile picture key, 261 flush right value, 30, 32
fill tile picture* key, 261 flushleft lower key, 32
fill zoom image key, 259 flushleft title key, 32
fill zoom image* key, 259 flushleft upper key, 32
fill zoom picture key, 259 flushright lower key, 32
final value, 421 flushright title key, 32
finish key, 197 flushright upper key, 32
finish broken key, 198 fontlower key, 29
finish broken pre key, 431 fontsize key, 403
finish fading vignette key, 275 fontsize value, 419
finish first key, 198 fontsize* value, 419
finish first and middle key, 198 fonttitle key, 29
finish first and middle pre key, 431 fontupper key, 29
finish first pre key, 431 \fooaux, 461, 470
finish last key, 198 fooaux key, 462
finish last pre key, 431 fooauxenv environment, 461
finish middle key, 198 foocolor color, 462
finish middle and last key, 198 foocolorbox environment, 460
finish middle and last pre key, 431 foocolorbox* environment, 460
finish middle pre key, 431 foocounter counter, 462
finish pre key, 431 foodummy key, 466
finish raised fading vignette key, 274 \foolength length, 462
finish unbroken key, 198 \foomakedocSubKey, 459
finish unbroken and first key, 198 \foomakedocSubKey*, 460
finish unbroken and first pre key, 431 \foosomething, 476
finish unbroken and last key, 198 footitle key, 461
finish unbroken and last pre key, 431 foovalue value, 461
finish unbroken pre key, 431 force remake key, 448
484
forced value, 46, 86 hyperlink interior key, 200
forced center value, 97 hyperlink node key, 200
forced left value, 97 hyperlink title key, 200
forced right value, 97 hyperref key, 199
forces nobeforeafter key, 78 hyperref interior key, 199
frame code key, 138 hyperref node key, 199
frame code app key, 431 hyperref title key, 199
frame code pre key, 431 hypertarget key, 100
frame empty key, 138 hyperurl key, 200
frame engine key, 135 hyperurl interior key, 200
frame hidden key, 149 hyperurl node key, 200
frame style key, 148 hyperurl title key, 200
frame style image key, 148 hyperurl* key, 200
frame style tile key, 149 hyperurl* interior key, 200
freelance key, 250 hyperurl* node key, 200
freelance Skin, 250 hyperurl* title key, 200
freelance value, 135, 136 hyphenationfix key, 96
freelancefirst Skin, 250
freelancelast Skin, 250 if odd page key, 101
freelancemiddle Skin, 250 if odd page or oneside key, 101
freeze extension key, 325 if odd page or oneside* key, 102
freeze file key, 325 if odd page* key, 102
freeze jpg key, 325 IfBooleanTF key, 435
freeze none key, 325 \ifboxarrayempty, 393
freeze pdf key, 325 IfNoValueTF key, 434
freeze png key, 325 IfValueTF key, 435
fuzzy halo key, 183 ignore nobreak key, 81
fuzzy shadow key, 189 ignored value, 24
image comment key, 311
geometry nodes key, 137 \imagename, 252
graphical environment key, 135 \imagepage, 253
graphics directory key, 254 index key, 100, 472
graphics options key, 254 index actual key, 470
graphics orientation key, 255 index annotate key, 471
graphics pages key, 254 index colorize key, 471
grow sidewards by key, 85 index command key, 470
grow to left by key, 84 index command name key, 470
grow to right by key, 84 index default settings key, 470
index format key, 470
halign key, 30 index german settings key, 470
halign lower key, 31 index level key, 470
halign title key, 32 index quote key, 470
halign upper key, 30 index* key, 100
halo key, 183 inherit height key, 57
hbox key, 94 input source on error key, 454
hbox value, 94 inside node key, 267
hbox boxed title key, 163 interior code key, 139
height key, 53, 401 interior code app key, 432
height fill key, 56 interior code pre key, 432
height fixed for key, 370 interior empty key, 139
height from key, 54 interior engine key, 136
height plus key, 53 interior hidden key, 150
highlight math key, 349 interior style key, 149
highlight math style key, 349 interior style image key, 150
hooks key, 9 interior style tile key, 150
horizontal size key, 268 interior titled code key, 138
hybrid value, 419 interior titled code app key, 431
hybrid* value, 419 interior titled code pre key, 432
Hyperlink color, 476 interior titled empty key, 138
hyperlink key, 199 interior titled engine key, 135
485
invisible key, 22 arc, 36
invisible value, 22, 24 arc is angular, 38
arc is curved, 38
justify value, 30 at begin tikz, 192
at begin tikz reset, 192
key key, 472 at end tikz, 192
Keys at end tikz reset, 192
/foo/ attach boxed title to bottom, 156
fooaux, 462 attach boxed title to bottom
foodummy, 466 center, 155
footitle, 461 attach boxed title to bottom left,
/tcb/ 155
add to height, 55 attach boxed title to bottom right,
add to list, 99 155
add to natural height, 55 attach boxed title to bottom*, 156
add to width, 34 attach boxed title to top, 156
adjust text, 18 attach boxed title to top center,
adjusted title, 18 155
adjusted title after break, 366 attach boxed title to top left, 155
after, 78 attach boxed title to top right,
after app, 425 155
after doc body, 475 attach boxed title to top*, 156
after doc body command, 475 attach title, 20
after doc body environment, 475 attach title to upper, 20
after doc body key, 475 auto outer arc, 38
after example, 469 autoparskip, 78
after lower, 66 baseline, 79
after lower app, 425 beamer, 228
after lower pre, 425 bean arc, 37
after lower*, 66 before, 78
after pre, 425 before app, 425
after skip, 80 before doc body, 475
after title, 64 before doc body command, 475
after title app, 424 before doc body environment, 475
after title pre, 424 before doc body key, 475
after upper, 65 before example, 469
after upper app, 424 before lower, 66
after upper pre, 424 before lower app, 425
after upper*, 65 before lower pre, 425
ams align, 351 before nobreak, 81
ams align lower, 351 before pre, 425
ams align upper, 351 before skip, 80
ams align*, 351 before title, 64
ams align* lower, 351 before title app, 424
ams align* upper, 351 before title pre, 424
ams equation, 350 before upper, 65
ams equation lower, 350 before upper app, 424
ams equation upper, 350 before upper pre, 424
ams equation*, 350 beforeafter skip, 80
ams equation* lower, 350 bicolor, 219
ams equation* upper, 350 blank, 208
ams gather, 352 blanker, 238
ams gather lower, 352 blankest, 239
ams gather upper, 352 blend before title, 113
ams gather*, 352 blend before title code, 114
ams gather* lower, 352 bookmark, 100
ams gather* upper, 352 bookmark*, 100
ams nodisplayskip, 353 borderline, 177
ams nodisplayskip lower, 353 borderline east, 180
ams nodisplayskip upper, 353
486
borderline horizontal, 181 description delimiters none, 344
borderline north, 180 description delimiters parenthesis,
borderline south, 180 344
borderline vertical, 181 description font, 345
borderline west, 180 description formatter, 345
bottom, 43 detach title, 20
bottomrule, 35 do not store to box array, 391
bottomrule at break, 369 doc description, 476
bottomsep at break, 369 doc head, 474
bottomtitle, 43 doc head command, 474
box align, 79 doc head environment, 474
boxed title size, 158 doc head key, 474
boxed title style, 159 doc into index, 476
boxrule, 36 doc left, 473
boxsep, 39 doc left indent, 473
break at, 367 doc marginnote, 476
breakable, 365 doc new, 476
capture, 94 doc new and updated, 476
center, 85 doc right, 473
center lower, 32 doc right indent, 473
center title, 32 doc updated, 476
center upper, 32 docexample, 469
check odd page, 101 documentation listing options, 469
circular arc, 37 documentation listing style, 469
clip lower, 176 documentation minted language, 469
clip title, 175 documentation minted options, 469
clip upper, 175 documentation minted style, 469
clip watermark, 171 draft, 248
code, 106 draftmode, 203
colback, 27 drop fuzzy midday shadow, 183
colbacklower, 220 drop fuzzy shadow, 182
colbacktitle, 27 drop fuzzy shadow east, 186
colframe, 27 drop fuzzy shadow north, 186
collower, 28 drop fuzzy shadow northeast, 186
color color, 471 drop fuzzy shadow northwest, 186
color command, 471 drop fuzzy shadow south, 185
color counter, 471 drop fuzzy shadow southeast, 185
color definition, 471 drop fuzzy shadow southwest, 185
color environment, 471 drop fuzzy shadow west, 185
color hyperlink, 471 drop large lifted shadow, 187
color key, 471 drop lifted shadow, 187
color length, 471 drop midday shadow, 182
color option, 471 drop shadow, 182
color value, 471 drop shadow east, 185
coltext, 28 drop shadow north, 184
coltitle, 28 drop shadow northeast, 185
colupper, 28 drop shadow northwest, 184
comment, 311 drop shadow south, 184
comment above listing, 318 drop shadow southeast, 184
comment above* listing, 318 drop shadow southwest, 184
comment and listing, 314 drop shadow west, 184
comment only, 311 drop small lifted shadow, 187
comment outside listing, 316 empty, 237
comment side listing, 316 enforce breakable, 366
comment style, 314 english language, 472
compilable listing, 322 enhanced, 206
compress page, 368 enhanced jigsaw, 213
description color, 344 enhanced standard, 208
description delimiters, 344 enhanced standard jigsaw, 213
487
enlarge bottom at break by, 83 finish first and middle, 198
enlarge bottom by, 83 finish first and middle pre, 431
enlarge bottom finally by, 82 finish first pre, 431
enlarge by, 84 finish last, 198
enlarge left by, 83 finish last pre, 431
enlarge right by, 83 finish middle, 198
enlarge top at break by, 83 finish middle and last, 198
enlarge top by, 83 finish middle and last pre, 431
enlarge top initially by, 82 finish middle pre, 431
enlargepage, 367 finish pre, 431
enlargepage flexible, 368 finish raised fading vignette, 274
equal height group, 61 finish unbroken, 198
every box, 91 finish unbroken and first, 198
every box on higher layers, 92 finish unbroken and first pre, 431
every box on layer n, 92 finish unbroken and last, 198
every float, 77 finish unbroken and last pre, 431
every listing line, 306 finish unbroken pre, 431
every listing line*, 306 finish vignette, 274
extend freelance, 250 fit, 413
extend freelancefirst, 250 fit algorithm, 419
extend freelancelast, 250 fit basedim, 414
extend freelancemiddle, 250 fit fontsize macros, 415
external, 105 fit height from, 418
externalize example, 453 fit height plus, 416
externalize example!, 453 fit maxfontdiff, 421
externalize listing, 453 fit maxfontdiffgap, 421
externalize listing!, 453 fit maxstep, 421
extras, 371 fit maxwidthdiff, 421
extras broken, 371 fit maxwidthdiffgap, 421
extras broken pre, 433 fit skip, 414
extras first, 371 fit to, 414
extras first and middle, 371 fit to height, 414
extras first and middle pre, 433 fit warning, 421
extras first pre, 433 fit width from, 417
extras last, 371 fit width plus, 416
extras last pre, 433 flip title, 156
extras middle, 371 float, 76
extras middle and last, 371 float*, 76
extras middle and last pre, 433 floatplacement, 76
extras middle pre, 433 flush left, 85
extras pre, 433 flush right, 85
extras title after break, 372 flushleft lower, 32
extras unbroken, 371 flushleft title, 32
extras unbroken and first, 371 flushleft upper, 32
extras unbroken and first pre, 433 flushright lower, 32
extras unbroken and last, 371 flushright title, 32
extras unbroken and last pre, 433 flushright upper, 32
extras unbroken pre, 433 fontlower, 29
extrude bottom by, 90 fonttitle, 29
extrude by, 90 fontupper, 29
extrude left by, 89 forces nobeforeafter, 78
extrude right by, 89 frame code, 138
extrude top by, 90 frame code app, 431
fill downwards, 87 frame code pre, 431
finish, 197 frame empty, 138
finish broken, 198 frame engine, 135
finish broken pre, 431 frame hidden, 149
finish fading vignette, 275 frame style, 148
finish first, 198 frame style image, 148
488
frame style tile, 149 image comment, 311
freelance, 250 index, 100
freeze extension, 325 index actual, 470
freeze file, 325 index annotate, 471
freeze jpg, 325 index colorize, 471
freeze none, 325 index command, 470
freeze pdf, 325 index command name, 470
freeze png, 325 index default settings, 470
fuzzy halo, 183 index format, 470
fuzzy shadow, 189 index german settings, 470
geometry nodes, 137 index level, 470
graphical environment, 135 index quote, 470
graphics directory, 254 index*, 100
graphics options, 254 inherit height, 57
graphics orientation, 255 interior code, 139
graphics pages, 254 interior code app, 432
grow sidewards by, 85 interior code pre, 432
grow to left by, 84 interior empty, 139
grow to right by, 84 interior engine, 136
halign, 30 interior hidden, 150
halign lower, 31 interior style, 149
halign title, 32 interior style image, 150
halign upper, 30 interior style tile, 150
halo, 183 interior titled code, 138
hbox, 94 interior titled code app, 431
hbox boxed title, 163 interior titled code pre, 432
height, 53 interior titled empty, 138
height fill, 56 interior titled engine, 135
height fixed for, 370 invisible, 22
height from, 54 keywords bold, 470
height plus, 53 label, 98
highlight math, 349 label separator, 346
highlight math style, 349 label type, 98
hyperlink, 199 left, 39
hyperlink interior, 200 left skip, 81
hyperlink node, 200 left*, 39
hyperlink title, 200 lefthand ratio, 120
hyperref, 199 lefthand width, 119
hyperref interior, 199 leftlower, 40
hyperref node, 199 leftright skip, 81
hyperref title, 199 leftrule, 35
hypertarget, 100 lefttitle, 40
hyperurl, 200 leftupper, 40
hyperurl interior, 200 lifted shadow, 190
hyperurl node, 200 lines before break, 366
hyperurl title, 200 list entry, 99
hyperurl*, 200 list text, 99
hyperurl* interior, 200 listing above comment, 318
hyperurl* node, 200 listing above text, 317
hyperurl* title, 200 listing above* comment, 318
hyphenationfix, 96 listing above* text, 317
if odd page, 101 listing and comment, 314
if odd page or oneside, 101 listing and text, 310
if odd page or oneside*, 102 listing engine, 310
if odd page*, 102 listing file, 310
IfBooleanTF, 435 listing inputencoding, 306
IfNoValueTF, 434 listing only, 310
IfValueTF, 435 listing options, 305
ignore nobreak, 81 listing outside comment, 316
489
listing outside text, 315 on line, 96
listing remove caption, 306 only, 106
listing side comment, 316 opacityback, 51
listing side text, 315 opacitybacktitle, 51
listing style, 305 opacityfill, 51
listing utf8, 307 opacityframe, 51
lower separated, 25 opacitylower, 52
lowerbox, 24 opacitytext, 52
marker, 215 opacitytitle, 52
math, 350 opacityupper, 52
math lower, 350 outer arc, 38
math upper, 350 overlay, 71
middle, 43 overlay app, 426
minimum for current equal height overlay broken, 72
group, 62 overlay broken app, 427
minimum for equal height group, 62 overlay broken pre, 427
minipage, 94 overlay first, 72
minipage boxed title, 163 overlay first and middle, 72
minipage boxed title*, 163 overlay first and middle app, 427
minted language, 308 overlay first and middle pre, 427
minted options, 308 overlay first app, 426
minted style, 309 overlay first pre, 426
move upwards, 87 overlay last, 72
move upwards*, 87 overlay last app, 427
nameref, 99 overlay last pre, 427
natural height, 53 overlay middle, 72
no borderline, 179 overlay middle and last, 72
no boxed title style, 162 overlay middle and last app, 427
no extras, 371 overlay middle and last pre, 427
no extras first, 371 overlay middle app, 427
no extras last, 371 overlay middle pre, 427
no extras middle, 371 overlay pre, 426
no extras title after break, 372 overlay unbroken, 72
no extras unbroken, 371 overlay unbroken and first, 72
no finish, 198 overlay unbroken and first app, 427
no finish first, 198 overlay unbroken and first pre, 427
no finish last, 198 overlay unbroken and last, 72
no finish middle, 198 overlay unbroken and last app, 427
no finish unbroken, 198 overlay unbroken and last pre, 427
no label type, 98 overlay unbroken app, 426
no listing options, 305 overlay unbroken pre, 426
no overlay, 72 oversize, 45
no process, 322 pad after break, 369
no recording, 128 pad at break, 369
no shadow, 182 pad at break*, 369
no underlay, 195 pad before break, 369
no underlay boxed title, 196 pad before break*, 369
no underlay first, 196 parbox, 95
no underlay last, 196 parfillskip restore, 81
no underlay middle, 196 parskip, 78
no underlay unbroken, 196 pdf comment, 312
no watermark, 167 pdf extension, 314
nobeforeafter, 78 phantom, 98
nofloat, 76 phantomlabel, 98
noparskip, 78 placeholder, 409
nophantom, 98 process code, 322
notitle, 18 raster after skip, 284
notitle after break, 366 raster before skip, 284
octogon arc, 37 raster column n, 288
490
raster column skip, 285 scale, 193
raster columns, 283 segmentation at break, 370
raster equal height, 287 segmentation code, 139
raster equal height group, 287 segmentation code app, 432
raster equal skip, 284 segmentation code pre, 432
raster even column, 288 segmentation empty, 139
raster even number, 289 segmentation engine, 136
raster even row, 289 segmentation hidden, 151
raster every box, 288 segmentation style, 151
raster force size, 288 separator sign, 343
raster halign, 286 separator sign colon, 343
raster height, 284 separator sign dash, 343
raster left skip, 285 separator sign none, 343
raster multicolumn, 290 shadow, 188
raster multirow, 291 sharp corners, 48
raster number n, 289 sharpish corners, 49
raster odd column, 288 shield externalize, 105
raster odd number, 289 show bounding box, 179
raster odd row, 288 shrink break goal, 368
raster reset, 288 shrink tight, 89
raster right skip, 285 sidebyside, 116
raster row m, 289 sidebyside adapt, 123
raster row m column n, 289 sidebyside align, 117
raster row skip, 285 sidebyside gap, 119
raster rows, 283 sidebyside switch, 125
raster valign, 286 size, 44
raster width, 283 skin, 134
record, 128 skin first, 134
remake, 105 skin first is subskin of, 141
remember, 193 skin last, 134
remember as, 194 skin last is subskin of, 141
reset, 105 skin middle, 134
reset and store to box array, 391 skin middle is subskin of, 141
reset box array, 388 smart shadow arc, 190
right, 40 space, 58
right skip, 81 space to, 59
right*, 41 space to both, 59
righthand ratio, 120 space to lower, 58
righthand width, 119 space to upper, 58
rightlower, 42 spartan, 247
rightrule, 35 split, 60
righttitle, 41 spread, 88
rightupper, 41 spread downwards, 88
rotate, 193 spread inwards, 87
rounded corners, 49 spread outwards, 87
run arara, 324 spread sidewards, 88
run biber, 324 spread upwards, 88
run bibtex, 324 spread upwards*, 88
run dvips, 324 square, 58
run latex, 324 squeezed title, 19
run lualatex, 324 squeezed title*, 19
run makeindex, 324 standard, 204
run pdflatex, 322 standard jigsaw, 205
run ps2pdf, 324 step, 98
run system command, 322 step and label, 98
run xelatex, 324 store to box array, 389
savedelimiter, 26 subtitle style, 21
savelowerto, 24 tabularx, 68
saveto, 23 tabularx*, 68
491
tcbimage comment, 312 underlay broken, 196
tcbox raise, 96 underlay broken pre, 430
tcbox raise base, 96 underlay first, 196
tcbox width, 97 underlay first and middle, 196
tempfile, 96 underlay first and middle pre, 430
terminator sign, 345 underlay first pre, 430
terminator sign colon, 346 underlay last, 196
terminator sign dash, 346 underlay last pre, 430
terminator sign none, 346 underlay middle, 196
text above listing, 317 underlay middle and last, 196
text above* listing, 317 underlay middle and last pre, 430
text and listing, 310 underlay middle pre, 430
text fill, 67 underlay pre, 430
text height, 54 underlay raised fading vignette,
text only, 311 273
text outside listing, 315 underlay raised shading vignette,
text side listing, 315 273
text width, 34 underlay shade in vignette, 273
theorem, 349 underlay unbroken, 196
theorem full label supplement, 347 underlay unbroken and first, 196
theorem label supplement, 347 underlay unbroken and first pre,
theorem name, 348 430
theorem name and number, 348 underlay unbroken and last, 196
theorem number and name, 348 underlay unbroken and last pre, 430
theorem style, 354 underlay unbroken pre, 430
tikz, 192 underlay vignette, 272
tikz lower, 69 upperbox, 22
tikz reset, 192 use height from group, 63
tikz upper, 69 valign, 33
tikznode, 70 valign lower, 33
tikznode boxed title, 164 valign scale limit, 33
tikznode lower, 70 valign upper, 33
tikznode upper, 70 varwidth boxed title, 164
tile, 224 varwidth boxed title*, 164
title, 18 varwidth upper, 70
title after break, 366 verbatim, 434
title code, 140 verbatim ignore percent, 127
title code app, 432 vfill before first, 370
title code pre, 432 visible, 22
title empty, 140 void, 107
title engine, 136 watermark color, 170
title filled, 27 watermark graphics, 166
title hidden, 152 watermark graphics app, 429
title style, 151 watermark graphics app on, 429
title style image, 152 watermark graphics on, 166
title style tile, 152 watermark graphics pre, 429
titlerule, 36 watermark graphics pre on, 429
titlerule style, 153 watermark opacity, 168
toggle enlargement, 86 watermark overzoom, 169
toggle left and right, 46 watermark shrink, 169
top, 42 watermark stretch, 170
toprule, 35 watermark text, 165
toprule at break, 369 watermark text app, 428
topsep at break, 369 watermark text app on, 428
toptitle, 42 watermark text on, 165
unbreakable, 366 watermark text pre, 428
underlay, 195 watermark text pre on, 428
underlay boxed title, 196 watermark tikz, 167
underlay boxed title pre, 430 watermark tikz app, 429
492
watermark tikz app on, 429 hooks, 9
watermark tikz on, 167 listings, 9
watermark tikz pre, 429 listingsutf8, 9
watermark tikz pre on, 429 magazine, 9
watermark zoom, 168 many, 10
widget, 233 minted, 9
width, 34 most, 10
/tcb/boxtitle/ poster, 9
xshift, 157 raster, 9
yshift, 157 skins, 9
yshift*, 157 theorems, 9
yshifttext, 157 vignette, 9
/tcb/doclang/ xparse, 10
color, 472 /tcb/new/
colors, 472 auto counter, 108
counter, 472 blend into, 112
counters, 472 Crefname, 111
environment, 472 crefname, 111
environment content, 472 list inside, 115
environments, 472 list type, 115
index, 472 no counter, 109
key, 472 number format, 110
keys, 472 number freestyle, 110
length, 472 number within, 110
lengths, 472 use counter, 109
new, 472 use counter from, 109
pageshort, 472 use counter*, 109
updated, 472 /tcb/poster/
value, 472 colspacing, 401
values, 472 columns, 401
/tcb/external/ height, 401
-, 448 prefix, 401
!, 448 rows, 401
clear preamble, 455 rowspacing, 401
clear preclass, 455 showframe, 401
compiler, 454 spacing, 401
environment, 454 width, 401
environment with percent, 454 /tcb/posterloc/
externalize, 448 above, 407
force remake, 448 at, 408
input source on error, 454 below, 407
minipage, 454 between, 408
name, 450 column, 405
PassOptionsToClass, 455 column*, 405
PassOptionsToPackage, 455 fixed height, 406
plain, 454 name, 405
preamble, 455 row, 406
preamble tcbset, 455 rowspan, 406
preclass, 455 sequence, 409
prefix, 448 span, 406
runner, 448 xshift, 410
runs, 454 yshift, 410
safety, 454 /tcb/posterset/
/tcb/library/ boxes, 403
all, 10 coverage, 402
breakable, 9 fontsize, 403
documentation, 10 no coverage, 402
external, 10 poster, 401
fitting, 9 /tcb/vig/
493
base color, 269 label key, 98
color from, 269 label separator key, 346
draw method, 270 label type key, 98
east size, 267 landscape value, 255
east style, 269 landscape* value, 255
fade in, 271 last value, 165–167, 370
fade out, 271 left key, 39
horizontal size, 268 left value, 30, 123, 286
inside node, 267 left skip key, 81
lower left corner, 266 left* key, 39
lowered color, 269 lefthand ratio key, 120
north size, 267 lefthand width key, 119
north style, 268 leftlower key, 40
outside node, 267 leftright skip key, 81
over node, 267 leftrule key, 35
over node offset, 267 lefttitle key, 40
raised color, 269 leftupper key, 40
scope, 269 length key, 472
semi fade in, 271 Lengths
semi fade out, 271 \foolength, 462
size, 268 lengths key, 472
south size, 267 lifted shadow key, 190
south style, 268 lines before break key, 366
upper right corner, 266 list entry key, 99
vertical size, 268 list inside key, 115
west size, 268 list text key, 99
west style, 269 list type key, 115
xmax, 266 listing above comment key, 318
xmin, 266 listing above text key, 317
ymax, 266 listing above* comment key, 318
ymin, 266 listing above* text key, 317
/tikz/ listing and comment key, 314
fill image opacity, 262 listing and text key, 310
fill image options, 262 listing engine key, 310
fill image scale, 262 listing file key, 310
fill overzoom image, 258 listing inputencoding key, 306
fill overzoom image*, 258 listing only key, 310
fill overzoom picture, 258 listing options key, 305
fill plain image, 256 listing outside comment key, 316
fill plain image*, 256 listing outside text key, 315
fill plain picture, 256 listing remove caption key, 306
fill shrink image, 260 listing side comment key, 316
fill shrink image*, 260 listing side text key, 315
fill shrink picture, 260 listing style key, 305
fill stretch image, 257 listing utf8 key, 307
fill stretch image*, 257 listings key, 9
fill stretch picture, 257 listings value, 112, 310
fill tile image, 261 listingsutf8 key, 9
fill tile image*, 261 lower left corner key, 266
fill tile picture, 261 lower separated key, 25
fill tile picture*, 261 lowerbox key, 24
fill zoom image, 259 lowered color key, 269
fill zoom image*, 259
fill zoom picture, 259 magazine key, 9
tcb fill frame, 154 many key, 10
tcb fill interior, 154 \marg, 463
tcb fill title, 154 margin value, 356
keys key, 472 margin apart value, 356
keywords bold key, 470 margin break value, 356
marker key, 215
494
math key, 350 no finish first key, 198
math lower key, 350 no finish last key, 198
math upper key, 350 no finish middle key, 198
maximum value, 56 no finish unbroken key, 198
\meta, 463 no label type key, 98
middle key, 43 no listing options key, 305
middle value, 165–167, 370 no overlay key, 72
middle and last value, 165–167, 370 no process key, 322
minimal value, 44 no recording key, 128
minimum center value, 97 no shadow key, 182
minimum for current equal height group no underlay key, 195
key, 62 no underlay boxed title key, 196
minimum for equal height group key, 62 no underlay first key, 196
minimum left value, 97 no underlay last key, 196
minimum right value, 97 no underlay middle key, 196
minipage key, 94, 454 no underlay unbroken key, 196
minipage value, 94, 280 no watermark key, 167
minipage boxed title key, 163 nobeforeafter key, 78
minipage boxed title* key, 163 nofloat key, 76
minted key, 9 none value, 46, 86, 123, 287, 368, 370
minted value, 310 noparskip key, 78
minted language key, 308 nophantom key, 98
minted options key, 308 normal value, 44, 158
minted style key, 309 north fading, 270
most key, 10 north value, 48, 49
move upwards key, 87 north size key, 267
move upwards* key, 87 north style key, 268
northeast value, 48, 49
name key, 405, 450 northwest value, 48, 49
nameref key, 99 notitle key, 18
natural height key, 53 notitle after break key, 366
new key, 472 number format key, 110
\newboxarray, 388 number freestyle key, 110
\newtcbexternalizeenvironment, 456 number within key, 110
\newtcbexternalizetcolorbox, 456
\NewTCBInputListing, 444 \oarg, 463
\newtcbinputlisting, 304 octogon arc key, 37
\NewTCBListing, 442 off value, 421, 470
\newtcblisting, 302 on value, 421
\NewTCBox, 439 on line key, 96
\newtcbox, 16 only key, 106
\NewTCBoxFit, 445 opacityback key, 51
\newtcboxfit, 412 opacitybacktitle key, 51
\newtcbtheorem, 339 opacityfill key, 51
\NewTColorBox, 437 opacityframe key, 51
\newtcolorbox, 15 opacitylower key, 52
\NewTotalTCBox, 441 opacitytext key, 52
\NewTotalTCBoxFit, 446 opacitytitle key, 52
\NewTotalTColorBox, 438 opacityupper key, 52
no borderline key, 179 Option color, 476
no boxed title style key, 162 outer arc key, 38
no counter key, 109 outside node key, 267
no coverage key, 402 over node key, 267
no extras key, 371 over node offset key, 267
no extras first key, 371 overlay key, 71
no extras last key, 371 overlay app key, 426
no extras middle key, 371 overlay broken key, 72
no extras title after break key, 372 overlay broken app key, 427
no extras unbroken key, 371 overlay broken pre key, 427
no finish key, 198 overlay first key, 72
495
overlay first and middle key, 72 \posterbox, 404
overlay first and middle app key, 427 posterboxenv environment, 404
overlay first and middle pre key, 427 preamble key, 455
overlay first app key, 426 preamble tcbset key, 455
overlay first pre key, 426 preclass key, 455
overlay last key, 72 prefix key, 401, 448
overlay last app key, 427 process code key, 322
overlay last pre key, 427 \ProvideTCBInputListing, 444
overlay middle key, 72 \ProvideTCBListing, 442
overlay middle and last key, 72 \ProvideTCBox, 439
overlay middle and last app key, 427 \ProvideTCBoxFit, 445
overlay middle and last pre key, 427 \ProvideTColorBox, 437
overlay middle app key, 427 \ProvideTotalTCBox, 441
overlay middle pre key, 427 \ProvideTotalTCBoxFit, 446
overlay pre key, 426 \ProvideTotalTColorBox, 438
overlay unbroken key, 72
overlay unbroken and first key, 72 raised color key, 269
overlay unbroken and first app key, 427 raster key, 9
overlay unbroken and first pre key, 427 raster after skip key, 284
overlay unbroken and last key, 72 raster before skip key, 284
overlay unbroken and last app key, 427 raster column n key, 288
overlay unbroken and last pre key, 427 raster column skip key, 285
overlay unbroken app key, 426 raster columns key, 283
overlay unbroken pre key, 426 raster equal height key, 287
oversize key, 45 raster equal height group key, 287
raster equal skip key, 284
pad after break key, 369 raster even column key, 288
pad at break key, 369 raster even number key, 289
pad at break* key, 369 raster even row key, 289
pad before break key, 369 raster every box key, 288
pad before break* key, 369 raster force size key, 288
pageshort key, 472 raster halign key, 286
parbox key, 95 raster height key, 284
parfillskip restore key, 81 raster left skip key, 285
parskip key, 78 raster multicolumn key, 290
PassOptionsToClass key, 455 raster multirow key, 291
PassOptionsToPackage key, 455 raster number n key, 289
path value, 135, 136 raster odd column key, 288
pathfirst value, 135, 136 raster odd number key, 289
pathfirstjigsaw value, 135 raster odd row key, 288
pathjigsaw value, 135 raster reset key, 288
pathlast value, 135, 136 raster right skip key, 285
pathlastjigsaw value, 135 raster row m key, 289
pathmiddle value, 135, 136 raster row m column n key, 289
pathmiddlejigsaw value, 135 raster row skip key, 285
pdf comment key, 312 raster rows key, 283
pdf extension key, 314 raster valign key, 286
\pdfpages, 254 raster width key, 283
pgf value, 470 record key, 128
pgfchapter value, 470 \refAux, 467
pgfsection value, 470 \refAuxcs, 467
phantom key, 98 \refCom, 466
phantomlabel key, 98 \refCom*, 466
placeholder key, 409 \refEnv, 466
plain key, 454 \refEnv*, 466
plain value, 354 \refKey, 467
plain apart value, 355 \refKey*, 467
portrait value, 255 remake key, 105
portrait* value, 255 remember key, 193
poster key, 9, 401 remember as key, 194
496
\renewtcbexternalizeenvironment, 456 segmentation code app key, 432
\renewtcbexternalizetcolorbox, 457 segmentation code pre key, 432
\RenewTCBInputListing, 444 segmentation empty key, 139
\renewtcbinputlisting, 304 segmentation engine key, 136
\RenewTCBListing, 442 segmentation hidden key, 151
\renewtcblisting, 303 segmentation style key, 151
\RenewTCBox, 439 semi east fading, 270
\renewtcbox, 16 semi fade in key, 271
\RenewTCBoxFit, 445 semi fade out key, 271
\renewtcboxfit, 412 semi north fading, 270
\renewtcbtheorem, 340 semi south fading, 270
\RenewTColorBox, 437 semi west fading, 270
\renewtcolorbox, 15 separator sign key, 343
\RenewTotalTCBox, 441 separator sign colon key, 343
\RenewTotalTCBoxFit, 446 separator sign dash key, 343
\RenewTotalTColorBox, 438 separator sign none key, 343
reset key, 105 sequence key, 409
reset and store to box array key, 391 shadow key, 188
reset box array key, 388 sharp corners key, 48
right key, 40 sharpish corners key, 49
right value, 30, 123, 286 shield externalize key, 105
right skip key, 81 show bounding box key, 179
right* key, 41 showframe key, 401
righthand ratio key, 120 shrink break goal key, 368
righthand width key, 119 shrink tight key, 89
rightlower key, 42 sidebyside key, 116
rightrule key, 35 sidebyside adapt key, 123
righttitle key, 41 sidebyside align key, 117
rightupper key, 41 sidebyside gap key, 119
rotate key, 193 sidebyside switch key, 125
rounded corners key, 49 size key, 44, 268
row key, 406 skin key, 134
rows key, 401 skin first key, 134
rows value, 287 skin first is subskin of key, 141
rowspacing key, 401 skin last key, 134
rowspan key, 406 skin last is subskin of key, 141
run arara key, 324 skin middle key, 134
run biber key, 324 skin middle is subskin of key, 141
run bibtex key, 324 Skins
run dvips key, 324 beamer, 228
run latex key, 324 beamerfirst, 230
run lualatex key, 324 beamerlast, 232
run makeindex key, 324 beamermiddle, 231
run pdflatex key, 322 bicolor, 219
run ps2pdf key, 324 bicolorfirst, 221
run system command key, 322 bicolorlast, 223
run xelatex key, 324 bicolormiddle, 222
runner key, 448 draft, 248
runs key, 454 empty, 237
emptyfirst, 240
safety key, 454 emptylast, 242
savedelimiter key, 26 emptymiddle, 241
savelowerto key, 24 enhanced, 206
saveto key, 23 enhanced jigsaw, 213
scale key, 193 enhancedfirst, 210
scale value, 33 enhancedfirst jigsaw, 214
scale* value, 33 enhancedlast, 212
scope key, 269 enhancedlast jigsaw, 218
segmentation at break key, 370 enhancedmiddle, 211
segmentation code key, 139
497
enhancedmiddle jigsaw, 215 tcb fill frame key, 154
freelance, 250 tcb fill interior key, 154
freelancefirst, 250 tcb fill title key, 154
freelancelast, 250 \tcbbreak, 377
freelancemiddle, 250 tcbclipframe environment, 172
spartan, 247 tcbclipinterior environment, 174
standard, 204 tcbcliptitle environment, 174
standard jigsaw, 205 \tcbcontinuedraftmode, 203
tile, 224 \tcbcounter, 108
tilefirst, 225 \tcbdocmarginnote, 468
tilelast, 227 \tcbdocnew, 468
tilemiddle, 226 \tcbdocupdated, 468
widget, 233 tcbexternal environment, 449
widgetfirst, 234 \tcbEXTERNALIZE, 448
widgetlast, 236 \tcbfitdim, 412–415
widgetmiddle, 235 \tcbfitsteps, 413
skins key, 9 \tcbfontsize, 412
small value, 44 \tcbheightfromgroup, 63
smart shadow arc key, 190 \tcbheightspace, 146
south fading, 270 \tcbhighmath, 341
south value, 48, 49 \tcbhypernode, 264
south size key, 267 \tcbifexternal, 455
south style key, 268 \tcbiffileprocess, 457
southeast value, 48, 49 \tcbifoddpage, 103
southwest value, 48, 49 \tcbifoddpageoroneside, 103
space key, 58 tcbimage comment key, 312
space to key, 59 \tcbincludegraphics, 251
space to both key, 59 \tcbincludepdf, 253
space to lower key, 58 \tcbinputlisting, 301
space to upper key, 58 \tcbinputrecords, 128
spacing key, 401 \tcbinterruptdraftmode, 203
span key, 406 tcbinvclipframe environment, 173
spartan key, 247 \tcbitem, 280
spartan Skin, 247 tcbitemize environment, 280
spartan value, 135, 136 \tcbline, 209
split key, 60 \tcbline*, 209
spread key, 88 tcblisting environment, 299
spread downwards key, 88 \tcblistof, 115
spread inwards key, 87 \tcblower, 12
spread outwards key, 87 \tcbmakedocSubKey, 466
spread sidewards key, 88 \tcbmaketheorem, 340
spread upwards key, 88 tcboutputlisting environment, 301
spread upwards* key, 88 \tcbox, 14
square key, 58 tcbox raise key, 96
squeeze value, 419 tcbox raise base key, 96
squeezed title key, 19 tcbox width key, 97
squeezed title* key, 19 tcboxeditemize environment, 282
standard key, 204 tcboxedraster environment, 281
standard Skin, 204 \tcboxedtitleheight, 157
standard value, 135, 136, 158, 354 \tcboxedtitlewidth, 157
standard jigsaw key, 205 \tcboxfit, 411
standard jigsaw Skin, 205 \tcboxmath, 341
step key, 98 \tcboxverb, 441
step and label key, 98 \tcbpatcharcangular, 263
store to box array key, 389 \tcbpatcharcround, 263
subtitle style key, 21 tcbposter environment, 399
\tcbpostercolspacing, 400
tables value, 112 \tcbpostercolumns, 400
tabularx key, 68 \tcbpostercolwidth, 400
tabularx* key, 68
498
\tcbposterheight, 400 \thetcbcounter, 108, 109
\tcbposterrowheight, 400 \thetcbrasternum, 279, 290
\tcbposterrows, 400 \thetcolorboxnumber, 104
\tcbposterrowspacing, 400 \thetcolorboxpage, 104
\tcbposterset, 400 tight value, 44
\tcbposterwidth, 400 tikz key, 192
tcbraster environment, 279 tikz lower key, 69
\tcbrecord, 128 tikz reset key, 192
\tcbsegmentstate, 147 tikz upper key, 69
\tcbset, 13 tikznode key, 70
\tcbsetforeverylayer, 13 tikznode boxed title key, 164
\tcbsetmacrotoheightofnode, 264 tikznode lower key, 70
\tcbsetmacrotowidthofnode, 264 tikznode upper key, 70
\tcbsetmanagedlayers, 92 tile key, 224
\tcbsettoheightofnode, 264 tile Skin, 224
\tcbsettowidthofnode, 264 tilefirst Skin, 225
\tcbsidebyside, 122 tilelast Skin, 227
\tcbstartdraftmode, 203 tilemiddle Skin, 226
\tcbstartrecording, 128 title key, 18
\tcbstopdraftmode, 203 title value, 44, 158
\tcbstoprecording, 128 title after break key, 366
\tcbsubskin, 141 title code key, 140
\tcbsubtitle, 21 title code app key, 432
\tcbtextheight, 147 title code pre key, 432
\tcbtextwidth, 146 title empty key, 140
\tcbtitle, 20 title engine key, 136
\tcbtitletext, 20 title filled key, 27
\tcbuselibrary, 9 title hidden key, 152
\tcbuselistinglisting, 301 title style key, 151
\tcbuselistingtext, 301 title style image key, 152
\tcbusetemp, 126 title style tile key, 152
\tcbusetemplisting, 301 titlerule key, 36
tcbverbatimwrite environment, 126 titlerule style key, 153
\tcbvignette, 265 toggle enlargement key, 86
tcbwritetemp environment, 126 toggle left and right key, 46
tcolorbox environment, 12 top key, 42
\tcolorboxenvironment, 17 top value, 33, 79, 117, 286
tempfile key, 96 top seam value, 117
terminator sign key, 345 toprule key, 35
terminator sign colon key, 346 toprule at break key, 369
terminator sign dash key, 346 topsep at break key, 369
terminator sign none key, 346 toptitle key, 42
text above listing key, 317 true value, 81, 365
text above* listing key, 317
text and listing key, 310 unbreakable key, 366
text fill key, 67 unbroken value, 165–167
text height key, 54 unbroken and first value, 165–167
text only key, 311 underlay key, 195
text outside listing key, 315 underlay boxed title key, 196
text side listing key, 315 underlay boxed title pre key, 430
text width key, 34 underlay broken key, 196
theorem key, 349 underlay broken pre key, 430
theorem full label supplement key, 347 underlay first key, 196
theorem label supplement key, 347 underlay first and middle key, 196
theorem name key, 348 underlay first and middle pre key, 430
theorem name and number key, 348 underlay first pre key, 430
theorem number and name key, 348 underlay last key, 196
theorem style key, 354 underlay last pre key, 430
theorems key, 9 underlay middle key, 196
underlay middle and last key, 196
499
underlay middle and last pre key, 430 doc, 470
underlay middle pre key, 430 downhill, 48, 49
underlay pre key, 430 east, 48, 49
underlay raised fading vignette key, 273 empty, 135, 136
underlay raised shading vignette key, 273 evenpage, 46, 86
underlay shade in vignette key, 273 false, 78, 81, 288, 365
underlay unbroken key, 196 fbox, 44
underlay unbroken and first key, 196 figures, 112
underlay unbroken and first pre key, 430 final, 421
underlay unbroken and last key, 196 first, 165–167, 370
underlay unbroken and last pre key, 430 first and middle, 165, 370
underlay unbroken pre key, 430 fitbox, 94
underlay vignette key, 272 flush center, 30, 32
unlimited value, 364, 365 flush left, 30, 32
updated key, 472 flush right, 30, 32
uphill value, 48, 49 fontsize, 419
upper right corner key, 266 fontsize*, 419
upperbox key, 22 foovalue, 461
use counter key, 109 forced, 46, 86
use counter from key, 109 forced center, 97
use counter* key, 109 forced left, 97
use height from group key, 63 forced right, 97
\useboxarray, 391 freelance, 135, 136
\usetcboxarray, 392 hbox, 94
hybrid, 419
valign key, 33 hybrid*, 419
valign lower key, 33 ignored, 24
valign scale limit key, 33 invisible, 22, 24
valign upper key, 33 justify, 30
value key, 472 landscape, 255
Values landscape*, 255
0, 147 last, 165–167, 370
1, 147 left, 30, 123, 286
2, 147 listings, 112, 310
all, 48, 49, 287, 368, 370 margin, 356
areasize, 419 margin apart, 356
areasize*, 419 margin break, 356
as-is, 255 maximum, 56
auto, 97 middle, 165–167, 370
auto limited, 97 middle and last, 165–167, 370
base, 79 minimal, 44
baselineskip, 368 minimum center, 97
both, 123 minimum left, 97
bottom, 33, 79, 117, 286 minimum right, 97
bottom seam, 117 minipage, 94, 280
break, 355 minted, 310
broken, 165–167 none, 46, 86, 123, 287, 368, 370
center, 30, 33, 79, 117, 286 normal, 44, 158
center seam, 117 north, 48, 49
change, 355 northeast, 48, 49
change apart, 355 northwest, 48, 49
change break, 355 off, 421, 470
change standard, 354 on, 421
clipped, 270 path, 135, 136
colon, 113 pathfirst, 135, 136
colon hang, 113 pathfirstjigsaw, 135
copy, 158 pathjigsaw, 135
dash, 113 pathlast, 135, 136
dash hang, 113 pathlastjigsaw, 135
direct, 270
500
pathmiddle, 135, 136 watermark text pre key, 428
pathmiddlejigsaw, 135 watermark text pre on key, 428
pgf, 470 watermark tikz key, 167
pgfchapter, 470 watermark tikz app key, 429
pgfsection, 470 watermark tikz app on key, 429
plain, 354 watermark tikz on key, 167
plain apart, 355 watermark tikz pre key, 429
portrait, 255 watermark tikz pre on key, 429
portrait*, 255 watermark zoom key, 168
right, 30, 123, 286 west fading, 270
rows, 287 west value, 48, 49
scale, 33 west size key, 268
scale*, 33 west style key, 269
small, 44 widget key, 233
south, 48, 49 widget Skin, 233
southeast, 48, 49 widgetfirst Skin, 234
southwest, 48, 49 widgetlast Skin, 236
spartan, 135, 136 widgetmiddle Skin, 235
squeeze, 419 width key, 34, 401
standard, 135, 136, 158, 354
tables, 112 xmax key, 266
tight, 44 xmin key, 266
title, 44, 158 xparse key, 10
top, 33, 79, 117, 286 xshift key, 157, 410
top seam, 117
true, 81, 365 ymax key, 266
unbroken, 165–167 ymin key, 266
unbroken and first, 165–167 yshift key, 157, 410
unlimited, 364, 365 yshift* key, 157
uphill, 48, 49 yshifttext key, 157
visible, 22, 24
west, 48, 49
values key, 472
varwidth boxed title key, 164
varwidth boxed title* key, 164
varwidth upper key, 70
verbatim key, 434
verbatim ignore percent key, 127
vertical size key, 268
vfill before first key, 370
vignette key, 9
visible key, 22
visible value, 22, 24
void key, 107
501