Hi, I would like to have replied to the original msg "StringGrid Woes" thread but even when at the moment I have more than 10000 msg in history that particular thread wasn't there :).

If you haven't noticed, in 0.9.29 one event OnValidateCell has been added to StringGrid, there is something in http://wiki.lazarus.freepascal.org/Grids_Reference_Page#Validating_Entered_Values about how this work which is basically what was requested in the original thread.

Jesus Reyes A.

Encuentra las mejores recetas en Yahoo! Cocina.
http://mx.mujer.yahoo.com/cocina/

And to reiterate my reply to the original thread. Why is such documentation not in the LCL fpdoc format, but rather the wiki? Such documentation should be located in ONE location only. Scattered documentation is just as good as NO documentation. Users have no clue what is the latest documentation either. There are some LCL StringGrid fpdoc documentation, but it seems the wiki has more information. As to which one is newer / more up-to-date, I have no clue!

PLEASE consider the idea of having documentation in ONE place only.

Regards,
- Graeme -

Let's use the wiki, to lower the threshold for contributing ;-)

Vincent

Zitat von Graeme Geldenhuys :

One reason: no one has explained how to do that.

The important goal is to refer/navigate easily between all documentations. The wiki contains some howtos and links to further help. The fpdoc files should have "see also" links to these pages. And we need an offline version of the wiki pages for download. And they should be packaged (e.g. added to the windows installer).

Graeme, if you want to move the wiki content to svn, then you need to provide:
- a conversion tool for wikis
- an easy to use export utility (because help must be readable without installing lazarus).
- a fancy editor
- support for translations

Mattias

What is the problem with fpdoc ? It has all this ?

The only thing that is missing is the ability to let people create/modify fpdoc entries over the web. This can be easily written, it is somewhere in my todo list. If that particular item is moved up in the priority list you can dump the wiki and have ready-help with the possibility for end-users to contribute.

(@joost: you were looking for something nice to demonstrate fpWeb with: here it is...)

Michael.

Mattias G?rtner wrote

- a conversion tool for wikis

Copy & Paste using OS clipboard. :-)

- an easy to use export utility (because help must be readable without installing lazarus).

Lazarus IDE supplies that via FPdoc editor or tooltips in editor.

- a fancy editor

FPDOC Editor included in Lazarus IDE

- support for translations

Currently RTL, FCL and LCL fpdoc (xml based help) does NOT include translations to other languages. So must this restriction suddenly be applied to all existing LCL (fpdoc) documentation as well?

My point with the TStringGrid wiki documentation is that the wiki actually contains class documentation. As far as I know, all LCL class documentation must be done in fpdoc format with all other LCL class documentation. Why is TStringGrid the exception??

Regards,
- Graeme -

FWIW: wikis' suxxors major bovine gonads unless one knows what to look for... and wikis are really in the shite when it comes to offline docs...

the further add(, and not distract!) i've been looking at the sikie for yonks and have yet to come to any real understanding as to how things really work whether they been FPC and/or Lazarus... this wiki documentation format is one of the main reasons why i have not been able to contribute more that i have... why? because i have to know how to work a wiki before i can get any answers to my queries... when they match up with something that the wiki /might/ have available...

personably, i'd much rather have a real book al la "mastering turbo pascal 6.0" in my hands but that us very unlikely to be seen ;)

Not if you're german :-)

Michael.

PLEASE consider the idea of having documentation in ONE place only.

I favor the idea of having one open place for documentation management (registration of docs, indexing...) and tool(s) to convert from various data source formats into one or two (code doc + articles) general formats.

DoDi

And we need an offline version of the wiki pages for download. And they should be packaged (e.g. added to the windows installer).

I'd suggest something like SVN for updates, in *both* directions.

ACK

DoDi

That would be nice, indeed :-)

What exact tools (editors/viewers...) do you mean with "fpdoc"? Which one should be used to view the entire (local) database?

http://www.freepascal.org/docs-html/fpdoc/fpdoc.html IMO is an example for an unpleasant/unusable documentation, lacking random navigation by means of separate index (tree?) and contents panes (CHM/lazde style...).

I also miss some indexing capabilities, for the entire content and external references. Something like makeskel for a wiki, with a feature to establish kind of bidirectional links between articles and the fpdoc entries.

DoDi

personably, i'd much rather have a real book al la "mastering turbo pascal 6.0" in my hands but that us very unlikely to be seen ;)

Books have (kind of) a TOC and an index (skeleton), covering all topics, and all topics are covered in the text part (meat). There exist one or more authors who built the TOC, then started to write down whatever they found worth to mention with every single topic. The book is published only after the whole work is done (skeleton+meat+skin).

With regards to the Lazarus IDE and LCL we don't have a finished skeleton, little meat, and I dunno about the skin :-(

BTW, people who write "mastering..." books make their *living* from writing such books, and do not much more than collecting, reorganizing and annotating *existing* documentation. Lack of collected and organized existing documentation is not a good base for writing such books :-(

What's the state of the German Lazarus book?

DoDi

--- El lun 24-ago-09, Graeme Geldenhuys escribi?:

Simply it was started before any tool to write fpdoc documentation exists(either lazdoc or lazde, ok, lazde had a previous version but it wasn't known too much). Coincidentaly the reason why some class reference is there is also documented in grids reference page, se http://wiki.lazarus.freepascal.org/Grids_Reference_Page#Information.

Currently there is no tool that does bidirectional documentation wiki<->fpdoc so in the lack of a better place I use the wiki. I have found that Chris Kirkpatrick made a great work documenting the grids classes and some parts of the wiki are now in fpdoc format like the "howto use grids" section, as currently this is a manual step that somebody have to actually do I can only say thanks for that.

It is probably time to drop some parts to the grids page but not without actually looking what it's already in fpdoc, I will take a look later in the week.

Jesus Reyes A.

Encuentra las mejores recetas en Yahoo! Cocina.
http://mx.mujer.yahoo.com/cocina/