Gesammelte Update von autogenerierter Doku.
Change-Id: If453f1dd933c092c12ca0b5b2667dbd64ca246f8
diff --git a/doc/wiz/familien b/doc/wiz/familien
index 6f1d305..bb6b9a0 100644
--- a/doc/wiz/familien
+++ b/doc/wiz/familien
@@ -1,4 +1,3 @@
-
FAMILIEN
********
diff --git a/doc/wiz/farben b/doc/wiz/farben
new file mode 100644
index 0000000..1e14631
--- /dev/null
+++ b/doc/wiz/farben
@@ -0,0 +1,80 @@
+Farben im Mud
+*************
+
+ Farben in der Ausgabe werden im MorgenGrauen bislang eher selten
+ verwendet und die Einfaerbung meistens den Triggern des Clients
+ ueberlassen. Moechte man allerdings direkt etwas (farblich)
+ markieren, stehen hierfuer einige Hervorhebungs-Tags zur
+ Verfuegung, welche in ReceiveMsg() durch die passenden Steuercodes
+ fuer den Terminaltypen des Clients ersetzt werden.
+
+ Hierfuer muss die Ausgabe lediglich durch ReceiveMsg() und deren
+ Wrapper erfolgen, weitere Massnahmen sind weder noetig noch
+ empfohlen.
+
+ Benutzt werden diese Tags, indem die in den auszugebenden Text
+ zwischen zwei "%^" gesetzt werden: "`%^tag%^markierter
+ Text%^endetag%^`". Hierbei sollte dann ReceiveMsg() allerdings auch
+ der Zeilenumbruch ueberlassen werden.
+
+ Zu beachten ist, dass je nach Client bzw. seinem Terminaltyp nicht
+ alle Tags benutzbar sind. Falls z.B. der Client kein ANSI
+ untertuetzt und die Spielerin dieses abgeschaltet hat, werden diese
+ Tags nicht gesendet oder als Tag "normal" behandelt.
+
+ Technisch erfolgt die Ersetzung mittels terminal_colour(), welches
+ man nutzen koennte, um Farben in eine Ausgabe zu bringen, ohne
+ ReceiveMsg & Co zu nutzen. Allerdings ist aktuell die Farbtabelle
+ des Spielerobjekts nicht abfragbar.
+
+
+Tag-Liste
+=========
+
+
+Logische Hervorhebungen
+-----------------------
+
+ Zusaetzlich zu den direkt physischen Hervorhebungen (s.u.) gibt es
+ noch logische Hervorhebungen, welche zu einer vom Spieler
+ konfigurierbaren (TODO) Darstellung fuehren:
+
+ mention
+ Erwaehnungen eines Charnamens mit @Charname
+
+ normal
+ Normale Darstellung des Clients
+
+
+Physische Hervorhebungen
+------------------------
+
+ Diese Hervorhebungen stellen direkt eine bestimmte Farbe oder
+ Darstellung ein.
+
+ Vordergrundfarben (ANSI)
+ black, red, green, yellow, blue, purple, cyan, white
+
+ Hintergrundfarben (ANSI)
+ bg_black, bg_red, bg_green, bg_yellow, bg_blue, bg_purple,
+ bg_cyan, bg_white
+
+ Sonstiges (VT100, ANSI)
+ bold (fettgedruckt), underlined (unterstrichen), blink
+ (blinkend), invers (Vorder- und Hintergrundfarbe invertiert)
+
+
+Beispiel
+========
+
+ this_player().ReceiveMsg(
+ "Zesstra wirft Dir einen %^red%^roten Eimer%^normal%^ an den
+ Kopf.", MT_LOOK, MA_EMOTE);
+
+
+SIEHE AUCH
+==========
+
+ ReceiveMsg(), *../efun/terminal_colour*, P_TTY, P_TTY_TYPE
+
+Letzte Aenderung: 10.22.2022
diff --git a/doc/wiz/gerrit-projekte b/doc/wiz/gerrit-projekte
index b613c9f..0f32021 100644
--- a/doc/wiz/gerrit-projekte
+++ b/doc/wiz/gerrit-projekte
@@ -1,4 +1,3 @@
-
Erstellung neuer Repositories in Gerrit
***************************************
@@ -35,13 +34,12 @@
* "Creatw New" in der Repositoryliste
- * Name in der Form d/region/magier/bla (kein / am Anfang, keiner
- am Ende und auch kein .git am Ende)
+ * Name in der Form d/region/magier/bla (kein / am Anfang, keiner am
+ Ende und auch kein .git am Ende)
- * Rechtetemplat: meist d/region - aber bei secure/-Verzeichnissen
- in dem Verzeichnis *muss* es All-Projects sein, Eigentuemer
- Erzmagier (damit Du die Rechte nach dem Erstellen noch anpassen
- darfst...)
+ * Rechtetemplat: meist d/region - aber bei secure/-Verzeichnissen in
+ dem Verzeichnis *muss* es All-Projects sein, Eigentuemer Erzmagier
+ (damit Du die Rechte nach dem Erstellen noch anpassen darfst...)
* und ganz wichtig: 'create initial commit' auf True, nur dann
importiert er beim Anlegen aus dem Mud. Im anderen Fall ist das
diff --git a/doc/wiz/gerrit-upload b/doc/wiz/gerrit-upload
index c564777..1d7f815 100644
--- a/doc/wiz/gerrit-upload
+++ b/doc/wiz/gerrit-upload
@@ -1,4 +1,3 @@
-
Upload via Gerrit
*****************
@@ -18,20 +17,20 @@
Folgt dem Git workflow bis Schritt 4 (einschliesslich). Ab dort gehts
wie folgt weiter:
- 5. Pusht eure Aenderungen zum Review nach Gerrit: "git push
- origin lokalerbranch:refs/for/master" Damit werden eure
- Aenderungen des Zweigs lokalerbranch in den Review fuer den
- master-Zweig im MG uebertragen. Fuer jeden Commit wird ein
- Change in Gerrit erzeugt. Ihr bekommt in der Ausgabe auch die
- URL zum Change, den ihr erzeugt habt. Anschliessend tragt ihr
- entweder dort auf der Weboberflaeche einen oder mehrere Reviewer
- ein oder redet mit denjenigen im Mud.
+ 5. Pusht eure Aenderungen zum Review nach Gerrit: "git push origin
+ lokalerbranch:refs/for/master" Damit werden eure Aenderungen des
+ Zweigs lokalerbranch in den Review fuer den master-Zweig im MG
+ uebertragen. Fuer jeden Commit wird ein Change in Gerrit
+ erzeugt. Ihr bekommt in der Ausgabe auch die URL zum Change, den
+ ihr erzeugt habt. Anschliessend tragt ihr entweder dort auf der
+ Weboberflaeche einen oder mehrere Reviewer ein oder redet mit
+ denjenigen im Mud.
6. Die Reviewerin hat oft Wuensche, d.h. ihr muesste den Change
nochmal ueberarbeiten. Dazu gibt es zwei Moeglichkeiten:
- 1. Ihr aendert auf der Weboberflaeche selber ("Edit" und
- spaeter dann "Publish Edit"
+ 1. Ihr aendert auf der Weboberflaeche selber ("Edit" und spaeter
+ dann "Publish Edit"
2. Wollt ihr bei euch lokal auf dem Rechner nur einen (den
letzten Commit in eurem lokalen Zweig) aendern geht das am
diff --git a/doc/wiz/git-workflow b/doc/wiz/git-workflow
index 5018910..8f64806 100644
--- a/doc/wiz/git-workflow
+++ b/doc/wiz/git-workflow
@@ -1,4 +1,3 @@
-
Git workflow
************
@@ -41,12 +40,12 @@
Hier mach ich jetzt alle moeglichen Arbeiten und Basteleien, die
ich fuer die neue Kampftaktik brauche. Tipps dazu:
- * Viele und haeufige Commits machen! Je kleiner einzelne
- Commits sind, desto besser kann man Aenderungen spaeter
- verfolgen (was z.B. super ist, wenn jemand was abnehmen muss!)
- und desto besser kann man einzelne Aenderungen spaeter bei
- Bedarf auch rueckgaengig machen, wenn man merkt, dass man
- stellenweise Unsinn gebaut hat. ;-)
+ * Viele und haeufige Commits machen! Je kleiner einzelne Commits
+ sind, desto besser kann man Aenderungen spaeter verfolgen (was
+ z.B. super ist, wenn jemand was abnehmen muss!) und desto
+ besser kann man einzelne Aenderungen spaeter bei Bedarf auch
+ rueckgaengig machen, wenn man merkt, dass man stellenweise
+ Unsinn gebaut hat. ;-)
* Thematisch unterschiedliche Dinge in verschiedene Commits
packen. Also z.B. erst Syntaxfehler editieren und commiten,
@@ -113,8 +112,8 @@
git merge neue_kampftaktik
-6. Aenderungen in das MUD-Repository uebertragen Jetzt bin ich
- bereit, die Aenderungen ins Mud zu uebertragen:
+6. Aenderungen in das MUD-Repository uebertragen Jetzt bin ich bereit,
+ die Aenderungen ins Mud zu uebertragen:
git push origin <lokaler_zweigname>:<zweigname_im_mg>
diff --git a/doc/wiz/homemud b/doc/wiz/homemud
index 81bc5c4..759ed6a 100644
--- a/doc/wiz/homemud
+++ b/doc/wiz/homemud
@@ -1,4 +1,3 @@
-
Homemud
*******
@@ -29,27 +28,26 @@
mudlib und einen Driver der Version LDMUD-3.6.4 oder
https://github.com/zesstra/ldmud/releases/tag/mgreboot-20210507
- 1. Lade den aktuellen Driver unter
- https://github.com/ldmud/ldmud herunter. Du kannst auch das Repo
- via git clonen.
+ 1. Lade den aktuellen Driver unter https://github.com/ldmud/ldmud
+ herunter. Du kannst auch das Repo via git clonen.
- 2. Lade die aktuelle Mudlib von
- https://mg.mud.de/gerrit/gitweb?p =mudlib-public.git herunter,
- entweder durch einen Klick auf "snapshot" oder mittels git
- clonen. Dabei kann sich git an unserem selbsterstellten SSL-
- Zertifikat stoeren, wenn Du Dich darum nicht kuemmern willst,
- nutze die Option "-c http.sslVerify=false".
+ 2. Lade die aktuelle Mudlib von https://mg.mud.de/gerrit/gitweb?p
+ =mudlib-public.git herunter, entweder durch einen Klick auf
+ "snapshot" oder mittels git clonen. Dabei kann sich git an
+ unserem selbsterstellten SSL-Zertifikat stoeren, wenn Du Dich
+ darum nicht kuemmern willst, nutze die Option "-c
+ http.sslVerify=false".
3. Gehe in das *src/*-Verzeichnis des drivers
- 4. Im *src/*-Verzeichnis, fuehre "./autogen.sh" aus (Hierfuer
- ist das Paket autoconf empfehlenswert.)
+ 4. Im *src/*-Verzeichnis, fuehre "./autogen.sh" aus (Hierfuer ist
+ das Paket autoconf empfehlenswert.)
5. Im src/-Verzeichnis, passe die Pfade in settings/morgengrauen
an, und fuehre settings/morgengrauen aus
- 6. im src/-Verzeichnis, kompiliere und installiere den Treiber
- mit "make all" und "make install-all". (Hierfuer wird das Paket
+ 6. im src/-Verzeichnis, kompiliere und installiere den Treiber mit
+ "make all" und "make install-all". (Hierfuer wird das Paket
bison benoetigt.)
7. Falls noch nicht geschehen, schiebe die Mudlib in den Ordner,