IPS Struktur/Scripte Dokumentation automatisch in einem Wiki

Hallo,

ich wollte hier mein kleines Projekt vorstellen, welches ich vor einiger Zeit realisiert habe.
Es handelt sich um eine automatische Dokumentationsunterstützung auf Basis von MediaWiki.

Ich betreibe seit längerer Zeit ein privates Wiki und wollte hier auch Teile meiner IPS Dokumentation integrieren.
Dabei kam mir der Gedanke einige Dinge im Wiki automatisch aktuell zu halten.

Was geht aktuell:

  • Automatisches Auslesen der IPS Struktur und Anlegen einer Übersichtsseite im Wiki
  • Details zu Scripten und Variablen
  • Automatische Versionierung durch die Wiki Software
  • Rote Markierung von Scripten, die als fehlerhaft markiert sind
  • Scripte werden als eigene Seiten angelegt und mit der Übersicht verlinkt
  • Das Script läuft jede Nacht und übermittelt nur Neues und Geändertes ans Wiki
  • Konfigurierbar, welche Informationen ich haben möchte (Letzte Ausführung & letzte Änderung einer Variable)

Gruß
Thorsten

Update vom 04.12.2011 (Version 1.2):
Ich habe die zwei notwendigen Dateien an diesen Beitrag angefügt.
Die notwendige Installationsanleitung habe ich im IPS Wiki (IPSWikiDoc) beschrieben.

Update vom 13.11.2011:
Ich habe das Script direkt im ersten Beitrag angehängt und werde es hier auch „pflegen“.
Das erleichtert das Auffinden der aktuellsten Version.

[ul]
[li]Zeilennummerierung in den PHP Scripten (Dank an Dapor)
[/li][li]Alphabetische Sortierung der Objekte (noch nicht 1:1 wie in der Konsole, aber besser als vorher)
[/li][li]Nur Scriptinhalte prüfen, deren Änderungsdatum größer der letzten „Inventur“ ist. Zyklische Laufzeit auf wenige Sekunden reduziert. (Dank an ChristianS)
[/li][/ul]

Update vom 21.11.2012:

[ul]
[li]PHP Timeout wird für das Skript auf 10 Minuten gesetzt
[/li][li]Es kann eine maximale Länge von Skripten gesetzt werden (MaxRowsPerScript). Wenn ein Skript mehr Zeilen hat dann wird es nicht ins Wiki übertragen (Standard: 2.300 Zeilen).
[/li][/ul]

Update vom 26.09.2015:

[ul]
[li]Minimale Anpassungen für IPS Version 4
[/li][/ul]

Update vom 16.11.2016:

[ul]
[li]Anpassung wegen UTF-8 Encoding
[/li][/ul]

Update vom 12.12.2016:

[ul]
[li]Archiv Handler wird auch gefunden wenn er umbenannt wurde
[/li][/ul]

IPSWikiDoc.php.txt (29.8 KB)
TM_WikiFunktionen.php.txt (8.45 KB)

Bildschirmfoto 2011-10-26 um 17.58.41.png

Hi Thorsten,

ein fettes RESPECT für die Nummer!
Ich hab mir dein Posting zunächst vorsichtig 2Mal durchgelesen und die Bilder angesehen - mit Doku hab ich momentan nicht viel am Hut (und auch nicht viel Erfahrung - zumindest im Softwareumfeld). Ich komme mit meinem IPS-Projekt gut zurecht. Derzeit lerne ich noch wie man innerhalb der Script dokumentiert - das klappt recht gut.
Hört sich doch gut an, oder?
Meiner Meinung nach nicht: ich hab zwar in letzter Zeit häufiger nach Fehlern suchen müssen und mich auch in alte Scripte wieder recht schnell eingelesen, bin mir sicher dass das derzeit nur an meiner Routine liegt. Ich hab mir schon häufiger Gedanken gemacht was wohl wäre wenn ich mal für 6 Monate deutlich weniger am IPS rumschraube und die Abhängigkeiten zwischen den IPS-Elementen nicht mehr so präsent sind. Ebenso kommt regelmäßig im Forum die Frage hoch: wie dokumentiert Ihr eigentlich?

Aber einen solchen Lösungsansatz hab ich noch nicht gesehen. Ich würd mich damit gern näher befassen wollen!
:wink:

Hi Raketenschnecke,

danke für deinen Respekt - ist schön wenn die eigenen Ideen gut ankommen ;).

Ich werde zukünftig u.a. noch DokuTags innerhalb der Scripte auswerten, so dass man direkt auf der Übersicht zu jedem Script die gemachten Kommentare sehen kann.

Außerdem hast Du mich auf die Idee gebracht, in jedem Script nach require(_once) und include(_once) zu suchen und eventuelle Abhängigkeiten auch mitzudokumentieren.

Gruß
Thorsten

Hi Thorsten,

tolle Idee - das ist ja nicht nur eine gute Doku, sondern auch eine Versionsverwaltung für Skripte. Weiter so!

Stellst du das irgendwann der Community zur Verfügung?

Danke & Gruß,
Axel

Danke Axel.
Das mit der Versionierung war auch einer der Hauptgründe es im Wiki zu machen.
Jetzt kann ich ein Script ändern und nach x-Tagen feststellen, dass ich etwas kaputt gespielt habe und schaue mir die vorherige Version im Wiki an :p.

Ich feile noch ein paar Ecken rund :smiley: und dann stelle ich es bei Interesse gerne mit einer ausführlicheren Anleitung zur Verfügung.

Gruß
Thorsten

Hi

Tolle Idee, bin auch schon am Überlegen wie ich das ganze ein wenig Dokumentieren soll. Dies werde ich ganz sicher testen.

Vielen dank

Gruss
Dani

INTERESSE ANGEKÜNDIGT.

Falls jemand keine Möglichkeit hat auf seiner Büchse noch ein MediaWiki zu betreiben, kann mir ne kurze PN schreiben, dann kann er eins von mir bereitgestellt bekommen.

Wer in Nidda beim Stammtisch dabei war, weiß was für eine Maschine bei mir für IPS zuständig ist :wink:

Da schließe ich mich bedingungslos an. Klasse Idee.

Ich versuche seit langer Zeit meinen Wust etwas zu bändigen aber wie das halt so geht mit den eigenen unwichtigen Dingen. Hab mir extra schon das Buch:„Schluss mit dem ewigen Aufschieben“ besorgt aber das Lesen habe ich bis heute auch noch nicht geschafft. :D:D:D

Daher nochmals Danke für so ein Projekt und die Vorstellung im Forum.

absoluten Respect für deine Vorstellung !

Melde Interesse an und eventuell je nach Zeit Untertstützung.

Gruß wibo

Super Idee. Werde es mir auf jeden Fall anschauen.
Grüße, Jürgen

Wann bekommen wir es denn ca. zu sehen ???

Jungs, bleibt mal locker :wink:

Erwollte doch erstmal abchecken ob überhaupt Interesse besteht. Gleichzeitig schreibt er ja das er noch nicht ganz fertig ist und an einigen Stellen noch rumgeschraubt werden muß. Ist ein guter Ansatz finde ich, da sollte nicht allzuviel Erwartungsdruck aufgebaut werden. Lieber was funktionierendes und etwas länger warten als umgekehrt :slight_smile:

Ich wollte da keinen Druck aufbauen. Ich wollte nur ne ungefähre Zeitvorstellung erfragen: 1 Woche / 1 Monat / oder so…

Ich finde die Idee wirklich Klasse. Frage mich allerdings warum ich da nicht drauf gekommen bin :confused:

Wahnsinn - ich hatte ja gehofft dass der eine oder andere Interesse zeigt, aber die vielen tollen Rückmeldungen hauen mich direkt um :D.

Ich habe das Script mittlerweile soweit umgebaut, dass alles wichtige über Parameter konfiguriert werden kann (u.a. auch Unterstützung von .htaccess geschützten Wikis, …).

Da ich aber gerne eine Version veröffentlichen würde, die gut funktioniert (auch in anderen Installationen als meine) würde ich das Script erst einem privaten Betatester geben und Feedback abwarten. Durch diese Installation würden noch Fehler, etc. auffallen, die ich noch beheben will.
Dann würde ich es der gesamten Öffentlichkeit zur Verfügung stellen.

Wer hätte dann aktuell schon eine aktuelle Version des MediaWikis zum testen da und würde sich als Betatester anbieten?

Ich habe auch noch eine Funktion eingebaut um mir Scripte und Variablen anzuzeigen die mehr als x-Tage nicht zum Einsatz kamen. Somit fallen vielleicht Altlasten auf, die man mal löschen könnte.

Gruß
Thorsten

Ich wollte auch mal’ der erste im Forum sein, der eine neue tolle Idee umsetzt :D.
Dem Betatester würde ich das Script bestimmt bis zum Wochenende geben können - und die Bugfixing Dauer ist abhängig von meinen bisher eingebauten Fehlern :rolleyes:.

Gruß
Thorsten

1.ter !!!

Ich habe aktuell kein MediaWikis installiert aber das erscheint mir nicht das große Problem.

Wenn Du noch einen suchst, der sich auf Knopfdruck unheimlich doof anstellen kann, dann sag Bescheid. Oft kann viel Wissen auch hinderlich sein und die Unbedarften finden die unglaublichsten Fehler. :stuck_out_tongue:

Okay Frank,
dann könnte ich eigentlich mit dem Script auf einen Installationsabend direkt bei Dir vorbeikommen :D.

Gruß
Thorsten

Kömmer nen Betatester-Tag machen :slight_smile:

Würde dann alles vorbereiten ( MediaWiki installiern u.ä.)

Dann ziehe ich zurück. Du kommmst mier nit rein. :p:p

Viel Spaß und Erfolg Jungs. Bin echt gespannt auf das Projekt.