diff options
author | Karl Berry <karl@freefriends.org> | 2014-01-10 23:26:17 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2014-01-10 23:26:17 +0000 |
commit | 1a6ebf01dcfbaa320337c0dd0242ec7064b21a6b (patch) | |
tree | f89f5681275dbb3222b37f141b32787690b791b5 /Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.coreoptions.tex | |
parent | 200c32dca65937f664a864f70aaede2217c129dc (diff) |
tcolorbox (10jan14)
git-svn-id: svn://tug.org/texlive/trunk@32631 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 | 58 |
1 files changed, 34 insertions, 24 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 8082974f916..7008cbdab9b 100644 --- a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.coreoptions.tex +++ b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.coreoptions.tex @@ -96,9 +96,9 @@ Now, we load the saved text:\\ \end{docTcbKey} \clearpage -\begin{docTcbKey}{lower separated}{\colOpt{=\meta{boolean value}}}{default |true|, initially |true|} +\begin{docTcbKey}{lower separated}{\colOpt{=true\textbar false}}{default |true|, initially |true|} If set to |true|, the lower part is visually separated from the upper part. -It depends from the chosen skin how the visualization of the separation is done. +It depends on the chosen skin how the visualization of the separation is done. \begin{dispExample} % \tcbuselibrary{skins} @@ -213,8 +213,8 @@ This is a \textbf{tcolorbox}. \end{docTcbKey} -\begin{docTcbKey}{title filled}{\colOpt{=\meta{boolean value}}}{default |true|, initially |false|} - Switches the drawing of the title background according to the \meta{boolean value}. +\begin{docTcbKey}{title filled}{\colOpt{=true\textbar false}}{default |true|, initially |false|} + Switches the drawing of the title background according to the given value. This option is set to |true| automatically by \refKey{/tcb/colbacktitle}, \refKey{/tcb/opacitybacktitle}, and \refKey{/tcb/title style}, and \refKey{/tcb/title code}. @@ -689,7 +689,7 @@ This is the lower part. \item |none|: no switching. \item |forced|: the values of the left and right rules and spaces are switched. \item |evenpage|: if the page is an even page, the values of the left and - right rules and spaces are switched. It is recommended to use this setting in + right rules and spaces are switched. It is recommended that one use this setting in conjunction with \refKey{/tcb/check odd page}. \end{itemize} \begin{dispListing} @@ -765,7 +765,7 @@ This is a \textbf{tcolorbox}. \begin{docTcbKey}{opacityfill}{=\meta{fraction}}{style, no default, initially \texttt{1.0}} Sets the fill opacity for frame, interior and optionally the title background - to to the given \meta{fraction}. + to the given \meta{fraction}. \begin{dispExample*}{sbs,lefthand ratio=0.6,segmentation style={pattern=crosshatch dots light steel blue}} \begin{tcolorbox}[standard jigsaw, opacityfill=0.7, title=This is a title] @@ -1095,7 +1095,7 @@ with a listing. \clearpage \subsection{Box Content Additions}\label{subsec:contentadditions} The following options introduce some arbitrary \meta{code} to the content -of a |tcolorbox|. These additions can be given at the begin or at the end +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. \begin{docTcbKey}{before title}{=\meta{code}}{no default, initially unset} @@ -1358,8 +1358,8 @@ One & Two & Three \\\hline\hline \clearpage \begin{docTcbKey}{tikz upper}{\colOpt{=\meta{options}}}{style} - This style adds a centered |tikzpicture| environment to the begin and - to the end of the upper part. + This style adds a centered |tikzpicture| environment to the start and end + of the upper part. \begin{dispExample} % \usepackage{tikz} @@ -1374,8 +1374,8 @@ One & Two & Three \\\hline\hline \end{docTcbKey} \begin{docTcbKey}{tikz lower}{\colOpt{=\meta{options}}}{style} - This style adds a centered |tikzpicture| environment to the begin and - to the end of the lower part. + This style adds a centered |tikzpicture| environment to the start and end + of the lower part. \begin{dispExample} % \usepackage{tikz} % \usetikzlibrary{skins,listings} @@ -1647,7 +1647,7 @@ are drawn by the codes given with \refKey{/tcb/text outside listing}. \end{marker} -\begin{docTcbKey}{sidebyside}{\colOpt{=\meta{boolean value}}}{default |true|, initially |false|} +\begin{docTcbKey}{sidebyside}{\colOpt{=true\textbar false}}{default |true|, initially |false|} Normally, the upper part and the lower part of the box have their positions as their names suggest. If |sidebyside| is set to |true|, the upper part is drawn \emph{left-handed} and the lower part is drawn \emph{right-handed}. @@ -1813,9 +1813,9 @@ This behavior is controlled by the keys |before| and |after|. Tries to detect the usage of the package |parskip| and sets the keys |before| and |after| accordingly. Actually, the following is done: \begin{itemize} - \item If the length of |\parskip| is greater than |0pt| at the begin of the document, + \item If the length of |\parskip| is greater than |0pt| at the beginning of the document, \refKey{/tcb/parskip} is executed. Here, the usage of package |parskip| is \emph{assumed}. - \item Otherwise, if the length of |\parskip| is not greater than |0pt| at the begin of the document, + \item Otherwise, if the length of |\parskip| is not greater than |0pt| at the beginning of the document, \refKey{/tcb/noparskip} is executed. Here, the absence of package |parskip| is \emph{assumed}. \end{itemize} |autoparskip| is the default for the package |tcolorbox|, if |before| or |after| @@ -1978,7 +1978,7 @@ This is a \textbf{tcolorbox}. \item |none|: no switching. \item |forced|: the values of the left and right enlargement are switched. \item |evenpage|: if the page is an even page, the values of the left and - right enlargement are switched. It is recommended to use this setting in + right enlargement are switched. It is recommended that one use this setting in conjunction with \refKey{/tcb/check odd page}. %Note that the page number detection may %fail in certain cases. For these cases, use the |forced| value. @@ -2181,6 +2181,15 @@ It may be changed by redefining this style. % setting all boxes to be enhanced: \tcbset{every box/.style={enhanced}} \end{dispListing} + +\begin{marker} +The alternative for setting something for every box (on every layer) is\\ +\refCom{tcbsetforeverylayer}: +\begin{dispListing} +% setting all boxes to be enhanced: +\tcbsetforeverylayer{enhanced} +\end{dispListing} +\end{marker} \end{docTcbKey} \clearpage @@ -2316,13 +2325,13 @@ This is a tcolorbox. \clearpage \subsection{Text Characteristics} -\begin{docTcbKey}{parbox}{\colOpt{=\meta{boolean value}}}{default |true|, initially |true|} +\begin{docTcbKey}{parbox}{\colOpt{=true\textbar 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 to use this experimental setting only + effects. It is recommended that one use this experimental setting only where you really want to have this feature. \end{docTcbKey} @@ -2343,8 +2352,8 @@ This is a tcolorbox. \clearpage -\begin{docTcbKey}{hyphenationfix}{\colOpt{=\meta{boolean value}}}{default |true|, initially |false|} - Long words at the begin of paragraphs in very narrow boxes +\begin{docTcbKey}{hyphenationfix}{\colOpt{=true\textbar 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. @@ -2407,7 +2416,7 @@ There are additional option keys which change the appearance of a |tcolorbox|. If only the core package is used, there is only one \emph{skin} and these keys are meaningless. The library \mylib{skins} adds more skins. The appropriate option keys for skins of -the core package are therefore described in section \ref{sec:skincorekeys} from +the core package are therefore described in \Vref{sec:skincorekeys} from page \pageref{sec:skincorekeys}. \clearpage @@ -2483,7 +2492,7 @@ If the \flqq list of tcolorbox(es)\frqq\ feature described in Subsection \ref{sec:listsof} from page \pageref{sec:listsof} is used, this key describes the \meta{text} for an entry into the generated list, e.\,g. \begin{dispListing} -list entry={\numberline{\thetcbcounter}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. @@ -2499,7 +2508,7 @@ This issues:\\ \end{docTcbKey} -\begin{docTcbKey}{check odd page}{\colOpt{=\meta{boolean value}}}{default |true|, initially |false|} +\begin{docTcbKey}{check odd page}{\colOpt{=true\textbar false}}{default |true|, initially |false|} If set to |true|, the even/odd page testing from the package |changepage| is applied. The \refKey{/tcb/toggle enlargement} check and the \refKey{/tcb/toggle left and right} check @@ -2553,7 +2562,7 @@ To avoid this, there are two possible strategies: \end{dispListing} \end{itemize} -\begin{docTcbKey}{shield externalize}{\colOpt{=\meta{boolean value}}}{default |true|, initially |false|} +\begin{docTcbKey}{shield externalize}{\colOpt{=true\textbar false}}{default |true|, initially |false|} If set to |true|, the drawing part of the |tcolorbox| is not being externalized which is a good thing at the current state of art. Nevertheless, if the |tcolorbox| contains a |tikzpicture|, this picture is still externalized. @@ -2571,7 +2580,8 @@ do \emph{not} use |\tikzexternaldisable| in front of the |tcolorbox|. \subsection{Miscellaneous} \begin{docTcbKey}{reset}{}{no value, initially set} -Sets (nearly) all |tcolorbox| settings (including loaded libraries) back to their default values. +Sets (nearly) all |tcolorbox| settings (including loaded libraries) back to their default values +\emph{plus} any settings given by \refCom{tcbsetforeverylayer}. \refKey{/tcb/savedelimiter} and \refKey{/tcb/capture} keep their values. This option is useful for boxes in boxes where the inner box should not inherit the settings of the outer box. |