SVG file in qhelpgenerator / assistant

SGaist

The SVG support comes with it, so just try it to check whether it allows the SVG to be loaded.

Albert-qt

@SGaist said in SVG file in qhelpgenerator / assistant:

check whether it allows the SVG to be loaded.

the question is how can I check this?

The small project I used:

The index.qhp file:

<?xml version="1.0" encoding="UTF-8"?>
<QtHelpProject version="1.0">
  <namespace>org.doxygen.Project</namespace>
  <virtualFolder>doc</virtualFolder>
  <filterSection>
    <filterAttribute>doxygen</filterAttribute>
    <toc>
      <section title="My Project" ref="index.html">
        <section title="Main" ref="index.html">
        </section>
      </section>
    </toc>
    <keywords>
    </keywords>
    <files>
      <file>aa.svg</file>
      <file>index.html</file>
    </files>
  </filterSection>
</QtHelpProject>

the index.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>My Project: Main</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
</head>
<body>
Generated <img src="aa.svg" alt="default"/>
</body>
</html>

The aa.svg:

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>My Project: Main</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
</head>
<body>
Generated <img src="aa.svg" alt="default"/>
</body>
</html>

The used commands:

D:\Qt\qt-everywhere-src-5.14.0\install_nmake_2017_64\bin\qhelpgenerator.exe index.qhp -o "My Project.qch"
D:\Qt\qt-everywhere-src-5.14.0\install_nmake_2017_64\bin\assistant.exe

The result is in the assistant:

so we can see that the image is not displayed, the image should look like:

SGaist

Just to be sure, if you use a .png, does it work ?

Albert-qt

Yes with a png file it does work.

index.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>My Project: Main</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
</head>
<body>
Generated <img src="aa.svg" alt="default"/>
<br>
Generated <img src="aa.png" alt="default"/>
</body>
</html>

index.qhp

<?xml version="1.0" encoding="UTF-8"?>
<QtHelpProject version="1.0">
  <namespace>org.doxygen.Project</namespace>
  <virtualFolder>doc</virtualFolder>
  <filterSection>
    <filterAttribute>doxygen</filterAttribute>
    <toc>
      <section title="My Project" ref="index.html">
        <section title="Main" ref="index.html">
        </section>
      </section>
    </toc>
    <keywords>
    </keywords>
    <files>
      <file>aa.png</file>
      <file>aa.svg</file>
      <file>index.html</file>
    </files>
  </filterSection>
</QtHelpProject>

The png file:

The result:

SGaist

Can you show the qdoc configuration file you are using ?

Albert-qt

I don't have a qdoc configuration file or maybe there is one in the Qt tree that I'm not aware of.
Note that I'm not creating the qhp file through a Qt program but it is created by means of another program (doxygen)
(Slow reply, can only post every 600 seconds, as I have not enough reputation yet)

SGaist

By the way, which version of Qt are you using ?

Albert-qt

The used version qt-everywhere-src-5.14.0

As a reference the used configure line:

..\qt-everywhere-src-5.14.0_2017_64\configure.bat -opensource -release -confirm-license --shared=no --static=yes -prefix D:\Qt\qt-everywhere-src-5.14.0\install_nmake_2017_64 -nomake tests -nomake examples -sanitize thread

Albert-qt

I just tried with the version 5.15.2 but still no svg file shown (in other words same result as with 5.14.0)

SGaist

What if you use on of the pre-built version ?

Albert-qt

Is there a quick possibility to get the qhelpgenerator and the assistant (for 5.15.2 or another version)?
I found hhttps://www.qt.io/download-open-source but it looks like to take ages...
(I'll try to keep downloading ...)

Edit: The fact that it took "ages" was because I used everything of the 5.15.2 version, not just the e.g. msvc2019_64 part.This give quite a reduction in used disk space (and in installation time, though for just 2 needed executables it still is quite long).

Albert-qt

I installed the 5.15.2 version and found the

D:\Qt\5.15.2\5.15.2\mingw81_32\bin\qhelpgenerator.exe
D:\Qt\5.15.2\5.15.2\mingw81_64\bin\qhelpgenerator.exe
D:\Qt\5.15.2\5.15.2\msvc2015_64\bin\qhelpgenerator.exe
D:\Qt\5.15.2\5.15.2\msvc2019\bin\qhelpgenerator.exe
D:\Qt\5.15.2\5.15.2\msvc2019_64\bin\qhelpgenerator.exe

and

D:\Qt\5.15.2\5.15.2\mingw81_32\bin\assistant.exe
D:\Qt\5.15.2\5.15.2\mingw81_64\bin\assistant.exe
D:\Qt\5.15.2\5.15.2\msvc2015_64\bin\assistant.exe
D:\Qt\5.15.2\5.15.2\msvc2019\bin\assistant.exe
D:\Qt\5.15.2\5.15.2\msvc2019_64\bin\assistant.exe

I used the msvc2019_64 version and this does work (I also tried msvc2015_64a and this works as well) .

It is still very interesting to know why my own build didn't work, so I can build my own version when necessary.

ferdymercury

I am experiencing the same issue. The SVG file is created by doxygen + qhelpgenerator, and then imported into QtCreator via Options, Help, Add qch file.

When pressing F1 on a function, it opens the help, but the dependency graphs (svg) are not properly shown in QtCreator 5.0 with Ubuntu19. Should I maybe open a bug report?

SGaist

Sorry I lost track of this one.

Yes you can. Even better if you can provide a minimal set of files and instructions to trigger this on the bug report.

ferdymercury

Thanks, I created https://bugreports.qt.io/browse/QTCREATORBUG-26272

There is an attachment in case you want to reproduce yourself.

ScumCoder

It's been 2.5 years, and there's still zero reaction to this issue.
I still can't browse qch help containing svg files:

Maybe it's me who is doing something wrong here? No way me and OP are the only two people who care about this.

Christian Ehrlicher

The bug report is wrong. It's not a QtCreator issue but QTexEdit (?) which does not support it. So the correct persons are not aware of the problem.

ScumCoder

I finally managed to get proper help back again, so I'm sharing the solution juuuust in case some other lost soul comes here in search of an answer.

Clone the QtCreator source code.
Checkout version v7.0.2 (this is the last version that supports Qt5).
Build it against Qt5.
Select "QtWebEngine" as the help renderer.

Not only did rolling back to v7.0.2 + Qt5 give me proper help, but it also fixed a whole plethora of other annoying bugs.
And even if there was any actual functionality added since that version, I didn't notice it, so I didn't even lose anything.

Снимок экрана_2025-07-06_20-31-22.png