Lazarus Dokumentation

[af0815]

(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" ).

Eistee ist auch im Kühlschrank SCNR

Die Tools sind da, nur keiner der sie nutzt bzw. die notwendigen Änderungen macht.

[Socke]

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.)

Ich hatte mich in den letzten Tagen mit Semantic Wiki beschäftigt. Damit ließe sich die bisherige FPDoc-Dokumentation in ein semantisches Wiki überführen. Damit könnte man (theoretisch) alles im Wiki erledigen. Die Lernkurve ist jedoch sehr steil und bedarf aufwändiger Einarbeitung. Ich denke mittlerweile, dass das Wiki nicht besser dazu geeignet ist die RTL-/FCL-/LCL-Dokumentation zu beherbergen. FPDoc ist wesentlich schneller zu erlernen.

Bezüglich der Vereinheitlichung würde ich mir ein kleines Beispiel wünschen, wie diese aussehen könnte. Bitte diskutiert alle mit, wie eine solche Struktur aussehen könnte! Eine Verknüpfung zwischen Wiki und FPDoc-Hilfen ist mit relativ geringem Aufwand machbar und in der Richtung von Wiki nach FPDoc durchaus üblich (aber ausbaufähig).

[af0815]

Bezüglich der Vereinheitlichung würde ich mir ein kleines Beispiel wünschen, wie diese aussehen könnte. Bitte diskutiert alle mit, wie eine solche Struktur aussehen könnte! Eine Verknüpfung zwischen Wiki und FPDoc-Hilfen ist mit relativ geringem Aufwand machbar und in der Richtung von Wiki nach FPDoc durchaus üblich (aber ausbaufähig).

Bitte einen eigenen Thread aufmachen, der hier wird schon etwas länger

Ich glaube auch, das die prinzipielle Diskussion auf der Mailling Liste mehr Sinn macht oder nicht ? Ich sehe hier ein paar Strömungen, einmal Freepascal und einmal Lazarus. Bei einer Diskussion, sollte man zuerst mal diese Them klären, ich bin hier für Lazarus, den die fpc Seite hat ja bereits einen Toolschain (egal wie einfach oder komplex der ist) nicht wirklich aber Lazarus. Dort ist immer/meistens der Verweis auf die Wiki. Oder ?

[marcov]

Ich glaube auch, das die prinzipielle Diskussion auf der Mailling Liste mehr Sinn macht oder nicht ? Ich sehe hier ein paar Strömungen, einmal Freepascal und einmal Lazarus. Bei einer Diskussion, sollte man zuerst mal diese Them klären, ich bin hier für Lazarus, den die fpc Seite hat ja bereits einen Toolschain (egal wie einfach oder komplex der ist) nicht wirklich aber Lazarus. Dort ist immer/meistens der Verweis auf die Wiki. Oder ?

Falsch. Lazarus ist meistens auch fpdoc. Die lazutils.chm und LCL.CHM ist fpdoc und enthalten über 22000 Lemma (die meisten sind noch Leer).

Nur die IDE Hilfe ist in der Wiki, und ich nehme an das sind das was, hundert oder so (aber Lange) Lemma sind?

[af0815]

Falsch. Lazarus ist meistens auch fpdoc. Die lazutils.chm und LCL.CHM ist fpdoc und enthalten über 22000 Lemma (die meisten sind noch Leer).

Nur die IDE Hilfe ist in der Wiki, und ich nehme an das sind das was, hundert oder so (aber Lange) Lemma sind?

Ich kenne folgende Hilfe in chm lokal (zum Downloaden von http://www.stack.nl/~marcov/doc-chm.zip oder http://sourceforge.net/projects/freepascal/files/Documentation/2.6.4/ für die fpdoc.chm, rtl.chm, fcl.chm, prog.chm, ref.chm, user.chm)
fcl.chm
fpdoc.chm
prog.chm
ref.chm
rtl.chm
user.chm
lcl.chm kann über die Lazarusinstallation erzeugt werden

Hilfe im html Format lokal
lcl (lazarus\docs\html\lcl) kann über die Lazarusinstallation erzeugt werden
user (lazarus\docs\html\user) kann über die Lazarusinstallation erzeugt werden

[marcov]

Ich kenne folgende Hilfe in chm lokal (zum Downloaden von http://www.stack.nl/~marcov/doc-chm.zip oder http://sourceforge.net/projects/freepascal/files/Documentation/2.6.4/ für die fpdoc.chm, rtl.chm, fcl.chm, prog.chm, ref.chm, user.chm)

Frueher war in doc-chm auch lazutils/lcl da. Das Archive fuer 1.2 ist noch stets da: ttp://www.stack.nl/~marcov/doc-chm_with_lcl12.zip

lcl.chm kann über die Lazarusinstallation erzeugt werden

Lazutils.chm auch.

Hilfe im html Format lokal
lcl (lazarus\docs\html\lcl) kann über die Lazarusinstallation erzeugt werden

user (lazarus\docs\html\user) kann über die Lazarusinstallation erzeugt werden

Den habe ich nicht. Merkwürdig auch, weil die FPC user manual Quellen in fpcdoc repo sind. (und in Latex). Vielleicht war lazutils gemeint?

Aber html als hilfe ist in sofern ich weiß nutzlos. Es ist ja keine Hilfe, nur Dokumentation die viel Platz benutzt, und langsam installiert oder rund zu kopieren ist. CHM ist generell besser, und vom IDE unterstützt, und weil html basiert mit fast dieselbe Möglichkeiten.

[mschnell]

LCL.CHM ist fpdoc und enthalten über 22000 Lemma (die meisten sind noch Leer).?

Das ist dann ja wirklich sehr hilfreich

(Genau deswegen diskutieren wir ja darüber, Wiki als Help Authoring Tool zu verwenden.)

-Michael

[marcov]

LCL.CHM ist fpdoc und enthalten über 22000 Lemma (die meisten sind noch Leer).?

Das ist dann ja wirklich sehr hilfreich

(Die eingefuelte Lemma sind noch immer mehr lemma als in wiki drin sein fuer IDE Hilfe)

(Genau deswegen diskutieren wir ja darüber, Wiki als Help Authoring Tool zu verwenden.)

Genau deswegen lehne ich das ab

[af0815]

Ich sehe bei der Dokumentation die verschiedenst Wege, aber nirgends eine Beschreibung, welche Dokumentation, wo und wie zu erstellen ist. Keine Beschreibung von EVA, nichts wirklich.

Dafür bekommt man bei einer neuen Installation von Lazarus Hilfedateien die vor 3 1/2 Jahren erstellt wurden. Heute ausprobiert (lazarus-1.2.6-fpc-2.6.4-win32.exe) unter Windows auf einen neuen PC ! Wenn man die Dateien von Sourceforge herunterladet, so sind die nur 1 1/2 Jahre alt . Gehe ich aber auf die FPC Seite vom 2.6.4 so sind die Dateien nur 11 Monate alt.

Langsam wird das ganze konfus für mich.

[creed steiger]

Paketierungs Problem .... ist halt eine Wissenschaft für sich.

[af0815]

Paketierungs Problem .... ist halt eine Wissenschaft für sich.

Leider bei der Hilfe noch das kleinste

[marcov]

Mattias hat auf mein Bericht in der Lazarus Maillist d.d. 2013-11-09 das ich neue lcl/lazutils chms regeneriert habe reagiert. (auch auf 2013-11-09).

FPC 2.6.4 CHMs können einfach aus der FPC 2.6.4 Distribution bezogen werden. Auch durch Packager.

Übrigens mit bezug zum doc/html (und nicht doc/chm) im Readmechm.txt:

Es gibt mehrere Versuche ein Script/Programm zu machen um CHM her zu stellen. Vielleicht habe die unterschiedliche Programme unterschiedliche Ziel Pfade.
ich nutze docs/html/build_chm_lcl.sh und der hat as Ziel Pfad docs/html/<module>/<module>.chm mit <module>=lcl oder lazutils

Habe den LPR nicht am laufen bekommen, aber auch nicht hart versucht, weill ich Typisch auf dem CHM Buildmachine keiner Kompletter Lazarus habe.

Der IDE durchsucht docs/html und das funzt. Dieser Pfad war ein Tip von Lazarus Core Leute. (glaube Marc, Vincent oder Mattias)

Niemals doc/chm benutzt. Das immer für ein potentielles Ausgebe Pfad von eine der andere Skripts gehalten, aber wusste/weiß nicht ob es je funktioniert hat.

Und ja, ich bin mich davon bewusst das das Ausgabe Pfad von das .sh Skript (docs/html/<modul>/<modul>.chm) nicht gleich is am Such Pfad (docs/html/<modul>.chm)

[af0815]

Habe den LPR nicht am laufen bekommen, aber auch nicht hart versucht, weill ich Typisch auf dem CHM Buildmachine keiner Kompletter Lazarus habe.

Unter Windows läuft das build_lcl_docs.lpr und erzeugt die lcl ohne Probleme. Die lcl.chm wird dann unter docs/html/lcl abgelegt.

Danke für deine Hilfe Marco, ich beginne jetzt ganz langsam die Dinge zu verstehen.

[marcov]

Danke für deine Hilfe Marco, ich beginne jetzt ganz langsam die Dinge zu verstehen.

Sorge auch dass FPDOC die .XCT's von FPC finden kann. Das sorgt dafür das LCL->RTL oder FCL Links funktionieren

[af0815]

Sorge auch dass FPDOC die .XCT's von FPC finden kann. Das sorgt dafür das LCL->RTL oder FCL Links funktionieren

Soweit bin ich noch nicht. Ich habe noch nicht herausgefunden, wie die Verlinkungen funktionieren. Ich aktuell froh, das das wikiget funktioniert und das ich mit wikiconvert eine Seite (Ohne navigation derzeit) erstellen kann.

Was ich nicht richtig zusammengebracht habe, ist die Seiten in der Wiki umzubenennen. Es geht, die alten Seiten bleibt aber als Weiterleitung über. Da weis ich noch nicht, wie man das richtig hinbekommt.
Eine Seite zu erstellen, mit Inhalt zu füllen, die richtigen Templates zu nehmen und mehrsprachig zu machen ist kein Problem.