diff options
author | Karl Berry <karl@freefriends.org> | 2014-02-21 23:12:36 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2014-02-21 23:12:36 +0000 |
commit | 2277d4f5877c4b465f623028c370c2eaf269d879 (patch) | |
tree | f90981da53ebaa83fc786c8c519096dd71e8cc7c /Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.documentation.tex | |
parent | 53cb3d4681fd05c641a0fbbcaa92f8ff62c3b573 (diff) |
tcolorbox (21feb14)
git-svn-id: svn://tug.org/texlive/trunk@33022 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.documentation.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.documentation.tex | 71 |
1 files changed, 58 insertions, 13 deletions
diff --git a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.documentation.tex b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.documentation.tex index 2b6e64f95c3..b1fe8a9d02d 100644 --- a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.documentation.tex +++ b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.documentation.tex @@ -13,8 +13,15 @@ The library is loaded by a package option or inside the preamble by: \tcbuselibrary{documentation} \end{dispListing} This also loads the library \mylib{listings}, see \Vref{sec:listings}, +the library \mylib{skins}, see \Vref{sec:skins}, and a bunch of packages, namely -|doc|, |pifont|, |marvosym|, |hyperref|, |makeidx|, and |refcount|. +|doc|, |pifont|, |marvosym|, |makeidx|, |refcount|, and |hyperref|. + +\begin{marker} +The package |makeidx| is loaded only, if \docAuxCommand*{printindex} is +\emph{not} already defined. Therefore, one can include an alternative to |makeidx| like +|imakeidx| \emph{before} the library |documentation| is used. +\end{marker} For UTF-8 support, load: \begin{dispListing} @@ -29,6 +36,7 @@ For |minted| \cite{rudolph:2011a} support, load: \subsection{Macros of the Library} +\enlargethispage*{15mm} \begin{docEnvironment}[doclang/environment content=command description]{docCommand}{\oarg{options}\marg{name}\marg{parameters}} Documents a \LaTeX\ macro with given \meta{name} where \meta{name} is written without backslash. The given \meta{options} are set with \refCom{tcbset}. @@ -142,21 +150,21 @@ The environment \docAuxEnvironment{fooauxenv} holds some interesting data. \end{dispExample} \end{docCommand} -\begin{docCommand}{docAuxEnvironment*}{\marg{name}} +\begin{docCommand}{docAuxEnvironment*}{\oarg{key path}\marg{name}} Identical to \refCom{docAuxEnvironment}, but without index entry. \end{docCommand} -\begin{docCommand}{docAuxKey}{\marg{name}} - Documents an auxiliary key with given \meta{name} including path. +\begin{docCommand}{docAuxKey}{\oarg{key path}\marg{name}} + Documents an auxiliary key with given \meta{name} and an optional \meta{key path}. It is automatically indexed. \begin{dispExample} -The key \docAuxEnvironment{/foo/fooaux} holds some interesting data. +The key \docAuxKey[foo]{fooaux} holds some interesting data. \end{dispExample} \end{docCommand} -\begin{docCommand}{docAuxKey*}{\marg{name}} +\begin{docCommand}{docAuxKey*}{\oarg{key path}\marg{name}} Identical to \refCom{docAuxKey}, but without index entry. \end{docCommand} @@ -169,7 +177,7 @@ The color \docColor{foocolor} is available. \end{dispExample} \end{docCommand} -\begin{docCommand}{docAuxColor*}{\marg{name}} +\begin{docCommand}{docColor*}{\marg{name}} Identical to \refCom{docColor}, but without index entry. \end{docCommand} @@ -381,7 +389,7 @@ Some pages back, one can see \refAuxcs{fooaux} as an example. % \begin{docCommand}{colDef}{\marg{text}} -Sets \meta{text} with the definition color, see \refKey{/tcb/color definition}. +Sets \meta{text} with the command color, see \refKey{/tcb/color command}. \begin{dispExample} This is my \colDef{text}. \end{dispExample} @@ -438,8 +446,30 @@ This is my \colOpt{text}. Used for \refKey{/tcb/listing engine}|=minted| only. \end{docTcbKey} + +\begin{docTcbKey}{color command}{=\meta{color}}{no default, initially |Definition|} + Sets the highlight color used by macro definitions. +\end{docTcbKey} + +\begin{docTcbKey}{color environment}{=\meta{color}}{no default, initially |Definition|} + Sets the highlight color used by environment definitions. +\end{docTcbKey} + +\begin{docTcbKey}{color key}{=\meta{color}}{no default, initially |Definition|} + Sets the highlight color used by key definitions. +\end{docTcbKey} + +\begin{docTcbKey}{color value}{=\meta{color}}{no default, initially |Definition|} + Sets the highlight color used by value definitions. +\end{docTcbKey} + +\begin{docTcbKey}{color color}{=\meta{color}}{no default, initially |Definition|} + Sets the highlight color used by color definitions. +\end{docTcbKey} + \begin{docTcbKey}{color definition}{=\meta{color}}{no default, initially |Definition|} - Sets the highlight color used by macro and key definitions. + Sets the highlight color for \refKey{/tcb/color command}, \refKey{/tcb/color environment}, + \refKey{/tcb/color key}, \refKey{/tcb/color value}, and \refKey{/tcb/color color}. \end{docTcbKey} \begin{docTcbKey}{color option}{=\meta{color}}{no default, initially |Option|} @@ -474,7 +504,7 @@ This is my \colOpt{text}. \end{itemize} \end{docTcbKey} -\clearpage + \begin{docTcbKey}{index actual}{=\meta{character}}{no default, initially |@|} Sets the character for 'actual' in automatic indexing. \end{docTcbKey} @@ -494,7 +524,7 @@ This is my \colOpt{text}. \refKey{/tcb/index level}. \end{docTcbKey} -%\enlargethispage*{20mm} + \begin{docTcbKey}{index german settings}{}{style, no value} Sets the |makeindex| values recommended for German language texts. This is identical to setting the following: @@ -503,7 +533,19 @@ This is my \colOpt{text}. \end{dispListing} \end{docTcbKey} +\begin{docTcbKey}{index annotate}{\colOpt{=true\textbar false}}{default |true|, initially |true|} + If set to |true|, the index entries are annotated with short descriptions + given by \refKey{/tcb/doclang/environment}, \refKey{/tcb/doclang/key}, + and others. +\end{docTcbKey} + +\begin{docTcbKey}{index colorize}{\colOpt{=true\textbar false}}{default |true|, initially |false|} + If set to |true|, the index entries colorized according to the color + settings given by \refKey{/tcb/color environment}, \refKey{/tcb/color key}, + and others. +\end{docTcbKey} +\clearpage The following keys are provided for language specific settings. The English language is predefined. @@ -535,6 +577,10 @@ The English language is predefined. Text used in the index for keys. \end{langTcbKey} +\begin{langTcbKey}{keys}{=\meta{text}}{no default, initially |Keys|} + Heading text used in the index for keys. +\end{langTcbKey} + \begin{langTcbKey}{value}{=\meta{text}}{no default, initially |value|} Text used in the index for values. \end{langTcbKey} @@ -551,7 +597,6 @@ The English language is predefined. Short text for page references. \end{langTcbKey} - \clearpage \begin{docTcbKey}{doc left}{=\meta{length}}{no default, initially |2em|} Sets the left hand offset of the documentation texts from @@ -586,6 +631,7 @@ The English language is predefined. \end{dispExample} \end{docTcbKey} +\enlargethispage*{10mm} \begin{docTcbKey}{doc right indent}{=\meta{length}}{no default, initially |0pt|} Sets the right hand indent of documentation heads from \refEnv{docCommand}, \refEnv{docEnvironment}, \refEnv{docKey}, etc, to \meta{length}. @@ -670,7 +716,6 @@ hand side if too long. Linebreaks can be used inside the \meta{text}. instead of \refEnv{docCommand}. \end{docTcbKey} -%\clearpage \subsection{Predefined Colors of the Library} |