[Paraview] Can a plugin add its documentation to PV Online Help window?

[Utkarsh Ayachit]

Not currently. But there's plan to support this use case for ParaView 3.8.

Utkarsh

On Thu, Oct 1, 2009 at 11:04 AM, Karl König <kkoenig11 at web.de> wrote:
> Hi,
>
> in short:
> Is there any means to have a plugin extend the Online Help (at least for PV CVS)? There is no mention of this in neither tutorials, wiki nor released plugins nor plugin examples in the PV source tree.
>
> a bit more elaborate:
> When using a plugin that provides a panel (like a custom filter or reader), there is always a help button. Clicking it the Output Messages window will raise the error
> like "QTextBrowser: No document for qthelp://paraview.org/paraview/Documentation/FooSeriesReader.html". So, we learn there is already a generic reference to a help file and there is no need to update somehow the PV help index itself for the time being. The error leads me to believe that I only have to somehow squeeze in my own HTML file.
>
> Obviously, there is no cmake variable BUILD_DOCUMENTATION when one compiles its own plugin. So, I tried manually, but unsuccessfully. My guess was to
>
> * have CMakeLists.txt include a *.qrc file instead of a *.xml file
>      GUI_RESOURCES FooReaderGUI.qrc
> #   GUI_RESOURCE_FILES FooReaderGUI.xml
>
> * extend this *.qrc file to not only include the GUI xml, but also a reference to a HTML or a Qt compiled help file (in the same way as it is done in Qt/Components/pqExtraResources.qrc and Applications/StreamingParaView/pqExtraResources.qrc):
>
> <RCC>
>     <qresource prefix="/ParaViewResources" >
>         <file>FooReaderGUI.xml</file>
>         <file alias="Documentation/FooSeriesReader.html">pqFooReader.qch</file>
>     </qresource>
> </RCC>
>
> * and finally by compiling this pqFooReader.qch from pqFooReader.qhp, a file designed according to
> ./Documentation/pqClient.qch using Qt 4.5.2's qhelpgenerator
>
> Everything compiles fine (against PV CVS as of today), but clicking on the help button when the custom reader's panel appears, still the same error is raised. I guess the alias in the *.qrc is incorrect? Anyone got this working already?
>
> Many thanks for hints
> Karl
>
> ______________________________________________________
> GRATIS für alle WEB.DE-Nutzer: Die maxdome Movie-FLAT!
> Jetzt freischalten unter http://movieflat.web.de
>
> _______________________________________________
> Powered by www.kitware.com
>
> Visit other Kitware open-source projects at http://www.kitware.com/opensource/opensource.html
>
> Please keep messages on-topic and check the ParaView Wiki at: http://paraview.org/Wiki/ParaView
>
> Follow this link to subscribe/unsubscribe:
> http://www.paraview.org/mailman/listinfo/paraview
>