Skip to content

Commit 2207d34

Browse files
committed
hyperbook: use new permaid feature to link to current XML docs
1 parent 2d4fef4 commit 2207d34

File tree

3 files changed

+7
-6
lines changed

3 files changed

+7
-6
lines changed

hyperbook/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
all: build
22

3-
dev: .hyperbook/node_modules
3+
dev:
44
npx --yes hyperbook dev
55

66
prod: bin/test-production.sh

hyperbook/book/spiele/25_hase-und-igel/xml.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
name: XML-Dokumentation
3+
permaid: xml
34
---
45

56
# XML-Elemente des Spiels Hase und Igel

hyperbook/book/xml/protokoll.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,24 @@ Die :t[Computerspieler]{#player} müssen lediglich das Kommunikationsprotokoll e
1212
Anfängern wird allerdings davon abgeraten, einen komplett eigenen Computerspieler zu schreiben.
1313
Es ist deutlich einfacher, auf einer bereitgestellten Spielervorlage aufzubauen,
1414
da man sich dabei nur um die Strategie und nicht um die Kommunikation kümmern muss.
15-
Außerdem wird vom Institut für Informatik die beste Unterstützung für Java/Kotlin geboten.
15+
Außerdem wird vom Institut für Informatik die beste Unterstützung für Java/Kotlin sowie Python geboten.
1616

1717
:::alert{warn}
1818
Im Verlauf des Wettbewerbes können Elemente zur Kommunikationsschnittstelle hinzugefügt werden,
1919
die in dieser Dokumentation nicht aufgeführt sind.
2020
Damit ein Computerspieler auch bei solchen Änderungen fehlerfrei mit dem Server kommunizieren kann,
21-
sollten beim Auslesen des :t[XML]{#xml} jegliche Daten verworfen werden,
21+
sollten beim Auslesen des XML jegliche Daten verworfen werden,
2222
die hier nicht weiter definiert sind.
2323
:::
2424

2525
:::alert{info}
2626
Die bereitgestellten Programme
2727
(Server, Java-Spieler) nutzen eine Bibliothek namens XStream,
28-
um Java-Objekte direkt in :t[XML]{#xml} zu konvertieren und umgekehrt.
28+
um Java-Objekte direkt in XML zu konvertieren und umgekehrt.
2929
Dabei werden XML-Nachrichten nicht unbedingt mit einem Zeilenumbruch abgeschlossen.
3030
:::
3131

32-
Spielspezifische Elemente werden in der Dokumentation des jeweiligen Spiels dokumentiert.
32+
Spielspezifische Elemente werden in der [XML-Dokumentation des aktuellen Spiels](/@/xml) dokumentiert.
3333

3434
## Der Aufbau
3535

@@ -52,7 +52,7 @@ client2App --> serverApp : Sendet Zug in XML
5252
:::
5353

5454
Die Darstellung skizziert die Architektur unseres Spielsystems,
55-
bestehend aus dem Server als :t[Spielleiter]{#server} und zwei Spielern.
55+
bestehend aus dem Server als Spielleiter und zwei Spielern.
5656
Der Server verwaltet das Spielgeschehen
5757
und interagiert über das XML-Protokoll mit den beiden Spielern,
5858
die jeweils auf einer Spielervorlage aufbauen.

0 commit comments

Comments
 (0)