[Lazarus] FPDoc chms and code examples

[Соболь Андрей Евгеньевич via lazarus]

Hello,
I see that nobody used to a tag  for creating documentation lcl, 
lazutil. That tag is used only the fpc team.

I have read a documentation and saw rtl .xml`s and so.
I want to create a directory for used examples of code as :

- lazarus/doc/exlcl
- lazarus/doc/exlazutil

and put inside files in notation with dots. For example:
fileutil.findallfiles.pas (I think it will be convenient)

+ readme.txt (into those directories)
+ wiki descriptions about it.

I have checked it, a html`s works and a chm`s too.

What is yours opinion about it?
And how to create directory, also by patch?

Andrey Sobol. 



--
Это сообщение было проверено AVG на наличие вирусов.
http://www.avg.com

--
___
lazarus mailing list
lazarus@lists.lazarus-ide.org
https://lists.lazarus-ide.org/listinfo/lazarus

Re: [Lazarus] FPDoc now with Markdown support

[Соболь Андрей Евгеньевич via lazarus]

> I've been looking at allowing markdown for the description files (they would
> be less verbose then), but there seems to be no decent markdown parser 
> available 
> for pascal. If somone cares to contribute one...

For "overview pages" (unit, class, package) I think need to move a "description 
section" to up and set it above a "uses section", because "description" is more 
useful information than list of units. Especially for the case when the list of 
files is big. I think that need to do for a html version also.
-- 
___
lazarus mailing list
lazarus@lists.lazarus-ide.org
https://lists.lazarus-ide.org/listinfo/lazarus

[Lazarus] lHelp improvements

[Соболь Андрей Евгеньевич via lazarus]

Hi, guys.

I am trying to do the lHelp more convenient. And after I have combined a chm 
indexes on start, I think about next step. What I see...
1. Exist a contradiction of behavior for contex searching through hh.exe 
(windows) an lHelp (this is for first start of help subsystem):
- When I press F1 for hh.exe enabled for context searching, then Lazarus send 
only one command - open chm file and seek TOC index position.
- When I press F1 for the lHelp enabled for context searching, then Lazarus 
send group of command as

got BeginUpdate
got BeginUpdate
got rturl, filename M:\lazarus\docs\chm\fcl.chm, url /index.html
got rturl, filename M:\lazarus\docs\chm\fclres.chm, url /index.html
got rturl, filename M:\lazarus\docs\chm\fpdoc.chm, url /index.html
got rturl, filename M:\lazarus\docs\chm\ideintf.chm, url /index.html
got rturl, filename M:\lazarus\docs\chm\lazutils.chm, url /index.html
got rturl, filename M:\lazarus\docs\chm\lcl.chm, url /index.html
got rturl, filename M:\lazarus\docs\chm\prog.chm, url /index.html
got rturl, filename M:\lazarus\docs\chm\ref.chm, url /index.html
got rturl, filename M:\lazarus\docs\chm\rtl.chm, url /index.html
got rturl, filename M:\lazarus\docs\chm\toc.chm, url /index.html
got rturl, filename M:\lazarus\docs\chm\user.chm, url /index.html
got EndUpdate
got rturl, filename M:\lazarus\docs\chm\ref.chm, url 
/ref/refse92.html#keyword_function
got EndUpdate
got rtmisc/mrShow

Lazarus sends commands for opening all chm files and the last command is 
for performing contex search. As result hh.exe always does it more faster then 
lHelp. I think behavior have to be same, only a perform of context seaching. On 
second request lHelp can open next file and index and so on.

2. I think that the lHelp (or user) should make a decision myself, open all 
indexes on first start or none (for contex search primarily). It should have 
own preferences for that. But the lHelp don`t have any information about 
searchpath where is chm files. I can add a new command for sending searchpath 
or add new option to Lazarus (open all indexes on first start - see paragraph  
1).

3. lHelp got a start command with the option "--hide" at start. Then lHelp gets 
many commands on openning of indexes. I think that I have the right to show 
lHelp or splash screen on getting first command. Without this, the user gets a 
hanging program (1-3 sec) and does not understand what happens. This is for the 
case when I open all the indexes.

What is your opinion about it?
-- 
___
lazarus mailing list
lazarus@lists.lazarus-ide.org
https://lists.lazarus-ide.org/listinfo/lazarus