Sign in Join

Live chat for Free Pascal, Lazarus, Delphi and every Pascal programmer.

Mailing lists / lazarus / 2009-07

ref,user and prog in chm format

3 messages · 2 people ·

Reply by email Subscribe to this list Your subscription

Read-only archive. Use j and k to move between messages.

Graeme Geldenhuys
Marco van de Voort wrote 15 lines
http://www.stack.nl/~marcov/doc-chm.zip Notes: * scripts require 2.3.1 r13357 or newer to compile * scripts only tested on windows, but don't expect problems on *nix. * The CHMs have no "index" page yet. The latex index is apparantly not translated by tex4ht. * the list of tables is still broken. * The title of the file is hardcoded on the cmdline. * The scripts are not fully recursive, and only add html files. Be careful if you try to modify them to fit all three manuals in one file. * (prog only) paragraph 0.1 has no chapter and is appended to "Contents", which is the same as the normal main index page. (on which the TOC is based)

Nice one, Marco. Now can this be integrated with Lazarus IDE some how? So that when I press F1 or Ctrl+F1 that lhelp gets launched and shows the appropriate context sensitive help? Like I have done with the Kylix 3 HyperHelp - as described in: http://wiki.freepascal.org/Adding_Kylix_Help

Having the Lazarus IDE help (various dialogs and options) available offline in this manner would also be a huge boon!

Many times I am not online, so the default online help (for the IDE or LCL/FCL/RTL) is not always appropriate. Offline help would be a great benefit.

Regards,
- Graeme -

fpGUI Toolkit - a cross-platform GUI toolkit using Free Pascal http://opensoft.homeip.net/fpgui/

Reply by email

Marco van de Voort
to Graeme Geldenhuys
Graeme Geldenhuys wrote
Nice one, Marco. Now can this be integrated with Lazarus IDE some how?

There is the chmhelp package. I also already translated the Windows CHM api, so an attempt at native CHM support might be doable also.

However I mostly focussed my efforts on the textmode IDE, not Lazarus.

There is still a problem there, showing the index of the LCL chm systematically crashes the textmode IDE on all platforms and architectures and I don't know why.

So that when I press F1 or Ctrl+F1 that lhelp gets launched and shows the appropriate context sensitive help? Like I have done with the Kylix 3 HyperHelp - as described in: http://wiki.freepascal.org/Adding_Kylix_Help

I do not know how contextsensitive help works in Lazarus, and I don't have Kylix. I haven't delved into the code yet, and couldn't find any docs about it.

I know tcomponent in newer delphi's have textual fields for help purposes (contrary to the older "integer" based Delphi .hlp and TP support)

Reply by email

Marco van de Voort

In our previous episode, Marco van de Voort said:

I updated the docs, and, for convenience I added the fpdoc based docs and fpdoc.chm too.

The archive is still at

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

but now swollen to +/- 10MB, however this is mostly due to the fact that I also included the LCL and .xcts. A typical FPC release would be in the magnitude of 4-5MB both in ZIP as unpacked. (compare, doc-html.zip is now 10MB _packed_ and tens of MB's uncompressed)

Changes:
- fpdoc based chms added, as well as fpdoc manual itself, hopefully with crossreferences and fulltext search.
- recompiled everything after Andrew Haines' chm package fixes last night.
- Added a script, fixdocs.sh to the fpcdocs repository which should somewhat automate the generation. Note that it hardly does any error checking.

The rest of my notes are at:

http://wiki.freepascal.org/chm_backend_for_fpdoc#compiling_and_TOC_generation

Reply by email