Dokumentation ?? Wir packen es an!!

Archiv Allgemeine Diskussion (2.x/3.x)
1

Hallo Gemeinschaft,

Ich wende mich heute mit einem sehr wichtigen Thema an euch.
Die Dokumentation.

Um Paresy und Co KG zu entlasten was die Doku angeht, würde ich mich über eure Hilfe freuen.

Bei der Anzahl der Möglichkeiten die IPS bietet ist die Doku hinzubiegen recht schwierig bei der Masse der Änderungen und Funktionen.

Mein Gedanke:
Jeder pickt sich ein Thema raus was Ihn stört oder aufgefallen ist. Schreibt die Doku dazu und wir Präsentieren es hier zur allgemeinen Begutachtung.

Wen alles i.O ist geht es an Paresy und Co KG zum Einpflegen in die Doku auf der HP.

LG Nick

2

Hier ein Beispiel für den Anfang,

Dokumentation/Befehlsreferenz/Ablaufsteuerung/Script Eventhandler
[b]

  • WebFront
  • Execute
  • TimerEvent
  • RunScript
  • Variable[/b]

if($IPS_SENDER == "WebFront") // Script wurde aus dem webfront getriggert.
	{
    	echo 'Führe den Code in den Klammern hier aus';
	}
	
if($IPS_SENDER == "Execute") // Wenn das Script mit "Ausführen" in der verwaltunkskonsohle gestartet wurde.
	{
    	echo 'Führe den Code in den Klammern hier aus';
	}
if($IPS_SENDER == "TimerEvent") // Wenn das Script durch den "Timerevent" aufgerufen wurde.
	{
    	echo 'Führe den Code in den Klammern hier aus';
	}
if($IPS_SENDER == "RunScript") // Wenn das Script durch ein anderes script mit  "IPS_RunScriptEx" aufgerufen wurde.
	{
    	echo 'Führe den Code in den Klammern hier aus';
	}
if ($IPS_SENDER == "Variable") ?????
	{
    	echo 'Führe den Code in den Klammern hier aus';
	}

Bitte dieses Beispiel vervollständigen damit es in die Doku kann…
LG Nick

3

möglicherweise habe ich den konzeptionellen Ansatz noch nicht verstanden, aber was aus dem Posting fehlt in dieser Doku?

4

Danke Raketenschnecke,

Resultierend aus meinem Post.

Habe es auch mit Sufu auf der Seite nicht gefunden.
Suche instinktiv unter der Dokumentation Befehlsreferenz.

Wäre das nicht unter Eventhänldler besser angebracht? Ist nur eine Idee…

Was ich mit diesem Thema erreichen möchte, ist die Doku aufzupepen. Da ich lieber mit Ihr arbeite als mich durch das Forum zu budeln.

Edit: She gerade ist schon angepasst.
"Nächster Part wird Wie mache ich was „Variablen profil exportieren“ anzupassen."

Gruß nick

5

grundsätzlich ist Dein Engagement zu begrüßen, aber eine Bitte: schalte bitte Deine Rechtschreibprüfung ein!

und ich hatte mehrfach in den verg. Monaten das gleiche Problem, diesen Dokuteil zu finden. Ich wusste, das es den gibt, ich wußte, das der an einer völlig unlogischen Stelle steht, hab ihn aber immer wieder länger suchen müssen. M.E. gehört der in eine eigene Rubrik namens „Systemvariablen“, entweder unter „Befehlsreferenz“ oder ins Root der Doku.

@paresy, was meinst Du?

6

Es gibt Sachen die ich in der Doku immer wieder suche und nur schwer finde.

Da ich mittlerweile eine WIKI habe liegt natürlich nahe diese Dinge in dort abzulegen was ich auch seit einigen Tagen so mache.

Zum Ansatz von Nick. Hier haben sich schon so einige ihre Gedanken gemacht wie man eine Dokumentation aufziehen könnte, ich denke aber das das Thema einfach zu komplex ist dieses ersten zu erstellen, auch wenn geteiltes Leid halbes Leid ist, und zweitens die Änderungen immer gepflegt werden müssen.

Letztendlich wird es nur das IPS-HQ vernünftig und aktuell hinbekommen die Doku zu erstellen.

7

Ihr habt Recht. Wir sollten das Wiki pflegen.

LG Nick