Sign in Join

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

Mailing lists / lazarus / 2017-11

register 3rd party help with the IDE

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

Hi,

Years back I wrote a tiOPF class documentation help intergation package for Lazarus. It could use local help (on your hard drive) or online help for the tiOPF.lpk package. But then it worked perfectly.

The other day I tried it out again with Lazarus Trunk, but it doesn't work. I tried to use the online help registration as follows:

  // for Online help files
   RegisterFPDocHTMLHelpForPackage('tiOPF2 Help','tiOPF2 Help Database',
               'http://geldenhuys.co.uk/tiopf/','tiOPF');

After I rebuild Lazarus IDE, the "tiOPF Help" appears in the help database list, but no URL appears in the BaseURL setting, and Pressing F1 on any code found in the tiOPF.lpk package doesn't work.

Any idea what I need to do to get the ide help integration working again?

The unit in question can be seen by following the URL below. By default it uses local help on the hard drive, but I locally modified it to use the Online help instead. But like I said, it doesn't seem to work any more.

https://github.com/graemeg/tiopf/blob/tiopf2/Compilers/FPC/pkghelpintegration.pas

Regards,
Graeme

fpGUI Toolkit - a cross-platform GUI toolkit using Free Pascal http://fpgui.sourceforge.net/ My public PGP key: http://tinyurl.com/graeme-pgp

Reply by email

Mattias Gaertner
to Graeme Geldenhuys: Years back I wrote a tiOPF class documentation help intergation package for Lazarus. It…
[...] // for Online help files RegisterFPDocHTMLHelpForPackage('tiOPF2 Help','tiOPF2 Help Database', 'http://geldenhuys.co.uk/tiopf/','tiOPF');

This only registers help for the source files of the tiOPF.lpk directory and its sub directories.
For additional directories use the AdditionalDirectories parameter. See your own examples:

 RegisterFPDocHTMLHelpForPackage('tiOPF2Core','tiOPF2 Core Help',
             'file://$PkgDir(tiOPF)/html/core','tiOPF','../../Core;../../Options;../../GUI');
After I rebuild Lazarus IDE, the "tiOPF Help" appears in the help database list, but no URL appears in the BaseURL setting, and Pressing F1 on any code found in the tiOPF.lpk package doesn't work.

The BaseURL is the property for the user to override the built-in default URL. I added a read only property, so the user can now see the default in the IDE options.

Mattias

Reply by email