diff options
Diffstat (limited to 'Master/texmf-dist')
| -rw-r--r-- | Master/texmf-dist/doc/latex/tikz-ladder/README.txt | 34 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/tikz-ladder/pgfmanual-en-macros.tex | 1760 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/tikz-ladder/tikz-ladder-doc.pdf | bin | 0 -> 335569 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/tikz-ladder/tikz-ladder-doc.tex | 716 | ||||
| -rw-r--r-- | Master/texmf-dist/tex/latex/tikz-ladder/tikzlibraryladder.code.tex | 580 |
5 files changed, 3090 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/tikz-ladder/README.txt b/Master/texmf-dist/doc/latex/tikz-ladder/README.txt new file mode 100644 index 00000000000..9995fe0ce29 --- /dev/null +++ b/Master/texmf-dist/doc/latex/tikz-ladder/README.txt @@ -0,0 +1,34 @@ +Copyright (C) 2018 by Luis Paulo Laus, <laus@utfpr.edu.br> +------------------------------------------------------------ + +The tikz-ladder package may be distributed and/or modified +under the conditions of the LaTeX Project Public License, +either version 1 of this license or (at your option) any later +version. The latest version of this license is in: + http://www.latex-project.org/lppl.txt and version 1 or +later is part of all distributions of LaTeX version 1999/12/01 +or later. + + Version 1 of 10 January 2018 + +------------------------------------------------------------ + +Ladder diagram (LD) is a graphical programming language +that has evolved from electrical wiring diagrams for relay +control systems used with programmable controllers (PLC) +as described in the international standard IEC-61131-3. A +LD program enables the programmable controller to test +and modify data by means of standardized graphic symbols. +These symbols are laid out in networks in a manner similar +to a ``rung'' of a relay ladder logic diagram. This library +provides TikZ symbols to draw high quality ladder diagrams. +All standard and some non-standard symbols are possible, +including all kids of contacts, coils and blocks. I decided +to write this package, despite of the fact that there is +available another package named `ladder' that also uses TikZ +to typeset ladder diagrams, because that package seems to +lack support for blocks. The tikz-ladder, on the contrary, +supports all features described in IEC-61131-3, namely, +blocks (for functions and function blocks), contacts and coils. + +------------------------------------------------------------
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/tikz-ladder/pgfmanual-en-macros.tex b/Master/texmf-dist/doc/latex/tikz-ladder/pgfmanual-en-macros.tex new file mode 100644 index 00000000000..9217305dd75 --- /dev/null +++ b/Master/texmf-dist/doc/latex/tikz-ladder/pgfmanual-en-macros.tex @@ -0,0 +1,1760 @@ +% Copyright 2006 by Till Tantau +% +% This file may be distributed and/or modified +% +% 1. under the LaTeX Project Public License and/or +% 2. under the GNU Free Documentation License. +% +% See the file doc/generic/pgf/licenses/LICENSE for more details. + +% $Header: /cvsroot/pgf/pgf/doc/generic/pgf/macros/pgfmanual-en-macros.tex,v 1.81 2014/03/20 10:07:44 tantau Exp $ + + +\providecommand\href[2]{\texttt{#1}} +\providecommand\hypertarget[2]{\texttt{#1}} +\providecommand\hyperlink[2]{\texttt{#1}} + + +\colorlet{examplefill}{yellow!80!black} +\definecolor{graphicbackground}{rgb}{0.96,0.96,0.8} +\definecolor{codebackground}{rgb}{0.9,0.9,1} + +\newenvironment{pgfmanualentry}{\list{}{\leftmargin=2em\itemindent-\leftmargin\def\makelabel##1{\hss##1}}}{\endlist} +\newcommand\pgfmanualentryheadline[1]{\itemsep=0pt\parskip=0pt{\raggedright\item\strut{#1}\par}\topsep=0pt} +\newcommand\pgfmanualbody{\parskip3pt} + +\let\origtexttt=\texttt +\def\texttt#1{{\def\textunderscore{\char`\_}\def\textbraceleft{\char`\{}\def\textbraceright{\char`\}}\origtexttt{#1}}} +\def\exclamationmarktext{!} +\def\atmarktext{@} + +{ + \catcode`\|=12 + \gdef\pgfmanualnormalbar{|} + \catcode`\|=13 + \AtBeginDocument{\gdef|{\ifmmode\pgfmanualnormalbar\else\expandafter\verb\expandafter|\fi}} +} + + + +\newenvironment{pgflayout}[1]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{% + \pgfmanualpdflabel{#1}{}% + \texttt{\string\pgfpagesuselayout\char`\{\declare{#1}\char`\}}\oarg{options}% + } + \index{#1@\protect\texttt{#1} layout}% + \index{Page layouts!#1@\protect\texttt{#1}}% + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + + +\newenvironment{command}[1]{ + \begin{pgfmanualentry} + \extractcommand#1\@@ + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\makeatletter + +\def\includeluadocumentationof#1{ + \directlua{require 'pgf.manual.DocumentParser'} + \directlua{pgf.manual.DocumentParser.include '#1'} +} + +\newenvironment{luageneric}[4]{ + \pgfmanualentry + \pgfmanualentryheadline{#4 \texttt{#1\declare{#2}}#3} + \index{#2@\protect\texttt{#2} (Lua)}% + \def\temp{#1} + \ifx\temp\pgfutil@empty\else + \index{#1@\protect\texttt{#1}!#2@\protect\texttt{#2} (Lua)}% + \fi + \pgfmanualbody +}{\endpgfmanualentry} + +\newenvironment{luatable}[3]{ + \medskip + \luageneric{#1}{#2}{ (declared in \texttt{#3})}{\textbf{Lua table}} +}{\endluageneric} + +\newenvironment{luafield}[1]{ + \pgfmanualentry + \pgfmanualentryheadline{Field \texttt{\declare{#1}}} + \pgfmanualbody +}{\endpgfmanualentry} + + +\newenvironment{lualibrary}[1]{ + \pgfmanualentry + \pgfmanualentryheadline{% + \pgfmanualpdflabel{#1}{}% + \textbf{Graph Drawing Library} \texttt{\declare{#1}}% + } + \index{#1@\protect\texttt{#1} graph drawing library}% + \index{Libraries!#1@\protect\texttt{#1}}% + \index{Graph drawing libraries!#1@\protect\texttt{#1}}% + \vskip.25em + {\ttfamily\char`\\usegdlibrary\char`\{\declare{#1}\char`\}\space\space \char`\%\space\space \LaTeX\space and plain \TeX}\\ + {\ttfamily\char`\\usegdlibrary[\declare{#1}]\space \char`\%\space\space Con\TeX t}\smallskip\par + \pgfmanualbody +}{\endpgfmanualentry} + +\newenvironment{luadeclare}[4]{ + \pgfmanualentry + \def\manual@temp@default{#3}% + \def\manual@temp@initial{#4}% + \def\manual@temp@{#3#4}% + \pgfmanualentryheadline{% + \pgfmanualpdflabel{#1}{}% + {\ttfamily/graph + drawing/\declare{#1}\opt{=}}\opt{#2}\hfill% + \ifx\manual@temp@\pgfutil@empty\else% + (\ifx\manual@temp@default\pgfutil@empty\else% + default {\ttfamily #3}\ifx\manual@temp@initial\pgfutil@empty\else, \fi% + \fi% + \ifx\manual@temp@initial\pgfutil@empty\else% + initially {\ttfamily #4}% + \fi% + )\fi% + }% + \index{#1@\protect\texttt{#1} key}% + \pgfmanualbody + \gdef\myname{#1}% +% \keyalias{tikz} +% \keyalias{tikz/graphs} +}{\endpgfmanualentry} + +\newenvironment{luadeclarestyle}[4]{ + \pgfmanualentry + \def\manual@temp@para{#2}% + \def\manual@temp@default{#3}% + \def\manual@temp@initial{#4}% + \def\manual@temp@{#3#4}% + \pgfmanualentryheadline{% + \pgfmanualpdflabel{#1}{}% + {\ttfamily/graph drawing/\declare{#1}}\ifx\manual@temp@para\pgfutil@empty\else\opt{\texttt=}\opt{#2}\fi\hfill% + (style\ifx\manual@temp@\pgfutil@empty\else, % + \ifx\manual@temp@default\pgfutil@empty\else% + default {\ttfamily #3}\ifx\manual@temp@initial\pgfutil@empty\else, \fi% + \fi% + \ifx\manual@temp@initial\pgfutil@empty\else% + initially {\ttfamily #4}% + \fi% + \fi)% + }% + \index{#1@\protect\texttt{#1} key}% + \pgfmanualbody% + \gdef\myname{#1}% +% \keyalias{tikz} +% \keyalias{tikz/graphs} +}{\endpgfmanualentry} + +\newenvironment{luanamespace}[2]{ + \luageneric{#1}{#2}{}{\textbf{Lua namespace}} +}{\endluageneric} + +\newenvironment{luafiledescription}[1]{}{} + +\newenvironment{luacommand}[4]{ + \hypertarget{pgf/lua/#1}{\luageneric{#2}{#3}{\texttt{(#4)}}{\texttt{function}}} +}{\endluageneric} + +\newenvironment{luaparameters}{\par\emph{Parameters:}% + \parametercount=0\relax% + \let\item=\parameteritem% + \let\list=\restorelist% +} +{\par +} + +\newenvironment{luareturns}{\par\emph{Returns:}% + \parametercount=0\relax% + \let\item=\parameteritem% + \let\list=\restorelist% +} +{\par +} + +\newcount\parametercount + +\newenvironment{parameterdescription}{\unskip% + \parametercount=0\relax% + \let\item=\parameteritem% + \let\list=\restorelist% +} +{\par +} +\let\saveditemcommand=\item +\let\savedlistcommand=\list +\def\denselist#1#2{\savedlistcommand{#1}{#2}\parskip0pt\itemsep0pt} +\def\restorelist{\let\item=\saveditemcommand\denselist} +\def\parameteritem{\pgfutil@ifnextchar[\parameteritem@{}}%} +\def\parameteritem@[#1]{\advance\parametercount by1\relax\hskip0.15em plus 1em\emph{\the\parametercount.}\kern1ex\def\test{#1}\ifx\test\pgfutil@empty\else#1\kern.5em\fi} + +\newenvironment{commandlist}[1]{% + \begin{pgfmanualentry} + \foreach \xx in {#1} {% + \expandafter\extractcommand\xx\@@ + }% + \pgfmanualbody +}{% + \end{pgfmanualentry} +}% + +% \begin{internallist}[register]{\pgf@xa} +% \end{internallist} +% +% \begin{internallist}[register]{\pgf@xa,\pgf@xb} +% \end{internallist} +\newenvironment{internallist}[2][register]{% + \begin{pgfmanualentry} + \foreach \xx in {#2} {% + \expandafter\extractinternalcommand\expandafter{\xx}{#1}% + }% + \pgfmanualbody +}{% + \end{pgfmanualentry} +}% +\def\extractinternalcommand#1#2{% + \removeats{#1}% + \pgfmanualentryheadline{% + \pgfmanualpdflabel{\textbackslash\strippedat}{}% + Internal #2 \declare{\texttt{\string#1}}}% + \index{Internals!\strippedat @\protect\myprintocmmand{\strippedat}}% + \index{\strippedat @\protect\myprintocmmand{\strippedat}}% +} + +%% MW: START MATH MACROS +\def\mvar#1{{\ifmmode\textrm{\textit{#1}}\else\rmfamily\textit{#1}\fi}} + +\makeatletter + +\def\extractmathfunctionname#1{\extractmathfunctionname@#1(,)\tmpa\tmpb} +\def\extractmathfunctionname@#1(#2)#3\tmpb{\def\mathname{#1}} + +\makeatother + +\newenvironment{math-function}[1]{ + \def\mathdefaultname{#1} + \extractmathfunctionname{#1} + \edef\mathurl{{math:\mathname}}\expandafter\hypertarget\expandafter{\mathurl}{}% + \begin{pgfmanualentry} + \pgfmanualentryheadline{\texttt{#1}}% + \index{\mathname @\protect\texttt{\mathname} math function}% + \index{Math functions!\mathname @\protect\texttt{\mathname}}% + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\def\pgfmanualemptytext{} +\def\pgfmanualvbarvbar{\char`\|\char`\|} + +\newenvironment{math-operator}[4][]{% + \begin{pgfmanualentry} + \csname math#3operator\endcsname{#2}{#4} + \def\mathtest{#4}% + \ifx\mathtest\pgfmanualemptytext% + \def\mathtype{(#3 operator)} + \else% + \def\mathtype{(#3 operator; uses the \texttt{#4} function)} + \fi% + \pgfmanualentryheadline{\mathexample\hfill\mathtype}% + \def\mathtest{#1}% + \ifx\mathtest\pgfmanualemptytext% + \index{#2@\protect\texttt{#2} #3 math operator}% + \index{Math operators!#2@\protect\texttt{#2}}% + \fi% + \pgfmanualbody +} +{\end{pgfmanualentry}} + +\newenvironment{math-operators}[5][]{% + \begin{pgfmanualentry} + \csname math#4operator\endcsname{#2}{#3} + \def\mathtest{#5}% + \ifx\mathtest\pgfmanualemptytext% + \def\mathtype{(#4 operators)} + \else% + \def\mathtype{(#4 operators; use the \texttt{#5} function)} + \fi% + \pgfmanualentryheadline{\mathexample\hfill\mathtype}% + \def\mathtest{#1}% + \ifx\mathtest\pgfmanualemptytext% + \index{#2#3@\protect\texttt{#2\protect\ #3} #4 math operators}% + \index{Math operators!#2#3@\protect\texttt{#2\protect\ #3}}% + \fi% + \pgfmanualbody +} +{\end{pgfmanualentry}} + +\def\mathinfixoperator#1#2{% + \def\mathoperator{\texttt{#1}}% + \def\mathexample{\mvar{x}\space\texttt{#1}\space\mvar{y}}% +} + +\def\mathprefixoperator#1#2{% + \def\mathoperator{\texttt{#1}}% + \def\mathexample{\texttt{#1}\mvar{x}}% +} + +\def\mathpostfixoperator#1#2{% + \def\mathoperator{\texttt{#1}} + \def\mathexample{\mvar{x}\texttt{#1}}% +} + +\def\mathgroupoperator#1#2{% + \def\mathoperator{\texttt{#1\ #2}}% + \def\mathexample{\texttt{#1}\mvar{x}\texttt{#2}}% +} + +\expandafter\let\csname matharray accessoperator\endcsname=\mathgroupoperator +\expandafter\let\csname matharrayoperator\endcsname=\mathgroupoperator + +\def\mathconditionaloperator#1#2{% + \def\mathoperator{#1\space#2} + \def\mathexample{\mvar{x}\ \texttt{#1}\ \mvar{y}\ {\texttt{#2}}\ \mvar{z}} +} + +\newcommand\mathcommand[1][\mathdefaultname]{% + \expandafter\makemathcommand#1(\empty)\stop% + \expandafter\extractcommand\mathcommandname\@@% + \medskip +} +\makeatletter + +\def\makemathcommand#1(#2)#3\stop{% + \expandafter\def\expandafter\mathcommandname\expandafter{\csname pgfmath#1\endcsname}% + \ifx#2\empty% + \else% + \@makemathcommand#2,\stop, + \fi} +\def\@makemathcommand#1,{% + \ifx#1\stop% + \else% + \expandafter\def\expandafter\mathcommandname\expandafter{\mathcommandname{\ttfamily\char`\{#1\char`\}}}% + \expandafter\@makemathcommand% + \fi} +\makeatother + +\def\calcname{\textsc{calc}} + +\newenvironment{math-keyword}[1]{ + \extracttikzmathkeyword#1@ + \begin{pgfmanualentry} + \pgfmanualentryheadline{\texttt{\color{red}\mathname}\mathrest}% + \index{\mathname @\protect\texttt{\mathname} tikz math function}% + \index{TikZ math functions!\mathname @\protect\texttt{\mathname}}% + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\def\extracttikzmathkeyword#1#2@{% + \def\mathname{#1}% + \def\mathrest{#2}% +} + +%% MW: END MATH MACROS + + +\def\extractcommand#1#2\@@{% + \removeats{#1}% + \pgfmanualentryheadline{% + \pgfmanualpdflabel{\textbackslash\strippedat}{}% + \declare{\texttt{\string#1}}#2% + }% + \index{\strippedat @\protect\myprintocmmand{\strippedat}} +} + +\def\luaextractcommand#1#2\relax{% + \declare{\texttt{\string#1}}#2\par% +% \removeats{#1}% + % \index{\strippedat @\protect\myprintocmmand{\strippedat}} + % \pgfmanualpdflabel{\textbackslash\strippedat}{}% +} + + +% \begin{environment}{{name}\marg{arguments}} +\renewenvironment{environment}[1]{ + \begin{pgfmanualentry} + \extractenvironement#1\@@ + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\def\extractenvironement#1#2\@@{% + \pgfmanualentryheadline{% + \pgfmanualpdflabel{#1}{}% + {\ttfamily\char`\\begin\char`\{\declare{#1}\char`\}}#2% + }% + \pgfmanualentryheadline{{\ttfamily\ \ }\meta{environment contents}}% + \pgfmanualentryheadline{{\ttfamily\char`\\end\char`\{\declare{#1}\char`\}}}% + \index{#1@\protect\texttt{#1} environment}% + \index{Environments!#1@\protect\texttt{#1}} +} + + +\newenvironment{plainenvironment}[1]{ + \begin{pgfmanualentry} + \extractplainenvironement#1\@@ + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\def\extractplainenvironement#1#2\@@{% + \pgfmanualentryheadline{{\ttfamily\declare{\char`\\#1}}#2}% + \pgfmanualentryheadline{{\ttfamily\ \ }\meta{environment contents}}% + \pgfmanualentryheadline{{\ttfamily\declare{\char`\\end#1}}}% + \index{#1@\protect\texttt{#1} environment}% + \index{Environments!#1@\protect\texttt{#1}}% +} + + +\newenvironment{contextenvironment}[1]{ + \begin{pgfmanualentry} + \extractcontextenvironement#1\@@ + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\def\extractcontextenvironement#1#2\@@{% + \pgfmanualentryheadline{{\ttfamily\declare{\char`\\start#1}}#2}% + \pgfmanualentryheadline{{\ttfamily\ \ }\meta{environment contents}}% + \pgfmanualentryheadline{{\ttfamily\declare{\char`\\stop#1}}}% + \index{#1@\protect\texttt{#1} environment}% + \index{Environments!#1@\protect\texttt{#1}}} + + +\newenvironment{shape}[1]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{% + \pgfmanualpdflabel{#1}{}% + \textbf{Shape} {\ttfamily\declare{#1}}% + }% + \index{#1@\protect\texttt{#1} shape}% + \index{Shapes!#1@\protect\texttt{#1}} + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\newenvironment{pictype}[2]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{% + \pgfmanualpdflabel{#1}{}% + \textbf{Pic type} {\ttfamily\declare{#1}#2}% + }% + \index{#1@\protect\texttt{#1} pic type}% + \index{Pic Types!#1@\protect\texttt{#1}} + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\newenvironment{shading}[1]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{% + \pgfmanualpdflabel{#1}{}% + \textbf{Shading} {\ttfamily\declare{#1}}}% + \index{#1@\protect\texttt{#1} shading}% + \index{Shadings!#1@\protect\texttt{#1}} + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + + +\newenvironment{graph}[1]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{% + \pgfmanualpdflabel{#1}{}% + \textbf{Graph} {\ttfamily\declare{#1}}}% + \index{#1@\protect\texttt{#1} graph}% + \index{Graphs!#1@\protect\texttt{#1}} + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\newenvironment{gdalgorithm}[2]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{% + \pgfmanualpdflabel{#1}{}% + \textbf{Layout} {\ttfamily/graph drawing/\declare{#1}\opt{=}}\opt{\meta{options}}}% + \index{#1@\protect\texttt{#1} layout}% + \index{Layouts!#1@\protect\texttt{#1}}% + \foreach \algo in {#2} + {\edef\marshal{\noexpand\index{#2@\noexpand\protect\noexpand\texttt{#2} algorithm}}\marshal}% + \index{Graph drawing layouts!#1@\protect\texttt{#1}} + \item{\small alias {\ttfamily/tikz/#1}}\par + \item{\small alias {\ttfamily/tikz/graphs/#1}}\par + \item{\small Employs {\ttfamily algorithm=#2}}\par + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\newenvironment{dataformat}[1]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{% + \pgfmanualpdflabel{#1}{}% + \textbf{Format} {\ttfamily\declare{#1}}}% + \index{#1@\protect\texttt{#1} format}% + \index{Formats!#1@\protect\texttt{#1}} + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\newenvironment{stylesheet}[1]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{% + \pgfmanualpdflabel{#1}{}% + \textbf{Style sheet} {\ttfamily\declare{#1}}}% + \index{#1@\protect\texttt{#1} style sheet}% + \index{Style sheets!#1@\protect\texttt{#1}} + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\newenvironment{handler}[1]{ + \begin{pgfmanualentry} + \extracthandler#1\@nil% + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\def\gobble#1{} +\def\extracthandler#1#2\@nil{% + \pgfmanualentryheadline{% + \pgfmanualpdflabel{/handlers/#1}{}% + \textbf{Key handler} \meta{key}{\ttfamily/\declare{#1}}#2}% + \index{\gobble#1@\protect\texttt{#1} handler}% + \index{Key handlers!#1@\protect\texttt{#1}} +} + + +\makeatletter + + +\newenvironment{stylekey}[1]{ + \begin{pgfmanualentry} + \def\extrakeytext{style, } + \extractkey#1\@nil% + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\def\choicesep{$\vert$}% +\def\choicearg#1{\texttt{#1}} + +\newif\iffirstchoice + +% \mchoice{choice1,choice2,choice3} +\newcommand\mchoice[1]{% + \begingroup + \firstchoicetrue + \foreach \mchoice@ in {#1} {% + \iffirstchoice + \global\firstchoicefalse + \else + \choicesep + \fi + \choicearg{\mchoice@}% + }% + \endgroup +}% + +% \begin{key}{/path/x=value} +% \begin{key}{/path/x=value (initially XXX)} +% \begin{key}{/path/x=value (default XXX)} +\newenvironment{key}[1]{ + \begin{pgfmanualentry} + \def\extrakeytext{} + %\def\altpath{\emph{\color{gray}or}}% + \extractkey#1\@nil% + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +% \insertpathifneeded{a key}{/pgf} -> assign mykey={/pgf/a key} +% \insertpathifneeded{/tikz/a key}{/pgf} -> assign mykey={/tikz/a key} +% +% #1: the key +% #2: a default path (or empty) +\def\insertpathifneeded#1#2{% + \def\insertpathifneeded@@{#2}% + \ifx\insertpathifneeded@@\empty + \def\mykey{#1}% + \else + \insertpathifneeded@#2\@nil + \ifpgfutil@in@ + \def\mykey{#2/#1}% + \else + \def\mykey{#1}% + \fi + \fi +}% +\def\insertpathifneeded@#1#2\@nil{% + \def\insertpathifneeded@@{#1}% + \def\insertpathifneeded@@@{/}% + \ifx\insertpathifneeded@@\insertpathifneeded@@@ + \pgfutil@in@true + \else + \pgfutil@in@false + \fi +}% + +% \begin{keylist}[default path] +% {/path/option 1=value,/path/option 2=value2} +% \end{keylist} +\newenvironment{keylist}[2][]{% + \begin{pgfmanualentry} + \def\extrakeytext{}% + \foreach \xx in {#2} {% + \expandafter\insertpathifneeded\expandafter{\xx}{#1}% + \expandafter\extractkey\mykey\@nil% + }% + \pgfmanualbody +}{% + \end{pgfmanualentry} +}% + +\def\extractkey#1\@nil{% + \pgfutil@in@={#1}% + \ifpgfutil@in@% + \extractkeyequal#1\@nil + \else% + \pgfutil@in@{(initial}{#1}% + \ifpgfutil@in@% + \extractequalinitial#1\@nil% + \else + \pgfmanualentryheadline{% + \def\mykey{#1}% + \def\mypath{}% + \gdef\myname{}% + \firsttimetrue% + \pgfmanualdecomposecount=0\relax% + \decompose#1/\nil% + {\ttfamily\declare{#1}}\hfill(\extrakeytext no value)}% + \fi + \fi% +} + +\def\extractkeyequal#1=#2\@nil{% + \pgfutil@in@{(default}{#2}% + \ifpgfutil@in@% + \extractdefault{#1}#2\@nil% + \else% + \pgfutil@in@{(initial}{#2}% + \ifpgfutil@in@% + \extractinitial{#1}#2\@nil% + \else + \pgfmanualentryheadline{% + \def\mykey{#1}% + \def\mypath{}% + \gdef\myname{}% + \firsttimetrue% + \pgfmanualdecomposecount=0\relax% + \decompose#1/\nil% + {\ttfamily\declare{#1}=}#2\hfill(\extrakeytext no default)}% + \fi% + \fi% +} + +\def\extractdefault#1#2(default #3)\@nil{% + \pgfmanualentryheadline{% + \def\mykey{#1}% + \def\mypath{}% + \gdef\myname{}% + \firsttimetrue% + \pgfmanualdecomposecount=0\relax% + \decompose#1/\nil% + {\ttfamily\declare{#1}\opt{=}}\opt{#2}\hfill (\extrakeytext default {\ttfamily#3})}% +} + +\def\extractinitial#1#2(initially #3)\@nil{% + \pgfmanualentryheadline{% + \def\mykey{#1}% + \def\mypath{}% + \gdef\myname{}% + \firsttimetrue% + \pgfmanualdecomposecount=0\relax% + \decompose#1/\nil% + {\ttfamily\declare{#1}=}#2\hfill (\extrakeytext no default, initially {\ttfamily#3})}% +} + +\def\extractequalinitial#1 (initially #2)\@nil{% + \pgfmanualentryheadline{% + \def\mykey{#1}% + \def\mypath{}% + \gdef\myname{}% + \firsttimetrue% + \pgfmanualdecomposecount=0\relax% + \decompose#1/\nil% + {\ttfamily\declare{#1}}\hfill (\extrakeytext initially {\ttfamily#2})}% +} + +% Introduces a key alias '/#1/<name of current key>' +% to be used inside of \begin{key} ... \end{key} +\def\keyalias#1{\vspace{-3pt}\item{\small alias {\ttfamily/#1/\myname}}\vspace{-2pt}\par + \pgfmanualpdflabel{/#1/\myname}{}% +} + +\newif\iffirsttime +\newcount\pgfmanualdecomposecount + +\makeatother + +\def\decompose/#1/#2\nil{% + \def\test{#2}% + \ifx\test\empty% + % aha. + \index{#1@\protect\texttt{#1} key}% + \index{\mypath#1@\protect\texttt{#1}}% + \gdef\myname{#1}% + \pgfmanualpdflabel{#1}{} + \else% + \advance\pgfmanualdecomposecount by1\relax% + \ifnum\pgfmanualdecomposecount>2\relax% + \decomposetoodeep#1/#2\nil% + \else% + \iffirsttime% + \begingroup% + % also make a pdf link anchor with full key path. + \def\hyperlabelwithoutslash##1/\nil{% + \pgfmanualpdflabel{##1}{}% + }% + \hyperlabelwithoutslash/#1/#2\nil% + \endgroup% + \def\mypath{#1@\protect\texttt{/#1/}!}% + \firsttimefalse% + \else% + \expandafter\def\expandafter\mypath\expandafter{\mypath#1@\protect\texttt{#1/}!}% + \fi% + \def\firsttime{}% + \decompose/#2\nil% + \fi% + \fi% +} + +\def\decomposetoodeep#1/#2/\nil{% + % avoid too-deep nesting in index + \index{#1/#2@\protect\texttt{#1/#2} key}% + \index{\mypath#1/#2@\protect\texttt{#1/#2}}% + \decomposefindlast/#1/#2/\nil% +} +\makeatletter +\def\decomposefindlast/#1/#2\nil{% + \def\test{#2}% + \ifx\test\pgfutil@empty% + \gdef\myname{#1}% + \else% + \decomposefindlast/#2\nil% + \fi% +} +\makeatother +\def\indexkey#1{% + \def\mypath{}% + \decompose#1/\nil% +} + +\newenvironment{predefinedmethod}[1]{ + \begin{pgfmanualentry} + \extractpredefinedmethod#1\@nil + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} +\def\extractpredefinedmethod#1(#2)\@nil{% + \pgfmanualentryheadline{% + \pgfmanualpdflabel{#1}{}% + Method \declare{\ttfamily #1}\texttt(#2\texttt) \hfill(predefined for all classes)} + \index{#1@\protect\texttt{#1} method}% + \index{Methods!#1@\protect\texttt{#1}} +} + + +\newenvironment{ooclass}[1]{ + \begin{pgfmanualentry} + \def\currentclass{#1} + \pgfmanualentryheadline{% + \pgfmanualpdflabel{#1}{}% + \textbf{Class} \declare{\texttt{#1}}} + \index{#1@\protect\texttt{#1} class}% + \index{Class #1@Class \protect\texttt{#1}}% + \index{Classes!#1@\protect\texttt{#1}} + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\newenvironment{method}[1]{ + \begin{pgfmanualentry} + \extractmethod#1\@nil + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} +\def\extractmethod#1(#2)\@nil{% + \def\test{#1} + \ifx\test\currentclass + \pgfmanualentryheadline{% + \pgfmanualpdflabel{#1}{}% + Constructor \declare{\ttfamily #1}\texttt(#2\texttt)} + \else + \pgfmanualentryheadline{% + \pgfmanualpdflabel{#1}{}% + Method \declare{\ttfamily #1}\texttt(#2\texttt)} + \fi + \index{#1@\protect\texttt{#1} method}% + \index{Methods!#1@\protect\texttt{#1}} + \index{Class \currentclass!#1@\protect\texttt{#1}}% +} + +\newenvironment{attribute}[1]{ + \begin{pgfmanualentry} + \extractattribute#1\@nil + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} +\def\extractattribute#1=#2;\@nil{% + \def\test{#2}% + \ifx\test\@empty + \pgfmanualentryheadline{% + \pgfmanualpdflabel{#1}{}% + Private attribute \declare{\ttfamily #1} \hfill (initially empty)} + \else + \pgfmanualentryheadline{% + \pgfmanualpdflabel{#1}{}% + Private attribute \declare{\ttfamily #1} \hfill (initially {\ttfamily #2})} + \fi + \index{#1@\protect\texttt{#1} attribute}% + \index{Attributes!#1@\protect\texttt{#1}} + \index{Class \currentclass!#1@\protect\texttt{#1}}% +} + + + +\newenvironment{predefinednode}[1]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{% + \pgfmanualpdflabel{#1}{}% + \textbf{Predefined node} {\ttfamily\declare{#1}}}% + \index{#1@\protect\texttt{#1} node}% + \index{Predefined node!#1@\protect\texttt{#1}} + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\newenvironment{coordinatesystem}[1]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{% + \pgfmanualpdflabel{#1}{}% + \textbf{Coordinate system} {\ttfamily\declare{#1}}}% + \index{#1@\protect\texttt{#1} coordinate system}% + \index{Coordinate systems!#1@\protect\texttt{#1}} + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\newenvironment{snake}[1]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{\textbf{Snake} {\ttfamily\declare{#1}}}% + \index{#1@\protect\texttt{#1} snake}% + \index{Snakes!#1@\protect\texttt{#1}} + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\newenvironment{decoration}[1]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{\textbf{Decoration} {\ttfamily\declare{#1}}}% + \index{#1@\protect\texttt{#1} decoration}% + \index{Decorations!#1@\protect\texttt{#1}} + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + + +\def\pgfmanualbar{\char`\|} +\makeatletter +\newenvironment{pathoperation}[3][]{ + \begin{pgfmanualentry} + \def\pgfmanualtest{#1}% + \pgfmanualentryheadline{% + \ifx\pgfmanualtest\@empty% + \pgfmanualpdflabel{#2}{}% + \fi% + \textcolor{gray}{{\ttfamily\char`\\path}\ + \ \dots} + \declare{\texttt{\noligs{#2}}}#3\ \textcolor{gray}{\dots\texttt{;}}}% + \ifx\pgfmanualtest\@empty% + \index{#2@\protect\texttt{#2} path operation}% + \index{Path operations!#2@\protect\texttt{#2}}% + \fi% + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} +\newenvironment{datavisualizationoperation}[3][]{ + \begin{pgfmanualentry} + \def\pgfmanualtest{#1}% + \pgfmanualentryheadline{% + \ifx\pgfmanualtest\@empty% + \pgfmanualpdflabel{#2}{}% + \fi% + \textcolor{gray}{{\ttfamily\char`\\datavisualization}\ + \ \dots} + \declare{\texttt{\noligs{#2}}}#3\ \textcolor{gray}{\dots\texttt{;}}}% + \ifx\pgfmanualtest\@empty% + \index{#2@\protect\texttt{#2} (data visualization)}% + \index{Data visualization!#2@\protect\texttt{#2}}% + \fi% + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} +\makeatother + +\def\doublebs{\texttt{\char`\\\char`\\}} + + +\newenvironment{package}[1]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{% + \pgfmanualpdflabel{#1}{}% + {\ttfamily\char`\\usepackage\char`\{\declare{#1}\char`\}\space\space \char`\%\space\space \LaTeX}} + \index{#1@\protect\texttt{#1} package}% + \index{Packages and files!#1@\protect\texttt{#1}}% + \pgfmanualentryheadline{{\ttfamily\char`\\input \declare{#1}.tex\space\space\space \char`\%\space\space plain \TeX}} + \pgfmanualentryheadline{{\ttfamily\char`\\usemodule[\declare{#1}]\space\space \char`\%\space\space Con\TeX t}} + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + + +\newenvironment{pgfmodule}[1]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{% + \pgfmanualpdflabel{#1}{}% + {\ttfamily\char`\\usepgfmodule\char`\{\declare{#1}\char`\}\space\space\space + \char`\%\space\space \LaTeX\space and plain \TeX\space and pure pgf}} + \index{#1@\protect\texttt{#1} module}% + \index{Modules!#1@\protect\texttt{#1}}% + \pgfmanualentryheadline{{\ttfamily\char`\\usepgfmodule[\declare{#1}]\space\space \char`\%\space\space Con\TeX t\space and pure pgf}} + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\newenvironment{pgflibrary}[1]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{% + \pgfmanualpdflabel{#1}{}% + \textbf{\tikzname\ Library} \texttt{\declare{#1}}} + \index{#1@\protect\texttt{#1} library}% + \index{Libraries!#1@\protect\texttt{#1}}% + \vskip.25em% + {{\ttfamily\char`\\usepgflibrary\char`\{\declare{#1}\char`\}\space\space\space + \char`\%\space\space \LaTeX\space and plain \TeX\space and pure pgf}}\\ + {{\ttfamily\char`\\usepgflibrary[\declare{#1}]\space\space \char`\%\space\space Con\TeX t\space and pure pgf}}\\ + {{\ttfamily\char`\\usetikzlibrary\char`\{\declare{#1}\char`\}\space\space + \char`\%\space\space \LaTeX\space and plain \TeX\space when using \tikzname}}\\ + {{\ttfamily\char`\\usetikzlibrary[\declare{#1}]\space + \char`\%\space\space Con\TeX t\space when using \tikzname}}\\[.5em] + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\newenvironment{purepgflibrary}[1]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{% + \pgfmanualpdflabel{#1}{}% + \textbf{{\small PGF} Library} \texttt{\declare{#1}}} + \index{#1@\protect\texttt{#1} library}% + \index{Libraries!#1@\protect\texttt{#1}}% + \vskip.25em% + {{\ttfamily\char`\\usepgflibrary\char`\{\declare{#1}\char`\}\space\space\space + \char`\%\space\space \LaTeX\space and plain \TeX}}\\ + {{\ttfamily\char`\\usepgflibrary[\declare{#1}]\space\space \char`\%\space\space Con\TeX t}}\\[.5em] + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\newenvironment{tikzlibrary}[1]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{% + \pgfmanualpdflabel{#1}{}% + \textbf{\tikzname\ Library} \texttt{\declare{#1}}} + \index{#1@\protect\texttt{#1} library}% + \index{Libraries!#1@\protect\texttt{#1}}% + \vskip.25em% + {{\ttfamily\char`\\usetikzlibrary\char`\{\declare{#1}\char`\}\space\space \char`\%\space\space \LaTeX\space and plain \TeX}}\\ + {{\ttfamily\char`\\usetikzlibrary[\declare{#1}]\space \char`\%\space\space Con\TeX t}}\\[.5em] + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + + + +\newenvironment{filedescription}[1]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{File {\ttfamily\declare{#1}}}% + \index{#1@\protect\texttt{#1} file}% + \index{Packages and files!#1@\protect\texttt{#1}}% + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + + +\newenvironment{packageoption}[1]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{{\ttfamily\char`\\usepackage[\declare{#1}]\char`\{pgf\char`\}}} + \index{#1@\protect\texttt{#1} package option}% + \index{Package options for \textsc{pgf}!#1@\protect\texttt{#1}}% + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + + + +\newcommand\opt[1]{{\color{black!50!green}#1}} +\newcommand\ooarg[1]{{\ttfamily[}\meta{#1}{\ttfamily]}} + +\def\opt{\afterassignment\pgfmanualopt\let\next=} +\def\pgfmanualopt{\ifx\next\bgroup\bgroup\color{black!50!green}\else{\color{black!50!green}\next}\fi} + + + +\def\beamer{\textsc{beamer}} +\def\pdf{\textsc{pdf}} +\def\eps{\texttt{eps}} +\def\pgfname{\textsc{pgf}} +\def\tikzname{Ti\emph{k}Z} +\def\pstricks{\textsc{pstricks}} +\def\prosper{\textsc{prosper}} +\def\seminar{\textsc{seminar}} +\def\texpower{\textsc{texpower}} +\def\foils{\textsc{foils}} + +{ + \makeatletter + \global\let\myempty=\@empty + \global\let\mygobble=\@gobble + \catcode`\@=12 + \gdef\getridofats#1@#2\relax{% + \def\getridtest{#2}% + \ifx\getridtest\myempty% + \expandafter\def\expandafter\strippedat\expandafter{\strippedat#1} + \else% + \expandafter\def\expandafter\strippedat\expandafter{\strippedat#1\protect\printanat} + \getridofats#2\relax% + \fi% + } + + \gdef\removeats#1{% + \let\strippedat\myempty% + \edef\strippedtext{\stripcommand#1}% + \expandafter\getridofats\strippedtext @\relax% + } + + \gdef\stripcommand#1{\expandafter\mygobble\string#1} +} + +\def\printanat{\char`\@} + +\def\declare{\afterassignment\pgfmanualdeclare\let\next=} +\def\pgfmanualdeclare{\ifx\next\bgroup\bgroup\color{red!75!black}\else{\color{red!75!black}\next}\fi} + + +\let\textoken=\command +\let\endtextoken=\endcommand + +\def\myprintocmmand#1{\texttt{\char`\\#1}} + +\def\example{\par\smallskip\noindent\textit{Example: }} +\def\themeauthor{\par\smallskip\noindent\textit{Theme author: }} + + +\def\indexoption#1{% + \index{#1@\protect\texttt{#1} option}% + \index{Graphic options and styles!#1@\protect\texttt{#1}}% +} + +\def\itemcalendaroption#1{\item \declare{\texttt{#1}}% + \index{#1@\protect\texttt{#1} date test}% + \index{Date tests!#1@\protect\texttt{#1}}% +} + + + +\def\class#1{\list{}{\leftmargin=2em\itemindent-\leftmargin\def\makelabel##1{\hss##1}}% +\extractclass#1@\par\topsep=0pt} +\def\endclass{\endlist} +\def\extractclass#1#2@{% +\item{{{\ttfamily\char`\\documentclass}#2{\ttfamily\char`\{\declare{#1}\char`\}}}}% + \index{#1@\protect\texttt{#1} class}% + \index{Classes!#1@\protect\texttt{#1}}} + +\def\partname{Part} + +\makeatletter +\def\index@prologue{\section*{Index}\addcontentsline{toc}{section}{Index} + This index only contains automatically generated entries. A good + index should also contain carefully selected keywords. This index is + not a good index. + \bigskip +} +\c@IndexColumns=2 + \def\theindex{\@restonecoltrue + \columnseprule \z@ \columnsep 29\p@ + \twocolumn[\index@prologue]% + \parindent -30pt + \columnsep 15pt + \parskip 0pt plus 1pt + \leftskip 30pt + \rightskip 0pt plus 2cm + \small + \def\@idxitem{\par}% + \let\item\@idxitem \ignorespaces} + \def\endtheindex{\onecolumn} +\def\noindexing{\let\index=\@gobble} + + +\newenvironment{arrowtipsimple}[1]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{\textbf{Arrow Tip Kind} {\ttfamily#1}} + \index{#1@\protect\texttt{#1} arrow tip}% + \index{Arrow tips!#1@\protect\texttt{#1}}% + \def\currentarrowtype{#1} + \pgfmanualbody} +{ + \end{pgfmanualentry} +} + +\newenvironment{arrowtip}[4]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{\textbf{Arrow Tip Kind} {\ttfamily#1}} + \index{#1@\protect\texttt{#1} arrow tip}% + \index{Arrow tips!#1@\protect\texttt{#1}}% + \pgfmanualbody + \def\currentarrowtype{#1} + \begin{minipage}[t]{10.25cm} + #2 + \end{minipage}\hskip5mm\begin{minipage}[t]{4.75cm} + \leavevmode\vskip-2em + \tikz{ + \draw [black!50,line width=5mm,-{#1[#3,color=black]}] (-4,0) -- (0,0); + \foreach \action in {#4} + { \expandafter\processaction\action\relax } + } + \end{minipage}\par\smallskip + } +{ + \end{pgfmanualentry} +} + +\newenvironment{arrowcap}[5]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{\textbf{Arrow Tip Kind} {\ttfamily#1}} + \index{#1@\protect\texttt{#1} arrow tip}% + \index{Arrow tips!#1@\protect\texttt{#1}}% + \pgfmanualbody + \def\currentarrowtype{#1} + \begin{minipage}[t]{10.25cm} + #2 + \end{minipage}\hskip5mm\begin{minipage}[t]{4.75cm} + \leavevmode\vskip-2em + \tikz{ + \path [tips, line width=10mm,-{#1[#3,color=black]}] (-4,0) -- (0,0); + \draw [line width=10mm,black!50] (-3,0) -- (#5,0); + \foreach \action in {#4} + { \expandafter\processaction\action\relax } + } + \end{minipage}\par\smallskip + } +{ + \end{pgfmanualentry} +} + +\def\processaction#1=#2\relax{ + \expandafter\let\expandafter\pgf@temp\csname manual@action@#1\endcsname + \ifx\pgf@temp\relax\else + \pgf@temp#2/0/\relax + \fi +} +\def\manual@action@length#1/#2/#3\relax{% + \draw [red,|<->|,semithick,xshift=#2] ([yshift=4pt]current bounding + box.north -| -#1,0) coordinate (last length) -- node + [above=-2pt] {|length|} ++(#1,0); +} +\def\manual@action@width#1/#2/#3\relax{% + \draw [overlay, red,|<->|,semithick] (.5,-#1/2) -- node [below,sloped] {|width|} (.5,#1/2); +} +\def\manual@action@inset#1/#2/#3\relax{% + \draw [red,|<->|,semithick,xshift=#2] ([yshift=-4pt]current bounding + box.south -| last length) -- node [below] {|inset|} ++(#1,0); +} + +\newenvironment{arrowexamples} +{\begin{tabbing} + \hbox to \dimexpr\linewidth-5.5cm\relax{\emph{Appearance of the below at line width} \hfil} \= + \hbox to 1.9cm{\emph{0.4pt}\hfil} \= \hbox to 2cm{\emph{0.8pt}\hfil} \= \emph{1.6pt} \\ + } +{\end{tabbing}\vskip-1em} + +\newenvironment{arrowcapexamples} +{\begin{tabbing} + \hbox to \dimexpr\linewidth-5.5cm\relax{\emph{Appearance of the below at line width} \hfil} \= + \hbox to 1.9cm{\emph{1ex}\hfil} \= \hbox to 2cm{\emph{1em}\hfil} \\ + } +{\end{tabbing}\vskip-1em} + +\def\arrowcapexample#1[#2]{\def\temp{#1}\ifx\temp\pgfutil@empty\arrowcapexample@\currentarrowtype[{#2}]\else\arrowcapexample@#1[{#2}]\fi} +\def\arrowcapexample@#1[#2]{% + {\sfcode`\.1000\small\texttt{#1[#2]}} \> + \kern-.5ex\tikz [baseline,>={#1[#2]}] \draw [line + width=1ex,->] (0,.5ex) -- (2em,.5ex); \> + \kern-.5em\tikz [baseline,>={#1[#2]}] \draw [line + width=1em,->] (0,.5ex) -- (2em,.5ex); \\ +} + +\def\arrowexample#1[#2]{\def\temp{#1}\ifx\temp\pgfutil@empty\arrowexample@\currentarrowtype[{#2}]\else\arrowexample@#1[{#2}]\fi} +\def\arrowexample@#1[#2]{% + {\sfcode`\.1000\small\texttt{#1[#2]}} \> + \tikz [baseline,>={#1[#2]}] \draw [line + width=0.4pt,->] (0,.5ex) -- (2em,.5ex); thin \> + \tikz [baseline,>={#1[#2]}] \draw [line + width=0.8pt,->] (0,.5ex) -- (2em,.5ex); \textbf{thick} \> + \tikz [baseline,>={#1[#2]}] \draw [line + width=1.6pt,->] (0,.5ex) -- (3em,.5ex); \\ +} +\def\arrowexampledup[#1]{\arrowexample[{#1] \currentarrowtype[}]} +\def\arrowexampledupdot[#1]{\arrowexample[{#1] . \currentarrowtype[}]} + +\def\arrowexampledouble#1[#2]{\def\temp{#1}\ifx\temp\pgfutil@empty\arrowexampledouble@\currentarrowtype[{#2}]\else\arrowexampledouble@#1[{#2}]\fi} +\def\arrowexampledouble@#1[#2]{% + {\sfcode`\.1000\small\texttt{#1[#2]} on double line} \> + \tikz [baseline,>={#1[#2]}] + \draw [double equal sign distance,line width=0.4pt,->] (0,.5ex) -- (2em,.5ex); thin \> + \tikz [baseline,>={#1[#2]}] + \draw [double equal sign distance,line width=0.8pt,->] (0,.5ex) -- (2em,.5ex); \textbf{thick} \> + \tikz [baseline,>={#1[#2]}] + \draw [double equal sign distance, line width=1.6pt,->] (0,.5ex) -- (3em,.5ex); \\ +} + + + +\newcommand\symarrow[1]{% + \index{#1@\protect\texttt{#1} arrow tip}% + \index{Arrow tips!#1@\protect\texttt{#1}}% + \texttt{#1}& yields thick + \begin{tikzpicture}[arrows={#1-#1},thick,baseline] + \useasboundingbox (-1mm,-0.5ex) rectangle (1.1cm,2ex); + \fill [black!15] (1cm,-.5ex) rectangle (1.1cm,1.5ex) (-1mm,-.5ex) rectangle (0mm,1.5ex) ; + \draw (0pt,.5ex) -- (1cm,.5ex); + \end{tikzpicture} and thin + \begin{tikzpicture}[arrows={#1-#1},thin,baseline] + \useasboundingbox (-1mm,-0.5ex) rectangle (1.1cm,2ex); + \fill [black!15] (1cm,-.5ex) rectangle (1.1cm,1.5ex) (-1mm,-.5ex) rectangle (0mm,1.5ex) ; + \draw (0pt,.5ex) -- (1cm,.5ex); + \end{tikzpicture} +} +\newcommand\symarrowdouble[1]{% + \index{#1@\protect\texttt{#1} arrow tip}% + \index{Arrow tips!#1@\protect\texttt{#1}}% + \texttt{#1}& yields thick + \begin{tikzpicture}[arrows={#1-#1},thick,baseline] + \useasboundingbox (-1mm,-0.5ex) rectangle (1.1cm,2ex); + \fill [black!15] (1cm,-.5ex) rectangle (1.1cm,1.5ex) (-1mm,-.5ex) rectangle (0mm,1.5ex) ; + \draw (0pt,.5ex) -- (1cm,.5ex); + \end{tikzpicture} + and thin + \begin{tikzpicture}[arrows={#1-#1},thin,baseline] + \useasboundingbox (-1mm,-0.5ex) rectangle (1.1cm,2ex); + \fill [black!15] (1cm,-.5ex) rectangle (1.1cm,1.5ex) (-1mm,-.5ex) rectangle (0mm,1.5ex) ; + \draw (0pt,.5ex) -- (1cm,.5ex); + \end{tikzpicture}, double + \begin{tikzpicture}[arrows={#1-#1},thick,baseline] + \useasboundingbox (-1mm,-0.5ex) rectangle (1.1cm,2ex); + \fill [black!15] (1cm,-.5ex) rectangle (1.1cm,1.5ex) (-1mm,-.5ex) rectangle (0mm,1.5ex) ; + \draw[double,double equal sign distance] (0pt,.5ex) -- (1cm,.5ex); + \end{tikzpicture} and + \begin{tikzpicture}[arrows={#1-#1},thin,baseline] + \useasboundingbox (-1mm,-0.5ex) rectangle (1.1cm,2ex); + \fill [black!15] (1cm,-.5ex) rectangle (1.1cm,1.5ex) (-1mm,-.5ex) rectangle (0mm,1.5ex) ; + \draw[double,double equal sign distance] (0pt,.5ex) -- (1cm,.5ex); + \end{tikzpicture} +} + +\newcommand\sarrow[2]{% + \index{#1@\protect\texttt{#1} arrow tip}% + \index{Arrow tips!#1@\protect\texttt{#1}}% + \index{#2@\protect\texttt{#2} arrow tip}% + \index{Arrow tips!#2@\protect\texttt{#2}}% + \texttt{#1-#2}& yields thick + \begin{tikzpicture}[arrows={#1-#2},thick,baseline] + \useasboundingbox (-1mm,-0.5ex) rectangle (1.1cm,2ex); + \fill [black!15] (1cm,-.5ex) rectangle (1.1cm,1.5ex) (-1mm,-.5ex) rectangle (0mm,1.5ex) ; + \draw (0pt,.5ex) -- (1cm,.5ex); + \end{tikzpicture} and thin + \begin{tikzpicture}[arrows={#1-#2},thin,baseline] + \useasboundingbox (-1mm,-0.5ex) rectangle (1.1cm,2ex); + \fill [black!15] (1cm,-.5ex) rectangle (1.1cm,1.5ex) (-1mm,-.5ex) rectangle (0mm,1.5ex) ; + \draw (0pt,.5ex) -- (1cm,.5ex); + \end{tikzpicture} +} + +\newcommand\sarrowdouble[2]{% + \index{#1@\protect\texttt{#1} arrow tip}% + \index{Arrow tips!#1@\protect\texttt{#1}}% + \index{#2@\protect\texttt{#2} arrow tip}% + \index{Arrow tips!#2@\protect\texttt{#2}}% + \texttt{#1-#2}& yields thick + \begin{tikzpicture}[arrows={#1-#2},thick,baseline] + \useasboundingbox (-1mm,-0.5ex) rectangle (1.1cm,2ex); + \fill [black!15] (1cm,-.5ex) rectangle (1.1cm,1.5ex) (-1mm,-.5ex) rectangle (0mm,1.5ex) ; + \draw (0pt,.5ex) -- (1cm,.5ex); + \end{tikzpicture} and thin + \begin{tikzpicture}[arrows={#1-#2},thin,baseline] + \useasboundingbox (-1mm,-0.5ex) rectangle (1.1cm,2ex); + \fill [black!15] (1cm,-.5ex) rectangle (1.1cm,1.5ex) (-1mm,-.5ex) rectangle (0mm,1.5ex) ; + \draw (0pt,.5ex) -- (1cm,.5ex); + \end{tikzpicture}, double + \begin{tikzpicture}[arrows={#1-#2},thick,baseline] + \useasboundingbox (-1mm,-0.5ex) rectangle (1.1cm,2ex); + \fill [black!15] (1cm,-.5ex) rectangle (1.1cm,1.5ex) (-1mm,-.5ex) rectangle (0mm,1.5ex) ; + \draw[double,double equal sign distance] (0pt,.5ex) -- (1cm,.5ex); + \end{tikzpicture} and + \begin{tikzpicture}[arrows={#1-#2},thin,baseline] + \useasboundingbox (-1mm,-0.5ex) rectangle (1.1cm,2ex); + \fill [black!15] (1cm,-.5ex) rectangle (1.1cm,1.5ex) (-1mm,-.5ex) rectangle (0mm,1.5ex) ; + \draw[double,double equal sign distance] (0pt,.5ex) -- (1cm,.5ex); + \end{tikzpicture} +} + +\newcommand\carrow[1]{% + \index{#1@\protect\texttt{#1} arrow tip}% + \index{Arrow tips!#1@\protect\texttt{#1}}% + \texttt{#1}& yields for line width 1ex + \begin{tikzpicture}[arrows={#1-#1},line width=1ex,baseline] + \useasboundingbox (-1mm,-0.5ex) rectangle (1.6cm,2ex); + \fill [black!15] (1.5cm,-.5ex) rectangle (1.6cm,1.5ex) (-1mm,-.5ex) rectangle (0mm,1.5ex) ; + \draw (0pt,.5ex) -- (1.5cm,.5ex); + \end{tikzpicture} +} +\def\myvbar{\char`\|} +\newcommand\plotmarkentry[1]{% + \index{#1@\protect\texttt{#1} plot mark}% + \index{Plot marks!#1@\protect\texttt{#1}} + \texttt{\char`\\pgfuseplotmark\char`\{\declare{\noligs{#1}}\char`\}} & + \tikz\draw[color=black!25] plot[mark=#1,mark options={fill=examplefill,draw=black}] coordinates{(0,0) (.5,0.2) (1,0) (1.5,0.2)};\\ +} +\newcommand\plotmarkentrytikz[1]{% + \index{#1@\protect\texttt{#1} plot mark}% + \index{Plot marks!#1@\protect\texttt{#1}} + \texttt{mark=\declare{\noligs{#1}}} & \tikz\draw[color=black!25] + plot[mark=#1,mark options={fill=examplefill,draw=black}] + coordinates {(0,0) (.5,0.2) (1,0) (1.5,0.2)};\\ +} + + + +\ifx\scantokens\@undefined + \PackageError{pgfmanual-macros}{You need to use extended latex + (elatex) or (pdfelatex) to process this document}{} +\fi + +\begingroup +\catcode`|=0 +\catcode`[= 1 +\catcode`]=2 +\catcode`\{=12 +\catcode `\}=12 +\catcode`\\=12 |gdef|find@example#1\end{codeexample}[|endofcodeexample[#1]] +|endgroup + +% define \returntospace. +% +% It should define NEWLINE as {}, spaces and tabs as \space. +\begingroup +\catcode`\^=7 +\catcode`\^^M=13 +\catcode`\^^I=13 +\catcode`\ =13% +\gdef\returntospace{\catcode`\ =13\def {\space}\catcode`\^^I=13\def^^I{\space}} +\gdef\showreturn{\show^^M} +\endgroup + +\begingroup +\catcode`\%=13 +\catcode`\^^M=13 +\gdef\commenthandler{\catcode`\%=13\def%{\@gobble@till@return}} +\gdef\@gobble@till@return#1^^M{} +\gdef\@gobble@till@return@ignore#1^^M{\ignorespaces} +\gdef\typesetcomment{\catcode`\%=13\def%{\@typeset@till@return}} +\gdef\@typeset@till@return#1^^M{{\def%{\char`\%}\textsl{\char`\%#1}}\par} +\endgroup + +% Define tab-implementation functions +% \codeexample@tabinit@replacementchars@ +% and +% \codeexample@tabinit@catcode@ +% +% They should ONLY be used in case that tab replacement is active. +% +% This here is merely a preparation step. +% +% Idea: +% \codeexample@tabinit@catcode@ will make TAB active +% and +% \codeexample@tabinit@replacementchars@ will insert as many spaces as +% /codeexample/tabsize contains. +{ +\catcode`\^^I=13 +% ATTENTION: do NOT use tabs in these definitions!! +\gdef\codeexample@tabinit@replacementchars@{% + \begingroup + \count0=\pgfkeysvalueof{/codeexample/tabsize}\relax + \toks0={}% + \loop + \ifnum\count0>0 + \advance\count0 by-1 + \toks0=\expandafter{\the\toks0\ }% + \repeat + \xdef\codeexample@tabinit@replacementchars@@{\the\toks0}% + \endgroup + \let^^I=\codeexample@tabinit@replacementchars@@ +}% +\gdef\codeexample@tabinit@catcode@{\catcode`\^^I=13}% +}% + +% Called after any options have been set. It assigns +% \codeexample@tabinit@catcode +% and +% \codeexample@tabinit@replacementchars +% which are used inside of +%\begin{codeexample} +% ... +%\end{codeexample} +% +% \codeexample@tabinit@catcode is either \relax or it makes tab +% active. +% +% \codeexample@tabinit@replacementchars is either \relax or it inserts +% a proper replacement sequence for tabs (as many spaces as +% configured) +\def\codeexample@tabinit{% + \ifnum\pgfkeysvalueof{/codeexample/tabsize}=0\relax + \let\codeexample@tabinit@replacementchars=\relax + \let\codeexample@tabinit@catcode=\relax + \else + \let\codeexample@tabinit@catcode=\codeexample@tabinit@catcode@ + \let\codeexample@tabinit@replacementchars=\codeexample@tabinit@replacementchars@ + \fi +} + +\newif\ifpgfmanualtikzsyntaxhilighting + +\pgfqkeys{/codeexample}{% + width/.code= {\setlength\codeexamplewidth{#1}}, + graphic/.code= {\colorlet{graphicbackground}{#1}}, + code/.code= {\colorlet{codebackground}{#1}}, + execute code/.is if=code@execute, + code only/.code= {\code@executefalse}, + pre/.store in=\code@pre, + post/.store in=\code@post, + % #1 is the *complete* environment contents as it shall be + % typeset. In particular, the catcodes are NOT the normal ones. + typeset listing/.code= {#1}, + render instead/.store in=\code@render, + vbox/.code= {\def\code@pre{\vbox\bgroup\setlength{\hsize}{\linewidth-6pt}}\def\code@post{\egroup}}, + ignorespaces/.code= {\let\@gobble@till@return=\@gobble@till@return@ignore}, + leave comments/.code= {\def\code@catcode@hook{\catcode`\%=12}\let\commenthandler=\relax\let\typesetcomment=\relax}, + tabsize/.initial=0,% FIXME : this here is merely used for indentation. It is just a TAB REPLACEMENT. + every codeexample/.style={width=4cm+7pt, tikz syntax=true}, + from file/.code={\codeexamplefromfiletrue\def\codeexamplesource{#1}}, + tikz syntax/.is if=pgfmanualtikzsyntaxhilighting, +} + + +\newread\examplesource + + +% Opening, reading and closing the results file + +\def\opensource#1{ + \immediate\openin\examplesource=#1 +} +\def\do@codeexamplefromfile{% + \immediate\openin\examplesource\expandafter{\codeexamplesource}% + \def\examplelines{}% + \readexamplelines + \closein\examplesource + \expandafter\endofcodeexample\expandafter{\examplelines}% +} + +\def\readexamplelines{ + \ifeof\examplesource% + \else + \immediate\read\examplesource to \exampleline + \expandafter\expandafter\expandafter\def\expandafter\expandafter\expandafter\examplelines\expandafter\expandafter\expandafter{\expandafter\examplelines\exampleline} + \expandafter\readexamplelines% + \fi +} + +\let\code@pre\pgfutil@empty +\let\code@post\pgfutil@empty +\let\code@render\pgfutil@empty +\def\code@catcode@hook{} + +\newif\ifcodeexamplefromfile +\newdimen\codeexamplewidth +\newif\ifcode@execute +\newbox\codeexamplebox +\def\codeexample[#1]{% + \begingroup% + \code@executetrue + \pgfqkeys{/codeexample}{every codeexample,#1}% + \pgfmanualswitchoncolors% + \ifcodeexamplefromfile\begingroup\fi + \codeexample@tabinit% assigns \codeexample@tabinit@[catcode,replacementchars] + \parindent0pt + \begingroup% + \par% + \medskip% + \let\do\@makeother% + \dospecials% + \obeylines% + \@vobeyspaces% + \catcode`\%=13% + \catcode`\^^M=13% + \code@catcode@hook% + \codeexample@tabinit@catcode + \relax% + \ifcodeexamplefromfile% + \expandafter\do@codeexamplefromfile% + \else% + \expandafter\find@example% + \fi} +\def\endofcodeexample#1{% + \endgroup% + \ifcode@execute% + \setbox\codeexamplebox=\hbox{% + \ifx\code@render\pgfutil@empty% + {% + {% + \returntospace% + \commenthandler% + \xdef\code@temp{#1}% removes returns and comments + }% + \catcode`\^^M=9% + \colorbox{graphicbackground}{\color{black}\ignorespaces% + \code@pre\expandafter\scantokens\expandafter{\code@temp\ignorespaces}\code@post\ignorespaces}% + }% + \else% + \colorbox{graphicbackground}{\color{black}\ignorespaces% + \code@render}% + \fi% + }% + \ifdim\wd\codeexamplebox>\codeexamplewidth% + \def\code@start{\par}% + \def\code@flushstart{}\def\code@flushend{}% + \def\code@mid{\parskip2pt\par\noindent}% + \def\code@width{\linewidth-6pt}% + \def\code@end{}% + \else% + \def\code@start{% + \linewidth=\textwidth% + \parshape \@ne 0pt \linewidth + \leavevmode% + \hbox\bgroup}% + \def\code@flushstart{\hfill}% + \def\code@flushend{\hbox{}}% + \def\code@mid{\hskip6pt}% + \def\code@width{\linewidth-12pt-\codeexamplewidth}% + \def\code@end{\egroup}% + \fi% + \code@start% + \noindent% + \begin{minipage}[t]{\codeexamplewidth}\raggedright + \hrule width0pt% + \footnotesize\vskip-1em% + \code@flushstart\box\codeexamplebox\code@flushend% + \vskip-1ex + \leavevmode% + \end{minipage}% + \else% + \def\code@mid{\par} + \def\code@width{\linewidth-6pt} + \def\code@end{} + \fi% + \code@mid% + \colorbox{codebackground}{% + \pgfkeysvalueof{/codeexample/prettyprint/base color}% + \begin{minipage}[t]{\code@width}% + {% + \let\do\@makeother + \dospecials + \frenchspacing\@vobeyspaces + \normalfont\ttfamily\footnotesize + \typesetcomment% + \codeexample@tabinit@replacementchars + \@tempswafalse + \def\par{% + \if@tempswa + \leavevmode \null \@@par\penalty\interlinepenalty + \else + \@tempswatrue + \ifhmode\@@par\penalty\interlinepenalty\fi + \fi}% + \obeylines + \everypar \expandafter{\the\everypar \unpenalty}% + \pgfkeysvalueof{/codeexample/typeset listing/.@cmd}{#1}\pgfeov + } + \end{minipage}}% + \code@end% + \par% + \medskip + \endcodeexample\endgroup +} + +\def\endcodeexample{\endgroup} + + +\makeatother + +\usepackage{pgfmanual} + + +% autoxref is now always on + +% \makeatletter +% % \pgfautoxrefs will be defined by 'make dist' +% \pgfutil@ifundefined{pgfautoxrefs}{% +% \renewcommand\pgfmanualpdflabel[3][]{#3}% NO-OP +% \def\pgfmanualpdfref#1#2{#2}% +% \pgfkeys{ +% /pdflinks/codeexample links=false,% DISABLED. +% }% +% }{} +% \makeatother + +\newdimen\pgfmanualcslinkpreskip + +% Styling of the pretty printer +\pgfkeys{ + /codeexample/syntax hilighting/.style={ + /codeexample/prettyprint/key name/.code={\textcolor{keycolor}{\pgfmanualpdfref{##1}{\noligs{##1}}}}, + /codeexample/prettyprint/key name with handler/.code 2 args={\textcolor{keycolor}{\pgfmanualpdfref{##1}{\noligs{##1}}}/\textcolor{blue!70!black}{\pgfmanualpdfref{/handlers/##2}{\noligs{##2}}}}, + /codeexample/prettyprint/key value display only/.code={\textcolor{keycolor}{{\itshape{\let\pgfmanualwordstartup\relax\pgfmanualprettyprintcode{##1}}}}}, + /codeexample/prettyprint/cs/.code={\textcolor{cscolor}{\pgfmanualcslinkpreskip4.25pt\pgfmanualpdfref{##1}{\noligs{##1}}}}, + /codeexample/prettyprint/cs with args/.code 2 args={\textcolor{black}{\pgfmanualcslinkpreskip4.25pt\pgfmanualpdfref{##1}{\noligs{##1}}}\{\textcolor{black}{\pgfmanualprettyprintcode{##2}}\pgfmanualclosebrace}, + /codeexample/prettyprint/cs arguments/pgfkeys/.initial=1, + /codeexample/prettyprint/cs/pgfkeys/.code 2 args={\textcolor{black}{\pgfmanualcslinkpreskip4.25pt\pgfmanualpdfref{##1}{\noligs{##1}}}\{\textcolor{black}{\pgfmanualprettyprintpgfkeys{##2}}\pgfmanualclosebrace}, + /codeexample/prettyprint/cs arguments/begin/.initial=1, + /codeexample/prettyprint/cs/begin/.code 2 args={\textcolor{black}{##1}\{\textcolor{cscolor}{\pgfmanualpdfref{##2}{\noligs{##2}}}\pgfmanualclosebrace}, + /codeexample/prettyprint/cs arguments/end/.initial=1, + /codeexample/prettyprint/cs/end/.code 2 args={\textcolor{black}{##1}\{\textcolor{cscolor}{\pgfmanualpdfref{##2}{\noligs{##2}}}\pgfmanualclosebrace}, + /codeexample/prettyprint/word/.code={\pgfmanualwordstartup{\begingroup\pgfkeyssetvalue{/pdflinks/search key prefixes in}{}\pgfmanualpdfref{##1}{\noligs{##1}}\endgroup}}, + /codeexample/prettyprint/point/.code={\textcolor{pointcolor}{\noligs{##1}}},% + /codeexample/prettyprint/point with cs/.code 2 args={\textcolor{pointcolor}{(\pgfmanualpdfref{##1}{\noligs{##1}}:\noligs{##2}}},% + /codeexample/prettyprint/comment font=\itshape, + /codeexample/prettyprint/base color/.initial=\color{basecolor}, + /pdflinks/render hyperlink/.code={% + {\setbox0=\hbox{##1}% + \rlap{{\color{linkcolor}\dimen0\wd0\advance\dimen0by-\pgfmanualcslinkpreskip\hskip\pgfmanualcslinkpreskip\vrule width\dimen0 height-1pt depth1.6pt}}% + \box0% + }% + } + },/codeexample/syntax hilighting +} + +\colorlet{keycolor}{black} +\colorlet{cscolor}{black} +\colorlet{pointcolor}{black} +\colorlet{basecolor}{black} +\colorlet{linkcolor}{black!8} + +\def\pgfmanualswitchoncolors{% + \colorlet{keycolor}{green!50!black}% + \colorlet{cscolor}{blue!70!black} + \colorlet{pointcolor}{violet} + \colorlet{basecolor}{black!55} + \colorlet{linkcolor}{white} +} + +\makeatletter + +\def\pgfmanualwordstartup{\textcolor{black}} + +\def\noligs#1{\pgfmanualnoligs#1\kern0pt--\pgf@stop}% +\def\pgfmanualnoligs#1--{% + \pgfutil@ifnextchar\pgf@stop{#1\pgfutil@gobble}{#1-\kern0pt-\kern0pt\pgfmanualnoligs}% +} +\makeatother + + +%%% Local Variables: +%%% mode: latex +%%% TeX-master: "beameruserguide" +%%% End: diff --git a/Master/texmf-dist/doc/latex/tikz-ladder/tikz-ladder-doc.pdf b/Master/texmf-dist/doc/latex/tikz-ladder/tikz-ladder-doc.pdf Binary files differnew file mode 100644 index 00000000000..a4aaf9673ad --- /dev/null +++ b/Master/texmf-dist/doc/latex/tikz-ladder/tikz-ladder-doc.pdf diff --git a/Master/texmf-dist/doc/latex/tikz-ladder/tikz-ladder-doc.tex b/Master/texmf-dist/doc/latex/tikz-ladder/tikz-ladder-doc.tex new file mode 100644 index 00000000000..dcd1d4c02b1 --- /dev/null +++ b/Master/texmf-dist/doc/latex/tikz-ladder/tikz-ladder-doc.tex @@ -0,0 +1,716 @@ +%% This is file `tikz-ladder.tex' +%% Version 1 of 10 January 2018 +%% +%% Copyright (C) 2018 by Luis Paulo Laus, laus@utfpr.edu.br +%% +%% This package can be redistributed and/or modified under the terms +%% of the LaTeX Project Public License distributed from CTAN +%% archives in directory macros/latex/base/lppl.txt; either +%% version 1 of the License, or (at your option) any later version, +%% with `The Package' referring to the software `tikzlibraryladder.code.tex' and its +%% accompanying documentation and `The Copyright Holder' referring to the +%% person Luis Paulo Laus. +%% +%% +%% IMPORTANT NOTICE: +%% +%% For error reports, comments or suggestions in case of UNCHANGED +%% versions send mail to: +%% laus@utfpr.edu.br +%% +%% +\documentclass[a4paper]{ltxdoc} +\usepackage[hyphens]{url} +\usepackage[pdfborder={0 0 0}]{hyperref} +\usepackage[version=latest]{pgf} +\usepackage{calc,listings,tikz} +\usepackage{tikz} + +\usepackage{hyperref} +\hypersetup{% + colorlinks=false, % use true to enable colors below: + linkcolor=blue,%red, + filecolor=blue,%magenta, + urlcolor=blue,%cyan, + citecolor=blue, + pdfborder=0 0 0, +} + +% We need lots of libraries... +\usetikzlibrary{backgrounds} + +\newif\ifgdccodebasic +\newif\ifgdccodeogdf + +\usepackage[a4paper,left=2.25cm,right=2.25cm,top=2.5cm,bottom=2.5cm,nohead]{geometry} +\usepackage{amsmath,amssymb} +\usepackage{xxcolor} +\usepackage{pifont} +\usepackage{makeidx} +\usepackage{enumitem} +\usepackage[T1]{fontenc} + +\input{pgfmanual-en-macros} % Borrowed from TikZ/PGF + +\makeindex + +\makeatletter +\renewcommand*\l@section[2]{% + \ifnum \c@tocdepth >\z@ + \addpenalty\@secpenalty + \addvspace{1.0em \@plus\p@}% + \setlength\@tempdima{2.5em}% + \begingroup + \parindent \z@ \rightskip \@pnumwidth + \parfillskip -\@pnumwidth + \leavevmode \bfseries + \advance\leftskip\@tempdima + \hskip -\leftskip + #1\nobreak\hfil \nobreak\hb@xt@\@pnumwidth{\hss #2}\par + \endgroup + \fi} +\renewcommand*\l@subsection{\@dottedtocline{2}{2.5em}{3.3em}} +\renewcommand*\l@subsubsection{\@dottedtocline{3}{5.8em}{4.2em}} +\def\@pnumwidth{2.2em} +\makeatother + + +% Global styles: +\tikzset{ + every plot/.style={prefix=plots/pgf-}, + shape example/.style={ + color=black!30, + draw, + fill=yellow!30, + line width=.5cm, + inner xsep=2.5cm, + inner ysep=0.5cm} +} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% +% This file really starts here, all the above is for pgfmanual +% compatibility +% \usetikzlibrary{ladder} +\input ../tex/tikzlibraryladder.code +% some new lenghts +\newlength{\ladderskip} +\setlength{\ladderskip}{5\tikzcircuitssizeunit} % 5\tikzcircuitssizeunit = 35pt +\newlength{\ladderrungsep} +\setlength{\ladderrungsep}{.2\ladderskip} +\def\ladderrungend#1{\pgftransformyshift{-#1\ladderskip-\ladderrungsep}} + +\begin{document} + +\title{Typesetting Ladder Diagrams with \LaTeX{} and \tikzname{}} +\author{Luis Paulo Laus\\e-mail: \texttt{laus@utfpr.edu.br}} +\date{Version 1 of 10 January 2018} + +\maketitle + +\section{Abstract} +Ladder diagram (LD) is a graphical programming language that has evolved from electrical wiring diagrams for relay control systems used with programmable controllers (PLC\footnote{Formerly known as programable logic controllers.}) as described in the international standard IEC-61\,131-3. A LD program enables the programmable controller to test and modify data by means of standardized graphic symbols. These symbols are laid out in networks in a manner similar to a ``rung'' of a relay ladder logic diagram. This library provides \tikzname\ symbols to draw high quality ladder diagrams. All standard and some non-standard symbols are possible, including all kids of contacts, coils and blocks. I decided to write this package, despite of the fact that there is available another package named |ladder| that also uses \tikzname\ to typeset ladder diagrams, because that package seems\footnote{Sorry, but the documentation is in French and I limited myself to look at the figures.} to lack support for blocks. The |tikz-ladder|, on the contrary, supports all features described in IEC-61\,131-3, namely, blocks (for functions and function blocks), contacts and coils. + + +\section{Ladder Diagram} +According to IEC-61\,131-3, the usage of letters, semigraphic or graphic for the representation of graphical elements is implementer specific and not a normative requirement. This poses a problem for creating a package for typesetting ladder diagrams in agreement to a standard that should be used by everyone: you can do whatever you want. Thus, this package provides \tikzname\ symbols for typesetting ladder diagram as close as possible to the standard, but not to close since a program in the standard would look like: +\begin{center} +\begin{minipage}{5cm} +\begin{verbatim} +| a b c d | ++--( )--| |--+--( )---( )--+ +| | e | +| +-----( )-----+ +| | +\end{verbatim} +\end{minipage} +\end{center} +and it is probably not what you want. With this package, you can produce something like\footnote{This slightly awkward example was extracted from~[IEC-61\,131-3/2013, p. 218]; and explained by: ``In the rung shown above, the value of the Boolean output $a$ is always |TRUE|, while the value of outputs $c$, $d$ and $e$ upon completion of an evaluation of the rung is equal to the value of the input $b$.''. In 2013 version there is typo: the $a$ is missing. The 2003 version is correct.}: + +\begin{center} +\begin{tikzpicture} [ladder,thick,x=\ladderskip,y=\ladderskip] + \draw(0,0) + to [coil={info={$a$}}] ++(1,0) + to [contact NO={info={$b$}}] ++(1,0) coordinate(node1) + to [coil={info={$c$}}] ++(1,0) + to [coil={info={$d$}}] ++(1,0) coordinate(laddertopright); + \draw(node1) -- ++(0,-1) + to [coil={info={$e$}}] ++(2,0); +% power rails + \draw let \p1=(laddertopright) in + (0,\y1+0.7\ladderskip) -- (0,-\ladderskip-\ladderrungsep) + (\x1,\y1+0.7\ladderskip) -- (\x1,-\ladderskip-\ladderrungsep); +\end{tikzpicture} +\end{center} + + +\section{Ladder Diagram Library} + +\begin{pgflibrary}{ladder} +This library provides graphics for ladder diagram related to programable controllers (PLC) and according to the international standard IEC-61\,131-3. The library was written to extend the standard \tikzname\ circuit library. The reader is urged to read the Section~``Circuit Libraries'' of \tikzname\ manual. +This library defines the following key: + +\begin{key}{/tikz/ladder} +This style calls |ladder| and installs ladder diagram graphics for symbols like contacts, coils and blocks. +\end{key} +In the next sections a description of the library features is provided. +\end{pgflibrary} + + +\section{Contacts} +A contact is an element which imparts a state to the horizontal link on its right side which is equal to the Boolean |AND| of the state of the horizontal link at its left side with an appropriate function of an associated Boolean input, output, or memory variable. A contact does not modify the value of the associated Boolean variable. + +\begin{codeexample}[] +\begin{tikzpicture}[ladder] + \node[name=s, shape=contact ladder, shape example, inner xsep=1cm, inner ysep=1cm, minimum width=6cm, minimum height=6cm]{}; +\foreach \anchor/\placement in {center/above, 30/above right, north/above, south/below, east/left, + west/right, north east/above, south east/below, south west/below, north west/above,input/left,output/right} + \draw[shift=(s.\anchor)] plot[mark=x] coordinates{(0,0)} node[\placement] {\scriptsize\texttt{(s.\anchor)}}; +\end{tikzpicture} +\end{codeexample} + +All kinds of standardized contacts can be represented: normally open contact (NO); normally closed contact (NC); positive transition-sensing contact (P); negative transition-sensing contact (N); compare contacts both typed and overloaded (for typesetting purposes it makes no difference.) In the following examples, the Boolean variable associated with the contact is indicated by ``***''. + +Normally open contact (NO): +\begin{codeexample}[] +\tikz[ladder,thick] \draw(0,0) to [contact NO={info={***}}] ++(2,0); +\end{codeexample} + +Normally closed contact (NC): +\begin{codeexample}[] +\tikz[ladder,thick] \draw(0,0) to [contact NC={info={***}}] ++(2,0); +\end{codeexample} + +Variation of normally closed contact (NC): +\begin{codeexample}[] +\tikz[ladder,thick] \draw(0,0) to [var contact NC={info={***}}] ++(2,0); +\end{codeexample} + +Positive transition-sensing contact (P): +\begin{codeexample}[] +\tikz[ladder,thick] \draw(0,0) to [contact P={info={***}}] ++(2,0); +\end{codeexample} + +Negative transition-sensing contact (N): +\begin{codeexample}[] +\tikz[ladder,thick] \draw(0,0) to [contact N={info={***}}] ++(2,0); +\end{codeexample} + +Compare contact (typed): +\begin{codeexample}[] +\tikz[ladder,thick] \draw(0,0) to [contact NO={ + info={\scriptsize intvalue1}, + info'={\scriptsize intvalue2}, + symbol={\tiny$\genfrac{}{}{0pt}{}{>}{\text{Int}}$}}] ++(2,0); +\end{codeexample} + +Compare contact (overloaded): +\begin{codeexample}[] +\tikz[ladder,thick] \draw(0,0) to [contact NO={ + info={\scriptsize value1}, + info'={\scriptsize value2}, + symbol={\tiny$\genfrac{}{}{0pt}{}{<>}{}$}}] ++(2,0); +\end{codeexample} + +There are two possibilities for normally closed contact. It is not recommended to mix them in the same document unless to explain their equivalence. + +\subsection{Keys for contacts} + +The most common key used with contacts is |info| which sets the variable name associated with the contacts. One may also need |info'| and |name|; all standard keys. In addition to the keys described in Section~''Circuit Libraries'' of ``The TikZ and PGF Packages -- Manual for version 3.0.1a'', contacts accept: +\begin{key}{/tikz/symbol=\meta{name}} +This key sets the information, usually a single letter or comparison symbol, that will appear between the vertical lines. Usable for drawing compare contacts. +\end{key} + + +\section{Coils} + +A coil copies the state of the link on its left to the link on its right without modification, and stores an appropriate function of the state or transition of the left link into the associated Boolean variable. + +\begin{codeexample}[] +\begin{tikzpicture}[ladder] + \node[name=s, shape=coil ladder, shape example, fill=none, inner xsep=1cm, inner ysep=1cm, minimum width=6cm, minimum height=6cm]{}; +\foreach \anchor/\placement in {center/above, 30/above right, north/above, south/below, east/left, + west/right, north east/above, south east/below, south west/below, north west/above,input/left,output/right} + \draw[shift=(s.\anchor)] plot[mark=x] coordinates{(0,0)} node[\placement] {\scriptsize\texttt{(s.\anchor)}}; + \draw[thin]([yshift=-4mm]s.south east) -- ++(0,-0.9) coordinate(x1) -- ++(0.2,0) + ([yshift=-4mm]$0.2*(s.south west) + 0.8*(s.south east)$) -- ++(0,-0.9) coordinate(x2) -- ++(-0.2,0) + (x2) -- ++(0,-0.2); + \draw[thin,<->] (x1) -- (x2) node[midway,above]{0.2}; + \draw[thin]([yshift=-4mm]s.south east) -- ++(0,-1.5) coordinate(x1) -- ++(0.2,0) + (x1) -- ++(0,-0.2) ([yshift=-4mm]s.south west) -- ++(0,-1.5) coordinate(x2) -- ++(-0.2,0) + (x2) -- ++(0,-0.2); + \draw[thin,<->] (x1) -- (x2) node[midway,above]{1}; +\end{tikzpicture} +\end{codeexample} +The |coil ladder curvature| controls how round the coils look like. The default value is 0.2 as indicated above; 0.5 makes a round coil like\footnote{It can be used to draw relay coils according to NEMA -- National Electrical Manufacturers Association.}: + +\begin{codeexample}[] +\tikz[ladder,thick] + \draw(0,0) to [coil R={info={Motor},coil ladder curvature=0.5, + minimum size=2.4\tikzcircuitssizeunit}] ++(2,0); +\end{codeexample} + +Note that it is also necessary to set the |minimum size| because coils have a proportion of $2.4\times2$. If you do this frequently, you can set the style for the coils like: + +\begin{codeexample}[code only] +every coil R/.style={coil ladder curvature=0.5,minimum size=2.4\tikzcircuitssizeunit} +\end{codeexample} + +Values above 0.5, although possible, lead to estrange figures. + +All kind of standardized coils are supported: coil (normal); negated coil (normally activated, NA); set (latch) coil; reset (unlatch) coil; positive transition-sensing coil; and negative transition-sensing coil. In the following examples, the Boolean variable associated with the coil is indicated by ``***''. + +Coil (normally deactivated): +\begin{codeexample}[] +\tikz[ladder,thick] \draw(0,0) to [coil={info={***}}] ++(2,0); +\end{codeexample} + +Negated coil (normally activated, NA): +\begin{codeexample}[] +\tikz[ladder,thick] \draw(0,0) to [coil NA={info={***}}] ++(2,0); +\end{codeexample} + +Variation of negated coil (normally activated, NA): +\begin{codeexample}[] +\tikz[ladder,thick] \draw(0,0) to [var coil NA={info={***}}] ++(2,0); +\end{codeexample} + +Set (latch) coil: +\begin{codeexample}[] +\tikz[ladder,thick] \draw(0,0) to [coil S={info={***}}] ++(2,0); +\end{codeexample} + +Reset (unlatch) coil: +\begin{codeexample}[] +\tikz[ladder,thick] \draw(0,0) to [coil R={info={***}}] ++(2,0); +\end{codeexample} + +Positive transition-sensing coil: +\begin{codeexample}[] +\tikz[ladder,thick] \draw(0,0) to [coil={info={***},symbol=P}] ++(2,0); +\end{codeexample} + +Negative transition-sensing coil: +\begin{codeexample}[] +\tikz[ladder,thick] \draw(0,0) to [coil={info={***},symbol=N}] ++(2,0); +\end{codeexample} + +Note that positive and negative transition-sensing coils are not supported directly because, to be honest, no one uses them. Their symbols have to be coined using a normal coil and the parameter |symbol|. + +There are two possibilities for negated coil (NA). It is not recommended to mix them in the same document unless to explain their equivalence. + +It is possible, though not recommend because it disagrees with IEC-61\,131-3, to used non-standard coils, e.g., some people uses L (for latch) and U (for unlatch) instead of, S and U, respectively. This is achieved by changing the |symbol| of a |coil| like: + +\begin{codeexample}[] +\tikz[ladder,thick] \draw(0,0) to [coil={info={***},symbol=L}] ++(2,0); +\end{codeexample} +The same trick used for positive and negative transition-sensing coils. + + +\subsection{Keys for coils} + +The most common key used with coils is |info| which sets the variable name associated with the coil. One may also need |info'|, |name| and |minimum size|; all standard keys. In addition to the keys described in Section~``Circuit Libraries'' of ``The TikZ and PGF Packages -- Manual for version 3.0.1a'', coils accept: +\begin{key}{/tikz/symbol=\meta{name}} +This key sets the information, usually a single letter, that will appear between the parenthesis. Usable for non-standard or rarely used coils lake positive and negative transition-sensing coils. +\begin{codeexample}[] +\tikz[ladder,thick] \draw(0,0) to [coil={info={***},symbol=L}] ++(2,0); +\end{codeexample} +\end{key} + +\begin{key}{/tikz/coil ladder curvature=\meta{curvature index} (initially 0.5)} +This key sets the curvature index, a number between 0.001 and 0.5 (in practice, though higher values are permitted) that defined how much the parentheses will be bent. It is the fraction of the total coil width occupied by one parenthesis. Usable for drawing electric coils in NEMA standard. In this case, |minimum size| will have to adjusted in order to correct the coil aspect ratio. +\begin{codeexample}[] +\tikz[ladder,thick] \draw(0,0) to [coil={info={***}, + coil ladder curvature=0.1}] ++(2,0); +\end{codeexample} +\begin{codeexample}[] +\tikz[ladder,thick] \draw(0,0) to [coil={info={***}, + coil ladder curvature=0.3}] ++(2,0); +\end{codeexample} +\end{key} + + +\section{Blocks} + +Blocks are used to represent all other features besides contacts and coils, namely functions and function blocks, manly: timers, counters, communication, string treatment, arithmetic and logical operations. Blocks can have many inputs and outputs. The first input and output shall be aligned with the rung line. This is done automatically and explains why the |center| anchor is not on the centre of the rectangle. For the exact rectangle centre use the |text| or |base| anchor\footnote{I am not happy with this and it might be change in the future.}. + +Next, a block for a counter is represented with the anchors, you can see the input |>A| causes a clock input indication and the symbol |>| itself is gobbled. The input and output names are not accordingly to the standard IEC-61\,131-3. + +\begin{codeexample}[] +\begin{tikzpicture}[ladder] + \node[name=s, shape=block ladder, shape example, minimum width=8cm, minimum height=8cm, inner xsep=1cm, + inner ysep=1cm, input sep=2cm, output sep=4cm, inputs={>A,B,C}, clksize=2cm, outputs={X,Y}, symbol + color=black!30, symbol={\textcolor{red}{CTU}}] {block \vrule width1pt height1.5cm}; + \foreach \anchor/\placement in {center/below, text/above left, 0/left, 30/above right, 60/above, + 270/above, 300/above, mid/above right, mid east/above right, mid west/above left, base/below right, + base east/below right, base west/left, north/above, south/below, east/left, west/right, + north east/above right, south east/below, south west/below, north west/above, input 1/left, + input 2/left, input 3/left, output 1/right, output 2/right} + \draw[shift=(s.\anchor)] plot[mark=x] coordinates{(0,0)} node[\placement] {\scriptsize\texttt{(s.\anchor)}}; +\end{tikzpicture} +\end{codeexample} + +In the following subsections the standard names are employed accordingly to IEC-61\,131-3. + +\subsection{Keys for blocks} + +The three most common keys used with blocks are |symbol| which sets the block type, |name| which sets a \tikzname\ label to be used in future references, particularly to access the inputs and outputs, and |info| which sets the variable name associated with the POU represented by the block. One may also need |info'| and |minimum width|; all standard keys. In addition to the keys described in Section~``Circuit Libraries'' of ``The TikZ and PGF Packages -- Manual for version 3.0.1a'', blocks accept: +\begin{key}{/tikz/symbol=\meta{name}} +This key sets the information that appears inside the block rectangle, on the top. It specifies the POU type represented by the block. +\end{key} + +\begin{key}{/tikz/symbol color=\meta{colour}} +This key sets the colour used for all texts inside the block: symbol, inputs and outputs. In a |beamer| presentation it can be override for a particular input/output by forcing the text colour like this: |{\textcolor{blue}{Q}}|. For other document classes, you need to use a box: +\begin{codeexample}[width=4.4cm] +\newsavebox{\myeqbox} % only once, preferable in the document preamble +\savebox{\myeqbox}{\textcolor{blue}{Q}} +\tikz[ladder,thick] \draw[orange](0,0) to [block={violet, + info={[blue]$CT1$},inputs={>CU,R,PV}, outputs={\usebox{\myeqbox},CV}, + symbol=CTU\_SINT, symbol color=red, minimum width=2.4cm}] ++(4,0); +\end{codeexample} +\end{key} + + +\begin{key}{/tikz/clksize=\meta{width} (initially 0.8\\|tikzcircuitssizeunit|)} +This key sets the size for the clock input indicator (|>|). +\begin{codeexample}[] +\tikz[ladder,thick] \draw(0,0) to [block={ + info=$CT1$,inputs={>$CU$,R,PV}, outputs={Q,CV}, + symbol=CTU\_SINT, clksize=0.4cm, + minimum width=2.4cm}] ++(4,0); +\end{codeexample} +\end{key} + +\begin{key}{/tikz/input sep=\meta{width} (initially 1.6\\|tikzcircuitssizeunit|)} +This key sets the vertical distance between two consecutive inputs. +\begin{codeexample}[width=5.3cm] +\begin{tikzpicture}[ladder,thick] + \draw(0,0) to [contact NO={info={$I1$}}] ++(1,0) + to [block={info=$TM1$,symbol=TON, + inputs={EN,IN,PT},outputs={ENO,Q,ET}, + name=TM1,minimum width=1.6cm, + input sep=1cm,output sep=1cm}] ++(3,0) + to [coil={info={$M$}}] ++(1,0); + \draw(0,-1) to [contact NO={info={$I2$}}] ++(1,0) -- (TM1.input 2) + (TM1.output 2) -- (4,-1) to [coil={info={$R$}}] ++(1,0) + (TM1.input 3) -- +(-3mm,0)node[left]{T\#3s} (0,1) -- +(0,-3.5); +\end{tikzpicture} +\end{codeexample} +\end{key} + +\begin{key}{/tikz/output sep=\meta{width} (initially 1.6\\|tikzcircuitssizeunit|)} +This key sets the vertical distance between two consecutive outputs (see example above). +\end{key} + +\begin{key}{/tikz/input=\meta{inputs} (initially |{IN}|)} +This key sets the input names that appear inside the block. It is a comma separated list of inputs. Clock inputs are indicated by the first character being |>|. Coordinates for future external connection are automatically generated in the form \emph{name}.|input|~$n$, where $n$ is the input number starting in 1. An empty input can be generated by |{~}|. The minimal number of inputs is one, an empty list of inputs generates an error. +\end{key} + +\begin{key}{/tikz/output=\meta{outputs} (initially |{Q}|)} +This key sets the output names that appear inside the block. It is a comma separated list of outputs. Coordinates for future external connection are automatically generated in the form \emph{name}.|output|~$n$, where $n$ is the output number starting in 1. An empty output can be generated by |{}|. The minimal number of outputs is one, an empty list of outputs generates an error. +\end{key} + + +\subsection{Timers} +The standard IEC-61\,131-3 specifies three timers as follows: + +\noindent{}On-delay: +\begin{codeexample}[width=6cm,pre={\begin{tikzpicture}[ladder,thick]},post=\end{tikzpicture}] +\node[block,inputs={IN,PT},outputs={Q,ET}, + symbol=TON,minimum width=18mm] (tp1) {}; +\draw (tp1.input 1) -- +(-5mm,0) node[left]{BOOL} + (tp1.input 2) -- +(-5mm,0) node[left]{TIME} + (tp1.output 1) -- +(5mm,0) node[right]{BOOL} + (tp1.output 2) -- +(5mm,0) node[right]{TIME}; +\end{codeexample} + +\noindent{}Off-delay: +\begin{codeexample}[width=6cm,pre={\begin{tikzpicture}[ladder,thick]},post=\end{tikzpicture}] +\node[block,inputs={IN,PT},outputs={Q,ET}, + symbol=TOF,minimum width=18mm] (tp1) {}; +\draw (tp1.input 1) -- +(-5mm,0) node[left]{BOOL} + (tp1.input 2) -- +(-5mm,0) node[left]{TIME} + (tp1.output 1) -- +(5mm,0) node[right]{BOOL} + (tp1.output 2) -- +(5mm,0) node[right]{TIME}; +\end{codeexample} + +\noindent{}Pulse: +\begin{codeexample}[width=6cm,pre={\begin{tikzpicture}[ladder,thick]},post=\end{tikzpicture}] +\node[block,inputs={IN,PT},outputs={Q,ET}, + symbol=TP,minimum width=18mm] (tp1) {}; +\draw (tp1.input 1) -- +(-5mm,0) node[left]{BOOL} + (tp1.input 2) -- +(-5mm,0) node[left]{TIME} + (tp1.output 1) -- +(5mm,0) node[right]{BOOL} + (tp1.output 2) -- +(5mm,0) node[right]{TIME}; +\end{codeexample} + +\subsection{Counters} +The clock input is indicated by the character |>| which need to be the very first one in the input description of a clock input. You can use any number of clock inputs and they can appear in any order. For instance, the inputs of an up-down counter with enable input shall be declare as |inputs={EN,>CU,>CD,R,LD,PV}|. + +The standard IEC-61\,131-3 specifies three counters. In the following examples, the symbol ``*'' indicates the numerical type of the counter (like |INT|, |DINT|, etc.). + +\noindent{}Up-Counter: +\begin{codeexample}[width=6cm,pre={\begin{tikzpicture}[ladder,thick]},post=\end{tikzpicture}] +\node[block,inputs={>CU,R,PV},outputs={Q,CV}, + symbol=CTU\_*,minimum width=20mm] (ct1) {}; +\draw (ct1.input 1) -- +(-5mm,0) node[left]{BOOL} + (ct1.input 2) -- +(-5mm,0) node[left]{BOOL} + (ct1.input 3) -- +(-5mm,0) node[left,yshift=-0.4ex]{*} + (ct1.output 1) -- +(5mm,0) node[right]{BOOL} + (ct1.output 2) -- +(5mm,0) node[right,yshift=-0.4ex]{*}; +\end{codeexample} + +\noindent{}Down-counters: +\begin{codeexample}[width=6cm,pre={\begin{tikzpicture}[ladder,thick]},post=\end{tikzpicture}] +\node[block,inputs={>CD,LD,PV},outputs={Q,CV}, + symbol=CTD\_*,minimum width=20mm] (ct1) {}; +\draw (ct1.input 1) -- +(-5mm,0) node[left]{BOOL} + (ct1.input 2) -- +(-5mm,0) node[left]{BOOL} + (ct1.input 3) -- +(-5mm,0) node[left,yshift=-0.4ex]{*} + (ct1.output 1) -- +(5mm,0) node[right]{BOOL} + (ct1.output 2) -- +(5mm,0) node[right,yshift=-0.4ex]{*}; +\end{codeexample} + +\noindent{}Up-down counters: +\begin{codeexample}[width=6cm,pre={\begin{tikzpicture}[ladder,thick]},post=\end{tikzpicture}] +\node[block,inputs={>CU,>CD,R,LD,PV},outputs={QU,QD,CV}, + symbol=CTUD\_*,minimum width=20mm] (ct1) {}; +\draw (ct1.input 1) -- +(-5mm,0) node[left]{BOOL} + (ct1.input 2) -- +(-5mm,0) node[left]{BOOL} + (ct1.input 3) -- +(-5mm,0) node[left]{BOOL} + (ct1.input 4) -- +(-5mm,0) node[left]{BOOL} + (ct1.input 5) -- +(-5mm,0) node[left,yshift=-0.4ex]{*} + (ct1.output 1) -- +(5mm,0) node[right]{BOOL} + (ct1.output 2) -- +(5mm,0) node[right]{BOOL} + (ct1.output 3) -- +(5mm,0) node[right,yshift=-0.4ex]{*}; +\end{codeexample} + +\subsection{Standard bistable function blocks} + +Bistable function block (set dominant): |RS(S1,R, Q1)| +\begin{codeexample}[width=6cm,pre={\begin{tikzpicture}[ladder,thick]},post=\end{tikzpicture}] +\node[block,inputs={S1,R},outputs={Q1}, + symbol=SR,minimum width=18mm] (sr1) {}; +\draw (sr1.input 1) -- +(-5mm,0) node[left]{BOOL} + (sr1.input 2) -- +(-5mm,0) node[left]{BOOL} + (sr1.output 1) -- +(5mm,0) node[right]{BOOL}; +\end{codeexample} + +\noindent{}Bistable function block (set dominant) with long input names: |RS(SET1,RESET, Q1)| +\begin{codeexample}[width=6cm,pre={\begin{tikzpicture}[ladder,thick]},post=\end{tikzpicture}] +\node[block,inputs={SET1,RESET},outputs={Q1}, + symbol=SR,minimum width=18mm] (sr1) {}; +\draw (sr1.input 1) -- +(-5mm,0) node[left]{BOOL} + (sr1.input 2) -- +(-5mm,0) node[left]{BOOL} + (sr1.output 1) -- +(5mm,0) node[right]{BOOL}; +\end{codeexample} + +\noindent{}Bistable function block (reset dominant): |RS(S,R1, Q1)| +\begin{codeexample}[width=6cm,pre={\begin{tikzpicture}[ladder,thick]},post=\end{tikzpicture}] +\node[block,inputs={S,R1},outputs={Q1}, + symbol=SR,minimum width=18mm] (sr1) {}; +\draw (sr1.input 1) -- +(-5mm,0) node[left]{BOOL} + (sr1.input 2) -- +(-5mm,0) node[left]{BOOL} + (sr1.output 1) -- +(5mm,0) node[right]{BOOL}; +\end{codeexample} + +\noindent{}Bistable function block (reset dominant) with long input names\footnote{Here we have a clear inconsistency between the text description that presents the input |RESET1| and graphical representation where it is |R1|. It is probably just a typo, but the form presented in~[IEC-61\,131-3/2013, p. 112] was kept unchanged.}: |RS(SET,RESET1, Q1)| +\begin{codeexample}[width=6cm,pre={\begin{tikzpicture}[ladder,thick]},post=\end{tikzpicture}] +\node[block,inputs={SET,R1},outputs={Q1}, + symbol=SR,minimum width=18mm] (sr1) {}; +\draw (sr1.input 1) -- +(-5mm,0) node[left]{BOOL} + (sr1.input 2) -- +(-5mm,0) node[left]{BOOL} + (sr1.output 1) -- +(5mm,0) node[right]{BOOL}; +\end{codeexample} + + +\subsection{Standard edge detection function blocks} + +Rising edge detector: |R_TRIG(CLK, Q)| +\begin{codeexample}[width=6cm,pre={\begin{tikzpicture}[ladder,thick]},post=\end{tikzpicture}] +\node[block,inputs={CLK},outputs={Q}, + symbol=R\_TRIG,minimum width=20mm] (ed1) {}; +\draw (ed1.input 1) -- +(-5mm,0) node[left]{BOOL} + (ed1.output 1) -- +(5mm,0) node[right]{BOOL}; +\end{codeexample} + +\noindent{}Falling edge detector: |F_TRIG(CLK, Q)| +\begin{codeexample}[width=6cm,pre={\begin{tikzpicture}[ladder,thick]},post=\end{tikzpicture}] +\node[block,inputs={CLK},outputs={Q}, + symbol=F\_TRIG,minimum width=20mm] (ed1) {}; +\draw (ed1.input 1) -- +(-5mm,0) node[left]{BOOL} + (ed1.output 1) -- +(5mm,0) node[right]{BOOL}; +\end{codeexample} + + +\subsection{Call representation} + +A call is used to execute a function, a function block instance, or a method of a function block or class. They are represented by blocks. + +The proper map for in-out variables (|VAR_IN_OUT|) need special care. This map is represented by a line internal to the block connecting the left and right side of the in-out variable. The problem is that |tikz-ladder| only creates anchors at the left side of the inputs and right side of outputs. We need the opposite. This situation can be overcome in either two ways: using |calc| library to add and subtract a suitable distance to/from the standard anchors; creating two coordinates related to the input and output anchors but dislocated a suitable amount towards the interior of the block. Using |calc| library, one examples is: +\begin{codeexample}[width=6cm,pre={\begin{tikzpicture}[ladder,thick]},post=\end{tikzpicture}] + \draw(0,0) + to [contact NO={info={cond}}] ++(1,0) + to [block={inputs={EN,A,C},outputs={ENO,B,C}, + symbol=myFB, info=myInst, name=mf1, + minimum width=1.6cm, + input sep=1.2em, output sep=1.2em}] ++(3,0) + to [coil={info={X}}] +(1,0); + \draw (mf1.input 2) -- +(-0.3cm,0) node[left]{v1} + (mf1.input 3) -- +(-0.3cm,0) node[left]{v3} + (mf1.output 2) -- +(0.3cm,0) node[right]{v2} + (mf1.output 3) -- +(0.3cm,0) + ($(mf1.input 3) + (1em,0)$) -- ($(mf1.output 3) - (1em,0)$); +\end{codeexample} + +If you prefer to use the |\coordinate| command, place: +\begin{codeexample}[code only] + \coordinate[xshift=1em] (p1) at (mf1.input 3); + \coordinate[xshift=-1em] (p2) at (mf1.output 3); +\end{codeexample} +\noindent{}between the two |\draw| commands and replace de last code line by |(p1) -- (p2);|. + + +\section{Design Guidance} +This section brings some recommendations that reflect the way I produce ladder diagrams. It may or may not work for you. Feel free to e-mail me if you have better ideas. + +The first to consider is that |tikz-ladder| uses the |\tikzcircuitssizeunit| to keep all figures proportional. Therefore, when you consider any dimension related to symbol size it is good idea to set that dimension in respect to |\tikzcircuitssizeunit|, i.e., using |\tikzcircuitssizeunit| as the length unit\footnote{Therefore, all the examples in the previous sections should be reviewed.}. The default value of |\tikzcircuitssizeunit| is 7\,pt or approximately 2.46\,mm and it can be set by the |circuit symbol unit| key among several other keys. Even better, you can establish your own length unit and set $x$ and $y$ to that length unit. In this way you will be working on a grid; if it is too big or too small you will have to change a single declaration. The |\tikzcircuitssizeunit| is too small for that purpose, so I use and recommend |5\tikzcircuitssizeunit| instead. Moreover, I like to leave a small space between rungs, so a second new length can be used to keep this amount. Again, you can adjust it globally. Thus, just after loading the |tikz-ladder| library I use to declare: +\begin{codeexample}[code only] +\newlength{\ladderskip} +\setlength{\ladderskip}{5\tikzcircuitssizeunit} % 5\tikzcircuitssizeunit = 35pt +\newlength{\ladderrungsep} +\setlength{\ladderrungsep}{.2\ladderskip} +\def\ladderrungend#1{\pgftransformyshift{-#1\ladderskip-\ladderrungsep}} +\end{codeexample} +\noindent{}where: +\begin{description}[align=right,leftmargin=3.2cm,labelwidth=3cm,labelsep=2mm] +\item[|ladderskip|] is the length that controls all distances in the diagram; +\item[|ladderrungsep|] is the additional separation between two successive rungs; and +\item[|ladderrungend|] is a macro that marks the end of a rung. Actually, it leaves a space and set the new vertical datum. The parameter of this macros is the number of rows the ending rung has plus some extra space if you like it. +\end{description} + +To keeps track of a few rows in a rung is easy, but to place manually everything in the diagram is not. So, I devised a strategy: draw one rung at a time and move the datum (reset the origin) at the end of every rung, thus I can start fresh another rung. This is done by macro |\ladderrungend| which resets the vertical reference to a vertical position $n$ rows below the current position (plus some inter rung space). The macro also serves to \emph{mark} rung end in the code (\tikzname\ ``program'') that generates the diagram making it more readable. + +The options passed to the \tikzname\ environment in the next example are |[ladder,thick,x=\ladderskip,y=\ladderskip]| meaning it is a ladder diagram and $x$ and $y$ length unit are both set to |1\ladderskip|. + +\begin{codeexample}[] +\begin{tikzpicture} [ladder,thick,x=\ladderskip,y=\ladderskip] + \draw(0,0) + to [contact NO={info={E}}] ++(1,0) --++(1,0) + to [block={inputs={IN,PT},outputs={Q,ET},symbol=TOF,name=tp1, + minimum width=1.2\ladderskip, + input sep=0.3\ladderskip, output sep=0.3\ladderskip}] ++(2,0) + to [coil={info={T}}] +(1,0) coordinate(laddertopright); + \draw (tp1.output 2) -- +(0.3\ladderskip,0) + (tp1.input 2) -- +(-0.3\ladderskip,0) node[left]{T\#3s}; +\ladderrungend{1.2} + \draw(0,0) + to [contact NO={info={$I$}}] ++(1,0) + to [contact NC={info={$M$}}] ++(1,0) coordinate(laddercoil) -- ++(2,0) + to [coil={info={$Q$}}] ++(1,0); + \draw(0,-1) + to [contact NC={info={$I$}}] ++(1,0) + to [contact NO={info={$Q$}}] ++(1,0) -- (laddercoil); +\ladderrungend{2} + \draw(0,0) + to [contact NO={info={$I$}}] ++(1,0) + to [contact NO={info={$M$}}] ++(1,0) coordinate(laddercoil) -- ++(2,0) + to [coil={info={$M$}}] ++(1,0); + \draw(0,-1) + to [contact NC={info={$I$}}] ++(1,0) + to [contact NO={info={$Q$}}] ++(1,0) -- (laddercoil); +\ladderrungend{2} +% power rails + \draw let \p1=(laddertopright) in + (0,\y1+0.7\ladderskip) -- (0,\ladderskip) + (\x1,\y1+0.7\ladderskip) -- (\x1,\ladderskip); +\end{tikzpicture} +\end{codeexample} + +In the example, the first row has a timer, so an extra space is needed and for this 1.2 is given to |\ladderrungend|. Note that the |\draw (tp1.output 2)|\ldots\ is not the start of a new row (the first rung has only one row); it is used solely to place the timer terminals for PT and ET. + +Every rung starts with |\draw(0,0)| to mark the first position. The next row of the same rung will start with |\draw(0,-1)| and so forth. + +All contacts and coils are placed by something like, e.g., |to [contact NC={info={$I$}}] ++(1,0)|. The |to| command places the element between the current position and the next position which is one length unit at the right of the current position. Blocks are bigger and need more space, so after a block use |++(2,0)|. +When a row is connected to a row above it, it is wise to mark the connection point on the row above using, e.g., |coordinate(laddercoil)|. Thus, the current row can be connected by |-- (laddercoil)| or \verb!-| (laddercoil)!. If there are several rows, connect only the last one. + +You also may need some fillers like |-- ++(2,0)| because the row (or rung) is shorter than the others or because you want to leave some space before a block. + +The last thing to do is to draw the power rails. For this, the end of the first row of the first rung was marked with |coordinate(laddertopright)|. In the example, both left and right power rails were drawn. To draw only the left one (mandatory\footnote{Actually, the standard reads ``The right power rail may be explicit or implied''.}), remove the |(\x1,\y1+0.7\ladderskip) -- (\x1,\ladderskip)|. + +You may need to change the diagram size. There are a few options: place it into |\resizebox|; use the key |scale|; and change the |\tikzcircuitssizeunit| through the key |circuit symbol unit|. Placing into a |\resizebox| changes everything and it is the preferable option for presentations. The key |scale| only changes the space between symbols, but the font size, line width and symbol sizes are all kept the same. Changing the |\tikzcircuitssizeunit| keeps the font size and line width, but changes the symbols size and, if you were careful, the distance between symbols. + +To shrink the diagram to half its normal size, place these commands before your |\begin{tikzpicture}|. Note that you will have to undo this after the diagram. + +\begin{codeexample}[code only] +\tikzset{circuit symbol unit=3.5pt} +\setlength{\ladderskip}{5\tikzcircuitssizeunit} % 5\tikzcircuitssizeunit = 35pt +\setlength{\ladderrungsep}{.2\ladderskip} +\tiny +\end{codeexample} + +Both |\ladderskip| and |\ladderrungsep| were redefined, also the font size was changed. Incidentally, |\tiny| means 50\% of the current size. The result should be: +\begin{center} +\tikzset{circuit symbol unit=3.5pt} +\setlength{\ladderskip}{5\tikzcircuitssizeunit} % 5\tikzcircuitssizeunit = 35pt +\setlength{\ladderrungsep}{.2\ladderskip} +\tiny +\begin{tikzpicture} [ladder,thick,x=\ladderskip,y=\ladderskip,execute at end picture=% +{ +\begin{pgfonlayer}{background} +\path[fill=graphicbackground] +($(current bounding box.south west) + (-0.2,-0.2)$) rectangle +($(current bounding box.north east) + (0.2,0.2)$); +\end{pgfonlayer} +}] + \draw(0,0) + to [contact NO={info={E}}] ++(1,0) --++(1,0) + to [block={inputs={IN,PT},outputs={Q,ET},symbol=TOF,name=tp1, + minimum width=1.2\ladderskip, + input sep=0.3\ladderskip, output sep=0.3\ladderskip}] ++(2,0) + to [coil={info={T}}] +(1,0) coordinate(laddertopright); + \draw (tp1.output 2) -- +(0.3\ladderskip,0) + (tp1.input 2) -- +(-0.3\ladderskip,0) node[left]{T\#3s}; +\ladderrungend{1.2} + \draw(0,0) + to [contact NO={info={$I$}}] ++(1,0) + to [contact NC={info={$M$}}] ++(1,0) coordinate(laddercoil) -- ++(2,0) + to [coil={info={$Q$}}] ++(1,0); + \draw(0,-1) + to [contact NC={info={$I$}}] ++(1,0) + to [contact NO={info={$Q$}}] ++(1,0) -- (laddercoil); +\ladderrungend{2} + \draw(0,0) + to [contact NO={info={$I$}}] ++(1,0) + to [contact NO={info={$M$}}] ++(1,0) coordinate(laddercoil) -- ++(2,0) + to [coil={info={$M$}}] ++(1,0); + \draw(0,-1) + to [contact NC={info={$I$}}] ++(1,0) + to [contact NO={info={$Q$}}] ++(1,0) -- (laddercoil); +\ladderrungend{2} +% power rails + \draw let \p1=(laddertopright) in + (0,\y1+0.7\ladderskip) -- (0,\ladderskip) + (\x1,\y1+0.7\ladderskip) -- (\x1,\ladderskip); +\end{tikzpicture} +\end{center} +\normalsize + +This may not be the best way to perform big adjustments, but it can help in some occasions where a small adjust is needed. Also, if you do it frequently, consider to write a macro to encapsulate the feature. + + +\section{Known Issues} +I am not happy with the block symbol anchors, particularly |text|, |mid| and |base| anchors. Also, |center| is not in the centre and it is disturbing, to say the least. That might be changed in the future. The way the library was written also annoys me: it seems that the official libraries are written in two separated files: one for \tikzname\ stuff and another for \pgfname, but I don't know how to separate it, thus we have a single file (at least for now). + + +\section{Final Remarks} + +This package has been tested and used for more than three years, so I do believe it is mature by now and I decided to share it. On the other hand, I was the only person who used it\footnote{Not entirely true, two people asked me for the package, but I never heard from them again.}, therefore idiosyncrasies were not detected. + +Any comments, suggestions, and feedbacks are welcomed. I will do my best to answer as soon as possible. My contact e-mail is in the first page. + +It should be great if someone with experience in writing \tikzname\ libraries could have a look in the code and point out error or improvements to be made. + +Typesetting ladder diagrams may be boring and time consuming. One thing you can try is \verb|JQM - Java Quine McCluskey| for minimization of Boolean functions available on \url{https://sourceforge.net/projects/jqm-java-quine-mccluskey/}. It can generate the solution and create the corresponding ladder diagram based on a given truth table. Unfortunately, it does not place blocks, so the last example was generated with it, but the rung with the timer had to be done manual and also some fillers had to be added. + +\end{document}
\ No newline at end of file diff --git a/Master/texmf-dist/tex/latex/tikz-ladder/tikzlibraryladder.code.tex b/Master/texmf-dist/tex/latex/tikz-ladder/tikzlibraryladder.code.tex new file mode 100644 index 00000000000..4960c8ece87 --- /dev/null +++ b/Master/texmf-dist/tex/latex/tikz-ladder/tikzlibraryladder.code.tex @@ -0,0 +1,580 @@ +%% This is file `tikzlibraryladder.code.tex' +%% Version 1 of 10 January 2018 +%% +%% Copyright (C) 2018 by Luis Paulo Laus, laus@utfpr.edu.br +%% +%% This package can be redistributed and/or modified under the terms +%% of the LaTeX Project Public License distributed from CTAN +%% archives in directory macros/latex/base/lppl.txt; either +%% version 1 of the License, or (at your option) any later version, +%% with `The Package' referring to the software `tikzlibraryladder.code.tex' and its +%% accompanying documentation and `The Copyright Holder' referring to the +%% person Luis Paulo Laus. +%% +%% +%% IMPORTANT NOTICE: +%% +%% For error reports, comments or suggestions in case of UNCHANGED +%% versions send mail to: +%% laus@utfpr.edu.br +%% +%% + + +\usetikzlibrary{circuits.ee} +% +% Setting up an ladder +% +\tikzset{ + ladder/.style={ + circuit ee, + inputs/.style={block ladder inputs={##1}}, + outputs/.style={block ladder outputs={##1}}, + input sep/.style={block ladder input sep={##1}}, + output sep/.style={block ladder output sep={##1}}, + clksize/.style={block ladder clksize={##1}}, + symbol/.style={ladder symbol={##1}}, + symbol color/.style={ladder symbol color={##1}}, + every ladder/.try + } +} + +\makeatletter + +\newif\ifpgfnormallyclosednegated% +\pgfkeys{ + /pgf/crossed ladder/.is if=pgfnormallyclosednegated,% +} + +\pgfkeys{/pgf/.cd, + contact ladder symbol/.initial=, % no value + contact NC ladder symbol/.initial=, % no value + var contact NC ladder symbol/.initial=$/$, + contact N ladder symbol/.initial=N, + contact P ladder symbol/.initial=P, + coil ladder symbol/.initial=, % no value + coil NA ladder symbol/.initial=, % no value + var coil NA ladder symbol/.initial=$/$, + coil S ladder symbol/.initial=S, + coil R ladder symbol/.initial=R, + coil ladder curvature/.initial=0.2, % parameter for ( and ) in coils + ladder symbol color/.initial=, % no value + ladder symbol/.initial=, + block ladder input sep/.initial=1.6\tikzcircuitssizeunit, + block ladder output sep/.initial=1.6\tikzcircuitssizeunit, + block ladder inputs/.initial={IN}, + block ladder outputs/.initial={Q}, + block ladder clksize/.initial=0.8\tikzcircuitssizeunit, + block ladder symbol/.initial=TON, % blocks like TON, TOF, TP, ADD, CDU, CDUD\_* +} + +% Internal macro for parsing inputs, outputs and clock inputs (no short version). +% +\expandafter\ifx\csname pgf@lib@sh@ladder@parseinout\endcsname\relax% +\def\pgf@lib@sh@ladder@parseinout#1{% + \edef\pgf@lib@sh@temp{\pgfkeysvalueof{/pgf/block ladder \pgf@lib@sh@ladder@inout}}% + \c@pgf@counta#1\relax% + \c@pgf@countb0\relax% + \expandafter\pgfutil@in@\expandafter,\expandafter{\pgf@lib@sh@temp}% + \let\pgf@lib@sh@next\pgf@lib@sh@ladder@parseinout@long% + \pgf@lib@sh@next% +} +\def\pgf@lib@sh@ladder@parseinout@long{% + \expandafter\pgf@lib@sh@ladder@parseinout@@long\pgf@lib@sh@temp,\pgf@stop,% +} +\def\pgf@lib@sh@ladder@parseinout@@long#1,{% + \ifx#1\pgf@stop% + \expandafter\edef\csname pgf@lib@sh@ladder@num\pgf@lib@sh@ladder@inout\endcsname{\the\c@pgf@countb}% + \let\pgf@lib@sh@next\relax% + \else% + \ifnum\c@pgf@countb=\c@pgf@counta% + \expandafter\edef\csname pgf@lib@sh@ladder@num\pgf@lib@sh@ladder@inout\endcsname{\the\c@pgf@countb}% + \let\pgf@lib@sh@next\relax% + \else% + \advance\c@pgf@countb1\relax% + \def\pgf@lib@sh@temp{#1}% + \expandafter\pgf@sh@resavedmacro\expandafter{\csname \pgf@lib@sh@ladder@inout-\the\c@pgf@countb\endcsname}{% + \expandafter\def\csname \pgf@lib@sh@ladder@inout-\the\c@pgf@countb\endcsname{\expandafter\pgf@lib@sh@temp}}% + \let\pgf@lib@sh@next\pgf@lib@sh@ladder@parseinout@@@long% + \fi% + \fi% + \pgf@lib@sh@next% +} +\def\pgf@lib@sh@ladder@parseinout@@@long{% + \pgfutil@ifnextchar x{\pgf@lib@sh@ladder@parseinout@@long}% + {\pgf@lib@sh@ladder@parseinout@@long}% +} +\fi% + + +% Adjust the width and height of the ladder block symbol. +\def\pgf@lib@sh@ladder@dimensions{ + \pgf@x.5\wd\pgfnodeparttextbox + \pgf@y.5\ht\pgfnodeparttextbox + \advance\pgf@y.5\dp\pgfnodeparttextbox + + % + % Adjust the height for the number of inputs and for the width and height of the ladder block symbol. + % + \c@pgf@counta\pgf@lib@sh@ladder@numinputs + \pgfmathsetlength\pgf@yb{\pgfkeysvalueof{/pgf/block ladder input sep}} + \edef\inputsep{\the\pgf@yb} + \addtosavedmacro\inputsep + \pgf@ya\pgf@yb + \advance\c@pgf@counta-1\relax + \multiply\pgf@yb\c@pgf@counta + \c@pgf@counta\pgf@lib@sh@ladder@numoutputs + \pgfmathsetlength\pgf@yc{\pgfkeysvalueof{/pgf/block ladder output sep}} + \edef\outputsep{\the\pgf@yc} + \addtosavedmacro\outputsep + \pgf@ya\pgf@yc + \advance\c@pgf@counta-1\relax + \multiply\pgf@yc\c@pgf@counta + \ifdim\pgf@yb<\pgf@yc% the highest between inputs and outputs + \pgf@yb\pgf@yc + \fi + % now the symbol width and height + \setbox\pgf@hbox\hbox{{$\mathrm{\pgfkeysvalueof{/pgf/ladder symbol}}$}}% add braces as color-aftergroup-fix TT (error when contains \_) +% \setbox\pgf@hbox\hbox{{$\ensuremath{\mathrm{\pgfkeysvalueof{/pgf/ladder symbol}}$}}}% add braces as color-aftergroup-fix TT +% \setbox\pgf@hbox\hbox{{$\mathrm{TESTE}$}}% add braces as color-aftergroup-fix TT +% \typeout{Test \the\wd\pgf@hbox \the\ht\pgf@hbox \the\dp\pgf@hbox} + \pgf@xc.5\wd\pgf@hbox + \pgf@yc\ht\pgf@hbox + \advance\pgf@yc\dp\pgf@hbox + \advance\pgf@yc1pt + \advance\pgf@yb0.5\pgf@yc + \advance\pgf@yc2pt + \edef\symbolypos{\the\pgf@yc} + \addtosavedmacro\symbolypos + \advance\pgf@yc0.5\pgf@yc + \advance\pgf@yc\pgf@yb + \advance\pgf@yc0pt + \pgf@yc.5\pgf@yc + \ifdim\pgf@x<\pgf@xc + \pgf@x\pgf@xc + \fi + \ifdim\pgf@y<\pgf@yc + \pgf@y\pgf@yc + \fi + \pgfmathaddtolength\pgf@x{\pgfkeysvalueof{/pgf/inner xsep}} + \pgfmathaddtolength\pgf@y{\pgfkeysvalueof{/pgf/inner ysep}} + + % + % Adjust for minimum height and width. + % + \pgfmathsetlength\pgf@xa{\pgfkeysvalueof{/pgf/minimum width}}% + \pgfmathsetlength\pgf@ya{\pgfkeysvalueof{/pgf/minimum height}}% + \ifdim\pgf@x<.5\pgf@xa% + \pgf@x.5\pgf@xa% + \fi% + \ifdim\pgf@y<.5\pgf@ya% + \pgf@y.5\pgf@ya% + \fi% + % + % Take into account the outer sep. + % + \pgfmathaddtolength\pgf@x{\pgfkeysvalueof{/pgf/outer xsep}}% + \pgfmathaddtolength\pgf@y{\pgfkeysvalueof{/pgf/outer ysep}}% + % + \edef\halfwidth{\the\pgf@x}% + \edef\halfheight{\the\pgf@y}% + \addtosavedmacro\halfwidth% + \addtosavedmacro\halfheight% + + \advance\pgf@yb\pgf@y + \advance\pgf@yb-\pgf@yc + \edef\boxdepth{\the\pgf@yb}% below 1st input + \addtosavedmacro\boxdepth +}% + + +\def\pgf@lib@sh@ladder@inputanchor#1{% + \dimensions% + \pgfpointorigin% + \advance\pgf@x-\halfwidth% + % + \pgfutil@tempdima\inputsep% + \multiply\pgfutil@tempdima#1\relax% + \advance\pgf@y-\pgfutil@tempdima% + \advance\pgf@y\inputsep% +} + +\def\pgf@lib@sh@ladder@outputanchor#1{% + \dimensions% + \pgfpointorigin% + \advance\pgf@x\halfwidth% + % + \pgfutil@tempdima\outputsep% + \multiply\pgfutil@tempdima#1\relax% + \advance\pgf@y-\pgfutil@tempdima% + \advance\pgf@y\outputsep% +} + +\def\pgfutil@first@until@relax#1#2\relax{#1} + +% Shapes +% block +\pgfdeclareshape{block ladder}{ + \expandafter\pgfutil@g@addto@macro\csname pgf@sh@s@block ladder\endcsname{% + \def\pgf@lib@sh@ladder@inout{inputs} + \pgf@lib@sh@ladder@parseinout{1024}% Maximum 1024 (!) inputs. + % + \pgfmathloop% + \ifnum\pgfmathcounter>\pgf@lib@sh@ladder@numinputs% + \else% + \pgfutil@ifundefined{pgf@anchor@block ladder@input \pgfmathcounter}{% + \expandafter\xdef\csname pgf@anchor@block ladder@input \pgfmathcounter\endcsname{% + \noexpand\pgf@lib@sh@ladder@inputanchor{\pgfmathcounter}% + }% + }{}% + \repeatpgfmathloop% + \ifnum\pgf@lib@sh@ladder@numinputs<1\relax% + \pgferror{An block must have at least one input}% + \fi% + % + \def\pgf@lib@sh@ladder@inout{outputs} + \pgf@lib@sh@ladder@parseinout{1024}% Maximum 1024 (!) outputs. + % + \pgfmathloop% + \ifnum\pgfmathcounter>\pgf@lib@sh@ladder@numoutputs% + \else% + \pgfutil@ifundefined{pgf@anchor@block ladder@output \pgfmathcounter}{% + \expandafter\xdef\csname pgf@anchor@block ladder@output \pgfmathcounter\endcsname{% + \noexpand\pgf@lib@sh@ladder@outputanchor{\pgfmathcounter}% + }% + }{}% + \repeatpgfmathloop% + \ifnum\pgf@lib@sh@ladder@numoutputs<1\relax% + \pgferror{An block must have at least one output}% + \fi% + }% + + \savedmacro\numinputs{\let\numinputs\pgf@lib@sh@ladder@numinputs}% + \savedmacro\numoutputs{\let\numoutputs\pgf@lib@sh@ladder@numoutputs}% + \savedmacro\dimensions{% + \pgf@lib@sh@ladder@dimensions% + } + \savedanchor\centerpoint{% + \pgfpointorigin + } + \savedanchor\midpoint{% + \pgf@x0pt% + \pgfmathsetlength\pgf@y{+0.5ex}% + } + \savedanchor\basepoint{% + \pgf@x0pt% + \pgf@y0pt% + } + \anchor{text}{\dimensions\pgfpointorigin\advance\pgf@x-.5\wd\pgfnodeparttextbox\advance\pgf@y\halfheight\advance\pgf@y-\boxdepth\advance\pgf@y-.5\ht\pgfnodeparttextbox\advance\pgf@y-.5\dp\pgfnodeparttextbox} +% \anchor{text}{\dimensions\pgfpointorigin\pgf@y\symbolypos\advance\pgf@x-.5\wd\pgfnodeparttextbox\advance\pgf@y-.5\ht\pgfnodeparttextbox\advance\pgf@y-.5\dp\pgfnodeparttextbox} % symbol + \anchor{center}{\pgfpointorigin} + \anchor{mid}{\dimensions\midpoint\advance\pgf@x-.5\wd\pgfnodeparttextbox\advance\pgf@y\halfheight\advance\pgf@y-\boxdepth\advance\pgf@y-.5\ht\pgfnodeparttextbox\advance\pgf@y-.5\dp\pgfnodeparttextbox\advance\pgf@y0.5ex} + \anchor{mid west}{\dimensions\midpoint\advance\pgf@x-\halfwidth\advance\pgf@y\halfheight\advance\pgf@y-\boxdepth\advance\pgf@y-.5\ht\pgfnodeparttextbox\advance\pgf@y-.5\dp\pgfnodeparttextbox\advance\pgf@y0.5ex}% + \anchor{mid east}{\dimensions\midpoint\advance\pgf@x\halfwidth\advance\pgf@y\halfheight\advance\pgf@y-\boxdepth\advance\pgf@y-.5\ht\pgfnodeparttextbox\advance\pgf@y-.5\dp\pgfnodeparttextbox\advance\pgf@y0.5ex}% + \anchor{base}{\dimensions\basepoint\advance\pgf@x-.5\wd\pgfnodeparttextbox\advance\pgf@y\halfheight\advance\pgf@y-\boxdepth\advance\pgf@y-.5\ht\pgfnodeparttextbox\advance\pgf@y-.5\dp\pgfnodeparttextbox} + \anchor{base west}{\dimensions\basepoint\advance\pgf@x-\halfwidth\advance\pgf@y\halfheight\advance\pgf@y-\boxdepth\advance\pgf@y-.5\ht\pgfnodeparttextbox\advance\pgf@y-.5\dp\pgfnodeparttextbox}% + \anchor{base east}{\dimensions\basepoint\advance\pgf@x\halfwidth\advance\pgf@y\halfheight\advance\pgf@y-\boxdepth\advance\pgf@y-.5\ht\pgfnodeparttextbox\advance\pgf@y-.5\dp\pgfnodeparttextbox}% + \anchor{north}{\dimensions\pgfpointorigin\advance\pgf@y\halfheight\advance\pgf@y\halfheight\advance\pgf@y-\boxdepth}% + \anchor{south}{\dimensions\pgfpointorigin\advance\pgf@y-\boxdepth}% + \anchor{east}{\dimensions\pgfpointorigin\advance\pgf@x\halfwidth\advance\pgf@y\halfheight\advance\pgf@y-\boxdepth}% + \anchor{west}{\dimensions\pgfpointorigin\advance\pgf@x-\halfwidth\advance\pgf@y\halfheight\advance\pgf@y-\boxdepth}% + \anchor{north east}{\dimensions\pgfpointorigin\advance\pgf@x\halfwidth\advance\pgf@y\halfheight\advance\pgf@y\halfheight\advance\pgf@y-\boxdepth}% + \anchor{north west}{\dimensions\pgfpointorigin\advance\pgf@x-\halfwidth\advance\pgf@y\halfheight\advance\pgf@y\halfheight\advance\pgf@y-\boxdepth}% + \anchor{south east}{\dimensions\pgfpointorigin\advance\pgf@x\halfwidth\advance\pgf@y-\boxdepth}% + \anchor{south west}{\dimensions\pgfpointorigin\advance\pgf@x-\halfwidth\advance\pgf@y-\boxdepth}% + \backgroundpath{% + \dimensions% + \pgf@xc\halfwidth% + \pgf@yc\halfheight% + \pgfmathaddtolength\pgf@xc{-\pgfkeysvalueof{/pgf/outer xsep}}% + \pgfmathaddtolength\pgf@yc{-\pgfkeysvalueof{/pgf/outer ysep}}% + + \pgf@yb\boxdepth% + \pgfmathaddtolength\pgf@yb{-\pgfkeysvalueof{/pgf/outer ysep}}% + {% + \pgfpathrectangle{\pgfqpoint{-\pgf@xc}{-\pgf@yb}}% + {% + \pgf@x2.0\pgf@xc% + \pgf@y2.0\pgf@yc% + }% + \pgfpathclose% + }% + } + \foregroundpath{ + \dimensions% + {% + % + % Write block type (symbol) + % + \pgf@yc\symbolypos + \expandafter\pgftext\expandafter[/pgf/text/at=\pgfqpoint{0pt}{\pgf@yc},/pgf/text/center]{% + \pgfkeysgetvalue{/pgf/ladder symbol color}{\pgf@lib@sh@temp}% + \ifx\pgf@lib@sh@temp\pgfutil@empty% + \else% + \expandafter\color\expandafter{\pgf@lib@sh@temp}% + \fi% + {\pgfkeysvalueof{/pgf/ladder symbol}}% + }% + % Draw inputs. + % + \pgf@xc-\halfwidth% + \pgfmathaddtolength\pgf@xc{\pgfkeysvalueof{/pgf/outer xsep}} + \pgf@xa\pgf@xc + \pgfmathaddtolength\pgf@xc{\pgfkeysvalueof{/pgf/inner xsep}} + \pgf@yc\inputsep% + \pgfmathloop% + \ifnum\pgfmathcounter>\numinputs% + \else% + \advance\pgf@yc-\inputsep% + \edef\pgf@lib@sh@temp{\csname inputs-\pgfmathcounter\endcsname} + \pgf@xb\pgf@xc + \if>\expandafter\pgfutil@first@until@relax\pgf@lib@sh@temp\relax + \edef\pgf@lib@sh@temp{\expandafter\expandafter\expandafter\pgfutil@gobble\pgf@lib@sh@temp} + \pgf@ya\pgf@yc + \pgfmathsetlength\pgf@yb{\pgfkeysvalueof{/pgf/block ladder clksize}} + \pgfmathaddtolength\pgf@ya{0.5\pgf@yb} + \pgfpathmoveto{\pgfqpoint{\pgf@xa}{\pgf@ya}} + \pgfmathaddtolength\pgf@ya{-0.5\pgf@yb} + \pgfmathaddtolength\pgf@xa{\pgf@yb} + \pgfpathlineto{\pgfqpoint{\pgf@xa}{\pgf@ya}} + \pgfmathaddtolength\pgf@ya{-0.5\pgf@yb} + \pgfmathaddtolength\pgf@xa{-\pgf@yb} + \pgfpathlineto{\pgfqpoint{\pgf@xa}{\pgf@ya}} + \pgfmathaddtolength\pgf@xb{\pgf@yb} + \pgfpathclose + \fi + \expandafter\pgftext\expandafter[/pgf/text/at=\pgfqpoint{\pgf@xb}{\pgf@yc},/pgf/text/left]{% + \pgfkeysgetvalue{/pgf/ladder symbol color}{\pgf@lib@sh@@temp}% + \ifx\pgf@lib@sh@@temp\pgfutil@empty% + \else% + \expandafter\color\expandafter{\pgf@lib@sh@@temp}% + \fi% + {\pgf@lib@sh@temp}% + }% + \repeatpgfmathloop% + % Draw outputs. + % + \pgf@xc\halfwidth% + \pgfmathaddtolength\pgf@xc{-\pgfkeysvalueof{/pgf/inner xsep}} + \pgfmathaddtolength\pgf@xc{-\pgfkeysvalueof{/pgf/outer xsep}} + \pgf@yc\outputsep% + \pgfmathloop% + \ifnum\pgfmathcounter>\numoutputs% + \else% + \advance\pgf@yc-\outputsep% + \expandafter\pgftext\expandafter[/pgf/text/at=\pgfqpoint{\pgf@xc}{\pgf@yc},/pgf/text/right]{% + \pgfkeysgetvalue{/pgf/ladder symbol color}{\pgf@lib@sh@temp}% + \ifx\pgf@lib@sh@temp\pgfutil@empty% + \else% + \expandafter\color\expandafter{\pgf@lib@sh@temp}% + \fi% + {\csname outputs-\pgfmathcounter\endcsname}% + }% + \repeatpgfmathloop% + + }% + } + \anchorborder{% + \dimensions% + \pgfextract@process\externalpoint{}% + \ifdim\pgf@y<0pt% + \pgf@process{\pgfpointborderrectangle{\externalpoint}{\pgfqpoint{\halfwidth}{\boxdepth}}}% + \else% + \pgf@yc\halfheight + \advance\pgf@yc\halfheight\advance\pgf@yc-\boxdepth + \pgf@process{\pgfpointborderrectangle{\externalpoint}{\pgfqpoint{\halfwidth}{\pgf@yc}}}% + \fi% + }% +} + + + + +% contact +\pgfdeclareshape{contact ladder} +{ + \inheritsavedanchors[from=rectangle ee] + \inheritanchor[from=rectangle ee]{center} + \inheritanchor[from=rectangle ee]{north} + \inheritanchor[from=rectangle ee]{south} + \inheritanchor[from=rectangle ee]{east} + \inheritanchor[from=rectangle ee]{west} + \inheritanchor[from=rectangle ee]{north east} + \inheritanchor[from=rectangle ee]{north west} + \inheritanchor[from=rectangle ee]{south east} + \inheritanchor[from=rectangle ee]{south west} + \inheritanchor[from=rectangle ee]{input} + \inheritanchor[from=rectangle ee]{output} + \inheritanchorborder[from=rectangle ee] + \savedanchor\centerpoint{% + \pgf@x.5\wd\pgfnodeparttextbox% + \pgf@y.5\ht\pgfnodeparttextbox% + \advance\pgf@y-.5\dp\pgfnodeparttextbox% + } + + \backgroundpath{ + \pgf@process{\pgfpointadd{\southwest}{\pgfpoint{\pgfkeysvalueof{/pgf/outer xsep}}{\pgfkeysvalueof{/pgf/outer ysep}}}} + \pgf@xa=\pgf@x \pgf@ya=\pgf@y + \pgf@process{\pgfpointadd{\northeast}{\pgfpointscale{-1}{\pgfpoint{\pgfkeysvalueof{/pgf/outer xsep}}{\pgfkeysvalueof{/pgf/outer ysep}}}}} + \pgf@xb=\pgf@x \pgf@yb=\pgf@y + \pgfpathmoveto{\pgfqpoint{\pgf@xa}{\pgf@ya}} + \pgfpathmoveto{\pgfqpoint{\pgf@xa}{\pgf@yb}} + \pgfpathlineto{\pgfqpoint{\pgf@xa}{\pgf@ya}} + \ifpgfnormallyclosednegated + \pgfsetbeveljoin + \pgfpathlineto{\pgfqpoint{\pgf@xb}{\pgf@yb}} + \else + \pgfpathmoveto{\pgfqpoint{\pgf@xb}{\pgf@yb}} + \fi + \pgfpathlineto{\pgfqpoint{\pgf@xb}{\pgf@ya}} + } + \foregroundpath{ + \pgftransformshift{\centerpoint} + \pgftext{\pgfkeysvalueof{/pgf/ladder symbol}} + } +} + +% coil +\pgfdeclareshape{coil ladder} +{ + \inheritsavedanchors[from=rectangle ee] + \inheritanchor[from=rectangle ee]{center} + \inheritanchor[from=rectangle ee]{north} + \inheritanchor[from=rectangle ee]{south} + \inheritanchor[from=rectangle ee]{east} + \inheritanchor[from=rectangle ee]{west} + \inheritanchor[from=rectangle ee]{north east} + \inheritanchor[from=rectangle ee]{north west} + \inheritanchor[from=rectangle ee]{south east} + \inheritanchor[from=rectangle ee]{south west} + \inheritanchor[from=rectangle ee]{input} + \inheritanchor[from=rectangle ee]{output} + \inheritanchorborder[from=rectangle ee] + \savedanchor\centerpoint{% + \pgf@x.5\wd\pgfnodeparttextbox% + \pgf@y.5\ht\pgfnodeparttextbox% + \advance\pgf@y-.5\dp\pgfnodeparttextbox% + } + + \backgroundpath{ + \pgf@process{\pgfpointadd{\southwest}{\pgfpoint{\pgfkeysvalueof{/pgf/outer xsep}}{\pgfkeysvalueof{/pgf/outer ysep}}}} + \pgf@xa=\pgf@x \pgf@ya=\pgf@y + \pgf@process{\pgfpointadd{\northeast}{\pgfpointscale{-1}{\pgfpoint{\pgfkeysvalueof{/pgf/outer xsep}}{\pgfkeysvalueof{/pgf/outer ysep}}}}} + \pgf@xb=\pgf@x \pgf@yb=\pgf@y + + \pgfmathsetlength\pgf@xc{\pgfkeysvalueof{/pgf/coil ladder curvature}\pgf@xb-\pgfkeysvalueof{/pgf/coil ladder curvature}\pgf@xa} % uses a reduction of 20% (by default) for beginning of the arcs, if it is 0.5 and width=height we got a circle, do not set to zero + \pgfmathsetlength\pgf@yc{.5\pgf@yb-.5\pgf@ya} + \pgfmathsetlength\pgf@ya{0.5\pgf@xc + 0.5\pgf@yc*\pgf@yc / \pgf@xc} % radius + \advance\pgf@xa by \pgf@xc + \advance\pgf@xb by-\pgf@xc + \pgfmathsetlength\pgf@yc{\pgf@yc / \pgf@ya} + \pgfmathasin{\pgf@yc} + \pgfmathsetlength\pgf@yc{\pgfmathresult} % angle + \pgfpathmoveto{\pgfqpoint{\pgf@xa}{\pgf@yb}} + \pgfpatharc{180-\pgf@yc}{180+\pgf@yc}{\pgf@ya} + \ifpgfnormallyclosednegated + \pgfsetbeveljoin + \pgfpathlineto{\pgfqpoint{\pgf@xb}{\pgf@yb}} + \else + \pgfpathmoveto{\pgfqpoint{\pgf@xb}{\pgf@yb}} + \fi + \pgfpatharc{\pgf@yc}{-\pgf@yc}{\pgf@ya} + } + \foregroundpath{ + \pgftransformshift{\centerpoint} + \pgftext{\pgfkeysvalueof{/pgf/ladder symbol}} + } +} +\makeatother + +\tikzset{ + circuit declare symbol=contact NO, + circuit declare symbol=contact NC, + circuit declare symbol=var contact NC, + circuit declare symbol=contact P, + circuit declare symbol=contact N, + circuit declare symbol=coil, + circuit declare symbol=coil NA, + circuit declare symbol=var coil NA, + circuit declare symbol=coil S, + circuit declare symbol=coil R, + circuit declare symbol=block, + set contact NO graphic={ + circuit symbol lines, + circuit symbol size=width 1.5 height 2, + transform shape, + shape=contact ladder + }, + set contact NC graphic={ + circuit symbol lines, + circuit symbol size=width 1.5 height 2, + transform shape, + crossed ladder=true, + shape=contact ladder + }, + set var contact NC graphic={ + circuit symbol lines, + circuit symbol size=width 1.5 height 2, + transform shape, + ladder symbol=\pgfkeysvalueof{/pgf/var contact NC ladder symbol}, + shape=contact ladder + }, + set contact P graphic={ + circuit symbol lines, + circuit symbol size=width 1.5 height 2, + transform shape, + ladder symbol=\pgfkeysvalueof{/pgf/contact P ladder symbol}, + shape=contact ladder + }, + set contact N graphic={ + circuit symbol lines, + circuit symbol size=width 1.5 height 2, + transform shape, + ladder symbol=\pgfkeysvalueof{/pgf/contact N ladder symbol}, + shape=contact ladder + }, + set coil graphic={ + circuit symbol lines, + fill=none, + circuit symbol size=width 2.4 height 2, + transform shape, + shape=coil ladder + }, + set coil NA graphic={ + circuit symbol lines, + circuit symbol size=width 2.4 height 2, + crossed ladder=true, + transform shape, + shape=coil ladder + }, + set var coil NA graphic={ + circuit symbol lines, + circuit symbol size=width 2.4 height 2, + ladder symbol=\pgfkeysvalueof{/pgf/var coil NA ladder symbol}, + transform shape, + shape=coil ladder + }, + set coil S graphic={ + circuit symbol lines, + circuit symbol size=width 2.4 height 2, + ladder symbol=\pgfkeysvalueof{/pgf/coil S ladder symbol}, + transform shape, + shape=coil ladder + }, + set coil R graphic={ + circuit symbol lines, + circuit symbol size=width 2.4 height 2, + ladder symbol=\pgfkeysvalueof{/pgf/coil R ladder symbol}, + transform shape, + shape=coil ladder + }, + set block graphic={ + circuit symbol lines, + circuit symbol size=width 2.4 height 2, + ladder symbol=\pgfkeysvalueof{/pgf/block ladder symbol}, + transform shape, + inner sep=.5ex, + shape=block ladder, + every ladder block/.try + } +}
\ No newline at end of file |