Verwendung von fpdoc

Für Fragen rund um die Ide und zum Debugger
marcov
Beiträge: 1087
Registriert: Di 5. Aug 2008, 09:37
OS, Lazarus, FPC: Windows ,Linux,FreeBSD,Dos (L trunk FPC trunk)
CPU-Target: 32/64,PPC(+64), ARM
Wohnort: Eindhoven (Niederlande)

Re: Verwendung von fpdoc

Beitrag von marcov »

mschnell hat geschrieben:
Di 15. Dez 2020, 10:31
PascalDragon hat geschrieben:
Di 15. Dez 2020, 09:27
Die FPC und Lazarus Entwickler sind sich hier einig: fpdoc. Was dritte machen ist nicht unter unserer Kontrolle.
Wirklich ?
Ich habe da vor einiger Zeit mal mitdiskutiert, weil ich bei der (englischen) Dokumentation helfen wollte, aber nicht bei der total unklaren Ausgangslage. Da gab Bestrebungen, irgendwie ein Wiki als Master-Dolkumentation zu verwenden und daraus die verschiedenen Formate zu generieren.
Bestrebungen von dich, nicht von Lazarus oder FPC core.

marcov
Beiträge: 1087
Registriert: Di 5. Aug 2008, 09:37
OS, Lazarus, FPC: Windows ,Linux,FreeBSD,Dos (L trunk FPC trunk)
CPU-Target: 32/64,PPC(+64), ARM
Wohnort: Eindhoven (Niederlande)

Re: Verwendung von fpdoc

Beitrag von marcov »

Socke hat geschrieben:
Di 15. Dez 2020, 11:22
Soweit ich das überblicke, gibt es für verschiedene Bereiche verschiede Quellformate:
  • Dokumentation FPC (User's Guide, Programmer's Guide, Language Reference Guide): LaTeX nach HTML/PDF (und CHM?)
Nein. Ja, CHM, aber via Bearbeitung des generiertes HTML. Also nicht wie fpdoc wo CHM und html viel teilen, aber immer noch trennte Ziele sind.
[*]Code-Dokumentation RTL, FCL, LCL: fpdoc nach HTML/PDF/CHM
Additionselle Quelle: fcl-res,fpdoc, lazutils
Additionselle Ziele : txt IPF usw.
[*]Anwendungsdokumentation Lazarus: Wiki (wird in Teilen auch in die CHM-Hilfe extrahiert)[/list]
Ist mir noch nie gelungen. In 15+ Jahre.
Zuletzt geändert von marcov am Mo 11. Jan 2021, 19:00, insgesamt 1-mal geändert.

marcov
Beiträge: 1087
Registriert: Di 5. Aug 2008, 09:37
OS, Lazarus, FPC: Windows ,Linux,FreeBSD,Dos (L trunk FPC trunk)
CPU-Target: 32/64,PPC(+64), ARM
Wohnort: Eindhoven (Niederlande)

Re: Verwendung von fpdoc

Beitrag von marcov »

Socke hat geschrieben:
Do 17. Dez 2020, 16:56
Als Lazarus-Anwender wäre eine durchgehende Code-Dokumentation durchaus wünschenswert; zumindest alle FPDoc-Dokumentationen sollten doch auch zusammen erstellt werden können? Gibt es diesbezüglich irgendwelche Absprachen zwischen den beiden Projekten Lazarus und FPC? Oder kocht hier jeder seine eigene Suppe?
(zusätzlich zu Pascaldragon's Antwort ). Die FPC-Lazarus Absprache sind meistens informell. Etwa im 2007-2010 Zeitraum gab es ein paar Lazarus Tage in die Niederlande (Delft, Nieuwegein) wo FPC(Michael,Joost, Daniel, ich) und Lazarus core (Marc, Mattias, Vincent, Michi) darüber geredet haben. CHMs funktionierte, und es wirde beschlossen das für Offline-Hilfe zu nutzen bis es etwas besseres gab. Mattias im besonderes war damals mehr auf Onlinehilfe orientiert.

Es gibt schon manche Probleme (zb, Hilfe von 3rd Party Packages im lazarus Hilfe System einbinden), aber CHM funktioniert noch immer gut. Alle Probleme die es gibt sind noch immer Magnituden einfacher dann Umstieg auf etwas anders.

Teilweise auch weil immer Leute gut sind die Alternativen im Forumposts zu entwerfen, aber weniger gut in sie tatsächlich zu implementieren.

Antworten