summaryrefslogtreecommitdiff
path: root/graphics/pgf/contrib/pinoutikz/pinoutikz_doc_en.tex
diff options
context:
space:
mode:
Diffstat (limited to 'graphics/pgf/contrib/pinoutikz/pinoutikz_doc_en.tex')
-rw-r--r--graphics/pgf/contrib/pinoutikz/pinoutikz_doc_en.tex93
1 files changed, 82 insertions, 11 deletions
diff --git a/graphics/pgf/contrib/pinoutikz/pinoutikz_doc_en.tex b/graphics/pgf/contrib/pinoutikz/pinoutikz_doc_en.tex
index 8b27813ff8..109c2c4073 100644
--- a/graphics/pgf/contrib/pinoutikz/pinoutikz_doc_en.tex
+++ b/graphics/pgf/contrib/pinoutikz/pinoutikz_doc_en.tex
@@ -42,7 +42,11 @@
classoffset=1,%
morekeywords={% macros and commands of pinouTikz
PDIP,%
+ pctPDIP,%
PLCC,%
+ pctPLCC,%
+ TQFP,%
+ pctTQFP,%
SOP},%
keywordstyle=\color{@xs@keywordspinouTikz},%
classoffset=0}
@@ -111,7 +115,7 @@
This package defines macros for generating symbolic pinout diagrams for different package classes, such as DIP, PLCC, etc.
\subsection{Motivation}
-Whoever has ever had to do with FPGA or MCUs (whether for living and leisure), it's just natural he or she might have been in a need to document some pins. So was my case and since I failed in finding any package in \LaTeX{} to suit my needs, I opted for creating one myself.
+Whoever has ever had to do with FPGA or MCUs (whether for living or leisure), it's just natural he or she might have been in a need to document some pins. So was my case and since I failed in finding any package in \LaTeX{} to suit my needs, I opted for creating one myself.
I hope others will find it as useful as it was to me and my colleagues.
@@ -129,28 +133,32 @@ In the following chapters, all the macros will be presented this way:
\textbf{Important}: in the following, a \argu{number} can be an integer written with numeric chars, a counter, or the result of an arithmetic operation made with the command \verbinline|\numexpr|.\smallskip
-All the macros of \pinouTikz are displayed in {\makeatletter\color{@xs@keywordspinouTikz}red}.
+All the macros of \pinouTikz are displayed in {\makeatletter\color{@xs@keywordspinouTikz}blue}.
\subsection{The pinout diagrams}
\subsubsection{\ttfamily\textbackslash PDIP}
\verbinline|\PDIP|\arguD{pincount}\ARGU{pinarray}
\smallskip
-Draws a PDIP package with generic number of pins.
+Draws a PDIP package with generic number of pins, as a standalone glyph.
+
+\verbinline|\pctPDIP|\arguD{pincount}\ARGU{pinarray}
+\smallskip
+
+Draws a PDIP package with generic number of pins, as a picture sub-element.
\begin{itemize}
\item \argu{pincount} the number of pins of a DIP package and should be an even number.
\item \ARGU{pinarray} is a comma-separated list of pins - each pin definition is as follows: \argu{pinnumber}/\ARGU{pinlabel}.
\end{itemize}
-%% 4-pin example
-%\begin{minipage}[t]{0.65\linewidth}
+%% 4-pin example, as a glyph
\begin{lstlisting}
\begin{figure}
\centering
\PDIP(4){%
1/{E},2/B,3/NC,4/C}
- \caption{NPN-Transistor, 4-pin PDIP package} \label{fig:X_DIP4}
+ \caption{NPN-Transistor, 4-pin PDIP package, as a glyph} \label{fig:X_DIP4}
\end{figure}
\end{lstlisting}%
@@ -163,10 +171,63 @@ Draws a PDIP package with generic number of pins.
3/NC,
4/C
}%
- \caption{NPN-Transistor, 4-pin PDIP package} \label{fig:X_DIP4}
+ \caption{NPN-Transistor, 4-pin PDIP package, as a glyph} \label{fig:X_DIP4}
+\end{figure}
+
+%% 4-pin example, within a picture
+\begin{lstlisting}
+\begin{figure}[ht!]
+ \centering
+ \begin{tikzpicture}
+ % an arbitrary picture laid over the PDIP diagram
+ \draw[thick,rounded corners=8pt](0,0)-- (0,2)-- (1,3.25)-- (2,2)-- (2,0)-- (0,2)-- (2,2)-- (0,0);
+ % a PDIP diagram itself
+ \pctPDIP(4){%
+ 1/{E},
+ 2/B,
+ 3/NC,
+ 4/C
+ }%
+ % a PDIP diagram itself
+ \begin{scope}[shift={(3.5,0.5)}]
+ \pctPDIP(4){%
+ 1/{E},
+ 2/B,
+ 3/NC,
+ 4/C
+ }%
+ \end{scope}
+ \end{tikzpicture}
+ \caption{NPN-Transistor, 4-pin PDIP package, placed within another picture, twice} \label{fig:X_DIP8}
+\end{figure}
+\end{lstlisting}%
+
+%% 4-pin example, within a picture
+\begin{figure}[ht!]
+ \centering
+ \begin{tikzpicture}
+ % an arbitrary picture laid over the PDIP diagram
+ \draw[thick,rounded corners=8pt](0,0)-- (0,2)-- (1,3.25)-- (2,2)-- (2,0)-- (0,2)-- (2,2)-- (0,0);
+ % a PDIP diagram itself
+ \pctPDIP(4){%
+ 1/{E},
+ 2/B,
+ 3/NC,
+ 4/C
+ }%
+ % a PDIP diagram itself
+ \begin{scope}[shift={(3.5,0.5)}]
+ \pctPDIP(4){%
+ 1/{E},
+ 2/B,
+ 3/NC,
+ 4/C
+ }%
+ \end{scope}
+ \end{tikzpicture}
+ \caption{NPN-Transistor, 4-pin PDIP package, placed within another picture, twice} \label{fig:X_DIP8}
\end{figure}
-%\end{minipage}\hfill
%% 8-pin example
%\begin{minipage}[t]{0.65\linewidth}
\begin{lstlisting}
@@ -182,7 +243,7 @@ Draws a PDIP package with generic number of pins.
7/NC,
8/$V_{cc}$%
}
- \caption{TTL logic chip, 8-pin PDIP package} \label{fig:X_DIP8}
+ \caption{TTL logic chip, 8-pin PDIP package, as a glyph} \label{fig:X_DIP8}
\end{figure}
\end{lstlisting}%
@@ -199,7 +260,7 @@ Draws a PDIP package with generic number of pins.
7/NC,
8/$V_{cc}$%
}
- \caption{TTL logic chip, 8-pin PDIP package} \label{fig:X_DIP8}
+ \caption{TTL logic chip, 8-pin PDIP package, as a glyph} \label{fig:X_DIP8}
\end{figure}
%\end{minipage}\hfill
@@ -253,7 +314,12 @@ Draws a PDIP package with generic number of pins.
\verbinline|\TQFP|\arguD{pinnumber}\ARGU{pinarray}
\smallskip
-Draws a TQFP package with generic number of pins.
+Draws a TQFP package with generic number of pins, as a standalone glyph.
+
+\verbinline|\pctTQFP|\arguD{pinnumber}\ARGU{pinarray}
+\smallskip
+
+Draws a TQFP package with generic number of pins, as a picture sub-element.
\begin{itemize}
\item \argu{pincount} the number of pins of a DIP package and should be an even number.
@@ -348,6 +414,11 @@ Draws a TQFP package with generic number of pins.
Draws a PLCC package with generic number of pins.
+\verbinline|\pctPLCC|\arguD{pinnumber}\ARGU{pinarray}
+\smallskip
+
+Draws a PLCC package with generic number of pins, as a picture sub-element.
+
\begin{itemize}
\item \argu{pincount} the number of pins of a DIP package and should be an even number.
\item \ARGU{pinarray} is a comma-separated list of pins - each pin definition is as follows: \argu{pinnumber}/\ARGU{pinlabel}.