db2qthelp — a DocBook book to QtHelp project converter

Introduction

db2qthelp converts a DocBook book to a QtHelp project.

db2qthelp is in an early stage of "development". It works well for me but it may work with my setup only.

Any feedback is appreciated.

Background

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.

Download and Installation

The current version is db2qthelp-0.2.

You may install db2qthelp using

python -m pip install db2qthelp

You may download a copy or fork the code at db2qthelp's github page.

Besides, you may download the current release here:

• db2qthelp-0.2.zip
• db2qthelp-0.2.tar.gz

License

db2qthelp is licensed under the BSD license.

Documentation

Usage

db2qthelp is implemented in Python. It is started on the command line.

db2qthelp parses a single-file HTML representation of a DocBook book. If you have a DocBook book you have to convert it to a single-file HTML document. The images you use within the book should be located in folders.

As soon as you have converted your DocBook book into a single-file HTML page, you may run db2qthelp to convert it into a QtHelp project.

The option

Options

The script has the following options:

• --input/-i <PATH>: the file or the folder to process
• --help: Prints the help screen

Examples

db2qthelp -i my_page.html -a quotes.german

Replaces !!!

db2qthelp -i my_folder -r --no-backup

Applies !!!

Further Documentation

• The PyPI page is located at: https://pypi.org/project/db2qthelp/
• The github repository is located at: https://github.com/dkrajzew/db2qthelp
• The issue tracker is located at: https://github.com/dkrajzew/db2qthelp/issues

Examples / Users

• PaletteWB — a sophisticated palette editor for MS Windows.

Change Log

Version 0.2

• Initial checkin
• Adding configuration options

Summary

Well, have fun. If you have any comments / ideas / issues, please submit them to db2qthelp's issue tracker on github.