HTML/JS/PHP Tool für die Dokumentation

Moderator: Moderatoren

Antworten
Benutzeravatar
azzo
1000 working lines a day
1000 working lines a day
Beiträge: 802
Registriert: So, 28. Mär 2010 19:21
Hat sich bedankt: 11 Mal
Danksagung erhalten: 22 Mal

HTML/JS/PHP Tool für die Dokumentation

Beitrag von azzo »

Hallo,
parallel zur Umstellung von WINHOTEL von Desktop zu einer WebApp arbeite ich auch an einem Tool für die Dokumentation. Ich verwende dafür HTML/JS/PHP. Es nutzt eine TreeView zur Strukturierung, TinyMCE als Editor und KI zur Erstellung von Texten und Flowcharts. Besonders beim Umstieg von XBase/Clipper auf Web-Technologien hilft es mir, komplexe Abläufe zu dokumentieren. Hier ein kleiner Einblick in die Benutzeroberfläche.

TreeView für die Navigation
- Die Dokumente sind hierarchisch organisiert, ähnlich wie in einer Explorer-Ansicht.
- Neue Knoten (z. B. Kapitel oder Unterkapitel) lassen sich einfach hinzufügen.

TinyMCE als Editor
- Inhalte lassen sich im HTLM-Format bearbeiten, was Formatierungen, Bilder und Links ermöglicht.
- Strukturierte Inhalte wie Code-Snippets, Tabellen oder Aufzählungen können problemlos eingefügt werden.

Automatisierte Flowcharts mit KI
- Statt Flowcharts manuell zu zeichnen, kann das System sie automatisch aus Prozessbeschreibungen generieren.
- Ideal für die Dokumentation von Abläufen, Algorithmen oder Entscheidungsprozessen.

Serverseitige Speicherung mit PHP
- Die erstellten Dokumente und Diagramme werden serverseitig gespeichert und können jederzeit wieder geladen werden.
- Versionierung oder Exportfunktionen sind denkbar als Erweiterung.

Hilfreich für den Umstieg von XBase/Clipper auf Web-Technologien
- Durch die strukturierte Dokumentation lassen sich ältere Desktop-Systeme besser analysieren und auf Web-Technologien umstellen.
- Das Tool eignet sich also sowohl für technische Dokumentation als auch für die Visualisierung von Software- und Geschäftsprozessen.

Der Vorteil hier ist, dass ich HTML zum Speichern der Dokumente verwende. Damit kann ich die Informationen sofort über den Webbrowser verfügbar machen, ohne das Format ändern zu müssen.

Nächster Schritt: Einbau der Volltextsuche.
LG
Otto

Bild
Zuletzt geändert von azzo am Di, 04. Feb 2025 12:43, insgesamt 1-mal geändert.
Benutzeravatar
Armin
Rekursionen-Architekt
Rekursionen-Architekt
Beiträge: 409
Registriert: Mo, 26. Sep 2005 12:09
Wohnort: 75331 Engelsbrand
Danksagung erhalten: 5 Mal
Kontaktdaten:

Re: HTML/JS/PHP Tool für die Dokumentation

Beitrag von Armin »

Hallo Otto,
TinyMCE als Editor
- Inhalte lassen sich im Rich-Text-Format bearbeiten, was Formatierungen, Bilder und Links ermöglicht.
TinyMCE unterstützt nicht von Haus aus die Bearbeitung von RTF-Dateien (Rich Text Format).

Grüße
Armin
sammler0002
UDF-Programmierer
UDF-Programmierer
Beiträge: 73
Registriert: Mi, 23. Dez 2015 22:46
Hat sich bedankt: 26 Mal
Danksagung erhalten: 13 Mal

Re: HTML/JS/PHP Tool für die Dokumentation

Beitrag von sammler0002 »

Moin Otto,

was muss ich tun, wenn ich dieses System so bei mir einsetzen wollen würde?

Ist das was Fertiges oder muss ich mir das dann selber basteln?
Grüße von Philipp
Benutzeravatar
azzo
1000 working lines a day
1000 working lines a day
Beiträge: 802
Registriert: So, 28. Mär 2010 19:21
Hat sich bedankt: 11 Mal
Danksagung erhalten: 22 Mal

Re: HTML/JS/PHP Tool für die Dokumentation

Beitrag von azzo »

Armin, danke.
Ich habe die Anleitung aus meiner Desktop-Version teilweise übernommen, und dort habe ich RTF mit dem Editor verwendet. TinyMCE arbeitet mit HTML. Ich setze nur die freie Version ein, die ich auf meinem eigenen Server hosten kann.
Von der Funktionalität her hinke ich noch ein Stück hinter der Desktop-Version her.
LG
Otto

Bild

Bild
Benutzeravatar
azzo
1000 working lines a day
1000 working lines a day
Beiträge: 802
Registriert: So, 28. Mär 2010 19:21
Hat sich bedankt: 11 Mal
Danksagung erhalten: 22 Mal

Re: HTML/JS/PHP Tool für die Dokumentation

Beitrag von azzo »

Philipp, ich entwickle das Tool parallel zur laufenden Programmierung. Wie ich geschrieben habe, ist es mit HTML/JS/PHP und TinyMCE noch mit mod_harbour. Bin aber dabei, hier alles auf PHP umzustellen. Kennst du dich mit HTML/JS/PHP etwas aus? Ich könnte dir dann den Source geben. Hast du einen Server, auf dem du es installieren kannst?

LG
Otto
sammler0002
UDF-Programmierer
UDF-Programmierer
Beiträge: 73
Registriert: Mi, 23. Dez 2015 22:46
Hat sich bedankt: 26 Mal
Danksagung erhalten: 13 Mal

Re: HTML/JS/PHP Tool für die Dokumentation

Beitrag von sammler0002 »

Ja, wäre mal ganz spannend, sich das anzuschauen.
HTML/JS/PHP sind mir nicht ganz fremd 👌

Allerdings bin ich bei harbour raus.. Lohnt sich das warten, bis Du es auf rein php umgestellt hast? Oder läuft es auch ohne die harbour Geschichten?
Grüße von Philipp
Benutzeravatar
azzo
1000 working lines a day
1000 working lines a day
Beiträge: 802
Registriert: So, 28. Mär 2010 19:21
Hat sich bedankt: 11 Mal
Danksagung erhalten: 22 Mal

Re: HTML/JS/PHP Tool für die Dokumentation

Beitrag von azzo »

Hallo Philipp,
ich habe gerade schon einen Teil übersetzt. Ich denke, ich kann es diese Woche erledigen.

LG
Otto
Antworten

Zurück zu „HTML“