[fpc-devel] fpdoc and fv

Graeme Geldenhuys graemeg.lists at gmail.com
Mon Aug 25 12:24:03 CEST 2008


On 8/25/08, Michael Schnell <mschnell at lumino.de> wrote:
>
>
> > I still like the principle though.
> >
>  I do understand this.
>
>  But especially with the non-English versions it would be nice to make the
> update of the help texts as easy as possible to enable the casual volunteer
> to get involved.

As an alternative to the "email link" I mentioned earlier (which I
still think is the better option), the is also LUFDOC.  You generate
you documentation HTML with fpdoc. Run the LUFDOC parser (which is
very quick) over the HTML which then modifies the HTML to include the
LUFDOC comments. The fpdoc HTML can be re-generated at any time
because the LUFDOC user comments are stored separately to the original
fpdoc HTML - the parser merges to two.  The CGI web app simply allows
a mechanism to edit the user comments section, but a standard IDE
plug-in or GUI app could also be written to do this job.

BTW:
  LUFDOC = Live User Fed Documentation.

It's create by the Powtils (CGI framework) author.

For more information on this see the following link.
  http://z505.com/cgi-bin/mse/idx.cgi?file=fpdocintegrated


Regards,
  - Graeme -


_______________________________________________
fpGUI - a cross-platform Free Pascal GUI toolkit
http://opensoft.homeip.net/fpgui/



More information about the fpc-devel mailing list