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_INTERNAL_EXTRA_LOOK.rst b/doc/sphinx/props/P_INTERNAL_EXTRA_LOOK.rst
new file mode 100644
index 0000000..8d07c63
--- /dev/null
+++ b/doc/sphinx/props/P_INTERNAL_EXTRA_LOOK.rst
@@ -0,0 +1,58 @@
+P_INTERNAL_EXTRA_LOOK
+=====================
+
+NAME
+----
+::
+
+ P_INTERNAL_EXTRA_LOOK "internal_extralook"
+
+DEFINIERT IN
+------------
+::
+
+ /sys/living/description.h
+
+BESCHREIBUNG
+------------
+::
+
+ Diese Property enthaelt ein Mapping, in dem alle einzelnen
+ Extra-Look-Eintraege des Livings enthalten sind. Dabei weden die Daten von
+ AddExtraLook() und RemoveExtraLook() verwaltet. Fragt man diese Prop mit
+ QueryProp() ab, erhaelt man die Ausgabe der gueltigen Extralooks des
+ Livings. Bei Abfrage per Query() erhaelt man ein Mapping mit allen
+ Eintraegen und deren Daten. Jeder Wert im Mapping ist erneut ein Mapping,
+ welches folgende Keys enthalten kann:
+ - "xllook": String, der im Extralook des Living angezeigt wird.
+ - "xlduration": Zeitstempel (int), der angibt, wie lang der Eintrag gueltig
+ ist. 0 == "Unendlich", negative Zahlen besagen, dass der
+ Eintrag nur bis Reboot/Ende gueltig sein und abs(xlduration)
+ ist der Zeitpunkt des Eintrages dieses Extralooks.
+ - "xlende": String, der nach Ablaufen an das Living ausgegeben wird.
+ - "xlfun": Funktion, die gerufen wird und den String zurueckliefern muss,
+ der ausgeben werden soll.
+ - "xlendefun": Funktion, die gerufen wird, wenn der Eintrag abgelaufen ist
+ und den String zurueckliefern muss, der dann ans Living
+ ausgeben wird.
+ - "xlobjectname": Objekt, in dem die o.a. Funktionen gerufen werden.
+
+BEMERKUNG
+---------
+::
+
+ DIESE PROPERTY BITTE NIEMALS PER HAND MIT Set()/SetProp() AENDERN!
+ Die Daten in dieser Prop werden vom Living selber verwaltet. Extralooks
+ koennen mittel AddExtraLook() eingetragen und mit RemoveExtraLook() entfernt
+ werden.
+
+SIEHE AUCH
+----------
+::
+
+ long(), /std/living/description.c, /std/player/base.c
+ AddExtraLook(), RemoveExtraLook()
+
+
+13.05.2007, Zesstra
+