[Lazarus] Documentation and Help for Lazarus

[Martin]

Graeme Geldenhuys wrote:
> 2009/8/21 Martin <lazarus at mfriebe.de>:
>   
>> That is more than insufficient.
>>     
>
> Speaking about plain text docs (Asciidoc). keywords can be generated
> from them or maybe a more informed keyword file could be built
> manually. Something like meta-tags used in blogs or web page headers.
> Alternatively, we can look how fpdoc generates keywords and indexes
> and use something similar.
>   
I don't know, but don't think fpdoc currently has that feature.

The problem is that you cannot trust the user to search for "TFrame" or 
"StackFrame" or TException", the user will search for the plain english 
word frame or exception. And that will bring a lot of extra results.

So its to steps:
- a list of translation: ask the user what frame he wants
- inside the page, make sure that the plain english word is not taken in 
account. With Tframe this si solved by the first step, because the 
actual search will be for "TFrame" and therefore miss the simple word 
frame. (yet with "function" the pascal keyword is equal to the english word)

> As long as we can start having help in a offline (and possible online)
> format, that would be a good push in the right direction. Currently
> wiki docs is not helping and is in the wrong (non-portable) format.
>   
Agree.
but the discussion so far mostly went about portability.
If a decision is made it should address the search issue too.

otherwise you could just download all wiki pages as html, and rewrite 
the links to point to the local pages. there are plenty of programs that 
can do exactly this. Of course the downloaded version would no longer 
have the "search button" since that is server side. But it would be 
portable. Simple html files on your local disk.
>   
>> - 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.
>>     
>
> In this case search for "frame" has a 'complete word', which should
> then ignore 1 and only return 2 as a result.
>   
complete word would also ignore the plural "frames" which you do not want.

But it was never about finding 3. It was about explicit search for 1 or 2
> But yes I get what you mean. Extra keywords or meta-tags for each
> document pages would be helpful. What does fpdoc do in this regards?
>