Access to custom help documentation from gedi

Find and share HowTos to various installations / configurations!
4 posts • Page 1 of 1
sblancha
Posts:64
Joined: Thu Feb 18, 2016 4:18 pm

Access to custom help documentation from gedi

Post by sblancha »

Hello,
I have put some html documentation of my libraries in PVSS project help/en_US.iso88591/ directory. Is it possible to make it accessible by the search feature of gedi help (panel called WinCC OA Online Help) or other gedi help panel?

Cheers,
Sebastien

tmalone
Posts:192
Joined: Mon Nov 22, 2010 11:21 pm

Re: Access to custom help documentation from gedi

Post by tmalone »

Take a look at std_miniHelp(). I have used it at runtime for displaying html help and .txt files.

sblancha
Posts:64
Joined: Thu Feb 18, 2016 4:18 pm

Re: Access to custom help documentation from gedi

Post by sblancha »

The help documents I put there (help/en_US.iso88591/) are not for users but for developers. I would like they have access easily from gedi native help menu.

mkoller
Posts:741
Joined: Fri Sep 17, 2010 9:03 am

Re: Access to custom help documentation from gedi

Post by mkoller »

Yes, it's possible.
You need to create a Qt compressed help file from your html files, and if that includes where a keyword is a function and the ref defines the name of the html file, the script editor
can show the help file from the function you selected.
How to create a Qt help file is explained here:
http://doc.qt.io/qt-5/qthelpproject.html
The generated help file needs to be added to the registered help files which you can do directly with the help viewer we deliver (assistant; in Preferences -> Documentation)

4 posts • Page 1 of 1