Offline-Dokumentationspakete

[monta]

Die LCL-Doku besitzt ihre Originalstruktur, wie sie vom Script generiert wird. Allerdings hab ich Tipue als Frame eingebunden, was eine Offline-Dateisuche mittels Javascript in der Doku bereitstellt.
Es ist keine Volltxtsuche, sondern die Suche orientiert sich an den Dateinamen. Eine Volltextsuche würde das Javascript wohl auch deutlich überfordern. Da aber für jedes Objekt eine Datei existiert, werden auch sämtliche Eigenschaften und Co problemos gefunden.

Zum Packet:
index.html > die Originalstartdatei der Dokumentation, wie sie auch Online zu finden ist.
Frames.html > Die Offlinedoku mit Suchfunktion im rechten Frame, sollte mit allen gängigen Browsern laufen, solange Javascript aktiviert ist

Die Ordner enthalten ansonsten die Originalstruktur der Dokumentation. So kann diese auch als Offline-Doku für die LCL in Lazarus eingebunden werden und ersetzt somit den Aufruf des Browsers nach druck auf F1.

Zum Einbinden:
Menü: Hilfe > Hilfe Konfigurieren > dort auf das dritte Tab: Datenbanken (ein etwas irreführender name finde ich) anschließend Links LCLUnits auswählen und bei BaseURL den Ordner angeben, in welchem sich die index.html und die entsprechenden Unterordner befinden.

Download der Doku hier:
http://www.lazarusforum.de/downloads.ph ... il&df_id=6" onclick="window.open(this.href);return false;
http://www.lazarusforum.de/downloads.ph ... l&df_id=29" onclick="window.open(this.href);return false;
http://www.lazarusforum.de/downloads.ph ... l&df_id=30" onclick="window.open(this.href);return false;
http://www.lazarusforum.de/downloads.ph ... l&df_id=31" onclick="window.open(this.href);return false; (LCL, RTL und FCL)

[Christian]

Sprich doch mal im Chat vincent an ob sie das nicht in die installation einbinden wollen, ich würd das zugern in der 0.9.26 sehn...

[monta]

Ich glaub mal kaum, das das endlich aufgenohmen wird. Aber zumindest könnte man auch mal die Verfügbare Version im CCR aktualisieren, die ist auch schon älter.

an wenn wende ich mich da? Hast du schreibrechte, und kannst die neue Version da hinschieben, lass ich mich von Vincent als Developer eintragen, oder schick ich sie ihm einfach?

[Christian]

Ich hab nur schreibrechte im CCR SVN. Vincent hilft dir aber sicher weiter. Ich bin mir nicht so sicher das das nit aufgenommen wird. Wenn man einen Patch dafür liefert mit fertig angepassten installer scripten sollte das schon aufgenommen werden.

[monta]

in der 9.26 nicht, dafür ists zu spät und in der 9.28 meint Vincent, gibt es ggf.irgend ein chmhelp-Package, ich weiß allerdings nicht, was damit genau gemeint sein soll. Irgendwie iritiert mich CHM ein wenig.

[marcov]

in der 9.26 nicht, dafür ists zu spät und in der 9.28 meint Vincent, gibt es ggf.irgend ein chmhelp-Package, ich weiß allerdings nicht, was damit genau gemeint sein soll. Irgendwie iritiert mich CHM ein wenig.

// kohle Deutsch an.

Seit 2.2.2 gibt es ein CHM reader/writer in FPC (packages/chm), und fpdoc kann direkt (auf alle Platformen) .CHM ausspucken.

Die Lazarus chmhelp package ist ein Lazarus basierte help system, aber afaik eine selbstaendige .EXE(binary). Die Lazarus IDE kommuniciert mit dieser Helferapp ueber TCP/IP (lnet). Alles ist native und portabel, unabhangig vom Fakt dat CHM von Windows abkuenftig ist.

// kohle Deutsch aus.

[knight]

Seit 2.2.2 gibt es ein CHM reader/writer in FPC (packages/chm), und fpdoc kann direct (auf alle Platformen) .CHM ausspucken.

Es wäre natürlich schön, wenn solche Dinge auch bei der Freigabe von 2.2.2 mitgeteilt werden. Wer nicht wie Marco zum Kreise der Entwickler zählt, bekommt solche Entwicklungen im Normalfall gar nicht mit. Was ja eigentlich schade ist, da es sich meist doch um nützliche Dinge handelt.

knight

[marcov]

Es wäre natürlich schön, wenn solche Dinge auch bei der Freigabe von 2.2.2 mitgeteilt werden. Wer nicht wie Marco zum Kreise der Entwickler zählt, bekommt solche Entwicklungen im Normalfall gar nicht mit. Was ja eigentlich schade ist, da es sich meist doch um nützliche Dinge handelt.

Einige andere:
- winunits-jedi ist updated auf den Stand von Februar oder so.
- an winunits-base ist viel gearbeitet.
- Shellapi sollte komplet sein,
- ActiveX wuerde poliert, und mehr Kompatibel gemacht.
- Der Inhalt saemtlicher Windows header wuerde vom Windows unit nach den Shlobj, commdlg units kopiert
- commctrl wuerde debugged.
- wininet addiert.
- users unit jetzt auch fuer Mac OS X,FreeBSD und Linux/x86_64
- httpd* ueberarbeitet.
- Die meisten DB pakkete funktionieren jetzt auch auf OS X. (firebird doch nur 2.2.3+)

Post 2.2.2:
- libxml2 (durch Ivo)
- iconvenc (libiconv)
- clocale (oder schon in 2.2.2?)

Aber FPC/Lazarus sind natuerlich Open Source Projekte. Jeder ist verantwortlich fuer Dokumentation (Wiki!)

[monta]

@marcov Danke für die Erklärung, jetzt ist es klarer.

[af0815]

Gibt es bezüglich Dokumentation etwas neues - auch bezüglich chm ? Bzw. Einbindung in Lazarus.

Die Frage die sich mir auch stellt ist, gibt es auch (später) die Möglichkeit die Sprache der Hilfe umzustellen ? Denn bei der ganzen Durchsicht von fpdoc und den Formatdefinitionen, finde ich nirgends den Hinweis auf Mehrsprachigkeit.

Es ist insofern von belang, als das schon in der Wiki die Mehrsprachigkeit sehr angenehm ist, auch wenn noch viele Seiten rein auf Englisch sind.

[marcov]

Gibt es bezüglich Dokumentation etwas neues - auch bezüglich chm ? Bzw. Einbindung in Lazarus.

Andrew (Haines, Drewski im IRC) arbeit wieder daran. Indexing und search sind implementiert.

Ich arbeite daran um chm im Textmode IDE ein zu binden. Das Funktioniert teilweise schon. Danach werde ich versuchen auch CHMs zu generieren fuer die nicht-fpdoc Dokumentation.

Die Frage die sich mir auch stellt ist, gibt es auch (später) die Möglichkeit die Sprache der Hilfe umzustellen ? Denn bei der ganzen Durchsicht von fpdoc und den Formatdefinitionen, finde ich nirgends den Hinweis auf Mehrsprachigkeit.

Braucht man denke ich auch nicht, man soll nur die XMLs übersetzen in eine neue (de) XML Satz. Aber die Tools fehlen vielleicht noch. (zb um heraus zu finden welche Nodes im Englischen XML mutiert sind)

Ich glaube fpdoc/makeskel koennen schon noch nicht dokumentierte Nodes herausgeben, also das muss man dann nicht manuell aussuchen.

Es ist insofern von belang, als das schon in der Wiki die Mehrsprachigkeit sehr angenehm ist, auch wenn noch viele Seiten rein auf Englisch sind.

Das ist ein anderes Dokumentations model, mit weniger Kontrolle und Konsistenz Fuer der Wiki ist kein problem (zeitliche und tutorial dokumentation), aber fuer Reference Dokumentation ist das anders.

[af0815]

Ich arbeite daran um chm im Textmode IDE ein zu binden. Das Funktioniert teilweise schon. Danach werde ich versuchen auch CHMs zu generieren fuer die nicht-fpdoc Dokumentation.

Gibt es dort auch schon eine vorgeschlagene Struktur ? Ich würde mich gerne an die Struktur halten.

Die Frage die sich mir auch stellt ist, gibt es auch (später) die Möglichkeit die Sprache der Hilfe umzustellen ? Denn bei der ganzen Durchsicht von fpdoc und den Formatdefinitionen, finde ich nirgends den Hinweis auf Mehrsprachigkeit.

Braucht man denke ich auch nicht, man soll nur die XMLs übersetzen in eine neue (de) XML Satz. Aber die Tools fehlen vielleicht noch. (zb um heraus zu finden welche Nodes im Englischen XML mutiert sind)

Die Frage ist für mich genauer - ein neues Verzeichnis mit der Deutschen Doku, oder nur über die Extension filename.sprache.xml. Beispiel 'actnlist.de.xml' für deutsch und 'actnlist.xml' für englisch als Standard.

[marcov]

Ich arbeite daran um chm im Textmode IDE ein zu binden. Das Funktioniert teilweise schon. Danach werde ich versuchen auch CHMs zu generieren fuer die nicht-fpdoc Dokumentation.

Gibt es dort auch schon eine vorgeschlagene Struktur ? Ich würde mich gerne an die Struktur halten.

Was wird damit gemeint? Textmode IDE oder nicht-fpdoc Dok? Multi language nicht-fpdoc wird schwierig weil die fast free-format sind (Latex), und auch weil die oft schwer geupdate werden gerade bevor eine neuen Release.

Die Frage die sich mir auch stellt ist, gibt es auch (später) die Möglichkeit die Sprache der Hilfe umzustellen ? Denn bei der ganzen Durchsicht von fpdoc und den Formatdefinitionen, finde ich nirgends den Hinweis auf Mehrsprachigkeit.

Es ist alles noch sehr neu, und heute meint Hilfe fpdoc Dokumentation, also RTL,FCL und LCL hilfe. Wie gesagt nicht-fpdoc muss meistens noch getan werden, und fuer die fpdoc ist die Verkettung zwischen IDE und Hilfe ist alle basiert auf . keys. Man kann einfach die Englische CHMs rauswerfen (oder gar nicht einmal downloaden/Installieren), die Deutsche CHMs registrieren, und fertig.

Fuer IDE wird das schwieriger. Aber dass hat noch nicht einmal angefangen, und ich hab kein Idee was den "such key" wird wie Lazarus ein Topic zu einem Menu Punkt in der Hilfe findet.

Die Frage ist für mich genauer - ein neues Verzeichnis mit der Deutschen Doku, oder nur über die Extension filename.sprache.xml. Beispiel 'actnlist.de.xml' für deutsch und 'actnlist.xml' für englisch als Standard.

Ich denke ein Verzeichnis wäre besser. Aber darüber muss du dich mit Michael (van Canneyt) einigen. Der ist Dok maintainer.

[af0815]

Ich denke ein Verzeichnis wäre besser. Aber darüber muss du dich mit Michael (van Canneyt) einigen. Der ist Dok maintainer.

Danke für die Auskünfte, es hat mir viel geholfen, ich werde mich an Michael wenden.

Momentan bin ich am aufarbeiten, wie die vorhandene Programme zusammenspielen.