[Lazarus] Documentation and Help for Lazarus

Martin lazarus at mfriebe.de
Fri Aug 21 00:15:13 CEST 2009


One thing that has been mentioned a couple of times in the past, is the 
ability of searching for entries.

More thna once this has been put down to a simple text search:
- web based docs can be googled 9or whatever your favourite search is)
- text base can be searched a la "find in files" (grep)

That is more than insufficient.

That is why the docomentation on the wiki is so oft judged as having no 
info on anything. Searche return plenty of matches, but even if you are 
lucky and the right page is somewhere in the list, you still have to 
search a lot of pages by hand.

Words in documentation often have special meaning, and often more than 
one. They must either be marked in hte text, as being a keyword X, or 
listed in a separate keyword list

Example;

- Frame (also in plural Frames must much the same pages):
There are at least 3 ways it can occur in the doc
 1 - TFrame => visual form inheritance
 2 - Stack frame
 3 - just the plain English word.
If you search for it, you should be asked if you mean 1 or 2.

Not to speak of related topics that may want to be suggested...

My 2 cents
Martin





More information about the Lazarus mailing list