Recent

Author Topic: Unofficial offline documentation update. (CHM)  (Read 8067 times)

marcov

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 9085
  • FPC developer.
Unofficial offline documentation update. (CHM)
« on: August 22, 2010, 08:51:27 pm »
For the upcoming FPC 2.4.2RC1 release, I've been working on fpdoc the last two weeks.

As a result there is a new CHM offline help snapshot for testing etc, uploaded to

http://www.stack.nl/~marcov/doc-chm.zip

The archive contains the FPC documentation (fcl,rtl,ref,prog,user and some minor archives) as well as a build of the LCL docs.

In this release, mainly the interlinking of classes that inherit from eachother was improved.

martinrame

  • Jr. Member
  • **
  • Posts: 88
Re: Unofficial offline documentation update. (CHM)
« Reply #1 on: August 23, 2010, 10:26:31 pm »
Hi Marco, good work!.

Is this CHM included in the trunk svn version? how can I generate it?.

Thanks in advance,
Leonardo.

Leledumbo

  • Hero Member
  • *****
  • Posts: 8307
  • Programming + Glam Metal + Tae Kwon Do = Me
Re: Unofficial offline documentation update. (CHM)
« Reply #2 on: August 24, 2010, 06:18:10 am »
Are they intended to be used by the IDEs only? When I open toc using hh.exe, it shows nothing.

marcov

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 9085
  • FPC developer.
Re: Unofficial offline documentation update. (CHM)
« Reply #3 on: August 25, 2010, 07:33:21 am »
Are they intended to be used by the IDEs only?

No. Though the strong point of CHM is the index that makes quick lookups easier.

The HTML and CHM docs also show more source detail than the PDFs.

Quote
When I open toc using hh.exe, it shows nothing.

Yes. toc.chm turned out broken. Don't worry, it is a autogenerated file, and does nothing but provide links to the TOCs of the other CHMs.

TOC.chm is mainly used to avoid a limitation of the textmode IDE (that it can only have one TOC in total, not one TOC per file), and has no relevance for Lazarus use.

Leledumbo

  • Hero Member
  • *****
  • Posts: 8307
  • Programming + Glam Metal + Tae Kwon Do = Me
Re: Unofficial offline documentation update. (CHM)
« Reply #4 on: August 25, 2010, 07:39:36 am »
Quote
Yes. toc.chm turned out broken. Don't worry, it is a autogenerated file, and does nothing but provide links to the TOCs of the other CHMs.
Will I be able to open it (when it's fixed) to open other linked chms (I don't use lazarus all the time, so it could access all other chms that would save me a few seconds locating other chms and opening it)?

marcov

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 9085
  • FPC developer.
Re: Unofficial offline documentation update. (CHM)
« Reply #5 on: August 25, 2010, 08:05:12 am »
Quote
Yes. toc.chm turned out broken. Don't worry, it is a autogenerated file, and does nothing but provide links to the TOCs of the other CHMs.
Will I be able to open it (when it's fixed) to open other linked chms (I don't use lazarus all the time, so it could access all other chms that would save me a few seconds locating other chms and opening it)?

Sure. I've put a fixed version on http://www.stack.nl/~marcov/toc.chm

(remember to unblock first)

 

TinyPortal © 2005-2018