summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/tikzcodeblocks/tikzcodeblocks-documentation.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2017-07-18 21:37:01 +0000
committerKarl Berry <karl@freefriends.org>2017-07-18 21:37:01 +0000
commit1f97875f5539ae5a035a4c2934f55bd0b170c9ae (patch)
treed9a8d431ca0e12c9b883fca35e3aa8ca289477c6 /Master/texmf-dist/doc/latex/tikzcodeblocks/tikzcodeblocks-documentation.tex
parent1259233aec698e07b7aedb390f151aec2f552a22 (diff)
tikzcodeblocks (18jul17)
git-svn-id: svn://tug.org/texlive/trunk@44841 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/tikzcodeblocks/tikzcodeblocks-documentation.tex')
-rw-r--r--Master/texmf-dist/doc/latex/tikzcodeblocks/tikzcodeblocks-documentation.tex507
1 files changed, 278 insertions, 229 deletions
diff --git a/Master/texmf-dist/doc/latex/tikzcodeblocks/tikzcodeblocks-documentation.tex b/Master/texmf-dist/doc/latex/tikzcodeblocks/tikzcodeblocks-documentation.tex
index 17eb2c34783..72f1798c95c 100644
--- a/Master/texmf-dist/doc/latex/tikzcodeblocks/tikzcodeblocks-documentation.tex
+++ b/Master/texmf-dist/doc/latex/tikzcodeblocks/tikzcodeblocks-documentation.tex
@@ -2,9 +2,10 @@
\usepackage[T1]{fontenc}
\usepackage[utf8]{inputenc}
-\usepackage[ngerman]{babel}
+\usepackage[english,ngerman]{babel}
-\usepackage[pxt]{tikzcodeblocks}
+\usepackage[%print
+]{tikzcodeblocks}
\usepackage{todonotes}
\usepackage{listings}
\usepackage{lmodern} % für textbf in texttt
@@ -19,7 +20,7 @@
breaklines=true,
%literate={ä}{{\"a}}1 {ü}{{\"u}}1 {ö}{{\"o}}1 {ß}{{\ss}}1 {Ä}{{\"A}}1 {Ü}{{\"Ü}}1 {Ö}{{\"O}}1,
tabsize=2,
- language=[LaTeX]{TeX},
+ language=[LaTeX]{TeX},
numbers=left, numberstyle=\tiny,%, stepnumber=5, numbersep=5pt,
keywordstyle=\color{red}, % keyword style
morekeywords={\node,\tikz},
@@ -46,12 +47,21 @@
\usepackage{enumitem}
\usepackage{hyperref}
-
-\title{TikZ Codeblocks v.0.1}
-\author{Adrian Salamon}
-\date{2017-07-06}
\usepackage{comment}
\usepackage{booktabs}
+\usepackage[nochapter]{vhistory}
+
+\usepackage{array}
+\usepackage{subcaption}
+\usepackage{tocloft}
+
+\newcommand{\listExample}{Liste der Beispiele}
+
+
+\title{TikZ Codeblocks v.\vhCurrentVersion}
+\author{Adrian Salamon}
+\date{\vhCurrentDate}
+
\setlength{\parindent}{0em}
@@ -61,24 +71,62 @@
\let\PrintMacroName\PrintDescribeMacro
\let\PrintEnvName\PrintDescribeEnv
+
\newcommand{\wichtig}{\noindent{\huge!~}\normalfont Hinweis: }
-\begin{document}
+% Define own examples
+\newcommand{\listofexamples}{Liste der Beispiele}
+\newlistof{example}{lex}{\listofexamples}
+\newcounter{examplesave}
+%
+\newcommand{\ex}[1]{\par\vspace*{1em}{\sffamily \bfseries \textcolor{buw-gruen}{#1\label{sec:#1}}\\}\vspace{0.5em}
+% add to list of examples
+\refstepcounter{example}
+\addcontentsline{lex}{example}{\protect\numberline{
+ \theexample}#1}
+}
+
+
+\begin{document}
\maketitle
\tableofcontents
-\section{Präambel}
+\section*{Versionshistorie}
+
+\begin{versionhistory}
+ \vhEntry{0.1}{2017-07-06}{AS}{published}
+ \vhEntry{0.11}{2017-07-18}{AS}{update}
+\end{versionhistory}
+ \begin{itemize}[leftmargin=*,noitemsep]
+ \item Translations
+ \begin{itemize}[noitemsep]
+ \item via \textbf{babel} for structures (if/wenn, then/dann\dots)
+ \item marcos and styles now (partly) also in english
+ \end{itemize}
+ \item new Shapes
+ \begin{itemize}[noitemsep]
+ \item \tikz\node[codeblocks,musik,pinhigh]{pinhigh};
+ \item \tikz\node[codeblocks,start,pinlow]{pinlow};
+ \end{itemize}
+ \item Package option print gets rid of all colors: \tikz\node[codeblocks,print, aktion,]{no colors};
+ \item Open-Roberta colors are now more accurate and usable next to the standard colors. (see \ref{sec:robertacolors}.)
+ \end{itemize}
+
+%\begin{versionhistory}
+% \vhEntry{0.13}{2017-07-23}{AS}{published}
+%\end{versionhistory}
+\section{Präambel}
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 muss weiterhin per Hand gestaltet werden.
Dies ist eine Entwicklerversion. Bezeichner und Paketname können in späteren Versionen noch variieren.
-Bei Fragen weden Sie sich bitte an: \href{mailto:salamon@uni-wuppertal.de}{salamon@uni-wuppertal.de} bzw. \href{adriansalamon@gmail.com}{adriansalamon@gmail.com}.
+Bei Fragen weden Sie sich bitte an \href{mailto:adriansalamon@gmail.com}{adriansalamon@gmail.com}.
\subsection{Alternativpakete}
@@ -89,13 +137,13 @@ Unterschied zu diesem Paket: \texttt{scratch} lässt sich \textbf{nicht} in ande
\subsection{Editoren mit graphischer Programmierung}
-Diese Sammlung wurde erstellt, um Quelltexte auf Blockbasis für Calliope mini zu setzen. Alle verwendeten Farben und Gestaltungen sind daher vom PXT Editor von Calliope inspiriert. Es lässt sich jedoch auch Code anderer Editoren setzen.
+Diese Sammlung wurde erstellt, um Quelltexte auf Blockbasis für 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 anderer Editoren setzen.
\begin{table}[hbt!]\centering
\begin{tabular}{ll}
\toprule
Editor & URL \\ \midrule
-
+
PXT - Calliope & \url{http://pxt.calliope.cc/} \\
Open Roberta & \url{https://lab.open-roberta.org/} \\
Scratch & \url{https://scratch.mit.edu/projects/editor} \\
@@ -104,7 +152,9 @@ Diese Sammlung wurde erstellt, um Quelltexte auf Blockbasis für Calliope mini z
\caption{Tabelle von Editoren mit graphischen Codeblöcken.}
\end{table}
-\clearpage
+
+
+
\section{Beispielcode}
%\begin{samepage}
@@ -122,6 +172,11 @@ Der Quellcode zur Erstellung der Vektorgraphik folgt unter dem Beispiel.
\end{center}
\lstinputlisting[basicstyle=\footnotesize \ttfamily]{bsp-start-roberta.tikz}
+\subsection{English Codeexample}
+\begin{center}
+ \input{bsp-english.tikz}
+\end{center}
+\lstinputlisting[basicstyle=\footnotesize \ttfamily, language={},morekeywords={square,moveindent,under,ifthenelsecode,loopcode,puzzlepiece,otherlanuage}]{bsp-english.tikz}
\clearpage
\section{Bausteine und Befehle}
@@ -129,180 +184,205 @@ Der Quellcode zur Erstellung der Vektorgraphik folgt unter dem Beispiel.
%\begin{commands}
\DescribeMacro{codeblocks} Mit \lstinline|\begin{tikzpicture}[codeblocks]| werden die Codeblock-Stile geladen. Es setzt das Verhalten für every Node.
-Die Skalierung des Bildes ist mit \lstinline|\begin{tikzpicture}[codeblocks,scale=0.7]| möglich.
+Die Skalierung des gesamten Bildes ist mit \lstinline|\begin{tikzpicture}[codeblocks,scale=0.7]| möglich.
\subsection{Bausteinklassen nach PXT-Calliope Editor}
-\newcommand{\trynode}[1]{\makebox[3cm][l]{\lstinline|#1|:} \tikz\node[#1,codeblocks]{#1};}
-\newcommand{\trynodeOpenRoberta}[1]{\makebox[3cm][l]{\lstinline|#1|:} \tikz\node[#1,codeblocks,eckig]{#1};}
+\newcommand{\trynode}[1]{\lstinline|#1|& \tikz\node[#1,codeblocks]{#1}; & \tikz\node[openroberta,#1,codeblocks,eckig,]{#1};\\}
+\newcommand{\trynodeOpenRoberta}[1]{\lstinline|#1|& \tikz\node[openroberta,#1,codeblocks,eckig,]{#1};\\}
-Die Klassen der Programmierbausteine werden nach folgendem Muster als TikZ-Style angegeben. Der Standard orientiert sich an den Farben und Formen des Calliope-PXT-Editors:
+Die Klassen der Programmierbausteine werden nach folgendem Muster als TikZ-Style angegeben. Der Standard orientiert sich an den Farben und Formen des Calliope-PXT-Editors.
\lstinline|\node[STYLE] {Inhalt};|
- \begin{itemize}[noitemsep]
- \item \trynode{grundlage}
- \item \trynode{eingabe}
- \item \trynode{schleife}
- \item \trynode{logik}
- \item \trynode{musik}
- \item \trynode{led}
- \item \trynode{platzhalter}
- \item \trynode{mathe}
- \item \trynode{funk}
- \item \trynode{motor}
- \item \trynode{zeichenkette} \footnote{Im Calliopeeditor heißt der entsprechende Eintrag \enquote{Texte}. Der Style \enquote{Text} ist von TikZ jedoch bereits intern belegt.}
- \item \trynode{spiel}
- \item \trynode{bild}
- \item \trynode{pins}
- \item \trynode{konsole}
- \item \trynode{steuerung}
- \item \trynode{bluetooth}
- \end{itemize}
-
-\sloppy
-Standardmäßig wird das Paket mit der Option \lstinline|\usepackage[pxt]{tikzcodeblocks}| geladen, um die Farben des PTX-Editors für Calliope zu verwenden.
-
-Die Stile unterscheiden sich nur durch ihre Farben.
-
-
-
-
-\subsection{Open-Roberta Stil}
- Mithilfe der Option \lstinline|\usepackage[openroberta]{tikzcodeblocks}| können Farb- und Stildefinitionen geladen werden, die sich an der NEPO-Umgebung von Open-Roberta orientieren.% Für eckige Elemente muss noch der Stil \lstinline|openroberta| für die Nodes, oder die umklammernde TikZ-Umgebung angegeben werden.
-
- \begin{itemize}[noitemsep]
- \item \trynodeOpenRoberta{start}
- \item \trynodeOpenRoberta{aktion}
- \item \trynodeOpenRoberta{sensor}
- \item \trynodeOpenRoberta{kontrolle}
- \item \trynodeOpenRoberta{logik}
- \item \trynodeOpenRoberta{mathe}
- \item \trynodeOpenRoberta{zeichenkette} \footnote{Im Open-Roberta-Editor heißt der entsprechende Eintrag \enquote{Texte}. Der Style \enquote{Text} ist von TikZ jedoch bereits intern belegt.}
- \item \trynodeOpenRoberta{liste}
- \item \trynodeOpenRoberta{farbe}
- \item \trynodeOpenRoberta{bild}
- \item \trynodeOpenRoberta{variablen}
- \item \trynodeOpenRoberta{funktion}
- \item \trynodeOpenRoberta{nachricht}
- \end{itemize}
-
-\wichtig{Aktuell ist es nicht möglich innerhalb eines Dokumentes beide Farbschemata zu verwenden. Daher sind die hier dargestellten Farben des Open-Roberta-Stils inkorrekt.}
-
-
-%\begin{tikzpicture}[codeblocks,umgebung]
-%\einruecken{
-% \node[logik] (log1){PXT Farben, obwohl obenroberta (logik)};
-% }
-%\node[mathe, unter={log1}{1}{0}]{\intbox{1}+\intbox{4} (mathe)};
-%\end{tikzpicture}
+Mithilfe des Stils \DescribeMacro{openroberta} \lstinline|openroberta| können 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.
+
+\label{sec:robertacolors}
+\renewcommand{\arraystretch}{0.6}
+ \begin{longtable}{lll}
+ \toprule
+\sffamily Stilname & \sffamily pxt (Standard) & \sffamily openroberta\\\endhead \midrule
+ \trynode{grundlage}
+ \trynode{eingabe}
+ \trynode{schleife}
+ \trynode{logik}
+ \trynode{musik}
+ \trynode{led}
+ \trynode{platzhalter}
+ \trynode{mathe}
+ \trynode{funk}
+ \trynode{motor}
+ \trynode{zeichenkette}
+ \trynode{spiel}
+ \trynode{bild}
+ \trynode{pins}
+ \trynode{konsole}
+ \trynode{steuerung}
+ \trynode{bluetooth}
+ % OopenRoberta
+ \trynode{start}
+ \trynode{aktion}
+ \trynode{sensor}
+ \trynode{kontrolle}
+ \trynode{liste}
+ \trynode{farbe}
+ \trynode{bild}
+ \trynode{variablen}
+ \trynode{funktion}
+ \trynode{nachricht}
+ \bottomrule
+
+ \end{longtable}
+
+\wichtig{In PXT- und im Open-Roberta-Editor heißen der entsprechende Einträge für Zeichenketten \enquote{Texte}. Der Style \enquote{Text} ist von TikZ jedoch bereits intern belegt.}
+
+
+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: pxt-grundlagen = openroberta-start, pxt-musik = openroberta-aktion, etc.}
+
+Die Stile unterscheiden sich voneinander nur durch ihre Farben. \lstinline|openroberta| läd standardmäßig noch den Stil \lstinline|eckig|.
+
\subsection{Farben}
\subsubsection{Lokale Farbänderung}
-Lokale Überschreibungen sind wie üblich durch Angabe einer Farbe bei den entsprechenden Node-Attributen möglich.
+Lokale Überschreibungen sind -- wie üblich -- durch Angabe einer Farbe bei den entsprechenden Node-Attributen möglich.
-Bsp: \tikz\node[codeblocks,fill=black,draw=red]{schwarzer Hintergrund - roter Rahmen};\\
+\ex{Bsp. Lokale Farbänderung}
+{\tikz\node[codeblocks,fill=black,draw=red]{schwarzer Hintergrund - roter Rahmen};\\
\lstinline|\node[fill=black,draw=red]{schwarzer Hintergrund - roter Rahmen}|
+}
+
+
\subsubsection{Globale Farbänderung}
-\DescribeMacro{\setcolor} \label{sec:setcolor} Der Befehl \cmd\setcolor\marg{farbreferenz}\marg{hexfarbcode} lässt zu, Farben Dokumentenweit umzudefinieren.
+\DescribeMacro{\setcolor} \label{sec:setcolor} Der Befehl \cmd\setcolor\marg{farbreferenz}\marg{hexfarbcode} lässt zu, Farben dokumentenweit umzudefinieren.
+\ex{Bsp. Globale Farbänderung}
\tikz\node[codeblocks,logik,]{Alte Farbe}; \lstinline|\setcolor{logik-color}{ff0000}| \setcolor{logik-color}{ff0000} \tikz\node[codeblocks,logik,]{Neue Farbe!};
\setcolor{logik-color}{006970}
+
+
+\subsubsection{Keine Farben (print)}
+
+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.
+
+\ex{Bsp. print}
+\begin{tikzpicture}[codeblocks,print]
+\einruecken{
+ \node[aktion](one){\stringbox{myText}};
+}
+\node[musik,under={one}{1}{0}](two){\intbox{11}\dropdown{=}\boolbox{wahr}};
+\end{tikzpicture}
+
\subsection{Boxen}
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.
-
-\DescribeMacro{\dropdown{}}
-\DescribeMacro{\intbox{}}
+\DescribeMacro{\dropdown{}}
+\DescribeMacro{\intbox{}}
\DescribeMacro{\stringbox{}}
-\DescribeMacro{\boolbox{}}
+\DescribeMacro{\boolbox{}}
-\begin{tabular}{cl}
- \dropdown{Dropdown} & \lstinline|\dropdown{Dropdown}| \\
- \intbox{5} & \lstinline|\intbox{5}| \\
- \stringbox{Text} & \lstinline|\stringbox{Text}| \\
-\boolbox{wahr} & \lstinline|\boolbox{wahr}|
+\begin{center}
+\begin{tabular}{m{0.32\linewidth}m{0.22\linewidth}m{0.22\linewidth}}
+ \toprule
+ \sffamily Code & \sffamily PXT & \sffamily Open Roberta \\\midrule
+ \lstinline|\dropdown{Dropdown}| & \tikz\node[codeblocks]{\dropdown{Dropdown}}; & \tikz\node[codeblocks,openroberta]{\dropdown{Dropdown}};\\
+ \lstinline|\intbox{5}| & \tikz\node[codeblocks]{\intbox{5}}; & \tikz\node[codeblocks,openroberta]{\intbox{5}}; \\
+ \lstinline|\stringbox{Text}| & \tikz\node[codeblocks]{\stringbox{Text}}; & \tikz\node[codeblocks,openroberta]{\stringbox{Text}}; \\
+ \lstinline|\boolbox{wahr}| & \tikz\node[codeblocks]{\boolbox{wahr}}; & \tikz\node[codeblocks,openroberta]{\boolbox{wahr}}; \\
+ \bottomrule
\end{tabular}
-
+\end{center}
\lstinline|\intbox|,
\lstinline|\stringbox|,
\lstinline|\boolbox| haben alle als optionales Argument die Möglichkeit Stile hinzuzufügen.
-\paragraph{Beispiel opt. Argument:}\intbox[puzzleteil]{42} \lstinline|\intbox[puzzleteil]{42}|
-\paragraph{Beispiel mit Kapselung:}
+\ex{Bsp. optionales Argument bei Boxen}
+\intbox[puzzleteil]{42}\\
+\lstinline|\intbox[puzzleteil]{42}|
+
+\ex{Bsp. Boxen mit Kapselung}
\tikz\node[codeblocks,eingabe]{Meine \dropdown{Dropdown}-Box mit Wert \intbox{5}};\\
\lstinline|\node[eingabe]{Meine \dropdown{Dropdown}-Box mit Wert \intbox{5}};|
-\wichtig{} Bei der Verwendung der Option \texttt{openroberta} ändern sich auch entsprechend die Farben der int-, string- und boolboxen.
+
+\wichtig{} Bei der Verwendung des Stils \texttt{openroberta} ändern sich auch entsprechend die Farben der int-, string- und boolboxen.
+
\subsection{Bilder/LED-Matrix}
-\DescribeMacro{\bild} Mit \cmd\bild\oarg{skalierfaktor}\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:
+\DescribeMacro{\bild} Mit \cmd\bild\oarg{skalierfaktor}\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:
\begin{itemize}[noitemsep]
\item \DescribeMacro{\emptyled} \lstinline|\emptyled| setzt eine $5 \times 5$ LED-Matrix, bei der alle LEDs ausgeschaltet sind.\\ \bild{\emptyled}
\item \DescribeMacro{\fullled} \lstinline|\fullled| setzt eine $5 \times 5$ LED-Matrix, bei der alle LEDs angeschaltet sind.\\ \bild{\fullled}
\item \DescribeMacro{\X} \lstinline|\X| repräsentiert darin eine angeschaltete LED \bild{\X\\}
\item \DescribeMacro{\0} \lstinline|\0| repräsentiert darin eine ausgeschaltete LED \bild{\0\\}
\item Die Kombination von \lstinline|\bild{}|, \lstinline|\X|, und \lstinline|\0| ergiebt schließlich alle möglichen LED-Maritzen:
-
+
\begin{minipage}[l]{0.6\textwidth}
\hspace*{-2cm}
-\begin{lstlisting}
+\begin{lstlisting}
\bild{
- \X \0 \X \0 \0 \\
+ \X \X \X \0 \0 \\
\X \0 \X \0 \0 \\
}
\end{lstlisting}
\end{minipage}
\begin{minipage}[c]{0.8\textwidth}
\bild{
- \X \0 \X \0 \0 \\
+ \X \X \X \0 \0 \\
\X \0 \X \0 \0 \\
}
\end{minipage}
\item \DescribeMacro{\bild} Mit dem optionalen Argument kann ein Skalierungsfaktor angegeben werden.
-\paragraph{Bsp.: Bildskalierung} \lstinline|\bild[0.4]{\emptyled} \bild[2]{\emptyled}|
+\ex{Bsp. Bildskalierung}
-\bild[0.4]{\emptyled} \bild[2]{\emptyled}
+\begin{tabular}{cc}
+ \bild[0.4]{\emptyled} & \bild[1.5]{\emptyled}\\
+ {\lstinline|\bild[0.4]{\emptyled}|} & {\lstinline|\bild[1.5]{\emptyled}|}\\
+\end{tabular}
\end{itemize}
-
+
\wichtig{} \lstinline|\X|, \lstinline|\0| sowie \lstinline|\emptyled| und \lstinline|\fullled| können nur innerhalb des \lstinline|\bild|-Kommandos verwendet werden.
\subsection{Strukturen} \label{sec:strukturen}
-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
+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.
\subsubsection{Verzweigungen}
-\DescribeMacro{\wenndann} Über den Befehl \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.
+\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.
-\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.
+\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}.
\wichtig{Das optionale Argument ist oft notwendig, um die Verzweigung richtig in Relation zu vorherstehenden Blöcken zu positionieren. Siehe hierfür \ref{sec:unter}.}
-\paragraph{Muster: Verzweigungen}
-\begin{tikzpicture}[codeblocks]
+\ex{Muster: Verzweigungen}
+
+\begin{tabular}{lll}
+&\begin{tikzpicture}[codeblocks]
\wenndann{TEXT: Bedingung}{\node[aktion]{NODE: Anweisung};}{name}
-\end{tikzpicture}
+\end{tikzpicture} &
\begin{tikzpicture}[codeblocks]
\wenndannsonst{TEXT: Bedingung}{\node[aktion]{NODE: Anweisung};}{\node[aktion]{NODE: Anweisung};}{name}
-\end{tikzpicture}
+\end{tikzpicture}\\
+Deutsch: &\lstinline|\wenndann| & \lstinline|\wenndannsonst|\\
+English: & \lstinline|\ifthenblocks| & \lstinline|\ifthenelseblocks| \\
+\end{tabular}
-\paragraph{Beispiel: Verzweigungen}
+\ex{Bsp. Verzweigungen}
\input{bsp-verzweigung.tikz}
\lstinputlisting[language={},morekeywords={wenndannsonst}]{bsp-verzweigung.tikz}
@@ -314,14 +394,19 @@ Strukturen helfen, die Positionierung von Nodes zu vereinfachen. Dafür können
\DescribeMacro{\schleife} Die Schleife nach dem Muster
\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}.
-\paragraph{Muster: Schleifen}
-\begin{tikzpicture}[codeblocks]
+\ex{Muster: Schleifen}
+\begin{tabular}{ll}
+& \begin{tikzpicture}[codeblocks]
\schleife{TEXT: Für/solange/etc}{TEXT:Bedingung}{\node[logik]{NODE: Anweisung};}{name}
-\end{tikzpicture}
+\end{tikzpicture}\\
+deutsch & \cmd\schleife\oarg{STIL}\marg{PRE}\marg{BED}\marg{ANW}\marg{NAME}\\
+english & \cmd\loopblocks\oarg{STYLE}\marg{PRE}\marg{COND}\marg{INST}\marg{NAME}\\\\
+\end{tabular}
-\paragraph{Beispiel: Schleifen}
-\begin{tikzpicture}[codeblocks,]
+
+\ex{Bsp. Schleifen}
+\begin{tikzpicture}[codeblocks]
\schleife[draw]{Solange}{\tikz\node[logik,keinezacken]{\dropdown{A}~\dropdown{=}~\dropdown{B}};}{
\node[aktion]{A=B+B};}{schl1}
@@ -336,119 +421,56 @@ Strukturen helfen, die Positionierung von Nodes zu vereinfachen. Dafür können
\node[aktion]{A=B+B};}{schl2}
\end{lstlisting}
-\section{Positioneriung der Nodes}
-
-\begin{comment}
-\section{Klammerstellungen der Blöcke darstellen}
-
-\DescribeMacro{umgebung} Für das Setzen einer optischen Klammerstellung der Blöcke müssen zusätzliche Nodes definiert werden. Diese müssen den Stil des jeweiligen Elementtyps haben und um den Stil \lstinline|umgebung| erweitert werden.
-
-\DescribeMacro{fit} Über das TikZ-Attribut \lstinline|fit=Liste der Nodenamen in runden Klammern| wird ein neuer Node als Rahmen erstellt. Alle Nodes, die der Rahmen umfassen soll, müssen hier als Parameter angegeben werden. Die Definition des Node mit dem fit-Attribut muss innerhalb der Umgebung\DescribeMacro{pgfonlayer} \lstinline|\begin{pgfonlayer}{background}| stehen, damit bestehende Nodes nicht überzeichnet werden.
-
-Beispiel:
-\begin{lstlisting}[language={},morekeywords={fit, pgfonlayer,log,motorlogik1,logsonst,musiklogik2},]
-\begin{tikzpicture}[codeblocks]
-\node[logik](log) {Wenn \dropdown{5} \dropdown{<} \intbox{5} dann mache};
-\node[motor, unter={log}{1}{1}] (motorlogik1) {setzte \intbox{5}V an Ausgang \stringbox{powerOut}};
-\node[logik, unter={motorlogik1}{-1}{0}] (logsonst) {ansonsten mache};
-\node[musik, unter={logsonst}{1}{1}] (musiklogik2) {spiele Note \dropdown{C} für \dropdown{1/4} Takt};
-
-% Umgebungen setzen mit fit
-\begin{pgfonlayer}{background}
- \node[umgebung, logik, fit=(log) (motorlogik1) (musiklogik2)] (logsonst){};
-\end{pgfonlayer}
-\end{tikzpicture}
-\end{lstlisting}
-
-\begin{tikzpicture}[codeblocks]
-
-\node[logik](log) {Wenn \dropdown{5} \dropdown{<} \intbox{5} dann mache};
-\node[motor, unter={log}{1}{1}] (motorlogik1) {setzte \intbox{5}V an Ausgang \stringbox{powerOut}};
-\node[logik, unter={motorlogik1}{-1}{0}] (logsonst) {ansonsten mache};
-\node[musik, unter={logsonst}{1}{1}] (musiklogik3) {spiele Note \dropdown{C} für \dropdown{1/4} Takt};
-\begin{scope}[yshift=-6cm]
-\node[logik](log) {Wenn \dropdown{5} \dropdown{<} \intbox{5} dann mache};
-\node[motor, unter={log}{1}{1}] (motorlogik1) {setzte \intbox{5}V an Ausgang \stringbox{powerOut}};
-\node[logik, unter={motorlogik1}{-1}{0}] (logsonst) {ansonsten mache};
-\node[musik, unter={logsonst}{1}{1}] (musiklogik2) {spiele Note \dropdown{C} für \dropdown{1/4} Takt};
+\subsubsection{Branches, loops and the english language}
+\begin{otherlanguage}{english}
+ 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.
+\end{otherlanguage}
-% Umgebungen setzen
-\begin{pgfonlayer}{background}
-\node[umgebung, logik, fit=(log) (motorlogik1) (musiklogik2)] (logsonst){};
-\end{pgfonlayer}
-\end{scope}
-
-
-\draw[-Latex, ultra thick, dashed] ($(musiklogik3.south east) +(1.5,0)$) -| ($(musiklogik3.south east) +(1.5,-2.5)$) node[ right,black, near end,] {+ neuer Node mit \textbf{fit}\\und \textbf{umgebung}};
-\end{tikzpicture}
-\end{comment}
-
-
-
-
-\begin{comment}
-\DescribeMacro{\setzenippel} \lstinline|\setzenippel{#1}| benötigt als Parameter eine Liste der Nodenamen, mit Komma getrennt. Hier ist keine Klammerung der Namen notwendig. Der Befehl muss innerhalb des \lstinline|codeblocks|-Stils stehen.
+\ex{English example}
+\begin{otherlanguage}{english}
+ \lstinline|\usepackage[english]{babel}|\\
+ \begin{tikzpicture}[codeblocks]
+ \wenndannsonst{A = B}{\node[aktion]{A++};}{\node[aktion]{B-{}-};}{name}
+ \end{tikzpicture}
+\end{otherlanguage}
-Beispiel:
-
-\begin{lstlisting}[keywords={},language={},morekeywords={\setzenippel, platz, steuerung}]
+\begin{lstlisting}[]
+\begin{otherlanguage}{english}
\begin{tikzpicture}[codeblocks]
- \node[platzhalter](platz){Setzte \dropdown{myString} auf \stringbox{Hallo Welt}};
- \node[steuerung,unter={platz}{0}{1}] (steuerung){Sende \dropdown{myString}};
- \setzenippel{platz,steuerung};
+\wenndannsonst{A = B}{\node[aktion]{A++};}{\node[aktion]{B-{}-};}{name}
\end{tikzpicture}
+\end{otherlanguage}
\end{lstlisting}
-\begin{tikzpicture}[codeblocks]
-\node[platzhalter](platz){Setzte \dropdown{myString} auf \stringbox{Hallo Welt}};
-\node[steuerung,unter={platz}{0}{1}] (steuerung){Sende \dropdown{myString}};
-\setzenippel{platz,steuerung};
-\end{tikzpicture}
-
-
-\DescribeMacro{\setzepuzzle} \lstinline|\setzepuzzle{#1}| benötigt als Parameter eine Liste der Nodenamen, mit Komma getrennt. Hier ist keine Klammerung der Namen notwendig. Der Befehl muss innerhalb des \lstinline|codeblocks|-Stils stehen.
-
-
-\begin{tikzpicture}[codeblocks]
-\node[logik] (log1) {Wenn \tikz\node[mathe](math1){\dropdown{A}+\dropdown{B}};
- \dropdown{<} \intbox{123}};
-
-\setzepuzzle{log1%,math1
-};
-\end{tikzpicture}
-
-\noindent \wichtig{} Sowohl \lstinline|\setzenippel| als auch \lstinline|\setzepuzzle| haben Positionierungsprobleme in verschaltenten Nodes. D.\,h., dass man Nodes innerhalb von Nodes nicht damit dekorieren kann.
-\end{comment}
-
+\section{Positioneriung der Nodes}
+\subsection{Manuelles Positionieren}\label{sec:unter}
-\subsection{Manuelles Einrücken}\label{sec:unter}
+Mit konsequenter Verwendung der Strukturen ist manuelles Einrücken selten notwendig. Jedoch ist das Aneinanderketten der Nodes unabdinglich. Hierfür wird der Stil
+\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.
-Mit konsequenter Verwendung der Strukturen ist manuelles Einrücken selten notwendig. Hierfür wird dann der Stil
-\DescribeMacro{unter} \texttt{unter=}\marg{NODE}\marg{X-Einzug-Faktor}\marg{Y-Einzug-Faktor} verwendet. Hierbei ist der Einzug jeweils als Ankerpunkt relativ zum Vorgänger gesetzt.
-
\vspace{1em}
\hspace*{-3cm}
\begin{tikzpicture}[codeblocks,scale=1.0]
\node[grundlage] (drueber) {Hier beginnt der Code};
\node[eingabe, unter={drueber}{1}{4}] (drunter){Das ist das letzte Kommando};
-
- \draw[black, ->, rounded corners=0] (drueber) -- (drunter.165) node[midway, black,right] {Abstand 4 (\#3)};
+
+ \draw[black, ->, rounded corners=0] (drueber) -- (drunter.165) node[midway, black,right] {Abstand 4 (\#3)};
\draw[black, ->, rounded corners=0] (drueber.south west) |- (drunter.west) node[midway, black,left] {Einzug 1 (\#2)};
-
+
\draw[black, ->, rounded corners=0] (drunter.east) |- (drueber.east) node[near start,right] {Bezug auf start-node (\#1)};
-
+
\end{tikzpicture}\vspace{2em}
-
-
+
+
\begin{lstlisting}[keywords={},morekeywords={drueber,drunter}]
\node[grundlage] (drueber) {Hier beginnt der Code};
\node[eingabe, unter={drueber}{1}{4}] (drunter){Das ist das letzte Kommando};
\end{lstlisting}
-
-
+
+
\subsubsection{Verschieben der Zacken bei manueller Einrückung}
%\input{bsp-openroberta-umgebung.tikz}
@@ -486,6 +508,7 @@ Mit konsequenter Verwendung der Strukturen ist manuelles Einrücken selten notwe
}
\end{lstlisting}
+\ex{Bsp. einruecken}
\input{bsp-einruecken.tikz}
\lstinputlisting[keywords={},language={},morekeywords={einruecken},firstline={2},lastline={5}]{bsp-einruecken.tikz}
@@ -499,29 +522,13 @@ Siehe \ref{sec:strukturen}!
\subsection{Puzzleoptik}
\newcommand{\mydeco}[1]{
- \tikz\node[codeblocks,mathe,#1](one){A+B};&\texttt{#1}\\
+ \tikz\node[codeblocks,mathe,#1](one){A+B};&#1
}
-\begin{wraptable}{r}{0.4\textwidth}
-%\begin{table}[htb!]
- \begin{center}\vspace*{-2.3em}
- \begin{tabular}{rl}
- \toprule
- \textsf{Form} & \textsf{verwendete Stile} \\\midrule
- \mydeco{}
- \mydeco{keinezacken}
- \mydeco{eckig}
- \mydeco{eckig, keinezacken}
- \mydeco{puzzleteil}
- \mydeco{puzzleteil, eckig}
- \bottomrule
- \end{tabular}
- \caption{Übersicht über Blockformen}
- \end{center}
-%\end{table}
-\end{wraptable}
-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.
+
+
+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.
Soll die \textit{horizontale} Beziehung von Bausteinen betont werden, so kann die Form \DescribeMacro{puzzleteil} \lstinline|puzzleteil| verwendet werden.
@@ -529,15 +536,40 @@ Soll die \textit{horizontale} Beziehung von Bausteinen betont werden, so kann di
\DescribeMacro{eckig} Der Stil \lstinline|eckig| entfernt alle runde Ecken und orientiert sich damit stärker an dem Erscheinungsbild von Open Roberta.
+Für Start- und Endbausteine sind die Formen \DescribeMacro{pinlow}\lstinline|pinlow| und \DescribeMacro{pinhigh}\lstinline|pinhigh| definiert.
+
+%\begin{wraptable}{r}{0.6\textwidth}
+\begin{table}[htb!]
+ \begin{center}%\vspace*{-2.3em}
+ \begin{tabular}{rll}
+ \toprule
+ \textsf{Shape} & \textsf{deutsch} & \textsf{english}\\\midrule
+ \mydeco{} & \\
+ \mydeco{pinlow} & pinlow \\
+ \mydeco{pinhigh} & pinhigh\\
+ \mydeco{keinezacken} & nopins\\
+ \mydeco{eckig} & square\\
+ \mydeco{eckig, keinezacken} & square, nopins\\
+ \mydeco{puzzleteil} & puzzlepiece \\
+ \mydeco{puzzleteil, eckig} & puzzlepiece, square\\
+ \bottomrule
+ \end{tabular}
+ \caption{Übersicht über Blockformen}
+ \end{center}
+\end{table}
+%\end{wraptable}
+
+
+\ex{Bsp. keinezacken}
+Der Stil \enquote{keinezacken} ist z.\,B. bei verschachtelten Nodes notwendig:
-\paragraph{Beispiel: keinezacken}
\begin{tikzpicture}
\node[codeblocks,logik](A){wenn \tikz\node[mathe]{A=B};};
\node[codeblocks,logik,right = 1cm of A](B){wenn \tikz\node[mathe,keinezacken]{A=B};};
-
+
\draw[->,very thick, dashed,black] (A)--(B);
\end{tikzpicture}
-
+%
\begin{lstlisting}[keywords={},morekeywords={keinezacken}]
\node[logik]{wenn \tikz\node[mathe,keinezacken]{A=B};};
\end{lstlisting}
@@ -551,7 +583,7 @@ Soll die \textit{horizontale} Beziehung von Bausteinen betont werden, so kann di
\clearpage
-\section{Q\&A}
+\section{FAQ}
\subsection{Wie kann ich für ein komplettes Dokument eine Farbe umdefinieren?}
\tikz\node[codeblocks,logik,]{Alte Farbe};
@@ -580,7 +612,7 @@ Soll die \textit{horizontale} Beziehung von Bausteinen betont werden, so kann di
\begin{tikzpicture}[codeblocks]
\node[musik,draw] (bad) {schlecht};
\node[musik,draw, rounded corners =0pt, right= 1.9em of bad] (good) {besser};
-
+
\draw[->,very thick,dashed, black] (bad)--(good);
\end{tikzpicture}
@@ -610,15 +642,32 @@ Verwende eine verschachtelte TikZ-Umgebung, z.\,B. mit dem \lstinline|\tikz|-Bef
\end{lstlisting}
-Keine Zacken aber Puzzleteil?
-falsch: puzzleteil ->keinezacken
-richtig: keinezacken,puzzleteil,
+%\todo{Keine Zacken aber Puzzleteil?
+%falsch: puzzleteil ->keinezacken
+%richtig: keinezacken,puzzleteil,}
+
+
+\subsection{Mein Block ist sehr klein und deswegen verformt}
+
+\tikz\node[codeblocks,logik](one){1};
+
+Erweitere den Nodeinhalt und Whitespace/Phantome oder setzte \lstinline|minimum width| für den Node:
+\tikz\node[codeblocks,logik,](one){2~~};
+\tikz\node[codeblocks,logik, minimum width=1cm](one){3};
+
+\begin{lstlisting}
+\node[logik](one){2~~};
+\node[logik, minimum width=1cm](one){3};
+\end{lstlisting}
+
\section{Mehr Beispielcode}
\subsection{Bsp: Calliope Smart Home}
\input{smarthome.tikz}
+
\lstinputlisting[basicstyle=\footnotesize \ttfamily]{smarthome.tikz}
-
+\listofexample
+
\end{document}