Recent

Author Topic: Answer to Question: How to use CHM help?  (Read 33406 times)

TurboRascal

  • Hero Member
  • *****
  • Posts: 672
  • "Good sysadmin. Bad programmer."™
Re: Answer to Question: How to use CHM help?
« Reply #15 on: March 04, 2011, 12:40:34 am »
That's right... there is no such item to setup in the help options.

Are there any plans to include it?
Regards, ArNy the Turbo Rascal
-
"The secret is to give them what they need, not what they want." - Scotty, STTNG:Relics

jamhitz

  • Jr. Member
  • **
  • Posts: 83
Re: Answer to Question: How to use CHM help?
« Reply #16 on: April 05, 2011, 11:28:42 am »
I can confirm that the lhelp works in Linux (in my installation at least) *but* I have to provide the StartPage BaseURL.  It should be set to toc.chm - which contains links to all the other documents. Unfortunately if I set it to toc.chm:// it loads the lhelp window but at the Statusbar it fails:

Code: [Select]
ms-its:toc.chm::/docs/index.html not found!
However, because in my case I reference the RTL documentation the most, I have set rtl.chm:// as the BaseURL for StartPage. During the weekend, I will crack open toc.chm and try to create/rename the missing index.html document.... if you don't beat me to it that is.

TurboRascal

  • Hero Member
  • *****
  • Posts: 672
  • "Good sysadmin. Bad programmer."™
Re: Answer to Question: How to use CHM help?
« Reply #17 on: April 08, 2011, 07:19:14 pm »
@jamhitz: that's quite an interesting work you are doing. If you succeed, you'll make some people happy ;)
Regards, ArNy the Turbo Rascal
-
"The secret is to give them what they need, not what they want." - Scotty, STTNG:Relics

marcov

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 7505
Re: Answer to Question: How to use CHM help?
« Reply #18 on: April 08, 2011, 07:42:42 pm »
The toc.chm file is not meant for Lazarus at all.

Lazarus should auto load rtl, fcl and lcl, and afaik has no facilities for anything else.

jamhitz

  • Jr. Member
  • **
  • Posts: 83
Re: Answer to Question: How to use CHM help?
« Reply #19 on: April 10, 2011, 05:06:47 pm »
The toc.chm file contains only one file (toc.chm). I decompiled the CHM file, made a copy of that file as index.html.  I then recompiled the file and voila! When I click on "Online Help" the list of available documents is displayed with correct hyperlinks.

This must just be a work-around coz on the status bar it still says:

Code: [Select]
ms-its:toc.chm::/docs/index.html not found!
Please see the two attached images to see what I mean...but at least it does not fail in error, and offers links to get one started.

Attached, also find my modified toc.chm file.

@marcov: In my setup (Laz 0.9.28.2, lhelp 2009.06.08), lhelp does not autoload the chm files.

marcov

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 7505
Re: Answer to Question: How to use CHM help?
« Reply #20 on: April 11, 2011, 10:42:30 am »
The toc.chm file contains only one file (toc.chm). I decompiled the CHM file, made a copy of that file as index.html.  I then recompiled the file and voila! When I click on "Online Help" the list of available documents is displayed with correct hyperlinks.

Toc is autogenerated by a program. It can be that it contains mistakes, but it shouldn't be altered. THe generator program should be fixed.

And again: toc.chm is meant for the textmode IDE, not for lazarus.

Quote
@marcov: In my setup (Laz 0.9.28.2, lhelp 2009.06.08), lhelp does not autoload the chm files.

Sorry, don't know very old versions that well. Afaik that is a FPC 2.2.4 version, and there are dozens of patches to
the core CHM libraries in FPC alone since then. And then I'm not even counting what happened in lazarus.

TurboRascal

  • Hero Member
  • *****
  • Posts: 672
  • "Good sysadmin. Bad programmer."™
Re: Answer to Question: How to use CHM help?
« Reply #21 on: April 11, 2011, 11:08:58 pm »

Toc is autogenerated by a program. It can be that it contains mistakes, but it shouldn't be altered. THe generator program should be fixed.

IIRC, all HTML and CHM documentation is created based on some XML files... Perhaps those files should be fixed...
Regards, ArNy the Turbo Rascal
-
"The secret is to give them what they need, not what they want." - Scotty, STTNG:Relics

marcov

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 7505
Re: Answer to Question: How to use CHM help?
« Reply #22 on: April 12, 2011, 10:33:30 am »

Toc is autogenerated by a program. It can be that it contains mistakes, but it shouldn't be altered. THe generator program should be fixed.

IIRC, all HTML and CHM documentation is created based on some XML files.

This is not true. Only RTL, FCL and LCL  (and some lesser ones like fpdoc and a few that are not compiled atm). These are processed by fpdoc.

prog, ref and user are in latex, exported to html and then post processed to CHM. (indexing and other little fixes)

toc is generated directly as CHM by a program, it simply opens all CHMs and provides a reference to it.

But again, TOC.chm is meant for the textmode IDE[/b\] that can only deal with one TOC.  It is a workaround to make the TOC an index page that references to the
other CHMs. It works fine for the textmode IDE, and is not important for the rest.