Debian Codegraph @

texmf-dist/doc/latex/tikzcodeblocks/tikzcodeblocks-documentation.tex

raw
1 \documentclass[12pt,a4paper]{ltxdoc}
2
3 % TODO: \ex schön machen
4 % TODO: Beispielliste anlegen und am Ende anzeigen lassen
5 % TODO: Eckige Boxen in Obenrobertamode ermöglichen
6
7 \usepackage[T1]{fontenc}
8 \usepackage[utf8]{inputenc}
9 \usepackage[english,ngerman]{babel}
10
11 \usepackage{standalone}
12
13 \usepackage[%print
14 ]{tikzcodeblocks}
15 \usepackage{todonotes}
16 \usepackage{listings}
17 \usepackage{lmodern} % für textbf in texttt
18 \usepackage{wrapfig,booktabs}
19 \usepackage[babel]{csquotes}
20 \usepackage[right=2cm,left=4.5cm,bottom=3cm,top=2.5cm]{geometry}
21
22 \definecolor{buw-gruen}{HTML}{446700}%89ba17
23
24 \lstset{
25 basicstyle=\ttfamily,
26 breaklines=true,
27 %literate={ä}{{\"a}}1 {ü}{{\"u}}1 {ö}{{\"o}}1 {ß}{{\ss}}1 {Ä}{{\"A}}1 {Ü}{{\"Ü}}1 {Ö}{{\"O}}1,
28 tabsize=2,
29 language=[LaTeX]{TeX},
30 numbers=left, numberstyle=\tiny,%, stepnumber=5, numbersep=5pt,
31 keywordstyle=\color{red}, % keyword style
32 morekeywords={\node,\tikz},
33 commentstyle=\itshape\color{purple!40!black},
34 frame=L, % adds a frame around the code
35 }
36
37 \lstset{literate=
38 {á}{{\'a}}1 {é}{{\'e}}1 {í}{{\'i}}1 {ó}{{\'o}}1 {ú}{{\'u}}1
39 {Á}{{\'A}}1 {É}{{\'E}}1 {Í}{{\'I}}1 {Ó}{{\'O}}1 {Ú}{{\'U}}1
40 {à}{{\`a}}1 {è}{{\`e}}1 {ì}{{\`i}}1 {ò}{{\`o}}1 {ù}{{\`u}}1
41 {À}{{\`A}}1 {È}{{\'E}}1 {Ì}{{\`I}}1 {Ò}{{\`O}}1 {Ù}{{\`U}}1
42 {ä}{{\"a}}1 {ë}{{\"e}}1 {ï}{{\"i}}1 {ö}{{\"o}}1 {ü}{{\"u}}1
43 {Ä}{{\"A}}1 {Ë}{{\"E}}1 {Ï}{{\"I}}1 {Ö}{{\"O}}1 {Ü}{{\"U}}1
44 {â}{{\^a}}1 {ê}{{\^e}}1 {î}{{\^i}}1 {ô}{{\^o}}1 {û}{{\^u}}1
45 {Â}{{\^A}}1 {Ê}{{\^E}}1 {Î}{{\^I}}1 {Ô}{{\^O}}1 {Û}{{\^U}}1
46 {œ}{{\oe}}1 {Œ}{{\OE}}1 {æ}{{\ae}}1 {Æ}{{\AE}}1 {ß}{{\ss}}1
47 {ű}{{\H{u}}}1 {Ű}{{\H{U}}}1 {ő}{{\H{o}}}1 {Ő}{{\H{O}}}1
48 {ç}{{\c c}}1 {Ç}{{\c C}}1 {ø}{{\o}}1 {å}{{\r a}}1 {Å}{{\r A}}1
49 {€}{{\euro}}1 {£}{{\pounds}}1 {«}{{\guillemotleft}}1
50 {»}{{\guillemotright}}1 {ñ}{{\~n}}1 {Ñ}{{\~N}}1 {¿}{{?`}}1
51 }
52
53 \usepackage{enumitem}
54 \usepackage{hyperref}
55
56 \usepackage{comment}
57 \usepackage{booktabs}
58 \usepackage[nochapter]{vhistory} %TODO ersetzen oder selber implementieren
59
60 \usepackage{array}
61 \usepackage{subcaption}
62
63
64 \title{TikZ Codeblocks v.\vhCurrentVersion}
65 \author{Adrian Salamon}
66 \date{\vhCurrentDate}
67
68
69 \setlength{\parindent}{0em}
70
71
72 \def\PrintDescribeMacro#1{\strut \MacroFont\textcolor{buw-gruen}{\string #1\ }}
73 \let\PrintDescribeEnv\PrintDescribeMacro
74 \let\PrintMacroName\PrintDescribeMacro
75 \let\PrintEnvName\PrintDescribeEnv
76
77
78
79 % Define own examples
80 \usepackage{marginnote}
81 \newcommand{\ex}[1]{\vspace*{1em} \marginnote{\textbf{\sffamily Bsp:} #1}}
82
83 \newcommand{\hinweis}{\noindent{\huge!\,}\normalfont\textbf{\sffamily Hinweis:}}
84
85
86
87
88 \begin{document}
89 \maketitle
90 \tableofcontents
91
92 \section*{Versionshistorie}
93
94 \begin{versionhistory}
95 \vhEntry{0.1 }{2017-07-06}{A. Salamon}{published}
96 \vhEntry{0.11}{2017-07-18}{A. Salamon}{update: shapes, translations and fix typos}
97 \vhEntry{0.12}{2018-04-03}{A. Salamon}{update: LED colors}
98 \vhEntry{0.13}{2020-04-06}{A.~Salamon, A.~Wagner }{bug-fix: wrongly shifed nodes}
99 \end{versionhistory}
100 %
101 \begin{itemize}[leftmargin=*,noitemsep]
102 \item Translations
103 \begin{itemize}[noitemsep]
104 \item via \textbf{babel} for structures (if/wenn, then/dann\dots)
105 \item marcos and styles are now (partly) also in english\footnote{Feel free to contact me, if you are an english speaker and want to use everything in english.}
106 \end{itemize}
107 \item new Shapes
108 \begin{itemize}[noitemsep]
109 \item \tikz\node[codeblocks,musik,pinhigh]{pinhigh};
110 \item \tikz\node[codeblocks,start,pinlow]{pinlow};
111 \end{itemize}
112 \item Package option \texttt{print} gets rid of all colors: \tikz\node[codeblocks,print, aktion,]{no colors};
113 \item Open-Roberta colors are now more accurate and usable next to the standard colors. (see \ref{sec:robertacolors}.)
114 \end{itemize}
115 \begin{itemize}
116 \item fixed LED-Color for NEPO-Editor.
117 \item Nepo:
118 \begin{tikzpicture}[codeblocks,openroberta]
119 \node[bild]{\bild{\0 \X \0 \0 \\}};
120 \end{tikzpicture}
121 %
122 PXT: \begin{tikzpicture}[codeblocks]
123 \node[start]{\bild{\0 \X \0 \0 \\}};
124 \end{tikzpicture}
125 \end{itemize}
126
127 %\begin{longtable}{llp}
128 %0.1. & 2017-07-06 & looong\\
129 %\end{longtable}
130
131 \section{Präambel}
132
133 Diese Sammlung von TikZ Stilen und Kommandos soll helfen, grafische Codeblöcke, wie beim Calliope mini Editor, der Sprache NEPO von Open Roberta oder der Programmierumgebung Scratch zu setzen. Sie ersetzt \textbf{nicht} die Auseinandersetzung mit TikZ und der entsprechenden Syntax. Die Positionierung, Benennung und Referenzierung der Elemente muss weiterhin manuell gestaltet werden.
134
135 Dies ist eine Entwicklerversion. Bezeichner und Paketname können in späteren Versionen noch variieren.
136
137 Fragen nehme ich gerne per \href{mailto:[email protected]?subject=Question for tikzcodeblocks}{[email protected]} entgegen.
138
139
140 \subsection{Editoren mit graphischer Programmierung}
141
142 \texttt{tikzcodeblocks} wurde erstellt, um Quelltexte auf Blockbasis für den Microcontroller Calliope mini zu setzen. Alle verwendeten Farben und Gestaltungen sind daher standardmäßig vom PXT Editor von Calliope inspiriert. Als alternative Farbgebung ist eine Variation nach Open Roberta implementiert (siehe \ref{sec:robertacolors}). Es lässt sich jedoch auch Code mit Farb- und Formgebungen anderer Editoren setzen.
143
144 \begin{table}[hbt!]\centering
145 \begin{tabular}{ll}
146 \toprule
147 Editor & URL \\ \midrule
148
149 PXT - Calliope & \url{http://pxt.calliope.cc/} \\
150 Open Roberta & \url{https://lab.open-roberta.org/} \\
151 Scratch & \url{https://scratch.mit.edu/projects/editor} \\
152 \bottomrule
153 \end{tabular}
154 \caption{Tabelle von Editoren mit graphischen Codeblöcken.}
155 \end{table}
156
157
158
159 \subsection{Alternativpakete}
160
161 Während der Entwicklung dieses Paketes wurde das Paket \texttt{scratch}\footnote{\url{https://www.ctan.org/pkg/scratch?lang=de}.} veröffentlicht. Damit lässt sich graphischer Code in der Optik von Scratch sehr einfach setzen. Die Dokumentation des Pakets ist zur Zeit auf Französisch verfügbar.
162
163 Ein Unterschied zwischen den Paketen \texttt{scratch} und \texttt{tikzcodeblocks} ist m.\,E. vor allem folgender: \texttt{scratch} lässt sich \textbf{nicht} in andere TikZ Umgebungen einbinden. Die einzelnen Objekte sind nicht als Nodes\footnote{In dieser Dokumentation wird die Bezeichnung \textbf{Node} für die Knoten in TikZ verwendet.} referenzierbar. Die Syntax ist jedoch deutlich schmaler als bei \texttt{tikzcodeblocks}. Ein Blick lohnt sich bestimmt für die meisten interessierten Nutzer.
164
165
166 \subsection{Installation und Benutzung}
167
168 Das Paket wird über die üblichen \LaTeX-Paketmanager installiert (z.\,B. \TeX{}Live)
169 und per \DescribeMacro{tikzcodeblocks} \lstinline|\usepackage{tikzcodeblocks}| in die Präambel des gewünschten Dokuments eingebunden.
170
171 \DescribeMacro{codeblocks} Mit \lstinline|\begin{tikzpicture}[codeblocks]| werden die Codeblock-Stile in die jeweilige tikzpicture-Umgebung geladen. Es setzt das Verhalten für \lstinline[language=TeX]|every Node|.
172
173 % Nacktes Beispiel
174 \begin{minipage}{0.6\textwidth}
175 \lstinputlisting[language={},morekeywords={usepackage, codeblocks}
176 ]{examples/bsp-hello-world.tikz}
177 \end{minipage}
178 \begin{minipage}{0.4\textwidth}
179 \input{examples/bsp-hello-world.tikz}
180 \end{minipage}
181
182
183 \section{Beispielcode}
184
185 Eine Beispiel zeigt Ergebnisse der Nutzung des Pakets.
186 Der Quellcode zur Erstellung der Vektorgrafik folgt unter dem Beispiel.
187
188 \begin{center}
189 \input{examples/bsp-start-roberta.tikz}
190 \end{center}
191 \lstinputlisting[basicstyle=\footnotesize \ttfamily]{examples/bsp-start-roberta.tikz}
192
193
194 \subsection{English Codeexample}
195
196 \begin{center}
197 \input{examples/bsp-english.tikz}
198 \end{center}
199 %
200 \lstinputlisting[
201 basicstyle=\footnotesize \ttfamily,
202 language={},
203 morekeywords={
204 square,
205 moveindent,
206 under,
207 ifthenelsecode,
208 loopcode,
209 puzzlepiece,
210 otherlanuage}
211 ]{examples/bsp-english.tikz}
212
213 \clearpage
214
215
216 \section{Bausteine und Befehle}
217
218 \subsection{Bausteinklassen nach PXT-Calliope Editor}
219
220 % Hilfskonstruktionen für das schnelle Setzen aller Stile
221 \newcommand{\trynode}[1]{\lstinline|#1|& \tikz\node[#1,codeblocks]{#1}; & \tikz\node[openroberta,#1,codeblocks,eckig,]{#1};\\}
222 \newcommand{\trynodeOpenRoberta}[1]{\lstinline|#1|& \tikz\node[openroberta,#1,codeblocks,eckig,]{#1};\\}
223
224 Die Klassen der Programmierbausteine werden nach folgendem Muster als TikZ-Style angegeben.
225
226 \begin{quotation}
227 \lstinline|\node[STYLE] {Inhalt};|
228 \end{quotation}
229
230 Die Defaulteinstellung orientiert sich an den Farben und Formen des Calliope-PXT-Editors. Mithilfe des Stils \DescribeMacro{openroberta} \lstinline|openroberta| können alternative Farb- und Formdefinitionen geladen werden, die sich an der NEPO-Umgebung von Open-Roberta orientieren. Der Stil kann auch für eine ganze TikZ-Umgebung verwendet werden.
231
232 \label{sec:robertacolors}
233 \renewcommand{\arraystretch}{0.6}
234 \begin{longtable}{lll}
235 \toprule
236 \sffamily Stilname & \sffamily pxt (Standard) & \sffamily openroberta\\ \midrule \endhead
237 \trynode{grundlage}
238 \trynode{eingabe}
239 \trynode{schleife}
240 \trynode{logik}
241 \trynode{musik}
242 \trynode{led}
243 \trynode{platzhalter}
244 \trynode{mathe}
245 \trynode{funk}
246 \trynode{motor}
247 \trynode{zeichenkette}
248 \trynode{spiel}
249 \trynode{bild}
250 \trynode{pins}
251 \trynode{konsole}
252 \trynode{steuerung}
253 \trynode{bluetooth}
254 % OopenRoberta
255 \trynode{start}
256 \trynode{aktion}
257 \trynode{sensor}
258 \trynode{kontrolle}
259 \trynode{liste}
260 \trynode{farbe}
261 \trynode{bild}
262 \trynode{variablen}
263 \trynode{funktion}
264 \trynode{nachricht}
265 \bottomrule
266
267 \end{longtable}
268
269 \hinweis{In PXT und im Open-Roberta-Editor heißen die entsprechenden Einträge für Zeichenketten \enquote{Texte}. Der Style \enquote{Text} ist von TikZ jedoch bereits intern belegt und wird hier deswegen als \enquote{zeichenkette} verwendet.}
270
271
272 Standardmäßig wird das Paket mit der PXT-Farbinformation geladen, um die Farben des PXT-Editors für Calliope zu verwenden.\footnote{Damit beide Stile problemlos ineinander überführt werden können, ohne dass bestimmte Stile in anderen Kontexten undefiniert sind, wurden einige Stile doppelt Zugeordnet: \texttt{pxt-grundlagen} = \texttt{openroberta-start}, \texttt{pxt-musik} = \texttt{openroberta-aktion}, etc.}
273
274 Die Stile unterscheiden sich voneinander nur durch ihre Farben. \lstinline|openroberta| läd standardmäßig noch den Stil \lstinline|eckig|.
275
276
277 \subsection{Skalierung}
278
279 \ex{Skalierung} Die Skalierung des gesamten Bildes ist mit dem TikZ-Boardmittel \texttt{scale} möglich.
280
281 \begin{minipage}{0.78\textwidth}
282 \begin{lstlisting}[language={},morekeywords={scale}]
283 \begin{tikzpicture}[codeblocks, scale=0.7]
284 \node[variablen]{Hello World;};
285 \end{tikzpicture}
286 %
287 \begin{tikzpicture}[codeblocks, scale=1.3]
288 \node[variablen]{Hello World;};
289 \end{tikzpicture}
290 \end{lstlisting}
291 \end{minipage}
292 \begin{minipage}{0.2\textwidth}
293 \begin{tikzpicture}[codeblocks, scale=0.7]
294 \node[variablen]{Hello World;};
295 \end{tikzpicture}
296 %
297 \begin{tikzpicture}[codeblocks, scale=1.3]
298 \node[variablen]{Hello World;};
299 \end{tikzpicture}
300 \end{minipage}
301
302
303
304
305 \subsection{Farben}
306
307 \subsubsection{Lokale Farbänderung}
308 Lokale Überschreibungen sind -- wie üblich -- durch Angabe einer Farbe bei den entsprechenden Node-Attributen möglich.
309
310 \ex{Lokale Farbänderung}
311 {\tikz\node[codeblocks,fill=black,draw=red]{schwarzer Hintergrund - roter Rahmen};\\
312 \lstinline|\node[fill=black,draw=red]{schwarzer Hintergrund - roter Rahmen}|
313 }
314
315
316
317 \subsubsection{Globale Farbänderung}
318
319 \DescribeMacro{\setcolor}\label{sec:setcolor}%
320 Der Befehl \cmd\setcolor\marg{farbreferenz}\marg{hexfarbcode} lässt zu, Farben dokumentenweit umzudefinieren.
321
322 \ex{Globale Farbänderung}
323 \tikz\node[codeblocks,logik,]{Alte Farbe}; \lstinline|\setcolor{logik-color}{ff0000}| \setcolor{logik-color}{ff0000} \tikz\node[codeblocks,logik,]{Neue Farbe!};
324 \setcolor{logik-color}{006970}
325
326
327
328 \subsubsection{Keine Farben (print)}
329
330 Mit der Paketoption \lstinline[language={},morekeywords=print]|\usepackage[print]{tikzcodeblocks}| lassen sich alle Farben entfernen. Es werden lediglich Umrisse, sowie ausgefüllte LEDs gezeichnet. Die Schriftfarbe ist schwarz.
331
332 \ex{print}
333 \begin{tikzpicture}[codeblocks,print]
334 \einruecken{
335 \node[aktion](one){\stringbox{myText}};
336 }
337 \node[musik,under={one}{1}{0}](two){\intbox{11}\dropdown{=}\boolbox{wahr}};
338 \end{tikzpicture}
339
340 \subsection{Boxen}
341 Boxen werden innerhalb von Codeblöcken verwendet, um bestimmte Platzhalter und Datentypen zu kennzeichnen. Die Farben werden dabei teilweise in Abhängigkeit zum Parent (durch Durchsichtigkeit) gesetzt.
342
343 \DescribeMacro{\dropdown{}}
344 \DescribeMacro{\intbox{}}
345 \DescribeMacro{\stringbox{}}
346 \DescribeMacro{\boolbox{}}
347
348 \begin{center}
349 \begin{tabular}{m{0.32\linewidth}m{0.22\linewidth}m{0.22\linewidth}}
350 \toprule
351 \sffamily Code & \sffamily PXT & \sffamily Open Roberta \\\midrule
352 \lstinline|\dropdown{Dropdown}| & \tikz\node[codeblocks]{\dropdown{Dropdown}}; & \tikz\node[codeblocks,openroberta]{\dropdown{Dropdown}};\\
353 \lstinline|\intbox{5}| & \tikz\node[codeblocks]{\intbox{5}}; & \tikz\node[codeblocks,openroberta]{\intbox{5}}; \\
354 \lstinline|\stringbox{Text}| & \tikz\node[codeblocks]{\stringbox{Text}}; & \tikz\node[codeblocks,openroberta]{\stringbox{Text}}; \\
355 \lstinline|\boolbox{wahr}| & \tikz\node[codeblocks]{\boolbox{wahr}}; & \tikz\node[codeblocks,openroberta]{\boolbox{wahr}}; \\
356 \bottomrule
357 \end{tabular}
358 \end{center}
359
360 \lstinline|\intbox|, \lstinline|\stringbox|, \lstinline|\boolbox| haben alle als optionales Argument die Möglichkeit Stile hinzuzufügen.
361
362
363 \ex{optionales Argument bei Boxen}
364 \begin{tabular}{rl}
365 \intbox[]{42} & \lstinline|\intbox{42}| \\[1em]
366 \intbox[puzzleteil]{42} &\lstinline|\intbox[puzzleteil]{42}|\\
367 \end{tabular}
368
369
370 \ex{Boxen mit Kapselung}
371 \tikz\node[codeblocks,eingabe]{Meine \dropdown{Dropdown}-Box mit Wert \intbox{5}};\\
372 \lstinline|\node[eingabe]{Meine \dropdown{Dropdown}-Box mit Wert \intbox{5}};|
373
374
375 \hinweis{} Bei der Verwendung des Stils \texttt{openroberta} ändern sich auch entsprechend die Farben der int-, string- und boolboxen.
376
377
378 \subsection{Bilder/LED-Matrix}
379
380 \DescribeMacro{\bild} Mit \cmd\bild\oarg{skalierungsfaktor}\marg{Inhalt} lassen sich LED-Matrizen setzen. Es erwartet einen Tabelleninhalt. Jede Zeile muss entsprechend per \lstinline|\\| beendet werden. Zeilen und Spalten könen dabei unbegrenzt sein. Dabei gelten weiterhin folgende Befehle:
381 \begin{itemize}[noitemsep]
382 \item \DescribeMacro{\emptyled} \lstinline|\emptyled| setzt eine $5 \times 5$ LED-Matrix, bei der alle LEDs ausgeschaltet sind.\\ \bild{\emptyled}
383 \item \DescribeMacro{\fullled} \lstinline|\fullled| setzt eine $5 \times 5$ LED-Matrix, bei der alle LEDs angeschaltet sind.\\ \bild{\fullled}
384 \item \DescribeMacro{\X} \lstinline|\X| repräsentiert darin eine angeschaltete LED~~\bild{\X\\}
385 \item \DescribeMacro{\0} \lstinline|\0| repräsentiert darin eine ausgeschaltete LED~~\bild{\0\\}
386 \item Die Kombination von \lstinline|\bild{}|, \lstinline|\X|, und \lstinline|\0| ergiebt schließlich alle möglichen LED-Maritzen:
387
388 \ex{Beliebige Matrix}
389 \begin{minipage}[l]{0.6\textwidth}
390 \hspace*{-2cm}
391 \begin{lstlisting}
392 \bild{
393 \X \X \X \X \0 \0 \\
394 \X \X \0 \X \0 \0 \\
395 }
396 \end{lstlisting}
397 \end{minipage}
398 \begin{minipage}[c]{0.8\textwidth}
399 \bild{
400 \X \X \X \X \0 \0 \\
401 \X \X \0 \X \0 \0 \\
402 }
403 \end{minipage}
404
405 \item \DescribeMacro{\bild} Mit dem optionalen Argument kann ein Skalierungsfaktor angegeben werden.
406
407 \ex{Bildskalierung}
408
409 \begin{tabular}{cc}
410 \bild[0.4]{\emptyled} & \bild[1.5]{\emptyled}\\
411 {\lstinline|\bild[0.4]{\emptyled}|} & {\lstinline|\bild[1.5]{\emptyled}|}\\
412 \end{tabular}
413 \end{itemize}
414
415 \hinweis{} \lstinline|\X|, \lstinline|\0| sowie \lstinline|\emptyled| und \lstinline|\fullled| können nur innerhalb des \lstinline|\bild|-Kommandos verwendet werden.
416
417
418
419 \subsection{Strukturen} \label{sec:strukturen}
420
421 Strukturen helfen, die Positionierung von Nodes zu vereinfachen. Dafür können Verzweigungen und Schleifen verwendet werden. Damit muss nur noch in seltenen Fällen eine manuelle Positionierung von Nodes vorgenommen werden. Intern werden Tabellen verwendet.
422
423 \subsubsection{Verzweigungen}
424
425 \DescribeMacro{\wenndann} Über den Befehl \sloppy \cmd\wenndann\oarg{TikZ-Stil}\marg{TEXT: Bedingung}\marg{NODE: Anweisung}\marg{TEXT: Nodename} wird die Kontrollstruktur Verzweigung abgebildet. Der \lstinline|logik|-/bzw. \lstinline|kontrolle|-Stil wird automatisch gesetzt. Das letzte Argument ist die Bezeichnung des eigenen Nodenamen, damit nachfolgende Codeblöcke dies bei ihrerer Positionierung referenzieren können.
426
427 \DescribeMacro{\wenndannsonst} \cmd\wenndannsonst\oarg{TikZ-Stil}\marg{TEXT: Bedingung}\marg{NODE: Dann-Anweisung}\marg{NODE: Sonst-Anweisung}\marg{TEXT: Nodename} verhält sich analog zu \cmd\wenndann, ist jedoch um einen Sonst-Block, der mit Nodes gefüllt wird, erweitert. Automatisch ergänzt werden die Wörter \enquote{wenn}, \enquote{dann} und \enquote{sonst}.
428
429 \hinweis{Das optionale Argument ist oft notwendig, um die Verzweigung richtig in Relation zu vorherstehenden Blöcken zu positionieren. Siehe hierfür \ref{sec:unter}.}
430
431 %\ex{Muster einer Verzweigungen}
432
433 \begin{tabular}{lll}
434 &\begin{tikzpicture}[codeblocks]
435 \wenndann{TEXT: Bedingung}{\node[aktion]{NODE: Anweisung};}{name}
436 \end{tikzpicture} &
437
438 \begin{tikzpicture}[codeblocks]
439 \wenndannsonst{TEXT: Bedingung}{\node[aktion]{NODE: Anweisung};}{\node[aktion]{NODE: Anweisung};}{name}
440 \end{tikzpicture}\\
441 Deutsch: &\lstinline|\wenndann| & \lstinline|\wenndannsonst|\\
442 English: & \lstinline|\ifthenblocks| & \lstinline|\ifthenelseblocks| \\
443 \end{tabular}
444
445
446 \ex{Verzweigungen}
447 \input{examples/bsp-verzweigung.tikz}
448 \lstinputlisting[language={},morekeywords={wenndannsonst}]{examples/bsp-verzweigung.tikz}
449
450 \hinweis{Sollen Nodes in Textfeldern gesetzt werden, so muss \lstinline|\tikz| vorgeschoben werden.}
451
452 \subsubsection{Schleifen}
453
454
455 \DescribeMacro{\schleife} Die Schleife nach dem Muster
456 \cmd\schleife\oarg{TikZ-Stil}\marg{TEXT: Für/solange/etc.}\marg{TEXT: Bedingung}\marg{NODE: Anweisung}\marg{TEXT: Nodename} ist eine weitere vordefinierte Struktur. Automatisch ergänzt wird der Begriff \enquote{mache}.
457
458 \ex{Muster: Schleifen}
459 \begin{tabular}{ll}
460 & \begin{tikzpicture}[codeblocks]
461 \schleife{TEXT: Für/solange/etc}{TEXT:Bedingung}{\node[logik]{NODE: Anweisung};}{name}
462 \end{tikzpicture}\\
463 deutsch & \cmd\schleife\oarg{STIL}\marg{PRE}\marg{BED}\marg{ANW}\marg{NAME}\\
464 english & \cmd\loopblocks\oarg{STYLE}\marg{PRE}\marg{COND}\marg{INST}\marg{NAME}\\\\
465 \end{tabular}
466
467
468
469 \ex{Schleifen}
470 \begin{tikzpicture}[codeblocks]
471 \schleife[draw]{Solange}{\tikz\node[logik,keinezacken]{\dropdown{A}~\dropdown{=}~\dropdown{B}};}{
472 \node[aktion]{A=B+B};}{schl1}
473
474 \schleife[draw,unter={schl1}{0}{0}]{Für}{\intbox{int i=0}, \intbox{i<10}, \intbox{i++}}{
475 \node[aktion]{A=B+B};}{schl2}
476 \end{tikzpicture}
477 \begin{lstlisting}[morekeywords={schleife}]
478 \schleife[draw]{Solange}{\tikz\node[logik,keinezacken]{\dropdown{A}~\dropdown{=}~\dropdown{B}};}{
479 \node[aktion]{A=B+B};}{schl1}
480
481 \schleife[draw,unter={schl1}{0}{0}]{Für}{\intbox{int i=0}, \intbox{i<10}, \intbox{i++}}{
482 \node[aktion]{A=B+B};}{schl2}
483 \end{lstlisting}
484
485
486 \subsubsection{Branches, loops and the english language}
487 \begin{otherlanguage}{english}
488 If you want to use this package in an english document just load \lstinline|\usepackage[english]{babel}| in the preamble. It will automatically set the outer words for branches and loops in english.
489 \end{otherlanguage}
490
491 \ex{English example}
492 \begin{otherlanguage}{english}
493 \lstinline|\usepackage[english]{babel}|\\
494 \begin{tikzpicture}[codeblocks]
495 \wenndannsonst{A = B}{\node[aktion]{A++};}{\node[aktion]{B-{}-};}{name}
496 \end{tikzpicture}
497 \end{otherlanguage}
498
499 \begin{lstlisting}[]
500 \begin{otherlanguage}{english}
501 \begin{tikzpicture}[codeblocks]
502 \wenndannsonst{A = B}{\node[aktion]{A++};}{\node[aktion]{B-{}-};}{name}
503 \end{tikzpicture}
504 \end{otherlanguage}
505 \end{lstlisting}
506
507 \DescribeMacro{\ifthenblocks}
508 \DescribeMacro{\ifthenelseblocks}
509 \DescribeMacro{\loopblocks} To fit the commands to the english language please you can use |\ifthenblocks|, |\ifthenelseblocks| and |\loopblocks|. Notice the added \enquote{blocks}, because the \LaTeX Command \lstinline|\ifthenelse| is already used by the \texttt{ifthen}-Package.
510
511 \begin{table}[htb] \centering
512 \begin{tabular}{ll}
513 \toprule
514 english & german\\ \midrule
515 \lstinline|\ifthenblocks| &\lstinline|\wenndann|\\
516 \lstinline|\ifthenelseblocks| &\lstinline|\wenndannsonst|\\
517 \lstinline|\loopblocks| &\lstinline|\schleife| \\ \bottomrule
518 \end{tabular}
519 \end{table}
520
521
522
523
524 \section{Positioneriung der Nodes}
525
526 \subsection{Manuelles Positionieren}\label{sec:unter}
527
528 Mit konsequenter Verwendung der Strukturen ist manuelles Einrücken selten notwendig. Jedoch ist das Aneinanderketten der Nodes unabdinglich. Hierfür wird der Stil
529 \DescribeMacro{unter} \texttt{unter=}\marg{NODE}\marg{X-Einzug-Faktor}\marg{Y-Einzug-Faktor} verwendet. Hierbei wird der Einzug als Ankerpunkt jeweils relativ zum Vorgänger gesetzt.
530
531 \vspace{1em}
532 % \hspace*{-3cm}
533 \begin{tikzpicture}[codeblocks,scale=1.0]
534 \node[grundlage] (drueber) {Hier beginnt der Code};
535 \node[eingabe, unter={drueber}{1}{8}] (drunter){Das ist das letzte Kommando};
536
537 \draw[black, ->, rounded corners=0] (drueber) -- (drunter.165) node[midway, black,right] {Abstand 8 (\#3)};
538 \draw[black, ->, rounded corners=0] (drueber.south west) |- (drunter.west) node[midway, black,left] {Einzug 1 (\#2)};
539
540 \draw[black, ->, rounded corners=0] (drunter.east) |- (drueber.east) node[near start,right] {Bezug auf start-node (\#1)};
541
542 \end{tikzpicture}\vspace{2em}
543
544 \begin{lstlisting}[keywords={},morekeywords={drueber,drunter}]
545 \node[grundlage] (drueber) {Hier beginnt der Code};
546 \node[eingabe, unter={drueber}{1}{8}] (drunter){Das ist das letzte Kommando};
547 \end{lstlisting}
548
549 \hinweis{Dank der Verwendung von Kontrollstrukturen (siehe \ref{sec:strukturen}) ist manuelles Einrücken in der Regel nicht notwendig.}
550
551
552
553 \subsubsection{Verschieben der Zacken bei manueller Einrückung}
554 %\input{examples/bsp-openroberta-umgebung.tikz}
555 %\lstinputlisting[language={},firstline=3, lastline=14,morekeywords={\einruecken}]{examples/bsp-openroberta-umgebung.tikz}
556
557 \DescribeMacro{\einruecken} Über das Kommando \cmd\einruecken\marg{nodes} lässt sich der untere Zacken eines Nodes um genau einen Einzug verschieben (siehe: \ref{sec:unter};). Die obere Ausbuchtung bleibt an ihrem normalen Platz.
558
559 \begin{otherlanguage}{english}
560 \DescribeMacro{\moveindent} The english equivalent to\cmd\einruecken{} is \cmd\moveindent.
561 \end{otherlanguage}
562
563 \vspace{1em}
564 \begin{tikzpicture}[codeblocks]
565 \node[kontrolle](eins){wenn\dots \\dann\dots};
566 \einruecken{
567 \node[kontrolle, right=2cm of eins](zwei){wenn\dots \\dann\dots};
568 }
569 \draw[black,dashed,very thick,->] ($(eins.south west)+(1.5em,-0.2em)$)--($(zwei.south)+(0em,-0.2em)$) node[midway,below]{\normalfont Zacken verschiebt sich nach rechts};
570 \end{tikzpicture}\hfil
571 %
572 %Verschachtelung mit Einrückung und Open Roberta Zacken
573 \ex{Verschachteltes Einrücken}
574 \input{examples/bsp-verschachtelt-zacken.tikz}
575 \lstinputlisting[basicstyle=\footnotesize \ttfamily, keywords={},language={},morekeywords={einruecken},]{examples/bsp-verschachtelt-zacken.tikz}
576
577
578 \ex{einruecken}
579 \input{examples/bsp-einruecken.tikz}
580 \lstinputlisting[keywords={},language={},morekeywords={einruecken},firstline={2},lastline={5}]{examples/bsp-einruecken.tikz}
581
582
583 \subsection{Automatisches Einrücken}
584 Siehe Strukturen \ref{sec:strukturen}!
585
586
587 \clearpage
588 \section{Dekorationen}
589
590 \subsection{Puzzleoptik}
591 \newcommand{\mydeco}[1]{
592 \tikz\node[codeblocks,mathe,#1](one){A+B};&#1
593 }
594
595
596
597
598 Um die Verzahnung der einzelnen Elemente darzustellen, wird standardmäßig eine Puzzleoptik verwendet, welche die \textit{vertikale} Beziehung der Bausteine zueinander verdeutlicht. Sie ist über die Form \DescribeMacro{robertashape} \lstinline|robertashape| definiert.
599
600 Soll die \textit{horizontale} Beziehung von Bausteinen betont werden, so kann die Form \DescribeMacro{puzzleteil} \lstinline|puzzleteil| verwendet werden.
601
602 \DescribeMacro{keinezacken} Mit dem Stil \lstinline|keinezacken| lassen sich alle vordefinierten Zacken entfernen. Dies ist v.\,A. bei verschachtelten Nodes notwendig. \lstinline|keinezacken| ist ein Alias für \lstinline|rectangle|.
603
604 \DescribeMacro{eckig} Der Stil \lstinline|eckig| entfernt alle runde Ecken und orientiert sich damit stärker an dem Erscheinungsbild von Open Roberta.
605
606 Für Start- und Endbausteine sind die Formen \DescribeMacro{pinlow}\lstinline|pinlow| und \DescribeMacro{pinhigh}\lstinline|pinhigh| definiert.
607
608 %\begin{wraptable}{r}{0.6\textwidth}
609 \begin{table}[htb!]
610 \begin{center}%\vspace*{-2.3em}
611 \begin{tabular}{rll}
612 \toprule
613 \textsf{Shape} & \textsf{deutsch} & \textsf{english}\\\midrule
614 \mydeco{} & \\
615 \mydeco{pinlow} & pinlow \\
616 \mydeco{pinhigh} & pinhigh\\
617 \mydeco{keinezacken} & nopins\\
618 \mydeco{eckig} & square\\
619 \mydeco{eckig, keinezacken} & square, nopins\\
620 \mydeco{puzzleteil} & puzzlepiece \\
621 \mydeco{puzzleteil, eckig} & puzzlepiece, square\\
622 \bottomrule
623 \end{tabular}
624 \caption{Übersicht über Blockformen}
625 \end{center}
626 \end{table}
627 %\end{wraptable}
628
629
630 \ex{keinezacken}
631 Der Stil \enquote{keinezacken} ist z.\,B. bei verschachtelten Nodes notwendig:
632
633 \begin{tikzpicture}
634 \node[codeblocks,aktion](A){mache \tikz\node[mathe]{A=B};};
635 \node[codeblocks,aktion,right = 1cm of A](B){mache \tikz\node[mathe,keinezacken]{A=B};};
636
637 \draw[->,very thick, dashed,black] (A)--(B);
638 \end{tikzpicture}
639 %
640 \begin{lstlisting}[keywords={},morekeywords={keinezacken}]
641 \node[aktion]{mache \tikz\node[mathe,keinezacken]{A=B};};
642 \end{lstlisting}
643
644
645 \subsection{Symbole und kleine Elemente}
646
647 \DescribeMacro{\usb} \lstinline|\usb| setzt ein \usb.
648
649 \DescribeMacro{\farbe} \lstinline|\farbe{color}| setzt ein Quadrat mit der angegeben Farbe \farbe{buw-gruen}. Zu verwenden auch in Nodes: \tikz\node[farbe,puzzleteil]{~\farbe{yellow}};
650
651 \clearpage
652
653
654 \section{FAQ}
655
656 \subsection{Wie kann ich für ein komplettes Dokument eine Farbe umdefinieren?}
657
658 \DescribeMacro{\setcolor}
659 \begin{longtable}{p{0.1\textwidth}p{0.9\textwidth}}
660 Ist: & \tikz\node[codeblocks,logik,]{Alte Farbe};\\
661 Soll: & \noindent\setcolor{logik-color}{ff0000}\tikz\node[codeblocks,logik,]{Neue Farbe!};\\
662 Lösung: & \lstinline|\setcolor{logik-color}{ff0000}|
663 \end{longtable}
664 %
665 % Globale Änderung wieder rückgängig machen
666 \setcolor{logik-color}{006970}
667
668
669 \subsection{Eine nested Box ist zu hoch/zu niedrig}
670
671
672 \begin{longtable}{p{0.1\textwidth}p{0.9\textwidth}}
673 Ist: & \begin{tikzpicture}[codeblocks]
674 \einruecken{\node[grundlage,pinlow](grund){dauerhaft};}
675 \node[logik,unter={grund}{1}{0}](wenn1){wenn \tikz\node[platzhalter,keinezacken]{\dropdown{modus}}; \dropdown{=} \intbox{1} };
676 \end{tikzpicture}\\
677 Soll: & \input{examples/bsp-einruecken.tikz}\\
678 Lösung: &
679 \noindent Verwende den Hilfstyle \lstinline|boden|:
680
681 \lstinputlisting[keywords={},language={},morekeywords={boden},firstline={2},lastline={5}]{examples/bsp-einruecken.tikz}\\
682 \end{longtable}
683
684
685
686
687
688 \begin{comment}
689 \subsection{Openroberta Stil hat hässliche Rundungen}
690
691 \begin{tikzpicture}[codeblocks]
692 \node[musik,draw] (bad) {schlecht};
693 \node[musik,draw, rounded corners =0pt, right= 1.9em of bad] (good) {besser};
694
695 \draw[->,very thick,dashed, black] (bad)--(good);
696 \end{tikzpicture}
697
698 \begin{lstlisting}
699 \begin{tikzpicture}[codeblocks,openroberta]
700 \node[musik,draw] (bad) {schlecht};
701 \node[musik,draw, rounded corners =0pt, right=of bad] (good) {besser};
702 \end{lstlisting}
703
704 Der Stil \enquote{musik} ist nicht für den Openroberta Style definiert\footnote{Es wurde sich an den Bezeichnern der Benutzeroberfläche orientiert}. U.u. wird auf den PXT Stil zurückgegriffen. Manuelles hinzufügen von \lstinline|rounded corners=0pt| ist ein lokaler hotfix.
705 \end{comment}
706
707 \subsection{Ich will einen Node innerhalb eines Nodes setzten}
708
709 Verwende eine verschachtelte TikZ-Umgebung, z.\,B. mit dem \lstinline|\tikz|-Befehl:
710
711 \begin{tikzpicture}[codeblocks]
712 \node[logik]{außen:
713 \tikz\node[aktion]{innen};
714 };
715 \end{tikzpicture}
716
717 \begin{lstlisting}
718 \node[logik]{außen:
719 \tikz\node[aktion]{innen};
720 };
721 \end{lstlisting}
722
723
724 %\todo{Keine Zacken aber Puzzleteil?
725 %falsch: puzzleteil ->keinezacken
726 %richtig: keinezacken,puzzleteil,}
727
728
729 \subsection{Mein Block ist sehr klein und deswegen verformt}
730
731 \begin{longtable}{p{0.1\textwidth}p{0.9\textwidth}}
732 Ist: & \tikz\node[codeblocks,logik](one){1};\\
733 Soll: & \tikz\node[codeblocks,logik,](one){2~~};
734 \tikz\node[codeblocks,logik, minimum width=1cm](one){3};\\
735 Lösung: & Erweitere den Inhalt des Nodes um Whitespace/Phantome oder setzte \lstinline|minimum width| für den Node.
736
737 \begin{lstlisting}
738 \node[logik](one){2~~};
739 \node[logik, minimum width=1cm](one){3};
740 \end{lstlisting}
741 \end{longtable}
742
743
744
745
746
747
748 \section{Mehr Beispielcode}
749
750 \subsection{Bsp: Calliope Smart Home}
751 \input{examples/smarthome.tikz}
752 \lstinputlisting[basicstyle=\footnotesize \ttfamily]{examples/smarthome.tikz}
753
754
755 \end{document}