diff options
author | Karl Berry <karl@freefriends.org> | 2013-07-15 22:46:30 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2013-07-15 22:46:30 +0000 |
commit | b927b3c4405faf2fc0c1a8b34e07cc7c5dd5b5e8 (patch) | |
tree | 3f0b50cbbf4621a283f566948a7f04fe91237876 /Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.documentation.tex | |
parent | baf92cd2b6a50c9aaf590f0c88a71532f72667dd (diff) |
tcolorbox (15jul13)
git-svn-id: svn://tug.org/texlive/trunk@31204 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 | 69 |
1 files changed, 58 insertions, 11 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 24e8e35dffd..4d7fa97d35b 100644 --- a/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.documentation.tex +++ b/Master/texmf-dist/doc/latex/tcolorbox/tcolorbox.doc.documentation.tex @@ -14,7 +14,7 @@ The library is loaded by a package option or inside the preamble by: \end{dispListing} This also loads the library 'listings', see section \ref{sec:listings}, and a bunch of packages, namely -|doc|, |pifont|, |marvosym|, |hyperref|, and |makeidx|. +|doc|, |pifont|, |marvosym|, |hyperref|, |makeidx|, and |refcount|. For UTF-8 support, load: \begin{dispListing} @@ -24,9 +24,10 @@ For UTF-8 support, load: \subsection{Macros of the Library} -\begin{docEnvironment}{docCommand}{\marg{name}\marg{parameters}} +\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. This macro takes mandatory or optional \meta{parameters}. + written without backslash. The given \meta{options} are set with \refCom{tcbset}. + This macro takes mandatory or optional \meta{parameters}. It is automatically indexed and can be referenced with \refCom{refCom}\marg{name}. \begin{dispExample} @@ -35,13 +36,21 @@ For UTF-8 support, load: documentation of keys with the given \meta{key path}. \end{docCommand} \end{dispExample} +\begin{dispExample} +\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} +\end{dispExample} \end{docEnvironment} - +\clearpage {\let\xdocEnvironment\docEnvironment \let\endxdocEnvironment\enddocEnvironment -\begin{xdocEnvironment}{docEnvironment}{\marg{name}\marg{parameters}} +\begin{xdocEnvironment}[doclang/environment content=environment description]{docEnvironment}{\oarg{options}\marg{name}\marg{parameters}} Documents a \LaTeX\ environment with given \meta{name}. + The given \meta{options} are set with \refCom{tcbset}. This environment takes mandatory or optional \meta{parameters}. It is automatically indexed and can be referenced with \refCom{refEnv}\marg{name}. @@ -51,10 +60,18 @@ For UTF-8 support, load: rounded corners and, optionally, two parts. \end{docEnvironment} \end{dispExample} +\begin{dispExample} +\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} +\end{dispExample} \end{xdocEnvironment}} -\clearpage -\begin{docEnvironment}{docKey}{\oarg{key path}\marg{name}\marg{parameters}\marg{description}} + +\begin{docEnvironment}[doclang/environment content=key description]{docKey}{\oarg{key path}\marg{name}\marg{parameters}\marg{description}} Documents a key with given \meta{name} and an optional \meta{key path}. This key takes mandatory or optional \meta{parameters} as value with a short \meta{description}. @@ -77,7 +94,7 @@ The macro \docAuxCommand{fooaux} holds some interesting data. \end{dispExample} \end{docCommand} - +\clearpage \begin{docCommand}{docColor}{\marg{name}} Documents a color with given \meta{name}. The color is automatically indexed. \begin{dispExample} @@ -109,7 +126,7 @@ This is a mandatory \marg{argument}. \end{dispExample} \end{docCommand} -\clearpage + \begin{docCommand}{oarg}{\marg{text}} Macro from |ltxdoc| \cite{carlisle:2007a} to typeset a \meta{text} with square brackets as an optional argument. The library overwrites the original macro. @@ -126,7 +143,7 @@ This is an optional \oarg{argument}. \end{dispExample} \end{docCommand} - +\clearpage {\let\xdispExample\dispExample \let\endxdispExample\enddispExample @@ -214,27 +231,57 @@ Some key. \begin{docCommand}{refCom}{\marg{name}} References a documented \LaTeX\ macro with given \meta{name} where \meta{name} is - written without backslash. + written without backslash. The page reference is suppressed if it links + to the same page. \begin{dispExample} We have created \refCom{foomakedocSubKey} as an example. \end{dispExample} \end{docCommand} +\begin{docCommand}{refCom*}{\marg{name}} + References a documented \LaTeX\ macro with given \meta{name} where \meta{name} is + written without backslash. There is no page reference. +\begin{dispExample} +We have created \refCom*{foomakedocSubKey} as an example. +\end{dispExample} +\end{docCommand} + + \begin{docCommand}{refEnv}{\marg{name}} References a documented \LaTeX\ environment with given \meta{name}. + The page reference is suppressed if it links to the same page. \begin{dispExample} We have created \refEnv{foocolorbox} as an example. \end{dispExample} \end{docCommand} +\begin{docCommand}{refEnv*}{\marg{name}} + References a documented \LaTeX\ environment with given \meta{name}. + There is no page reference. +\begin{dispExample} +We have created \refEnv*{foocolorbox} as an example. +\end{dispExample} +\end{docCommand} + +\clearpage \begin{docCommand}{refKey}{\marg{name}} References a documented key with given \meta{name} where \meta{name} is the full path name of the key. + The page reference is suppressed if it links to the same page. \begin{dispExample} We have created \refKey{/foo/footitle} as an example. \end{dispExample} \end{docCommand} +\begin{docCommand}{refKey*}{\marg{name}} + References a documented key with given \meta{name} where \meta{name} + is the full path name of the key. + There is no page reference. +\begin{dispExample} +We have created \refKey*{/foo/footitle} as an example. +\end{dispExample} +\end{docCommand} + % \begin{docCommand}{colDef}{\marg{text}} Sets \meta{text} with the definition color, see \refKey{/tcb/color definition}. |