Verbesserung Dokumentation/Wiki (WAS: Make...)

[wp_xyz]

Sicher nicht - solange bei den Core-Entwicklern eine solche Stimmung vorherrscht. Ich bin einmal mit einem Versuch (LazInfos vorgeprescht und habe entsprechend Erfahrungen gemacht), Seither ist mir das ganze auch Sche..egal. Ich habe auch den ganzen Weg wie die Dokumentation kompiliert wird nachvollzogen und war in der Lage die originale Doku erfolgreich zu kompilieren. Auch wie in Lazarus die doku gebildet wird habe ich nachvollzogen. Wie es darum gegangen ist, Beispiele aus der offizielle Doku zu versuche zu kompilieren und festgestellt habe das etliche Beispiele gar nicht funktionieren, bin ich recht rüde Abgespeist worden, das das "per Design" so ist (das die nicht funktionieren, weil die wichtige Hälfte fehlt) und das man sich gefälligst alle Beispiel Sourcen aus einem eigene Git holen soll.

Nö ich habe mittlerweile damit abgeschlossen. Und solange sich dort in den Köpfen nicht ändert wird es auch so bleiben. Mehr als 10 Jahre vergebliches bohren sind genug.

Klingt ja ziemlich frustiert. Kannst du auf den Bugtracker-Eintrag verweisen, in dem du die Kompilierungsfehler gemeldet hast?

[af0815]

https://forum.lazarus.freepascal.org/in ... 68508.html
besonders die Aussage

The samples contained in the documentation are not necessarily meant to be completely usable or even compileable. They simply illustrate the principles of what is documented.

Das war nur der letzte Tropfen der bei mir das Fass zum überlaufen gebracht hat. Da habe ich auf einen Eintrag im Bugtracker verzichtet.

[wp_xyz]

Naja, da kommt es natürlich auf den Zusammenhang an. Aber prinzipiell finde ich PascalDragon's Ansicht nicht falsch: Ich selbst schreibe in einem Forums- oder wiki-Beitrag oft nur das Wesentliche einer Prozedur. Um das kompilierbar zu haben, braucht man in der Regel noch viel Drumherum, und es liegt am Autor der Zeilen, ob er dem Leser zumuten kann, sich dieses selbst zu rekonstruieren. Andernfalls wäre das Wesentliche aber oft nicht zu erkennen.

Klar, aber wenn natürlich "program xyz" in der ersten Zeile steht und ein "end." mit Punkt am Ende, und nirgendwo Auslassungspünktchen vorhanden sind, dann suggeriert das vollständigen Code, also dass man diesen Text 1:1 in die IDE kopieren kann und so ein lauffähiges Programm erhält. Da gebe ich dir mit deiner Entrüstung recht.

Für ein ähnliches Beispiel wie von dir in dem zitierten Beitrag angesprochen habe ich mal einen Bug-Report erstellt (https://gitlab.com/freepascal.org/fpc/s ... sues/40554). Mal sehen, was passiert...

[EDIT]
Michael hat geantwortet. Hast Recht, nix zu machen...

[af0815]

Ja, MvC und andere haben mich durch Jahre dazu bewogen keine Energie mehr in Dokumentation zu stecken.

[hum4n0id3]

Ich habe gerade ein Buch über Lazarus bei mir auf der Festplatte gefunden,

LazInfos
Das Lazarus Beispielbuch
Andreas Frieß
Die Community von www.lazarusforum.de
7. Januar 2010

Weiter steht drin,

Copyright (C) 2007 Andreas Frieß. Es wird die Erlaubnis gewährt, dieses Dokument
zu kopieren, zu verteilen und/oder zu modifizieren, unter den Bestimmungen
der GNU Free Documentation License, Version 1.2 oder jede spätere Version, veröffentlicht
von der Free Software Foundation; mit keinen unveränderlichen Abschnitten,
keinen vorderen Umschlagtexten und keinen hinteren Umschlagtexten. Eine
Kopie der Lizenz ist aufgenommen in den Abschnitt mit dem Titel "GNU Free Documentation
License".
Copyright
c 2007 Andreas Friess Permission is granted to copy, distribute and/or
modify this document under the terms of the GNU Free Documentation License,
Version 1.2 or any later version published by the Free Software Foundation; with no
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the
license is included in the section entitled “GNU Free Documentation License”.

Keine Ahnung wo ich es her habe, vielleicht auch aus dem Forum. Mir kam jedenfalls die Idee, es auf eine ähnliche Weise zu veröffentlichen wie, https://python-gtk-3-tutorial.readthedo ... index.html. Das Buch könnte dann über GitHub/GitLab der Community zur Verfügung gestellt und gewartet werden. Es ist schon viel beschrieben, nur eben alt. Man müsste es aktualisieren.

[fliegermichl]

Schau mal in die Signatur von af0815

[charlytango]

Man müsste es aktualisieren.

Es ist die alte Frage nach den verfügbaren Ressourcen.

Wer ist für dich "man" ?

[hum4n0id3]

Schau mal in die Signatur von af0815

Und wieder etwas geklärt

LazInfos sagte mir was, aber nicht genau was. Ich lese mir ja nicht immer und überall Fußnoten durch. Irgendwann habe ich es wohl bei af0815 getan und das Buch gefunden. Ich kann mich aber beim besten Willen nicht mehr daran erinnern wann das geschah.

Ich habe gestern nur meine digitale Bibliothek zu einem anderem Thema durchforsten und da ist es mir aufgefallen.

[Niesi]

Interessant ist auch dieses "Lazarus Buch":

https://unterrichten.zum.de/wiki/Lazarus

Und ganz unten wird doch tatsächlich auch auf das Buch von Andreas verwiesen ...

[hum4n0id3]

Man müsste es aktualisieren.

Es ist die alte Frage nach den verfügbaren Ressourcen.

Wer ist für dich "man" ?

Du zum Beispiel, weil du dich gerade freiwillig gemeldet hast
Du hast in einigen Threads etwas abfällig über Lazarus gesprochen, nun tue Buße und bearbeite das Buch

Aber Ernsthaft, das Buch ist von 2007-2010 und heute gibt es viele neue Möglichkeiten wie man so ein Buch aufziehen könnte. Ich habe mir zunächst so vorgestellt:

Am besten mit der Erlaubnis von af0815 (ist ja sein Buch) das Buch in Text auf ein GitHub/GitLab (gibt es ein deutsches-lazarusforum git account?) hochladen. Damit kann jeder Freiwilliger, also "man", sich das Buch holen, einen Teil bearbeiten und als Pull-Request wieder ins Projekt geben. Jeder der will kann etwas beitragen, viel oder wenig. Da das Buch alt ist, müsste man zunächst die Texte aktualisieren, sowie die Bilder. Als Referenz gilt zum Beispiel Lazarus 3.0.0, das es wohl bald rauskommen soll. Somit gibt es nicht einen Autor, sondern (im Idealfall) viele Autoren.

Nächster Schritt wäre so einen Dienst wie ReadTheDocs zu nutzen das Anhand der GitHub/GitLab Repository ein Online-Buch erstellt. Das wiederum kann man den Leuten auf entsprechenden Seiten anbieten.

So mein Gedanke.

[hum4n0id3]

Interessant ist auch dieses "Lazarus Buch":

https://unterrichten.zum.de/wiki/Lazarus

Und ganz unten wird doch tatsächlich auch auf das Buch von Andreas verwiesen ...

Na also

[wp_xyz]

Am besten mit der Erlaubnis von af0815 (ist ja sein Buch) das Buch in Text auf ein GitHub/GitLab (gibt es ein deutsches-lazarusforum git account?) hochladen. Damit kann jeder Freiwilliger, also "man", sich das Buch holen, einen Teil bearbeiten und als Pull-Request wieder ins Projekt geben.

Bin immer noch nicht 100% sicher mit git, aber ich gehe davon aus, dass es jemanden geben muss, der den Pull-Request prüft und ins Repository übernimmt. Damit sind wir schon wieder bei dem Punkt, dass jemand für das Repo Verantwortung übernehmen muss. Ja, die Sache mit "man" ist sehr verflixt...

[hum4n0id3]

Bin immer noch nicht 100% sicher mit git, aber ich gehe davon aus, dass es jemanden geben muss, der den Pull-Request prüft und ins Repository übernimmt.

Man kann damit dann prima Üben

Damit sind wir schon wieder bei dem Punkt, dass jemand für das Repo Verantwortung übernehmen muss. Ja, die Sache mit "man" ist sehr verflixt...

Es ist gerade mal ein halber Tag vergangen, wo ich diese Idee äußerte. Zur Not müssen alle Mitglieder von Lazarusforum EV aus einem Ihnen vorgelegten Streichhälzern ziehen und das kürzeste Streichholz gewinnt

Vielleicht muss man erst festlegen was man alles Verantworten soll. Zum Beispiel einmal im Monat nach den Pull-Requests schauen. Ja das ist echt schwierig, wp_xyz.

[af0815]

Na, hat mich wer gefunden

[hum4n0id3]

Ich habe gestern auf GitLab einen Test gemacht und ein Repository mit Texten aus LazInfos gemacht. Da ich GitHub nutze musste ich mich erstmal zurecht finden und dabei vielleicht etwas interessantes gefunden. Für die jenigen die sich nicht mit Git auskennen und Probleme befürchten, bietet GitLab einen internen Webeditor (erinnert sehr Stark an VS Code, ist es vielleicht auch) wo man die Texte direkt Online bearbeiten kann. Statt Speichern wird direkt ins Repository geschrieben. Man braucht also nichts unbedingt was auf dem Host extra laufen.

Ich habe meine Idee inzwischen etwas ausgeweitet. Man könnte ein Lazarusforum-EV Git-Account (zb auf GitLab) anlegen und drauf dann diese Projekte LazInfos, Dokus, Arbeitshefte usw. darauf legen. Jeder könnte sich sein gewünschtes Projekt forken und anschließend Pull-Requests zurück schicken. Somit hätten die einzelnen Projekte nicht den Anschein einer "Ein-Mann-Show".

@af0815: Ich wußte nur noch das ich den Begriff LazInfos schon von irgendwoher kannte. Nicht böse sein wenn ich nicht sofort an dich dachte. Jetzt weiß ich ja wer der Autor ist