summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.skins.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.skins.tex')
-rw-r--r--Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.skins.tex161
1 files changed, 150 insertions, 11 deletions
diff --git a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.skins.tex b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.skins.tex
index 3dbdba3fe1e..a3d730301f3 100644
--- a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.skins.tex
+++ b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.skins.tex
@@ -95,6 +95,7 @@ Every engine for the up to four steps can be set to one of the following types:
\item |pathmiddle|: a |tikz| path which can be controlled by options.
\item |pathlast|: a |tikz| path which can be controlled by options.
\item |freelance|: arbitrary user code.
+\item |spartan|: a quite spartan code.
\end{enumerate}
%\clearpage
@@ -113,7 +114,8 @@ Every engine for the up to four steps can be set to one of the following types:
\item |pathlast|: a |tikz| path which is controlled by \refKey{/tcb/frame style},
\item |pathlastjigsaw|: a |tikz| path which is controlled by \refKey{/tcb/frame style},
\item |freelance|: arbitrary user code which is given by \refKey{/tcb/frame code}.
- \end{itemize}
+ \item |spartan|: a quite spartan code.
+\end{itemize}
\end{docTcbKey}
\begin{docTcbKey}{interior titled engine}{=\meta{name}}{no default, initially \texttt{standard}}
@@ -127,6 +129,7 @@ Every engine for the up to four steps can be set to one of the following types:
\item |pathmiddle|: a |tikz| path which is controlled by \refKey{/tcb/interior style},
\item |pathlast|: a |tikz| path which is controlled by \refKey{/tcb/interior style},
\item |freelance|: arbitrary user code which is given by \refKey{/tcb/interior titled code}.
+ \item |spartan|: a quite spartan code.
\end{itemize}
\end{docTcbKey}
@@ -142,6 +145,7 @@ Every engine for the up to four steps can be set to one of the following types:
\item |pathmiddle|: a |tikz| path which is controlled by \refKey{/tcb/interior style},
\item |pathlast|: a |tikz| path which is controlled by \refKey{/tcb/interior style},
\item |freelance|: arbitrary user code which is given by \refKey{/tcb/interior code}.
+ \item |spartan|: a quite spartan code.
\end{itemize}
\end{docTcbKey}
@@ -153,6 +157,7 @@ Every engine for the up to four steps can be set to one of the following types:
\item |standard|: the original code from the core package,
\item |path|: a |tikz| path which is controlled by \refKey{/tcb/segmentation style},
\item |freelance|: arbitrary user code which is given by \refKey{/tcb/segmentation code}.
+ \item |spartan|: a quite spartan code.
\end{itemize}
\end{docTcbKey}
@@ -167,10 +172,11 @@ Every engine for the up to four steps can be set to one of the following types:
\item |pathmiddle|: a |tikz| path which is controlled by \refKey{/tcb/title style},
\item |pathlast|: a |tikz| path which is controlled by \refKey{/tcb/title style},
\item |freelance|: arbitrary user code which is given by \refKey{/tcb/title code}.
+ \item |spartan|: a quite spartan code.
\end{itemize}
\end{docTcbKey}
-\begin{docTcbKey}{geometry nodes}{\colOpt{=\meta{boolean value}}}{default |true|, initially |false|}
+\begin{docTcbKey}{geometry nodes}{\colOpt{=true\textbar 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|.
@@ -711,7 +717,7 @@ To avoid this optical glitch, just set \refKey{/tcb/pad at break} to any desired
\clearpage
-\begin{docTcbKey}{clip watermark}{\colOpt{=\meta{boolean value}}}{default |true|, initially |true|}
+\begin{docTcbKey}{clip watermark}{\colOpt{=true\textbar false}}{default |true|, initially |true|}
Sets the watermark to be clipped to the interior area.
\begin{dispExample}
\tcbset{enhanced,colback=white,colframe=blue!50!white,fonttitle=\bfseries,
@@ -810,7 +816,7 @@ Defines a |Tikz| scope which clips to the title area path.
\end{docEnvironment}
\clearpage
-\begin{docTcbKey}{clip title}{\colOpt{=\meta{boolean value}}}{default |true|, initially |false|}
+\begin{docTcbKey}{clip title}{\colOpt{=true\textbar false}}{default |true|, initially |false|}
Sets the title to be clipped to the title area.
\begin{dispExample}
\tcbset{enhanced,width=5cm,colframe=red!50!white,coltitle=black,
@@ -828,7 +834,7 @@ This is a tcolorbox.
\end{docTcbKey}
-\begin{docTcbKey}{clip upper}{\colOpt{=\meta{boolean value}}}{default |true|, initially |false|}
+\begin{docTcbKey}{clip upper}{\colOpt{=true\textbar false}}{default |true|, initially |false|}
Sets the upper part to be clipped to the interior area.
\begin{dispExample}
\newcommand{\mygraphics}[2][]{%
@@ -861,7 +867,7 @@ options provide an easy solution.
\end{dispExample}
-\begin{docTcbKey}{clip lower}{\colOpt{=\meta{boolean value}}}{default |true|, initially |false|}
+\begin{docTcbKey}{clip lower}{\colOpt{=true\textbar false}}{default |true|, initially |false|}
Sets the lower part to be clipped to the interior area.
\begin{dispExample}
\tcbset{enhanced,width=5cm,colframe=red!50!black,text and listing}
@@ -1466,7 +1472,7 @@ This is a tcolorbox.
\begin{docTcbKey}{at begin tikz}{=\meta{tikz code}}{no default, initially empty}
- The given \meta{tikz code} is executed at the begin of the |tikzpicture| environment
+ The given \meta{tikz code} is executed at the beginning of the |tikzpicture| environment
after the TikZ option |execute at begin picture| was applied.
If this option is applied a second time, the new \meta{tikz code} is appended to the current code.
\end{docTcbKey}
@@ -1478,7 +1484,7 @@ This is a tcolorbox.
\begin{docTcbKey}{at end tikz}{=\meta{tikz code}}{no default, initially empty}
- The given \meta{tikz code} is executed at the end of the |tikzpicture| environment
+ The given \meta{tikz code} is executed at the ending of the |tikzpicture| environment
before the TikZ option |execute at end picture| was applied.
If this option is applied a second time, the new \meta{tikz code} is appended to the current code.
\end{docTcbKey}
@@ -1523,7 +1529,7 @@ This is a tcolorbox.
\begin{docTcbKey}{remember}{}{style, initially unset}
- Shortcut for |tikz={remember picture}|. This allows to reference nodes
+ Shortcut for |tikz={remember picture}|. This allows one to reference nodes
in other TikZ pictures.
\begin{dispExample}
\begin{tcolorbox}[enhanced,remember,colback=red!5!white,colframe=red!75!black,
@@ -1539,6 +1545,7 @@ This is a tcolorbox.
\end{docTcbKey}
\clearpage
+\tcbinterruptdraftmode%
\begin{docTcbKey}{remember as}{=\meta{name}}{style, no default, initially unset}
The |frame| node will be remembered by the given \meta{name} to be referenced
in other TikZ pictures.
@@ -1573,6 +1580,7 @@ This is a test.
\end{tikzpicture}
\end{dispExample}
\end{docTcbKey}
+\tcbcontinuedraftmode%
\clearpage
\subsection{Jigsaw Skin Variants}\label{subsec:skinjigsaw}
@@ -1622,12 +1630,12 @@ and \refSkin{enhanced jigsaw}.
frame style={left color=red!75!black,right color=red!10!yellow},
fonttitle=\bfseries,interior hidden,title hidden}
-\begin{tcolorbox}[title=A normal box with hidden interior and titel]
+\begin{tcolorbox}[title=A normal box with hidden interior and title]
This is a tcolorbox.
\end{tcolorbox}
\begin{tcolorbox}[enhanced jigsaw,
- title=A jigsaw box with hidden interior and titel]
+ title=A jigsaw box with hidden interior and title]
This is a tcolorbox.
\end{tcolorbox}
\end{dispExample*}
@@ -1645,6 +1653,81 @@ and \refSkin{enhanced jigsaw}.
\clearpage
+\subsection{Draft Mode}\label{subsec:draftmode}
+To reduce the compiliation time while drafting a document, the \emph{draft mode}
+can be applied. Basically, it changes all skins to \refSkin{spartan} and
+sets the \refKey{/tcb/fit algorithm} to |squeeze|. Especially,
+when fuzzy shadows are used, the speedup will be considerable high.
+
+\begin{marker}
+It is strongly recommended that the draft mode is \emph{not} used for the final document.
+Use \refSkin{spartan} directly, if you want to stay with it. The draft mode
+implementation may change in future.
+\end{marker}
+
+\begin{marker}
+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, \refKey{/tcb/remember as}
+will not have any effect. You may exclude critical code with
+\refCom{tcbinterruptdraftmode} / \refCom{tcbcontinuedraftmode}
+from converting to draft mode.
+\end{marker}
+
+
+\begin{docCommand}{tcbstartdraftmode}{}
+ Any following |tcolorbox| code is put into \emph{draft mode}. All skin
+ settings are overruled with \refSkin{spartan}. Overlays, watermarks,
+ shadows, borderlines, and rounded corners are deactivated for all |tcolorbox|
+ layers.
+\end{docCommand}
+
+\begin{docCommand}{tcbstopdraftmode}{}
+ The \emph{draft mode} is deactivated for the following code.
+\end{docCommand}
+
+\begin{docCommand}{tcbinterruptdraftmode}{}
+ If the compilation is in \emph{draft mode}, the \emph{draft mode} is deactivated
+ until a following \refCom{tcbcontinuedraftmode} is detected.\par
+ If the compilation is not in \emph{draft mode}, no happens and a following
+ \refCom{tcbcontinuedraftmode} will not start the \emph{draft mode}.
+ \begin{marker}
+ The pair |\tcbinterruptdraftmode| and |\tcbcontinuedraftmode| cannot
+ be used nested.
+ \end{marker}
+\end{docCommand}
+
+\begin{docCommand}{tcbcontinuedraftmode}{}
+ Continues the \emph{draft mode} which was suspended by a preceding
+ \refCom{tcbinterruptdraftmode}. Nothing happens, if there was no draft
+ mode before \refCom{tcbinterruptdraftmode}.
+ \begin{marker}
+ Code, which is place between \refCom{tcbinterruptdraftmode} and
+ \refCom{tcbcontinuedraftmode} is shielded from \emph{draft mode}.
+ \end{marker}
+\end{docCommand}
+
+\enlargethispage*{2cm}
+\begin{docTcbKey}{draftmode}{\colOpt{=true\textbar false}}{default |true|, initially |false|}
+ If set to |true|, the \emph{draft mode} is started.
+ If set to |false|, the \emph{draft mode} is stopped.
+
+\begin{dispExample*}{}
+\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}
+\end{dispExample*}
+\end{docTcbKey}
+
+
+
+\clearpage
\tcbset{skintable/.style={colframe=red!50!yellow!50!black,
colback=red!50!yellow!5!white,coltitle=red!50!yellow!3!white,
fonttitle=\bfseries,before=\par\smallskip,
@@ -3138,6 +3221,62 @@ Nevertheless, this skin can be applied independently.
\clearpage
+\subsection{Skin 'spartan'}\label{subsec:spartan}
+
+\begin{docSkin}{spartan}
+ This skin is quite \ldots\ spartan.
+ It supports no rounded corners, no overlays, no shadows, no borderlines,
+ and no \refKey{/tcb/geometry nodes}. One cannot do any fancy things with
+ this skin, but it compiles very fast. Therefore, the |spartan| skin is
+ used for the draft mode, see \Vref{subsec:draftmode}.
+ Nevertheless, it can be used as a normal skin.
+
+\begin{tcolorbox}[skintable=spartan]
+ \begin{tabbing}
+ \refKey{/tcb/interior titled engine}: \=\kill
+ \refKey{/tcb/graphical environment}: \> |tikzpicture|\\
+ \refKey{/tcb/frame engine}: \> |spartan|\\
+ \refKey{/tcb/interior titled engine}: \> |spartan|\\
+ \refKey{/tcb/interior engine}: \> |spartan|\\
+ \refKey{/tcb/segmentation engine}: \> |spartan|\\
+ \refKey{/tcb/title engine}: \> |spartan|
+ \end{tabbing}
+\end{tcolorbox}
+\end{docSkin}
+
+
+\begin{docTcbKey}{spartan}{}{style, no value}
+ This is an abbreviation for setting |skin=spartan|.
+\end{docTcbKey}
+
+
+\begin{dispExample}
+\tcbset{spartan,equal height group=spartan,
+ colback=LightGreen,colframe=DarkGreen,colbacklower=LimeGreen!75!LightGreen,
+ width=(\linewidth-6mm)/4,nobeforeafter,
+ left=1mm,right=1mm,top=1mm,bottom=1mm,middle=1mm}
+%
+\begin{tcolorbox}
+ This is my content.
+\end{tcolorbox}\hfill
+\begin{tcolorbox}
+ This is my content.
+ \tcblower
+ More content.
+\end{tcolorbox}\hfill
+\begin{tcolorbox}[adjusted title=My title]
+ This is my content.
+\end{tcolorbox}\hfill
+\begin{tcolorbox}[adjusted title=My title]
+ This is my content.
+ \tcblower
+ More content.
+\end{tcolorbox}
+\end{dispExample}
+
+
+\clearpage
+
\subsection{Skin 'draft'}\label{subsec:draft}
\begin{docSkin}{draft}