+ Antworten
Seite 1 von 28 1 2 3 11 ... LetzteLetzte
Ergebnis 1 bis 10 von 271
  1. #1
    Registriert seit
    Nov 2010
    Ort
    Wetterau
    Beiträge
    1,035

    Lightbulb 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.
    • Zeilennummerierung in den PHP Scripten (Dank an Dapor)
    • Alphabetische Sortierung der Objekte (noch nicht 1:1 wie in der Konsole, aber besser als vorher)
    • Nur Scriptinhalte prüfen, deren Änderungsdatum größer der letzten "Inventur" ist. Zyklische Laufzeit auf wenige Sekunden reduziert. (Dank an ChristianS)


    Update vom 21.11.2012:
    • PHP Timeout wird für das Skript auf 10 Minuten gesetzt
    • 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).


    Update vom 26.09.2015:
    • Minimale Anpassungen für IPS Version 4


    Update vom 16.11.2016:
    • Anpassung wegen UTF-8 Encoding


    Update vom 12.12.2016:
    • Archiv Handler wird auch gefunden wenn er umbenannt wurde


    IPSWikiDoc.php.txt
    TM_WikiFunktionen.php.txt
    Miniaturansichten angehängter Grafiken Miniaturansichten angehängter Grafiken Klicken Sie auf die Grafik für eine größere Ansicht 

Name:	Bildschirmfoto 2011-10-26 um 17.58.09.png 
Hits:	1457 
Größe:	75.5 KB 
ID:	13660   Klicken Sie auf die Grafik für eine größere Ansicht 

Name:	Bildschirmfoto 2011-10-26 um 17.58.41.png 
Hits:	1005 
Größe:	16.8 KB 
ID:	13661   Klicken Sie auf die Grafik für eine größere Ansicht 

Name:	Bildschirmfoto 2011-10-26 um 17.59.28.png 
Hits:	1213 
Größe:	79.2 KB 
ID:	13662   Klicken Sie auf die Grafik für eine größere Ansicht 

Name:	Bildschirmfoto 2011-10-26 um 18.00.01.png 
Hits:	948 
Größe:	75.9 KB 
ID:	13663   Klicken Sie auf die Grafik für eine größere Ansicht 

Name:	Bildschirmfoto 2011-10-26 um 18.00.12.png 
Hits:	937 
Größe:	99.5 KB 
ID:	13664  

    Klicken Sie auf die Grafik für eine größere Ansicht 

Name:	Bildschirmfoto 2011-10-26 um 18.01.13.png 
Hits:	1002 
Größe:	35.6 KB 
ID:	13665   Klicken Sie auf die Grafik für eine größere Ansicht 

Name:	Bildschirmfoto 2011-10-26 um 18.03.47.png 
Hits:	773 
Größe:	55.8 KB 
ID:	13666  
    Geändert von thorsten9 (12.12.16 um 20:14 Uhr) Grund: Version 1.6
    IPS 5 auf Raspian, KNX, DALI, Homematic, EKM, RGB868 Stripe

  2. #2
    Registriert seit
    Oct 2010
    Ort
    HH
    Beiträge
    4,613

    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!
    mit gebücktem Gruss
    Raketenschnecke
    IPS-Projekte und -Tools auf
    www.raketenschnecke.net

  3. #3
    Registriert seit
    Nov 2010
    Ort
    Wetterau
    Beiträge
    1,035

    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
    IPS 5 auf Raspian, KNX, DALI, Homematic, EKM, RGB868 Stripe

  4. #4
    Registriert seit
    Apr 2011
    Ort
    Cologne
    Beiträge
    801

    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

  5. #5
    Registriert seit
    Nov 2010
    Ort
    Wetterau
    Beiträge
    1,035

    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 .

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

    Gruß
    Thorsten
    IPS 5 auf Raspian, KNX, DALI, Homematic, EKM, RGB868 Stripe

  6. #6
    Registriert seit
    Feb 2010
    Beiträge
    109

    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
    IPS V4.1, SymBox, KNX, 1-Wire

  7. #7
    Registriert seit
    Jan 2010
    Ort
    Friedrichsdorf-Köppern
    Beiträge
    1,441

    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
    • Server: 3x 19" 1HE ITX Intel Atom D525 Server
    • Router: Sophos UTM 9
    • IPS-Server: 19" Intel I5/ 32 GB / 500 GB HDD
    • HT: Homematic 95% / 1-Wire 5% / Z-Wave Beginner

  8. #8
    Registriert seit
    Jul 2010
    Ort
    Südwestpfalz
    Beiträge
    6,953

    Zitat Zitat von Raketenschnecke Beitrag anzeigen
    Hi Thorsten,

    ein fettes RESPECT für die Nummer!
    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.

    Daher nochmals Danke für so ein Projekt und die Vorstellung im Forum.
    Gruß Boui . . . IPS-unlim. auf Tinker Board S und aktuell auf einem Pi3 läuft pivccu3

    Die gefährlichste Form der Zensur ist die Schere im eigenen Kopf.(Curzio Malaparte)

  9. #9
    Registriert seit
    Jan 2010
    Ort
    Rheinland Pfalz
    Beiträge
    1,766

    absoluten Respect für deine Vorstellung !

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

    Gruß wibo

  10. #10
    Registriert seit
    Jun 2010
    Ort
    Nähe Trier
    Beiträge
    381

    Super Idee. Werde es mir auf jeden Fall anschauen.
    Grüße, Jürgen
    IPS V5.3 (Docker)
    Homematic piVCCU, versch. Sensoren mit Arduino
    Davis Vantage Pro LAN

Ähnliche Themen

  1. Newbie hat eine Frage! Mail per IPS?
    Von Xanon im Forum Allgemeine Diskussion
    Antworten: 7
    Letzter Beitrag: 14.10.10, 18:40
  2. IPS runterfahren während Designer noch läuft !
    Von guyabano im Forum Dashboard
    Antworten: 11
    Letzter Beitrag: 14.01.07, 22:42
  3. Fernbedienung und IPS: Wie kann ich beides zur Steuerung verwenden?
    Von Budgreg im Forum Sonstige Funkkomponenten / Wetterstationen
    Antworten: 10
    Letzter Beitrag: 29.11.06, 09:11
  4. IPS für mehrere Nutzer (RDP)
    Von f0rd42 im Forum Allgemeine Diskussion
    Antworten: 27
    Letzter Beitrag: 26.10.06, 07:51
  5. ips friert ein und kann nicht beendet werden
    Von pleibling im Forum Allgemeine Diskussion
    Antworten: 0
    Letzter Beitrag: 02.07.06, 14:24