DocMaker generated chm for lib doesnt work with F1 on proced

[Didelphodon]

Recently I built with DocMaker a chm helpfile for one of my libraries but it seems that the propagated usecase of automatically showing the matching page for the procedure under the cursor when pressing F1 is somehow broken. Is there something I have to care for to have that functionality working?

[Danilo]

Did you add LibName.chm to your library.desc? And the pages are named FunctionName.html, not .htm?
HTML pages are in the main directory within the .chm, no sub-directory?

[Didelphodon]

Did you add LibName.chm to your library.desc? And the pages are named FunctionName.html, not .htm?
HTML pages are in the main directory within the .chm, no sub-directory?

library.desc - what's that? All the rest (.html, .chm, etc.) is generated by DocMaker, so I expect(ed) it to do it right - well, I checked for .html or .htm => .html, and there's also no subdirectory besides the main-(sub-)directory which is done automatically by DocMaker.

[Danilo]

library.desc - what's that?

It's your library description. PB's LibraryMaker (in PB SDK) combines a .desc and .lib/.obj into a PureBasic library.
The .desc contains informations about imported libs, all your new commands and its parameters, etc.
One entry in the .desc is for the 'help directory', which is your library.chm on Windows.
Examples of PB Libs (ASM/C) and .desc library descriptions are to be found in the PB SDK.

[Didelphodon]

library.desc - what's that?

It's your library description. PB's LibraryMaker (in PB SDK) combines a .desc and .lib/.obj into a PureBasic library.
The .desc contains informations about imported libs, all your new commands and its parameters, etc.
One entry in the .desc is for the 'help directory', which is your library.chm on Windows.
Examples of PB Libs (ASM/C) and .desc library descriptions are to be found in the PB SDK.

Ah, understood. Well, I just wanted to add a CHM helpfile for my own library still in source code which I add to my projects/programs via IncludeFile. I guess I'll have to go the LibraryMaker-way to be able to achieve the F1-functionality?

[Fred]

Yes, it's needed but you will have another issue: the commands will then be declared as internal and will clash with the one found in your sources.

[Danilo]

Yes, it's needed but you will have another issue: the commands will then be declared as internal and will clash with the one found in your sources.

After porting his lib to C or ASM (or any language who's compiler is able to output PB-compatible .obj/.lib),
he does not need to include it as source anymore.

[Didelphodon]

Yes, it's needed but you will have another issue: the commands will then be declared as internal and will clash with the one found in your sources.

After porting his lib to C or ASM (or any language who's compiler is able to output PB-compatible .obj/.lib),
he does not need to include it as source anymore.

True. However, is it really necessary to convert/translate the lib to another language than native PB? I thought one can write a PB userlib natively in PB.

[Danilo]

However, is it really necessary to convert/translate the lib to another language than native PB? I thought one can write a PB userlib natively in PB.

PB itself does not support it. There are rumours that TailBite was created to do that, but I never used it. Check it out yourself.

- http://www.tailbite.com/

TailBite is a tool that splits the PureBasic.asm file generated by PureBasic for Windows from a *.pb source file into several asm files,
and compiles them into a PureBasic library using different tools included with PureBasic.

[Didelphodon]

However, is it really necessary to convert/translate the lib to another language than native PB? I thought one can write a PB userlib natively in PB.

PB itself does not support it. There are rumours that TailBite was created to do that, but I never used it. Check it out yourself.

- http://www.tailbite.com/

TailBite is a tool that splits the PureBasic.asm file generated by PureBasic for Windows from a *.pb source file into several asm files,
and compiles them into a PureBasic library using different tools included with PureBasic.

Ah, yes, I remember tailbite - long ago