[Lazarus] Lazarus helpfiles

Mattias Gaertner nc-gaertnma at netcologne.de
Tue Jul 10 14:19:43 CEST 2012

Sven Barth <pascaldragon at googlemail.com> hat am 10. Juli 2012 um 13:37

> Am 10.07.2012 13:33, schrieb Mattias Gaertner:
> >  >
> >  > IIRC, you asked Lazarus developers a good question some months ago: is
> >  > there a standard help format and help viewer?
> >  > Again, IIRC, at that time the answer was: no, you can choose whichever
> >  > viewer you want.
> >
> > About standard help format:
> >
> > For sources fpdoc is currently pretty much the standard.
> >
> > Nowadays it supports topics.
> You are aware that this was meant more in the direction of
> CHM vs. HTML vs. INF
> ?
> All those can be generated using fpdoc ;)

Yes. :)

My point is that sources have almost a standard format, but that is not true for
the rest.
The FPC docs uses latex, which is hard to refer to by fpdoc. The wiki and fpdoc
can easily refer to each other, although there is currently no help editor that
supports both, so you have to set the links manually.
pasdoc does not seem to be used much.

The fpc messages are in a special format, that afaik can only be shown by fpc
and the IDE. References are not possible.

latex can be converted to some degree to html, chm and inf.

fpdoc can be converted to html, chm, inf or shown directly. At the moment the
fpdoc parser has problems with some FPC sources (nested types).

The wiki can be downloaded and converted to some degree to html and chm or shown

All the above is very abbreviated and there are a lot of detail problems to

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.lazarus-ide.org/pipermail/lazarus/attachments/20120710/7236d15f/attachment-0003.html>

More information about the Lazarus mailing list