Manpages als reStructuredText erstellt
Unsere Manpages wurden mit einem LPC-Tool in
reStructuredText konvertiert und liegen jetzt
in diesem Verzeichnis als Quelldaten.
Aus diesen reStructuredText sollen dann per
Script die ASCII-Manpages und per Sphinx HTML u.a.
erzeugt werden.
Change-Id: I75d659a7b3f9863aecb11dbeb0037e6cae227c36
diff --git a/doc/sphinx/props/P_DOOR_INFOS.rst b/doc/sphinx/props/P_DOOR_INFOS.rst
new file mode 100644
index 0000000..20c9e0c
--- /dev/null
+++ b/doc/sphinx/props/P_DOOR_INFOS.rst
@@ -0,0 +1,59 @@
+P_DOOR_INFOS
+============
+
+NAME
+----
+::
+
+ P_DOOR_INFOS "door_infos"
+
+DEFINIERT IN
+------------
+::
+
+ /sys/doorroom.h
+
+BESCHREIBUNG
+------------
+::
+
+ Mapping mit Informationen ueber eine im Raum per NewDoor() definierte
+ Tuer. Diese Infos werden ueber /std/room/doors.c an den /obj/doormaster.c
+ weitergegeben und dem Raum, der die Tuer besitzt, als Property gesetzt.
+ Werden mehrere Tueren in einem Raum eingebunden, enthaelt das Mapping
+ entsprechend viele Eintraege.
+
+ Dieses Mapping dient zur internen Verwaltung der Tueren im
+ /obj/doormaster.c und sollte nicht per Hand veraendert werden!
+
+ Die Eintraege im Mapping haben folgende keys (definiert in
+ /sys/doorroom.h):
+
+ D_DEST : Zielraum (string)
+ D_CMDS : Befehl(e), um durch die Tuer zu gehen (string oder *string)
+ D_IDS : IDs der Tuer (string oder *string)
+ D_FLAGS : Besondere Eigenschaften der Tuer (Tuer braucht Schluessel etc.)
+ D_LONG : Langbeschreibung (string)
+ D_SHORT : Kurzbeschreibung (string)
+ D_NAME : Name (string oder *string)
+ D_GENDER : Geschlecht
+ D_FUNC : Funktion, die VOR dem Durchschreiten der Tuer aufgerufen wird
+ D_MSGS : Bewegungsmeldungen
+ D_FUNC2 : Funktion, die NACH dem Durchschreiten der Tuer aufgerufen wird
+ D_TESTFUNC : Funktion die im Sartraum testet, ob die Tuer durchschritten
+ werden darf
+ D_RESET_MSG : Meldungen beim Tuer-Reset
+ D_OPEN_WITH_MOVE : Falls gesetzt, wird die Tuer auch mit dem
+ Bewegungsbefehl geoeffnet und durchschritten, falls
+ Oeffnen erfolgreich
+
+SIEHE AUCH
+----------
+::
+
+ NewDoor(), QueryDoorKey(), QueryDoorStatus(), SetDoorStatus(),
+ /std/room/doors.c, /obj/doormaster.c, GetPhiolenInfos(), QueryAllDoors()
+
+
+Letzte Aenderung: Don, 08.05.2014, Gabylon
+