Lazarus Dokumentation

[mschnell]

Für den Anwender ist das zumutbar

Nur dass es keine "Anwender" gibt. Wer das tut, macht es aus reinem Alutrismus. Ihm selber nützt es überhaupt nichts. So jemandem ist das nicht zuzumuten.

(Im Gegegsatz dazu kommen Beiträge zu Open Source Software projekten immer von Leuten, die das, was sie da schreiben selber tatsächlich brauchen und sich nur die zusätzliche Mühe machen, es zu zu veröffentlichen.)

-Michael

[Socke]

Ist sie auch. Es gibt nur ein paar Bedingungen und muss sich etwas Mühe geben. Man konnte in einer Mittag ein Linux VM (oder ein RPI) aufsetzen die Docs baut und zu einen Webserver hoch ladet. Ist in Vergangenheit auch schon getan. (zb Lazarus-CCR, vielleicht noch immer).

Wo findet man denn derzeit welche Versionen der Dokumentation?

• http://lazarus-ccr.sourceforge.net/docs/
  Enthält RTL, FCL und LCL Dokumentation. Keine Angabe über den Stand; der Webserver sagt Januar 2012.
• http://lazarus-ccr.sourceforge.net/fpcdoc/
  Enthält Dokumentation wie 3. Die FCL-Dokumentaiton ist dort ebenfalls vorhanden, aber nicht verlinkt. Compiler-Dokumentation ist auf dem Stand von August 2008/Version 2.2
• http://www.freepascal.org/docs.var
  Offizielle Dokumentation; enthält RTL und FCL. Compiler-Dokumentation ist auf dem Stand von März 2014/2.6

Ich gehe davon aus, dass Punkt 3 aktuell zur stabilen FPC-Version ist und der Rest aufgegeben wurde.

[af0815]

4. Von der wiki Installing CHM help for the RTL, FCL and LCL in the Lazarus IDE wird man auf http://sourceforge.net/projects/lazarus ... p/download verwiesen. Stand lt. Angabe 15.6.2014

Hinweis dabei:

Code: Alles auswählen

These are the help files in chm format for the LCL, FCL and RTL.
The Lazarus downloads/installers already contain them.

[af0815]

Für den Anwender ist das zumutbar

Nur dass es keine "Anwender" gibt. Wer das tut, macht es aus reinem Alutrismus. Ihm selber nützt es überhaupt nichts. So jemandem ist das nicht zuzumuten.

Anwender ist hier nicht der Programmierer gemeint, sondern der Benutzer der Hilfe !!!

[mschnell]

Anwender ist hier nicht der Programmierer gemeint, sondern der Benutzer der Hilfe !!!

??? Dem wird das Generieren der Hilfe nicht zugemutet, Nach Installation von Lazarus ist sie mit "F1" einfach da. ???
-Michael

[af0815]

Anwender ist hier nicht der Programmierer gemeint, sondern der Benutzer der Hilfe !!!

??? Dem wird das Generieren der Hilfe nicht zugemutet, Nach Installation von Lazarus ist sie mit "F1" einfach da. ???
-Michael

Wirklich ?!!!

Auf einem neuen System ist nur die lcl dabei. Den Rest muss man sich erst herunterladen und richtig hinkopieren. Und es gibt die Hilfe aktuell NUR auf Englisch.

[marcov]

Solch eine Unsinn?! fpdoc wird weiterentwickelt.

OK.
Was waren die letzten Veränderungen ?

-Michael

(build prozess gerelatierten patches ignoriert)
r28598 | marco | 2014-09-05 11:48:08 +0200 (Fri, 05 Sep 2014) | 2 lines

* patch from Graeme that exists if a node is not assigned, mantis #26678

und fuer CHM:
------------------------------------------------------------------------
r28884 | marco | 2014-10-19 22:32:05 +0200 (Sun, 19 Oct 2014) | 2 lines

* fulltext search demo by Reinier Olislagers, mantis #26863

------------------------------------------------------------------------
r28718 | marco | 2014-09-27 14:21:05 +0200 (Sat, 27 Sep 2014) | 2 lines

* allow chmls extractall without second param. Patch by Reinier, mantis #26778

[marcov]

Ist sie auch. Es gibt nur ein paar Bedingungen und muss sich etwas Mühe geben. Man konnte in einer Mittag ein Linux VM (oder ein RPI) aufsetzen die Docs baut und zu einen Webserver hoch ladet. Ist in Vergangenheit auch schon getan. (zb Lazarus-CCR, vielleicht noch immer).

Wo findet man denn derzeit welche Versionen der Dokumentation?

Wie gesagt gibt es heute keine tägliche Snapshots (war mich nicht ganz sicher von -CCR), aber jede kann damit anfangen. Es benutzt keine spezielle Privilegien, wenn man es auf seine eigene Seite host. Also das ist keine fundamentale Grund warum es System nicht taugt.

Letzter FPC chms sind von 2.6.4, März 2014. Ich nehme an das Juni Archiv ist dieser built aktualisiert mit dem LCL.chm der letzter Lazarus Release.

[Socke]

Wie gesagt gibt es heute keine tägliche Snapshots (war mich nicht ganz sicher von -CCR), aber jede kann damit anfangen. Es benutzt keine spezielle Privilegien, wenn man es auf seine eigene Seite host. Also das ist keine fundamentale Grund warum es System nicht taugt.

Letzter FPC chms sind von 2.6.4, März 2014. Ich nehme an das Juni Archiv ist dieser built aktualisiert mit dem LCL.chm der letzter Lazarus Release.

Bei den CHM-Dateien finde ich es einigermaßen in Ordnung, dass auf Sourceforge die Dateien zu einer bestimmen Lazarus-Version angeboten werden. Bei den HTML-Versionen fände ich eine aktuelle, offizielle Stelle zur Veröffentlichung besser geeignet. Ansonsten gibt es nicht nur drei Versionen wie jetzt sondern viel mehr.

[af0815]

Was mir aktuell auffällt, ist das der Umgang mit den Tools fpdoc und LazDE nicht für Anwender beschrieben ist. Ich habe jetzt aktuell die Erkenntnis gewonnen, das nicht das Buildsystem eine Hürde darstellen, sondern schon der Einstieg, wie man mit den Programmen wirklich umgeht. In der Wiki sind die Sachen nicht klar beschrieben. Zumindest komme ich mit den Informationen in der Wiki noch nicht klar. Ausserdem dürften die Artikel alte vorgehensweisen beschreiben und nicht mehr an das aktuelle System fpc 2.6 und Lazarus 1.2 angepasst worden sein.

DerBereich Help und Doc in der Wiki gehört meiner Meinung nach verbessert und zumindest mal die nicht mehr aktuellen Sachen von wissenden entfernt.

Zusatzfrage lcl Dokumentation:
Gibt es ein Zenttraldokument, damit man alles der lcl Hilfe in LazDE hat (wie im lhelp) oder muss man jede xml einzeln durchforsten ?

Oder sind die Fragen schon besser im englischen Forum zu stellen ?

[Socke]

Zusatzfrage lcl Dokumentation:
Gibt es ein Zenttraldokument, damit man alles der lcl Hilfe in LazDE hat (wie im lhelp) oder muss man jede xml einzeln durchforsten ?

Edit: Es gibt einen Patch im Bug-Tracker: http://bugs.freepascal.org/view.php?id=27263
Beim Beenden wird zwar eine Liste der zuletzt verwendeten Dateien gespeichert, aber nur die zuletzt geöffnete bei einem Neustart geladen.

Ein Nachtrag zum Wiki:
In der deutschen Wikipedia gibt es jede Menge Navigationsleisten, mit denen eine einfache Verknüpfung zwischen verwandten Themen hergestellt werden kann. Ich habe einen Bug-Report eröffnet, damit ein Admin diese importieren kann.

Für weitere Strukturierung wie in Büchern kann das Addon Collections verwendet werden. Hier ist auch Ausgabe in PDF, DocBook, ePub und gedrucktes Buch möglich.
Für Übersetzungen kann das Addon Translate verwendet werden. Damit könnte man prinzipiell sogar Lazarus selbst übersetzen (siehe https://translatewiki.net).

[marcov]

Ich glaube das fpdoc seit etwa 2 Jahren auch ein Projekt Datei hat. Viel wird die noch nicht genutzt. Auch weiß ich nicht of Lazde dafür überarbeitet ist.

[marcov]

Enthält RTL, FCL und LCL Dokumentation. Keine Angabe über den Stand; der Webserver sagt Januar 2012.

Das konnte auch der Datum der statische Index Seite sein. Immerhin, irgendwo soll hier ein Datum sichtbar gemacht werden

[mschnell]

Auf einem neuen System ist nur die lcl dabei. Den Rest muss man sich erst herunterladen und richtig hinkopieren.

Ooops. Ich wusste gar nicht, dass der aktuelle Zustand der "released" Version von Lazarus so schlecht ist

-Michael

[af0815]

Auf einem neuen System ist nur die lcl dabei. Den Rest muss man sich erst herunterladen und richtig hinkopieren.

Ooops. Ich wusste gar nicht, dass der aktuelle Zustand der "released" Version von Lazarus so schlecht ist

Irgendwie logisch, der 'Rest' gehört nicht zu Lazarus sondern zum fpc. Deshalb auch mittlerweile abweichende Wege die Dokumentation zu erstellen. Die lcl erstellt sich Lazarus bei Bedarf selbst. Man sieht es insbesonders, wenn man unter Windows mit dem TortoiseSVN arbeitet, welche Dateien nicht aus dem SVN sind, sondern erst später selbst mit dem fpdoc erzeugt wurden.