Lazarus Dokumentation

[mschnell]

Ich würde schon glücklich als die Hilfe etwas komplett wäre, für eine gewisse Basissatz Klassen, und die Sprache.

Wie gesagt. Ich hab's versucht und Texte geschrieben und bin dann gescheitert, als ich mein "Werk" im Zusammenhang (also mit "F1") anschauen wollten bevor, ich es jemandem anderen zeigen muss. (Auf eine andere Arbeitsweise habe ich keine Lust.) Deshalb habe ich den Text "nackt" in der Mailiungliste veröffentlicht und da ist er anscheinend untergegangen.

-Michael

[af0815]

Ich glaube, wir haben des Pudels Kern in der Diskussion erreicht.

Das Hilfesystem das unbekannte Wesen.

Die letzten 10 Einträge zeigen genauer, woran es liegt. Das System ist einfach zu unbekannt, zumindest im deutschspachigen Forum/Bereich.

[af0815]

Ich würde schon glücklich als die Hilfe etwas komplett wäre, für eine gewisse Basissatz Klassen, und die Sprache.

Hast du Beispiele dafür ? Nur damit ich den Satz auch wirklich begreifen kann.

[marcov]

Ich würde schon glücklich als die Hilfe etwas komplett wäre, für eine gewisse Basissatz Klassen, und die Sprache.

Hast du Beispiele dafür ? Nur damit ich den Satz auch wirklich begreifen kann.

War meistens die Komplett sein von LCL Dokumentation gemeint, viel sind da nur Einzeiliger Stubs. Auch muss noch sehr viel von FPC 3.0.x Dokumentiert werden

[marcov]

Ich glaube, wir haben des Pudels Kern in der Diskussion erreicht.

Das Hilfesystem das unbekannte Wesen.

Die letzten 10 Einträge zeigen genauer, woran es liegt. Das System ist einfach zu unbekannt, zumindest im deutschspachigen Forum/Bereich.

Ich denke die Beitrage von Michael Schnell können einfach als "Kann nicht und will nicht" charakterisiert werden. Und, ärger, er hat schon mehrere Malen sich an solche Diskussionen beteiligt, also er sollte besser wissen

[af0815]

Ich denke die Beitrage von Michael Schnell können einfach als "Kann nicht und will nicht" charakterisiert werden. Und, ärger, er hat schon mehrere Malen sich an solche Diskussionen beteiligt, also er sollte besser wissen

Das ist für die Sache nicht relevant. Ich habe jetzt gelernt, das sich auch in der Hilfe sehr viel bewegt hat, nur das das ganze scheinbar Top Secret ist. Mein Eindruck bisher war, das die Hilfe nicht wirklich existent ist. Das stimmt nicht, man muss sie nur finden und das ist meiner Meinung nach das Problem.

Ich versuche mal für mich, mich noch weiter damit zu beschäftigen und auch zu verstehen.

[mschnell]

Das Hilfesystem das unbekannte Wesen. :

Was meinst Du mit "Hilfesystem" ? Das System zum Anzeigen oder das Authoring-System zum Editieren und Bauen der anzuzeigenden Dateien. Beides ist bezüglich der "F1" Hilfe komplex genug. Wenn dann noch die davon völlig getrennten aber für den User genauso notwendigen hilfreichen Wiki-Seiten dazugenommen werden wird das noch unübersichtlicher.

-Michael

[mschnell]

nur das das ganze scheinbar Top Secret ist

Ich habe - wie gesagt - von ca. 2 Jahren wirklich intensiv versucht, zur fpc-RTL Hilfe beizutragen und in der Englischen Mailing Liste nach Hilfestellung gesucht und von Graeme auch diverse Tips bekommen. Hat leider im Endeffekt (mit für einen "Volontär" vertretbarem Aufwand) nicht zu einem Ergebnis oder einen gangbaren Weg, Hilfetexte zu editieren und sofort anzuzeigen, geführt.

-Michael

[af0815]

Die Sachen in der Hilfe sind wirklich TopSecret

Im Verzeichnis von Lazarus befindet sich unter components/wiki sich eine Applikationssammlung zum Downloaden und konvertieren der Freepascal Wiki. Damit ist es sehr wohl möglich die Wiki auf den lokalen Rechner herunter zu laden und in verschiedene Formate zu bringen. Die ersten Infos aus dem README.txt.

Code: Alles auswählen

BEWARE: This is all work in progress.
 
UNDER CONSTRUCTION
 
This directory contains tools to create the offline help of the wiki.
 

Header aus der Wikiget.lpr

Code: Alles auswählen

Console utility to download the Lazarus wiki.
  Maybe it also works for other MediaWikis sites.
 
  Copyright (C) 2012  Mattias Gaertner  mattias@freepascal.org
 

Die Tools funktionieren mit Einschränkungen. Beim Downloader machen die mit russischen Schriftzeichen Probleme, aber ansonsten habe ich jetzt die ganze Wiki bei mir am Rechner und kann mal die Konverter ausprobieren.
Was mir dabei klar geworden ist, das sowohl bei den Programmen eine Menge arbeit zu tun ist, als auch in der Wiki selbst. Zum Beispiel sind sehr viele Tags verwendet worden, die zwar im html Gültigkeit haben, in der Wikisprache noch keine Auswirkung haben, aber im xml das die Wiki selbst erzeugen kann, nicht erlaubt sind. Beispiel ist der Ampersand normalerweise als & a m p ; geschrieben, da der aber direkt auch funktioniert, ist er verwendet worden, aber im xml wird das als Fehler erkannt . Siehe auch making_nbsp_work_with_xml_rss_and_atom

Genauso mit den zyrillischen Seitennamen, die machen auch riesige Probleme (statt pagename/ru direkt in zyrillisch benannt).

BTW. Der Wikiscanner aus der Lazarus-ccr, den kann man nicht verwenden, der funktioniert nicht mehr, der wird auch sofort vom Schutz der Wiki geblockt.

Wenn man das probieren will und Probleme mit den russischen Seiten hat, so hilft ein kleiner Q&D Patch der wikiget.lpr
Zeile 299 von

Code: Alles auswählen

 if (Page<>'') and (not IsIgnoredPage(Page)) then begin;

in

Code: Alles auswählen

 if (Page<>'') and (not IsIgnoredPage(Page)) and (Page[1]<>'%') then begin;
 

ändern, dann werden die Seiten die ärger machen zu Testen mal ausgeklammert.

[mschnell]

Was mir dabei klar geworden ist, das sowohl bei den Programmen eine Menge arbeit zu tun ist, als auch in der Wiki selbst.

Yep !
Und wenn man dazu noch bedenkt, dass das FPC-Core-Team (ich habe nur mit denen gesprochen, das Lazarus Team sieht das anscheinend anders), einen Umstieg zu Wiki als Basis für die Hilfe ablehnt, ist eine brauchbare integrierte Hilfe (und damit eine verbesserte öffentliche Akzeptanz von Lazarus/fpc) wohl in weiter Ferne.

-Michael

[marcov]

ist eine brauchbare integrierte Hilfe (und damit eine verbesserte öffentliche Akzeptanz von Lazarus/fpc) wohl in weiter Ferne.

... deiner Meinung nach. Ich denke das die FPC Dokumentation (und Hilfe) heute besser davor steht als die Lazarus Dokumentation. Und Lazarus nutzte schon immer wiki. Das sagt genug

[af0815]

Ich sehe das nicht so.

Es gibt, so wie es aussieht, doch einige Tools die einem helfen. Was fehlt ist das Wissen wie die arbeiten. Soweit ich es bis jetzt beurteilen kann, ist es deswegen nicht wirklich vorangekommen, weil es viele, sehr viele, kleine Baustellen sind. Derjenige der das Tool geschrieben hat, ist sicher an den kleinen Problemen (sind halt nur viele!) und hat deshalb nicht weitergearbeitet, weil es ganz einfach Zeitaufwendig ist, die anderen Probleme zu lösen.
Umgekehrt ändert keiner was an der Wiki, weil es viel arbeit und auch wozu, es gibt ja eh keine Tools die vernünftig arbeiten.

Und so geht ganz einfach nichts weiter, weil es keinen gibt der dort oder dort repariert. Jammern über die Situation ist natürlich leichter und menschlicher.

Ich beschäftige mich mal mit den Tools aus dem Verzeichnis components/wiki. Das Programm wikiget läuft ja fürs erste mal, ich habe die Wiki auf meinem Rechner und jetzt teste ich mal das wikiconvert. Es kann html und chm erzeugen, das hab ich schon getestet, aber da habe ich noch viel zum begreifen.

[mschnell]

... deiner Meinung nach. ...

Ich hier wollte nicht die eine oder andre Variante (aktuelles FPDOC oder Wiki-basiert) favorisieren, sondern nur sagen, dass eine einheitliche Hilfe-Authoring Methode notwendig ist. (Sonst ist allein schon die Dokumentation des Verfahrens zum Hilfe-Authoring und die Pflege der notwendigen Tools nicht sinnvoll machbar.)

-Michael

[af0815]

pS: fpdoc geht scheinbar auch Noch nicht getestet, aber im Quellcode vorgesehen.

[mschnell]

Ich beschäftige mich mal mit den Tools aus dem Verzeichnis components/wiki.

Das ist natürlich absolut lobenswert. Leider ist das eine Sackgasse solange nicht Einigkeit darüber besteht, dass sowohl Lazarus als auch FPC Wiki als Basis der Hilfe verwenden wollen

Ich sage da immer: "Man sollte sich entscheiden ob man Tee oder Bier trinken will, bevor man das Wasser aufsetzt oder den Kühlschrank öffnet" .

Und so geht ganz einfach nichts weiter, weil es keinen gibt der dort oder dort repariert. Jammern über die Situation ist natürlich leichter und menschlicher.

Eben darum

-Michael