summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/tkz/pgfornament/doc/usefulcommands.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/tkz/pgfornament/doc/usefulcommands.tex')
-rw-r--r--macros/latex/contrib/tkz/pgfornament/doc/usefulcommands.tex109
1 files changed, 109 insertions, 0 deletions
diff --git a/macros/latex/contrib/tkz/pgfornament/doc/usefulcommands.tex b/macros/latex/contrib/tkz/pgfornament/doc/usefulcommands.tex
new file mode 100644
index 0000000000..4af2421923
--- /dev/null
+++ b/macros/latex/contrib/tkz/pgfornament/doc/usefulcommands.tex
@@ -0,0 +1,109 @@
+\makeatletter
+\AddToShipoutPicture{%
+\begingroup
+\setlength{\@tempdima}{2mm}%
+\setlength{\@tempdimb}{\paperwidth-\@tempdima-1cm}%
+\setlength{\@tempdimc}{\paperheight-\@tempdima}%
+\put(\LenToUnit{\@tempdima},\LenToUnit{\@tempdimc}){%
+ \pgfornament[color=Maroon,anchor=north west,width=1cm]{39}}
+\put(\LenToUnit{\@tempdima},\LenToUnit{\@tempdima}){%
+ \pgfornament[color=Maroon,anchor=south west,width=1cm,symmetry=h]{39}}
+\put(\LenToUnit{\@tempdimb},\LenToUnit{\@tempdimc}){%
+ \pgfornament[color=Maroon,anchor=north east,width=1cm,symmetry=v]{39}}
+\put(\LenToUnit{\@tempdimb},\LenToUnit{\@tempdima}){%
+ \pgfornament[color=Maroon,anchor=south east,width=1cm,symmetry=c]{39}}
+\endgroup
+}
+\let\strippt\strip@pt
+\makeatother
+
+\newcommand{\eachpageornament}{%
+\begin{picture}(0,0)
+\put(0,0){\pgfornament[width=1cm]{41}};
+\put(\strippt\textwidth,0){\pgfornament[width=1cm,symmetry=v]{41}};
+\put(0,-\strippt\textheight){\pgfornament[width=1cm,symmetry=h]{41}};
+\put(\strippt\textwidth,-\strippt\textheight){\pgfornament[width=1cm,symmetry=c]{41}}; %
+\end{picture}}
+
+
+% Standardize command font styles and environments
+\newcommand{\docparen}[1]{\ensuremath{(#1)}}% optional command argument
+\definecolor{fondpaille}{cmyk}{0,0,0.1,0}
+\pagecolor{fondpaille}
+\color{Maroon}
+\colorlet{graphicbackground}{fondpaille}
+\colorlet{numbackground}{fondpaille}
+\colorlet{codebackground}{Periwinkle!10}
+\colorlet{codeonlybackground}{Periwinkle!10}
+\colorlet{textcodecolor}{MidnightBlue} % Maroon
+\colorlet{numcolor}{gray}
+\newcommand*{\tkzname}[1]{\textbf{\texttt{\textcolor{Maroon}{#1}}}}
+\newcommand*{\PGF}{\tkzname{PGF}}
+\newcommand*{\TIKZ}{\tkzname{Ti\emph{k}Z}}
+\newcommand*{\pdf}{\textsc{pdf}}
+\newcommand*{\pgfname}{\textsc{pgf}}
+\newcommand*{\tikzname}{Ti\emph{k}Z}
+\newcommand*{\pstricks}{\textsc{pstricks}} %
+\newcommand*{\tkzAttention}[3]{\ \\\llap{\textcolor{#3}{#1\hskip #2}}}
+\newcommand*{\tkzHand}{\ \\\llap{\textcolor{red}{\lefthand\hskip1em}}}
+\newcommand*{\tkzHandBomb}{\ \\\llap{\textcolor{red}{\lefthand\ \bomb\hskip1em}}}
+\newcommand*{\tkzBomb}{\ \\\llap{\textcolor{red}{\bomb\hskip1em}}}
+\newcommand*{\tkzTwoBomb}{\ \\\llap{\textcolor{red}{\bomb\ \bomb\hskip1em}}}
+\newcommand*{\tkzimp}[1]{\textbf{#1}}
+\newcommand*{\tkzcname}[1]{\textbf{\texttt{\textcolor{Maroon}{\textbackslash#1}}}}
+\newcommand*{\tkzhname}[1]{\textbf{\texttt{\textcolor{Maroon}{\textbackslash#1}}}}
+% Macros for typesetting the documentation
+\newcommand{\hlred}[1]{\textcolor{Maroon}{#1}}% prints in red
+\newcommand{\hangleft}[1]{\makebox[0pt][r]{#1}}
+\newcommand{\hairsp}{\hspace{1pt}}% hair space
+\newcommand{\hquad}{\hskip0.5em\relax}% half quad space
+\newcommand{\TODO}{\textcolor{red}{\bf TODO!}\xspace}
+\newcommand{\tuftebs}{\symbol{'134}}% a backslash in tt type in OT1/T1
+\newcommand{\doccmdnoindex}[2][]{\texttt{\tuftebs#2}}% command name -- adds backslash automatically (and doesn't add cmd to the index)
+\newcommand{\doccmddef}[2][]{%
+ \hlred{\texttt{\tuftebs#2}}\label{cmd:#2}%
+ \ifthenelse{\isempty{#1}}%
+ {% add the command to the index
+ \index{#2 command@\protect\hangleft{\texttt{\tuftebs}}\texttt{#2}}% command name
+ }%
+ {% add the command and package to the index
+ \index{#2 command@\protect\hangleft{\texttt{\tuftebs}}\texttt{#2} (\texttt{#1} package)}% command name
+ \index{#1 package@\texttt{#1} package}\index{packages!#1@\texttt{#1}}% package name
+ }%
+}% command name -- adds backslash automatically
+
+\newcommand{\doccmd}[2][]{%
+ \texttt{\tuftebs#2}%
+ \ifthenelse{\isempty{#1}}%
+ {% add the command to the index
+ \index{#2 command@\protect\hangleft{\texttt{\tuftebs}}\texttt{#2}}% command name
+ }%
+ {% add the command and package to the index
+ \index{#2 command@\protect\hangleft{\texttt{\tuftebs}}\texttt{#2} (\texttt{#1} package)}% command name
+ \index{#1 package@\texttt{#1} package}\index{packages!#1@\texttt{#1}}% package name
+ }%
+}% command name -- adds backslash automatically
+\newcommand{\docopt}[1]{\ensuremath{\protect\langle}\textrm{\textit{#1}}\ensuremath{\protect\rangle}}% optional command argument
+\newcommand{\docarg}[1]{\textrm{\textit{#1}}}% (required) command argument
+\newenvironment{docspec}{\begin{quotation}\ttfamily\parskip0pt\parindent0pt\ignorespaces}{\end{quotation}}% command specification environment
+\newcommand{\docdist}[1]{\texttt{#1}\index{#1 distribution@\texttt{#1} distribution}\index{distributions!#1@\texttt{#1}}}% environment name
+\newcommand{\docenv}[1]{\texttt{#1}\index{#1 environment@\texttt{#1} environment}\index{environments!#1@\texttt{#1}}}% environment name
+\newcommand{\docenvdef}[1]{\hlred{\texttt{#1}}\label{env:#1}\index{#1 environment@\texttt{#1} environment}\index{environments!#1@\texttt{#1}}}% environment name
+\newcommand{\docoption}[2]{\texttt{#1}\index{#1 option@\texttt{#1} option}\index{options(#2)!#1@\texttt{#1}}}% package name
+\newcommand{\docpkg}[1]{\texttt{#1}\index{#1 package@\texttt{#1} package}\index{packages!#1@\texttt{#1}}}% package name
+\newcommand{\doclib}[1]{\texttt{#1}\index{#1 tikz library@\texttt{#1} library}\index{library!#1@\texttt{#1}}}% libray name
+\newcommand{\doccls}[1]{\texttt{#1}}% document class name
+\newcommand{\docclsopt}[1]{\texttt{#1}\index{#1 class option@\texttt{#1} class option}\index{class options!#1@\texttt{#1}}}% document class option name
+\newcommand{\docclsoptdef}[1]{\hlred{\texttt{#1}}\label{clsopt:#1}\index{#1 class option@\texttt{#1} class option}\index{class options!#1@\texttt{#1}}}% document class option name defined
+\newcommand{\docmsg}[2]{\bigskip\begin{fullwidth}
+\noindent\ttfamily#1\end{fullwidth}\medskip\par\noindent#2}
+\newcommand{\docfilehook}[2]{\texttt{#1}\index{file hooks!#2}\index{#1@\texttt{#1}}}
+\newcommand{\doccounter}[1]{\texttt{#1}\index{#1 counter@\texttt{#1} counter}}
+\newcommand{\docStyle}[1]{\texttt{#1}\index{#1 style(\TIKZ)@\texttt{#1} style(\TIKZ)}\index{styles(\TIKZ)!#1@\texttt{#1}}}% package name
+\newcommand*{\Imacro}[1]{\index{#1_1@\texttt{\textbackslash#1}}}%n
+\newcommand{\docfamily}[1]{\texttt{#1}\index{#1 family@\texttt{#1} family}\index{families!#1@\texttt{#1}}}% package name
+\newcommand{\docvo}[1]{\texttt{#1}\index{#1 vector ornament@\texttt{#1} vector ornament}\index{vector ornaments!#1@\texttt{#1}}}% package name
+%
+
+
+\endinput \ No newline at end of file