Hi Wanderlan -
I am currently trying to assemble on-line help for the LCL, and if you
are offering to help, I am delighted!
The tool we use is FPCDoc, which takes the source xx.pas or xx.pp and
extracts all the identifiers, declared classes and types, procedures and
functions, etc, and then looks at a descriptor file which we have
constructed that gives details of the procedures, properties etc. This
documentation is contained in a xx.xml file, and it is the construction
of these .xml files that is occupying my time at present. FPCDoc uses
the original xx.pas file and the xx.xml file to construct HTML files
that are used to provide the on-line help that is currently accessed
through SourceForge, but will eventually be included as help-files in
the distribution.
There is a utility called LazDE (for Lazarus Documentation Editor) that
is quite useful in constructing and editing the .xml files, although I
do quite a lot of the work using a conventional test editor. Details of
LazDE are found here:
http://wiki.freepascal.org/Lazarus_Documentation_Editor
and I suggest you read that thoroughly, together with the FPCDoc manual.
If you want to collaborate in doing some of the documentation, and
particularly if yuo have an understanding of some of the more abstruse
aspects of programming, please let me know and we can decide on priorities.
With kindest regards - Chris Kirkpatrick
Wanderlan Santos dos Anjos wrote:
Hello Mattias,
I did some tests now and all is quick... Probably Sourceforge site,
that host the Lazarus help, was slow when I tested. And this occurs
frequently. Sorry by my precipitate comment.:(
One suggestion:
Pascal reserved words would be recognized to show articles at FP
Reference Guide and furthers guides.
Two asks:
How to colaborate for write more descriptions in RTL/FCL/LCL online help?
How to complete the help when there are missing links? For example:
AddDisk routine there isn't a link.
Can FPDoc help with it?
TIA
Wanderlan
On 11/20/07, Mattias Gaertner <[EMAIL PROTECTED]> wrote:
On Tue, 20 Nov 2007 11:23:53 -0300
"Wanderlan Santos dos Anjos" <[EMAIL PROTECTED]> wrote:
I tryed Live Search with optimal results http://search.live.com/
It is more quick and its parser is better than Google.
For example, try this syntax in Live Search:
TStringGrid (site:lazarus-ccr.sourceforge.net OR
site:www.lazarus.freepascal.org)
It would replace the Lazarus IDE Help engine too, that is slow.
What do you mean with 'Lazarus IDE Help engine'?
At the moment the IDE just collects some context information and starts
an external browser to fetch the page from the internet. Do you mean
starting an external browser and fetching an internet page is slow, or
do you mean the IDE help system is slow?
I'm currently working on an integrated FPDoc browser.
Mattias
_________________________________________________________________
To unsubscribe: mail [EMAIL PROTECTED] with
"unsubscribe" as the Subject
archives at http://www.lazarus.freepascal.org/mailarchives
_________________________________________________________________
To unsubscribe: mail [EMAIL PROTECTED] with
"unsubscribe" as the Subject
archives at http://www.lazarus.freepascal.org/mailarchives
