summaryrefslogtreecommitdiff
path: root/graphics/pinoutikz/pinoutikz_doc_en.tex
blob: d72b572cf48a0667d34baf75d07ee52564c6a586 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
\documentclass[english,a4paper,10pt]{article}
\usepackage{fontspec}
\usepackage[bookmarks=true,bookmarksopen=true,colorlinks=true,hyperfootnotes=false,filecolor=black,linkcolor=blue,urlcolor=blue,pdfauthor={Robert Blazek},pdftitle={pinouTikz},pdfsubject={package for strings of tokens},pdfkeywords={pinouTikz,latex,chip,pinout},pdfcreator={LaTeX}]{hyperref}
\usepackage[margin=1.9cm]{geometry}
\usepackage{libertine}
\usepackage[scale=0.85]{noto-mono}
\usepackage[bottom]{footmisc}
\usepackage{amsmath,amssymb,amsfonts,color,eurosym,xspace,babel,listings}
\usepackage{pinoutikz}
\makeatletter
\definecolor{@xs@bckgcolor}{rgb}{0.9,1,1}
\definecolor{@xs@keywordspinouTikz}{rgb}{0,0,0.9}
\definecolor{@xs@keywordslatex}{rgb}{1,0,0}
\definecolor{@xs@arguments}{rgb}{0,0,0}
\definecolor{@xs@comments}{rgb}{0.5,0.5,0.5}
\definecolor{violet}{rgb}{0.66,0,0.66}
\lstset{%
	language=[AlLaTeX]TeX,%
	morekeywords={numexpr,detokenize},%
	float=hbp,%
	basicstyle=\small\ttfamily,%
	identifierstyle=\color{@xs@arguments},%
	keywordstyle=\color{@xs@keywordslatex},%
	commentstyle=\itshape\color{@xs@comments},%
	columns=fixed,%
	tabsize=4,%
	frame=single,%
	extendedchars=true,%
	showspaces=false,%
	showstringspaces=false,%
	numbers=left,%
	numberstyle=\tiny\ttfamily,%
	breaklines=true,%
	breakindent=3em,%
	backgroundcolor=\color{@xs@bckgcolor},%
	breakautoindent=true,%
	captionpos=t,%
	xleftmargin=1em,%
	xrightmargin=1em,%
	lineskip=0pt,%
	numbersep=1em,%
	classoffset=1,%
	morekeywords={% macros and commands of pinouTikz
		PDIP,%
		PLCC,%
		SOP},%
	keywordstyle=\color{@xs@keywordspinouTikz},%
	classoffset=0}
\makeatother

\newcommand\guill[1]{"#1"}
\newcommand\argu[1]{$\langle$\textit{#1}$\rangle$}
\newcommand\ARGU[1]{\texttt{\{}\argu{#1}\texttt{\}}}
\newcommand\arguC[1]{\texttt{[}\argu{#1}\texttt{]}}
\newcommand\arguCC[2]{\texttt{[}\argu{#1}{,}\argu{#2}\texttt{]}}
\newcommand\arguD[1]{\texttt{(}\argu{#1}\texttt{)}}
\newcommand\texte[1]{\texttt{text}${}_{#1}$}
\newcommand\etoile{$\langle$\texttt{[*]}$\rangle$}
\newenvironment{Conditions}[1][1cm]%
{\begin{list}%
	{$\vartriangleright$}%
	{\setlength{\leftmargin}{#1}
	 \setlength{\itemsep}{0pt}
	 \setlength{\parsep}{0pt}
	 \setlength{\topsep}{2ptplus3ptminus2pt}
	}}%
{\end{list}}
\renewcommand\th{${}^\text{th}$\xspace}
\newcommand\US{syntax unit\xspace}
\newcommand\USs{syntax units\xspace}
\newcommand\pinouTikz{\textsf{pinouTikz}\xspace}
\newcommand\styleexemple{\small\baselineskip1.03\baselineskip\vskip\baselineskip\relax}
\newcommand\styleexercice{\footnotesize}
\newcommand\verbinline{\lstinline[basicstyle=\normalsize\ttfamily]}
\newcommand\colorise{\color{violet}}
\begin{document}
\setlength{\parindent}{0pt}
\begin{titlepage}
	\null\par\vfill
	\begin{center}
		\begin{minipage}{0.75\linewidth}
			\begin{center}
				\Huge\bfseries \pinoutikzname\par\vspace{5pt}
				\small v\pinoutikzversion\par\vspace{25pt}
				\normalsize User's manual
			\end{center}
		\end{minipage}
	\end{center}
	\vspace{1cm}
	\begin{center}
		Robert {\sc Blazek}\par\small
		\href{mailto:robert.h.blazek@gmail.com}{\nolinkurl{robert.h.blazek@gmail.com}}\par\vspace{5pt}
		%\xstringenglishdate
	\end{center}
	\vfill\hrulefill
	\begin{center}
		\begin{minipage}{0.85\linewidth}
			\noindent
			\hfill\textbf{\textit{Abstract}}\hfill{}\medskip\par
			This package which requires $\varepsilon$-\TeX{}, provides macros manipulating strings of tokens. For a basic use, tokens can be alphanumeric chars, but the macros can also be useful for manipulating tokens, i.e. \TeX{} code. 

		\end{minipage}
	\end{center}
	\hrulefill\vfill{}
\end{titlepage}

\tableofcontents

\section{Introduction}
\subsection{Description}
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.

I hope others will find it as useful as it was to me and my colleagues.

This is my first latex package documentation ever - and since I hate reinventing the wheel - this manual has been based upon that of \textbf{xstrings} - with the courtesy of the author, of course.

\section{The macros}
For a better understanding, let's see first the macros with the simpler arguments possible. No special catcode, no exotic token, no control sequence neither: only alphanumeric chars will be contained in the arguments.\medskip

In the following chapters, all the macros will be presented this way:
\begin{itemize}
	\item a short description of the operation;
	\item the operation under special conditions. For each conditions considered, the operation described has priority on that (those) below;
	\item finally, several examples are given. I tried to find them most easily comprehensible and most representative of the situations met in normal use.
\end{itemize}\smallskip

\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}.

\subsection{The pinout diagrams}
\subsubsection{\ttfamily\textbackslash PDIP}
\verbinline|\PDIP|\arguD{pinnumber}\ARGU{pinarray}
\smallskip

\begin{itemize}
	\item \argu{pinnumber} thethe  number of pins of a DIP package and should be an even number.
	\item \ARGU{pinarray} is a list of pins - position of every pin's description is defined by its position in this array.
\end{itemize}

%% 4-pin example
%\begin{minipage}[t]{0.65\linewidth}
\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}
\end{figure}
\end{lstlisting}%

%% 4-pin example
\begin{figure}
  \centering
  \PDIP(4){%
  	1/E,
  	2/B,
  	3/NC,
  	4/C
  	}%
  \caption{NPN-Transistor, 4-pin PDIP package} \label{fig:X_DIP4}
\end{figure}

%\end{minipage}\hfill
%% 8-pin example
%\begin{minipage}[t]{0.65\linewidth}
\begin{lstlisting}
\begin{figure}
  \centering
  \PDIP(8){%
  	1/CLK,
  	2/A,
  	3/B,
  	4/GND,
  	5/Y,
  	6/\FormatPinLabel{~Y~},
  	7/NC,
  	8/$V_{cc}$%
  	}
  \caption{TTL logic chip, 8-pin PDIP package} \label{fig:X_DIP8}
\end{figure}
\end{lstlisting}%

%% 8-pin example
\begin{figure}
  \centering
  \PDIP(8){%
  	1/CLK,
  	2/A,
  	3/B,
  	4/GND,
  	5/Y,
  	6/\FormatPinLabel{~Y~},
  	7/NC,
  	8/$V_{cc}$%
  	}
  \caption{TTL logic chip, 8-pin PDIP package} \label{fig:X_DIP8}
\end{figure}

%\end{minipage}\hfill
%% 14-pin example
%\begin{minipage}[t]{0.65\linewidth}
\begin{lstlisting}
\begin{figure}
  \centering
  \PDIP(14){%
  	1/A1,										%1
  	2/B1,										%2
  	3/\FormatPinLabel{\#1 AND/~OR~/GPIO1},			%3
  	4/Y1,										%4
  	5/C1,										%5
  	6/\FormatPinLabel{\#2 AND/~OR~/GPIO2},			%6
  	7/GND,									%7
  	8/PCLK,									%8
  	9/PDAT,									%9
  	10/A2,									%10
  	11/B2,									%11
  	12/\FormatPinLabel{\#2 INV/~SME~/GPIO3},		%12
  	13/C2,									%13
  	14/$V_{cc}$}								%14
  \caption{Generic programmable TTL logic chip, 14-pin PDIP package} \label{fig:X_DIP14}
\end{figure}
\end{lstlisting}%
%\end{minipage}\hfill

%% 14-pin example
\begin{figure}
  \centering
  \PDIP(14){%
  	1/A1,									%1
  	2/B1,									%2
  	3/\FormatPinLabel{\#1 AND/~OR~/GPIO1},		%3
  	4/Y1,									%4
  	5/C1,									%5
  	6/\FormatPinLabel{\#2 AND/~OR~/GPIO2},		%6
  	7/GND,								%7
  	8/PCLK,								%8
  	9/PDAT,								%9
  	10/A2,								%10
  	11/B2,								%11
  	12/\FormatPinLabel{\#2 INV/~SME~/GPIO3},	%12
  	13/C2,								%13
  	14/$V_{cc}$}							%14
  \caption{Generic programmable TTL logic chip, 14-pin PDIP package} \label{fig:X_DIP14}
\end{figure}

%% Examples for PDIP packages
\begin{minipage}[t]{0.35\linewidth}
	\styleexemple
\end{minipage}%


%\bigskip\bigskip
\begin{center}
$\star$\par
$\star$\quad$\star$
\end{center}
\par\nobreak\bigskip\bigskip
That's all, I hope you will find this package useful!\par\nobreak
Please, send me an \href{mailto:robert.h.blazek@gmail.com}{email} if you find a bug or if you have any idea of improvement\ldots\par\nobreak\medskip
Robert Blazek
\end{document}