I usually write my user documentation using DocBook. For my recent applications built on top of Qt, I needed something that generates in-app help page

GitHub - dkrajzew/db2qthelp: A DocBook to QtHelp converter.

submited by

Style Pass

2023-01-23 21:00:06

I usually write my user documentation using DocBook. For my recent applications built on top of Qt, I needed something that generates in-app help pages. db2qthelp does this.

You should have a user documentation written as a DocBook book. Images should be stored in a subfolder, at best one that is located in the same folder as the DocBook document itself. E.g. if you have a project, you may have a folder “docs” in which the document itself (“docs/userdocs.xml”) is located and the images / figures it references are located in “docs/images/*”.

In the first step, you have to convert this document to a single-HTML document. Being in the docs folder, I use xsltproc for this using a call similar to this one:

Here, “single_html.xsl” is a slightly modified DocBook style sheet. You may find it in this package under “data/single_html.xsl”. Please not that you have to update the references to your docbook stylesheets location.

You will get a file named “template.qhp”. It should be located in the same folder as your DocBook document. You may though name it differently to set it's name on generation use: