Page MenuHomePhabricator

Qt help is shown if no doxygen is installed
Closed, ResolvedPublic

Assigned To
None
Authored By
kilgus
Apr 23 2010, 2:29 PM
Referenced Files
F517: help.patch
Jul 9 2010, 1:58 PM
F516: MitkExtQtHelpCollection.qhc
Jun 30 2010, 3:08 PM
F515: MITKBlankPage.qch
Jun 23 2010, 4:52 PM
Unknown Object (File)
Apr 23 2010, 4:09 PM

Description

If there is no doxygen installed and you click on "Help" -> "Help" the Qt assistent opens the Qt help.

Event Timeline

The cause of this bug is, that the mitk help pages are build when mitk is build. If either doxygen is not installed or the cmake variables concerning doxygen not set, they will not be created.
This only concerns self-compiled versions, any installers or similar, being compiled already, are not concerned with this.

Last bug squashing session several approaches to this problem have been mentioned:

  1. Do nothing. As anybody who wants to use MITK as a program usually downloads binarys they already have the documentation. Those that download the source and compile it themselves either should install doxygen or read the .dox files.
  1. Include blank page Create an empty page that ships with the source. Should no doxygen variable be set set this page as the target for the F1 help. This way no QT help is shown.

If the variables are set make sure not to include this page in the F1 help.

  1. Include impressum page or similar Same as blank page, but included even if other help pages are build

Opinions?

First draft of a blank page attached. If no help files have been build copy to \mitk\Modules\Bundles\org.mitk.gui.qt.extapplication\documentation\UserManual\qch

The ExtApp (QExtApplicationPlugin) is loading a Qt Help Collection File "MitkExtQtHelpCollection.qhc" placed in
'$MITK_BIN\bin\ExtBundles\org.mitk.gui.qt.extapplication\resources'

The .qhc file must be generated by qcollectiongenerator using a .qhcp file (collection config file) containing the link to the MITKBlankPage.qch file

<?xml version="1.0"?>
<QHelpCollectionProject version="1.0">

<docFiles>
    <register>
        <file>MITKBlankPage.qch</file>
    </register>
</docFiles>

</QHelpCollectionProject>

Help collection file linking to the BlankPage.qch

[SVN revision 24194]
FIX (#3789): Adding pregenerated help page. updating CMakeLists.txt

Should be done now. Reopen if problems arise.

Precompiled help files are copied to the binary tree if either doxygen is not found or blueberry use qt help is deactivated.

Added patch to print out the paths that are used to access the default help files.

Reopen, still some issues with files not found on external versions.

Copy from mailing list:

thank you for your answer. I applied your patch and the additional output is as following:

...
[BlueBerry] ERROR: Registering compressed help file/data/development/mitk/mitk-24408-x11/bin/ExtBundles/org.mitk.gui.qt.extapplication/resources/MITKBlankPage.qch
failed
-collectionFile,/data/development/mitk/mitk-24408-x11/bin/ExtBundles/org.mitk.gui.qt.extapplication/resources/MitkExtQtHelpCollection.qhc,-register,/data/development/mitk/mitk-24408-x11/bin/ExtBundles/org.mitk.gui.qt.extapplication/resources/MITKBlankPage.qch,-quiet

Both files exist:
XXX@XXX:/data/development/mitk/mitk-24408-x11/bin/ExtBundles/org.mitk.gui.qt.extapplication/resources$
l
total 48K
-rw-r--r-- 1 XXX XXX 7.9K 2010-07-07 10:47 icon_research.xpm
-rw-rw-r-- 1 XXX XXX 27K 2010-07-14 20:33 MITKBlankPage.qch
-rw-rw-r-- 1 XXX XXX 10K 2010-07-07 10:47 MitkExtQtHelpCollection.qhc

User rights are also not the problem.

This might be due to us creating the files on windows. Need to test on a linux system without doxygen to see if they can reproduce the error. Strangely enough starting the QtAssistant by itself and adding the documentation works.

Works on Marcos machine (Linux, no doxygen)

Problem was due to qt/bin not being set in the path variable