diff options
author | Karl Berry <karl@freefriends.org> | 2014-09-22 22:17:46 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2014-09-22 22:17:46 +0000 |
commit | d618f80f8f62c896392904e75aefd221af6fa9e6 (patch) | |
tree | 28777aa698936b11b02d58431345e41e0d3c6655 /Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.coreoptions.tex | |
parent | 942f0cacc577ae897adcaf7f1705b0a864223002 (diff) |
tcolorbox (22sep14)
git-svn-id: svn://tug.org/texlive/trunk@35232 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.coreoptions.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.coreoptions.tex | 69 |
1 files changed, 64 insertions, 5 deletions
diff --git a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.coreoptions.tex b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.coreoptions.tex index 03569b2014d..3c350f3b655 100644 --- a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.coreoptions.tex +++ b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.coreoptions.tex @@ -1122,9 +1122,32 @@ This is a tcolorbox. This is a tcolorbox. This is a tcolorbox. \end{dispExample} \end{docTcbKey} +\clearpage +\begin{docTcbKey}[][doc new=2014-09-22]{height fill}{\colOpt{=true\textbar false}}{default |true|, initially |false|} +If set to |true|, the height of the |tcolorbox| is set to the rest of the +available vertical space of the current page. Note that the |tcolorbox| +is always set as its own paragraph using this option. +This option overrules \refKey{/tcb/natural height}, \refKey{/tcb/height}, etc. +\begin{marker} +Note that the library \mylib{breakable} has to be loaded to use this key! +\end{marker} +This height control key is only applicable to unbreakable boxes but it +uses code from the library \mylib{breakable}. +The counterpart for breakable boxes is \refKey{/tcb/height fixed for}. +\begin{dispListing} +% \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} +\end{dispListing} +\end{docTcbKey} +{\tcbusetemp} -\clearpage +%\clearpage \begin{docTcbKey}{space}{=\meta{fraction}}{no default, initially 0} If the height of a |tcolorbox| is not the natural height, the space difference between the forced and the natural size is distributed @@ -1794,6 +1817,13 @@ This is the lower part. \refKey{/tcb/overlay} overwrites this key. \end{docTcbKey} +\begin{docTcbKey}[][doc new=2014-09-19]{overlay first and middle}{=\meta{graphical code}}{no default, initially unset} + This is an optimized abbreviation for setting + \refKey{/tcb/overlay first} and + \refKey{/tcb/overlay middle} together. + \refKey{/tcb/overlay} overwrites this key. +\end{docTcbKey} + \begin{dispListing*}{breakable,before upper={This example demonstrates the application of break sequence specific overlay options. @@ -1812,7 +1842,6 @@ are drawn by the codes given with %\tcbuselibrary{skins,breakable} %\newcounter{example} \colorlet{colexam}{red!75!black} - \newtcolorbox[use counter=example]{myexample}{% empty,title={Example \thetcbcounter},attach boxed title to top left, boxed title style={empty,size=minimal,toprule=2pt,top=4pt, @@ -1922,6 +1951,24 @@ are drawn by the codes given with \end{docTcbKey} +\begin{docTcbKey}[][doc new=2014-09-19]{every float}{=\meta{code}}{no default, initially empty} + For floating objects, the \refKey{/tcb/before} and \refKey{/tcb/after} + settings are ignored. Instead, the given \meta{code} is inserted before + a floating box. If the box is \refKey{/tcb/breakable}, the given \meta{code} is + inserted before every part of the break sequence. + The most common use case is |every float=\centering|. + +\begin{dispListing} +\tcbox[float=htb,title={Floating box},every float=\centering, + colback=blue!50!black,colframe=blue!50!white,colbacktitle=blue!10!white, + coltitle=black,center title] + {\includegraphics[height=6cm]{lichtspiel.jpg}} +\end{dispListing} +{\tcbset{reset}\tcbusetemp} + +\end{docTcbKey} + + \clearpage \subsection{Side by Side}\label{subsec:sidebyside} \begin{marker} @@ -2363,7 +2410,7 @@ Lorem \tcbox{ipsum} dolor sit amet, consectetuer adipiscing elit. \end{dispExample} \end{docTcbKey} -\begin{docTcbKey}{extrude left by}{=\meta{length}}{style, no default, initially unset} +\begin{docTcbKey}[][doc updated=2014-09-19]{extrude left by}{=\meta{length}}{style, no default, initially unset} The (upper part of the) colored box is extruded by the given \meta{length} to the left side. The inner width and the bounding box is kept unchanged and the operation is additiv! @@ -2379,7 +2426,7 @@ Nam arcu libero, nonummy eget, consectetuer id, vulputate a, magna. \end{dispExample} \end{docTcbKey} -\begin{docTcbKey}{extrude right by}{=\meta{length}}{style, no default, initially unset} +\begin{docTcbKey}[][doc updated=2014-09-19]{extrude right by}{=\meta{length}}{style, no default, initially unset} The (upper part of the) colored box is extruded by the given \meta{length} to the right side. The inner width and the bounding box is kept unchanged and the operation is additiv! @@ -2748,7 +2795,7 @@ Test\dotfill %page \pageref{sec:skincorekeys}. \clearpage -\subsection{Counters, Labels and References} +\subsection{Counters, Labels, and References} \begin{docTcbKey}{phantom}{=\meta{code}}{no default, initially unset} The \meta{code} is put in a box at the upper left corner of the |tcolorbox|. @@ -2826,6 +2873,18 @@ See Section \ref{listing:exercises} from page \pageref{listing:exercises} for a complete example. \end{docTcbKey} +\begin{docTcbKey}[][doc new=2014-09-19]{list text}{=\meta{text}}{style, no default} +This is a shortcut for setting \refKey{/tcb/list entry} to\\ +|\protect\numberline{\thetcbcounter}|\meta{text}. +So, the following settings are identical: +\begin{dispListing} +list text={My beautiful Example}, +list entry={\protect\numberline{\thetcbcounter}My beautiful Example} +\end{dispListing} +See Section \ref{listing:exercises} from page \pageref{listing:exercises} +for a complete example. +\end{docTcbKey} + \begin{docTcbKey}{add to list}{=\marg{list}\marg{type}}{no default, initially unset} If the \flqq list of tcolorbox(es)\frqq\ feature described in Subsection \ref{sec:listsof} from page \pageref{sec:listsof} is used, list entries are |