LAZ-Hilfesystem

[Frank Ranis]

Hallo ,

ich versuche mich schon einige Zeit darann , das Hilfesystem von Lazarus zu verstehen , aber so richtig gelingt mir das nicht.

Super ist ja das Einblenden von Hilfetexten im Objektinspektor , oder der Hint , wenn man im Quelltext auf ein Element geht .
Hier dann mit der Maus auf einen LINK gehen und schon ist man in der passenden Unit oder findet eine Hilfeseite per 'Hilfewähler' nach LHelp.

Könnte man Lazarus nicht so umbasteln , das wenn

1) ich in die Infobox des Objektinspektors gehe , mit der rechten Maustaste das Popup aufmache , einen neuen Eintrag bekomme , der mir die Möglichkeit gibt , diesen Hilfetext zu bearbeiten.
Also , es soll ein Editor aufmachen , der mir die Quellen dieser Infobox anzeigt , damit ich was änderm oder erweitern kann.
Ich denke mal das diese Infos in XML-Dateien stehen , die LAZ verwendet um was zu finden, aber so ganz habe ich das noch nicht verstanden.

2) das gleiche Spiel mit dem Hintfenster im Quelltexteditor , einen Popupeintrag , der mir das Editieren der HINT-Quelle ermöglicht.

3) Dann zum LHelp .
Auch hier wäre es sensationell , wenn man mit der rechten Maustaste einen Popup-Eintrag hätte , um die angezeigte HTML-Seite mit einem Editor zu öffnen und bearbeiten zu können.
Und dann noch ein Button in LHelp für das neu kompilieren der CHM-Seiten erledigt.

Dann sollten alle geänderten Dateien auch als Kopie in einem separaten Odner gesammelt werden , damit man sie irgendwo irgenwie auch der Öffentlichkeit zugänglich machen kann .
Wohin müßte man so etwas überhaupt schicken , und wer prüft das dann u.u.u. .

Ich denke mal , das viele LAZ-NormalUser solche neuen Funktionen auch nutzen würden um die Hilfe zu erweitern.
Mit den derzeitigen Programmen wie FPDoc-Editor oder auch LazDe komme ich nicht so recht klar und das geht wohl vielen so , sonst wäre die Hilfe sicherlich schon weiter.
Für mich ist das alles sehr undurchsichtig .

Gruß

Frank

[marcov]

Einiges um sich zu überlegen

1. Der HTML innerhalb der LCL wird normalerweise generiert. Also die editieren ist zwecklos, man muss die originelle fpdoc XML Dateien editieren.
2. Kompilieren der lcl.chm kostet einige Minuten.
3. kompilation passiert direct von XML +sources innerhalb fpdoc. Es gibt also kein Project um ein entpackte CHM wieder zu packen. CHM ist nicht ZIP, und NICHT ganz bidirektional( also, ein entpack-pack cyclus gibt nicht dieselbe Datei)
4. Es sind etwa 19000 Dateien innerhalb lcl.chm.

Also das ist alles nicht sehr praktisch.

[Frank Ranis]

Hallo marcov,

vielen Dank für deine Antwort.

>>>>
1. Der HTML innerhalb der LCL wird normalerweise generiert. Also die editieren ist zwecklos, man muss die originelle fpdoc XML Dateien editieren.
3. kompilation passiert direct von XML +sources innerhalb fpdoc. Es gibt also kein Project um ein entpackte CHM wieder zu packen. CHM ist nicht ZIP, und ganz bidirektional.
<<<<

So weit , wie ich das bis jetzt verstanden habe.
Also mit fpdoc soll ich eine vorhandene XML bearbeiten können .
Diese wird dann in eine HTML-Seite umgewandelt und zum Schluß werden dann alle vorhandenen HTML-Seiten zu einer CHM compiliert , damit alles schön Kompackt in einer Datei vorhanden ist.

Mit ist es bis dato aber noch nicht gelungen , auch nur die kleinste Information im fpdoc angezeigt zu bekommen .
Nach der Anleitung 'FPDoc Editor/de' aus dem Wiki haut das bei mir nicht hin.
Ich habe fpdoc (LAZ-Menü / Ansicht / FPDoc-Editor) geöffnet , dort sind die Buttons (XML öffnen , Speichern ) disabled , so das man keine Chance hat , eine XML-Datei zu öffnen.

Bin nach folgender Anleitung vorgegangen , aber es rührt sich im FPDoc rein gar nichts:
>>>>
Benutzung des FPDoc Editors
Die Verwendung von FPDoc ist sehr einfach.
1. Öffnen Sie den FPDoc Editor. Sie können ihn im Menü "Ansicht" finden.
2. Setzen und bewegen Sie den Cursor. Nachdem der Cursor im Quelltext-Editor platziert wurde, werden Sie bemerken, dass sich die Beschriftung des Formulars FPDoc ändert. Die Beschriftung zeigt das ausgewählte Quellelement und den Dateinamen der Dokumentationsdatei. Durch Auswahl der geeigneten Seite in FPDoc können Sie ein spezifisches Dokumentations-Tag bearbeiten. Natürlich ist es auch möglich, FPDoc nur als Betrachter zu nutzen.
3. Klicken Sie auf die Schaltfläche 'Hilfe erzeugen'. Falls Sie die FPDoc-Suchpfade noch nicht eingerichtet haben, wird die IDE Sie fragen, wo die FPDoc-Dateien gespeichrt werden sollen. Für Projekte werden Sie normalerweise ein Unterverzeichnis 'docs' nehmen.
4. Schreiben Sie eine kurze Beschreibung.
5. Klicken Sie auf den Speichern-Knopf links oder gehen Sie zum nächsten Element (Der Editor speichert automatisch, wenn sie das Element verlassen).
<<<<

Für mich ist der FPDoc-Editor damit unbrauchbar, weil ich kann nichts editieren , er funktioniert bei mir nicht .

>>>>
4. Es sind etwa 19000 Dateien innerhalb lcl.chm.
2. Kompilieren der lcl.chm kostet einige Minuten.
<<<<

Ok , die CHM-Datei zu erzeugen ist ja der letzte Schritt in der Kette und wenn das mehrere Minuten dauert , dann ist das halt so .

Noch mal zu dem Wunsch mit dem Bearbeitungs-Button in der Infobox des Objektinspektors und bei den Hint-Fenstern im Quelltexteditor.
Das könnte man doch auf die XML-Datei anwenden , oder nicht ?
Ich gehe in die Infobox , klicke rechts , dann auf Bearbeiten und es macht ein Editor auf , der mir die Infos aus der aktuellen XML-Datei für den gerade gwählten Knoten anzeigt.
Dann editieren und speichern .
Damit wäre ja dann schon mal das XML geändert und auf der Platte .
Und beim nächsten Besuch in der Infobox ständen dort die geänderten Informationen .
Eine Kopie dieser XML-Datei in einen separaten Ordner , den man dann veröffentlichen kann.

Ein schickes Plus wäre noch , wenn man in die XML-Datei noch Bilder einpflegen könnte, oder geht das schon ?

Gruß

Frank

[marcov]

So weit , wie ich das bis jetzt verstanden habe.
Also mit fpdoc soll ich eine vorhandene XML bearbeiten können .
Diese wird dann in eine HTML-Seite umgewandelt und zum Schluß werden dann alle vorhandenen HTML-Seiten zu einer CHM compiliert , damit alles schön Kompackt in einer Datei vorhanden ist.

Aber das gilt auch für eine neue Dokumentationsystem basiert auf neue Prinzipien. Nichts ist in einmal gut, und das System das durch dich beschrieben wird, ist komplizierter als das Heutige, also
der Implementation wird schwieriger, länger dauern usw. Es ist nicht nur Prinzipien aber auch tatsächliche Implementation

Ich nutze fpdoc Editor nicht, editieren die XML direkt.

Für mich ist der FPDoc-Editor damit unbrauchbar, weil ich kann nichts editieren , er funktioniert bei mir nicht .

Vielleicht, keine Ahnung. Aber ich sehe nicht warum bei jeder Detail Fehler im Dokumenten System das immer Radikal anders sein muss.. Mit etwas neues macht man zuerst eine Menge schritte zurück, und meistens werden
die Versprochene Verbesserungen nicht einmal realisiert bevor man wieder etwas anderes versucht.

Wenn es nicht funktioniert, repariere es, oder zahle jemand es zu reparieren.

Ok , die CHM-Datei zu erzeugen ist ja der letzte Schritt in der Kette und wenn das mehrere Minuten dauert , dann ist das halt so .

(6-8 Minuten single threaded, etwa 1:50 auf ein i7 in 4 fach threaded Modus (nicht default)).