Skip to content

Commit f9e6d91

Browse files
author
c0pperdragon
committed
Fix spelling in documentation
Mainly german documentation, but there were also some errors in the english version.
1 parent 60815f1 commit f9e6d91

File tree

5 files changed

+202
-201
lines changed

5 files changed

+202
-201
lines changed

Documentation/DocumentationGenerator.cs

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,19 +37,23 @@ static void Main(String[] args)
3737
"C:/Program Files (x86)/Microsoft/Small Basic/SmallBasicLibrary.xml",
3838
"EV3Basic Developer Manual",
3939
Documentation.Properties.Resources.Manual,
40+
"Returns",
41+
"Property",
4042
"C:/Users/Reinhard/Documents/GitHub/EV3Basic/Documentation/ev3basic_manual.html"
4143
);
4244

4345
generate("C:/Users/Reinhard/Documents/GitHub/EV3Basic/Documentation/SmallBasicEV3Extension.DE.xml",
4446
"C:/Program Files (x86)/Microsoft/Small Basic/SmallBasicLibrary.DE.xml",
4547
"EV3Basic Benutzerhandbuch",
4648
Documentation.Properties.Resources.ManualDE,
49+
"Rückgabewert",
50+
"Eigenschaft",
4751
"C:/Users/Reinhard/Documents/GitHub/EV3Basic/Documentation/ev3basic_manual_de.html"
4852
);
4953
}
5054

5155

52-
internal static void generate(String xml1, String xml2, String title, String part1, String outfilename)
56+
internal static void generate(String xml1, String xml2, String title, String part1, String returnstext, String propertytext, String outfilename)
5357
{
5458
objects = new Dictionary<String,EV3Object>();
5559

@@ -116,7 +120,7 @@ internal static void generate(String xml1, String xml2, String title, String par
116120
foreach (var pkey in plist)
117121
{
118122
String p = o.properties[pkey];
119-
target.WriteLine("<H3 class=\"property\">" + opkey+"."+pkey + " - property</H3>");
123+
target.WriteLine("<H3 class=\"property\">" + opkey+"."+pkey + " - "+propertytext+"</H3>");
120124
target.WriteLine("<P class=\"propertysummary\">" + p.Replace("\n","<BR>") + "</P>");
121125
}
122126
// write functions
@@ -138,7 +142,7 @@ internal static void generate(String xml1, String xml2, String title, String par
138142
// write return value
139143
if (f.returnvalue != null)
140144
{
141-
target.WriteLine("<H4 class=\"returns\">Returns</H4>");
145+
target.WriteLine("<H4 class=\"returns\">"+returnstext+"</H4>");
142146
target.WriteLine("<P class=\"returnssummary\">" + f.returnvalue + "</P>");
143147
}
144148
}

Documentation/Resources/ManualDE.txt

Lines changed: 27 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
<H1 class="chapter">EV3Basic</H1>
22
<P>
3-
Einen Roboter nach eigenen Ideen zu programmieren macht Spa�. Der einfachste Weg, den Lego EV3 Brick f�r einfache Aufgaben
4-
zu programmieren, ist mit der grafischen Software von Lego.
5-
Aber f�r gr��ere und komplexere Programm, ist diese Method nicht mehr gut geeignet und man braucht eine textbasierte
6-
Programmiersprache daf�r.
7-
Es gibt auch viele verschiedene Projekte um Programmiersprachen f�r den EV3 zu adaptieren (LeJOS, MonoBrick, RobotC, ev3dev, and andere).
3+
Einen Roboter nach eigenen Ideen zu programmieren macht Spa�. Am einfachsten gelingt das Programmieren einfacher Aufgaben
4+
mit der grafischen Software von Lego.
5+
F�r gr��ere und komplexere Programme braucht man jedoch eine textbasierte Programmiersprache.
6+
Es gibt auch viele verschiedene Projekte, um Programmiersprachen f�r den EV3 zu adaptieren (LeJOS, MonoBrick, RobotC, ev3dev, and andere).
87
Aber alle haben eine Sache gemeinsam: Sie sind unglaublich schwierig zum Laufen zu bringen und zu benutzen. Man ben�tigt
9-
jahrelange Erfahrung um auch nur eine davon benutzen zu k�nnen.
8+
jahrelange Erfahrung, um auch nur eine davon benutzen zu k�nnen.
109
</P>
1110
<P>
1211
Um diese L�cke zwischen ganz-einfach-aber-eingeschr�nkt und allm�chtig-aber-schwierig zu f�llen, habe ich EV3Basic entwickelt.
@@ -29,19 +28,19 @@ [email protected]
2928

3029
<H1 class="chapter">Erste Schritte</H1>
3130
<P>
32-
Was man zuerst braucht, ist ein PC mit Microsoft Windows (jede Version seit Windows XP) and the aktuelle Version von
31+
Was man zuerst braucht, ist ein PC mit Microsoft Windows (jede Version seit Windows XP) und die aktuelle Version von
3332
<a href="http://smallbasic.com">Microsoft Small Basic</a> die man sich gratis runterladen kann. F�r komplette Programmier-Neulinge empfehle
3433
ich die Tutorials auf Small Basic - Webseite um die grundlegenden Prinzipien zu erlernen. Das dauert nicht all zu lange und macht f�r sich
3534
alleine auch schon Spa�.
3635
</P>
3736
<P>
38-
Der n�chste Schritt ist, die EV3-Erweiterung f�r Small Basic zunterzuladen und zu installieren.
39-
Bei der <a href="https://github.com/c0pperdragon/EV3Basic/releases">neuesten Version</a> gibt es das die Datei "EV3BasicInstaller.msi", die
37+
Der n�chste Schritt ist, die EV3-Erweiterung f�r Small Basic runterzuladen und zu installieren.
38+
Bei der <a href="https://github.com/c0pperdragon/EV3Basic/releases">neuesten Version</a> gibt es die Datei "EV3BasicInstaller.msi", die
4039
man gratis runterladen und installieren kann.
41-
Die Installation muss direkt in das selbe Verzeichnis wie Small Basic gemacht werden. Normalerweise ist das schon richtig voreingestellt, wenn man
40+
Die Installation muss direkt in das selbe Verzeichnis wie Small Basic gespeichert werden. Normalerweise ist das schon richtig voreingestellt, wenn man
4241
den Installationspfad vom vorigen Schritt auch nicht ver�ndert hat.
43-
Beim n�chsten Start von Small Basic, hat man Zugriff auf verschiedene Objekte, mit denen sich die unterschiedlichen Aspekte des EV3-Bricks ansprechen lassen,
44-
und noch ein paar weitere universell n�tzliche Objekte au�erdem.
42+
Beim n�chsten Start von Small Basic, hat man Zugriff auf verschiedene Objekte, mit denen sich die unterschiedlichen Aspekte des EV3-Bricks ansteuern lassen,
43+
sowie noch ein paar weitere universell n�tzliche Objekte.
4544
</P>
4645
<P>
4746
Als erstes Programm k�nnte man
@@ -57,24 +56,24 @@ Sobald der EV3-Brick
5756
mit dem gro�en blauen "Ausf�hren" - Knopf von Small Basic starten.
5857
</P>
5958
<P>
60-
W�hrend des Programmierens zeigt das Intellisense-System von Small Basic die m�glichen Bibliotheksfunktionen und Erkl�rung
59+
W�hrend des Programmierens zeigt das Intellisense-System von Small Basic die m�glichen Bibliotheksfunktionen und Erkl�rungen
6160
f�r deren Benutzung. Diese Information is die selbe wie im Kapitel "Programmierbibliotheken".
6261
Es sind noch viele zus�tzliche Beispiel auf der EV3Basic Webseite als 'Examples.zip' verf�gbar.
6362
</P>
6463
<P>
6564
Den EV3-Brick vom PC aus fernzusteuern ist eine gute Sache, aber f�r viele Anwendungen ist es besser, das Programm direkt
66-
und unabh�ngig auf dem Robotor auszuf�hren, ohne einen PC, der jeden einzelnen Schritt festlegen muss.
65+
auf dem Roboter auszuf�hren, unabh�ngig von einem PC, der jeden einzelnen Schritt festlegen muss.
6766
</P>
6867
<P>
6968
Um das Programm auf den Brick zu bekommen, gibt es den EV3Explorer, der gleichzeit mit der EV3-Erweiterung mitinstalliert wurde, und
70-
nun �ber des Windows Start Men� (EV3Basic/EV3Explorer) ge�ffnet werden kann. Dieses Programm zeigt ein Fenster mit zwei H�lften: Links
71-
sieht man die Dateien, die ma Brick gespeichert sind und rechts die Dateien am PC.
72-
Man kann jedes der Beispiele oder jedes eigene Programm �bersetzen und am Brick starten indem man es selektier und "Compile and Run" dr�ckt.
69+
nun �ber das Windows Start Men� (EV3Basic/EV3Explorer) ge�ffnet werden kann. Dieses Programm zeigt ein Fenster mit zwei H�lften: Links
70+
sieht man die Dateien, die am Brick gespeichert sind und rechts die Dateien am PC.
71+
Man kann jedes der Beispiele oder jedes eigene Programm �bersetzen und am Brick starten, indem man es ausw�hlt und "Compile and Run" dr�ckt.
7372
Dadurch wird das Quellprogramm in eine f�r den Brick verst�ndliche Form �bersetzt (in eine Datei mit der Erweiterung .rbf), auf den
7473
Brick �bertragen und sofort gestartet.
75-
Wenn das Programm auch im Menu auf dem Brick sichtbar sein soll, muss zuerst ein Unterverzeichnis des "prjs"-Verzeichnisses mit einem sprechenden
76-
Namen erstellt werden, in das das Ausf�hrbar Programm hineincopiert werden muss (Der EV3-Brick zeigt nur Programme im Men� an, die auch in ihrem
77-
eignene Unterverzeichnis liegen).
74+
Wenn das Programm auch im Menu auf dem Brick sichtbar sein soll, muss zuerst ein Unterverzeichnis des "prjs"-Verzeichnisses mit einem
75+
aussagekr�ftigen Namen erstellt werden, in das das ausf�hrbare Programm hineinkopiert werden muss (Der EV3-Brick zeigt nur Programme im Men�
76+
an, die auch in ihrem eigenen Unterverzeichnis liegen).
7877
</P>
7978

8079
<H1 class="chapter">Kurzreferenz f�r Small Basic</H1>
@@ -95,7 +94,7 @@ Das Beispiel l
9594
B[a] = 55 ' Arrays werden implizit deklariert und wachsen bei Bedarf
9695
X = "hi" ' Variablen k�nnen auch Text enthalten
9796

98-
Sub write ' Definiert ein Unterprogram (Parameter sind nicht m�glich)
97+
Sub write ' Definiert ein Unterprogramm (Parameter sind nicht m�glich)
9998
TextWindow.WriteLine(X) ' Aufruf einer Bibliotheksfunktion, Zugriff auf Variable
10099
EndSub
101100
' Ablauf des Hauptprogramms flie�t um die Sub-Definition herum
@@ -114,7 +113,7 @@ Das Beispiel l
114113
EndFor
115114

116115
Sub write2
117-
write() ' Unterprogram ruft andereres Unterprogram auf
116+
write() ' Unterprogramm ruft andereres Unterprogramm auf
118117
write()
119118
EndSub
120119
' Ablauf des Hauptprogramms flie�t um die Sub-Definition herum
@@ -173,13 +172,13 @@ von den Datentypen der Operanden. Zweite Ausnahme ist der "+" - Operator, der en
173172
Texte zusammenh�ngt.
174173
�hnliche Einschr�nkungen gibt es f�r die Parameter von Bibliotheksfunktionen, die jeweils einen fixen Typ erwarten.
175174
Als kleine Erleichterung werden dort Zahlen automatisch in Texte konvertiert, wenn die Funktion einen Text ben�tigt
176-
(aber nicht anders herum)
175+
(aber nicht anders herum).
177176
</P>
178177

179178
<H3 class="subchapter">Arrays</H3>
180179
<P>
181180
Die Arrays von Small Basic arbeiten sehr universell und k�nnen jede Zahl oder jeden Text als Index verwenden.
182-
EV3-Basic kann das nicht. Nur Zahlen sind als Index erlaubt, und nur nicht-negative ganze Zahlen funktioniert wie erwartet.
181+
EV3-Basic kann das nicht. Nur Zahlen sind als Index erlaubt, und nur nicht-negative ganze Zahlen funktionieren wie erwartet.
183182
(A[4.5] ist das selbe wie A[4], A[-4] liefert aber immer 0 oder "")
184183
Es gibt keine Unterst�tztung f�r mehrdimensionale Arrays.
185184
Arrays k�nnen an Bibliotheksfunktionen �bergeben werden. Array-R�ckgabewerte m�ssen aber jeweils sofort in eine Variable gespeichert werden
@@ -204,7 +203,7 @@ so konfiguriert werden, dass die Kommunikation auch drahtlos m
204203
Wenn es noch nicht bereits geschehen ist, muss der EV3 zur Liste der Bluetooth-Ger�te am
205204
PC hinzugef�gt werden. Zuerst muss Bluetooth am EV3 aktiviert werden. Dazu m�ssen im Einstellungs-Men� die Punkte
206205
"Bluetooth" und "Visibility" angew�hlt werden.
207-
Am PC muss man dann in der �bersicht der Bluetooth-Ger�te ein neues Ger�t suchen und hinzuf�gen. Nach einigen
206+
Am PC muss man dann in der �bersicht der Bluetooth-Ger�te das neue Ger�t suchen und hinzuf�gen. Nach einigen
208207
weiteren gef�hrten Schritten, bei denen man auch am EV3 den Zugriff zulassen, und einen Kopplungs-Code
209208
(ist normalerweise "1234") eingeben muss, sollte die Verbindung hergestellt sein.
210209
</P>
@@ -218,7 +217,7 @@ in der Eigenschafts-Seite des Bluetooth-Ger
218217
Um diese neue Verbindung mit EV3-Basic zu verwenden, muss man nur das Programm wie gewohnt vom Small Basic
219218
starten, oder den EV3-Explorer benutzen. Falls kein EV3 an einem USB-Anschluss gefunden werden kann, zeigt
220219
das Programm weitere M�glichkeiten an. In dem Dialogfenster erscheinen auch alle potentiellen "Seriellen
221-
Anschl�sse", an denen ein EV3 verbunden sein k�nnte. Wenn man den richtigen ausw�hlt, dann sollte
220+
Anschl�sse", an denen ein EV3 verbunden sein k�nnte. Wenn man den richtigen ausw�hlt, sollte
222221
eine Verbindung funktionieren.
223222
</P>
224223

@@ -248,7 +247,7 @@ in der Liste angezeigt.
248247
<P>
249248
Um endlich den EV3 von Small Basic oder mit dem EV3-Explorer anzusteuern, muss man den "WiFi"-Button im Dialogfenster,
250249
das nach der richtigen Verbindungsmethode fragt, dr�cken.
251-
Dort muss man die IP-Adresse genauso wie vom Brick angezeigt eingegeben werden. Das muss man nur einmal machen,
250+
Dort muss die IP-Adresse genauso wie vom Brick angezeigt eingegeben werden. Das muss man nur einmal machen,
252251
diese Adresse wird am PC f�r zuk�nftige Verwendung gespeichert.
253252
</P>
254253
<P>
@@ -258,7 +257,7 @@ Achtung: Der EV3-Brick verbindet sich nach dem Start nicht automatisch mit dem R
258257
<H1 class="chapter">Dokumentation der Bibliotheksfunktionen</H1>
259258
<P>
260259
Die Laufzeit-Bibliothek f�r den EV3 besteht aus einzelnen Komponenten, die 'Objekte' genannt werden. Jedes Objekt
261-
stellt Funktionen f�r eine spezifischen Teil des Systemes bereit.
260+
stellt Funktionen f�r einen spezifischen Teil des Systemes bereit.
262261
Diese Liste enth�lt alle Objekte, die sowohl f�r Small Basic am PC (mit der EV3-Erweiterung) als auch am EV3-Brick selbst verf�gbar sind.
263262
Beim Schreiben vom Programmen, die sowieso nur am PC laufen sollen, kann man auch alle weiteren Objekte von Small Basic benutzen.
264263
Sie sind hier aber nicht beschrieben.

0 commit comments

Comments
 (0)