{"id":37738708,"url":"https://github.com/dkrajzew/db2qthelp","last_synced_at":"2026-01-20T16:51:09.219Z","repository":{"id":65186645,"uuid":"584910415","full_name":"dkrajzew/db2qthelp","owner":"dkrajzew","description":"A DocBook to QtHelp converter.","archived":false,"fork":false,"pushed_at":"2025-08-24T13:30:44.000Z","size":168,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-08T15:28:27.214Z","etag":null,"topics":["docbook","documentation","qt","qthelp"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dkrajzew.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-03T20:44:17.000Z","updated_at":"2025-08-24T13:27:18.000Z","dependencies_parsed_at":"2024-11-15T13:44:50.081Z","dependency_job_id":"41e1e20c-9eaa-4c76-9b6d-878b94c30642","html_url":"https://github.com/dkrajzew/db2qthelp","commit_stats":{"total_commits":50,"total_committers":2,"mean_commits":25.0,"dds":"0.33999999999999997","last_synced_commit":"76dbd146378df80caba1a55603350e5e60b67a47"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/dkrajzew/db2qthelp","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dkrajzew%2Fdb2qthelp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dkrajzew%2Fdb2qthelp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dkrajzew%2Fdb2qthelp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dkrajzew%2Fdb2qthelp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dkrajzew","download_url":"https://codeload.github.com/dkrajzew/db2qthelp/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dkrajzew%2Fdb2qthelp/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28479091,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T11:59:17.896Z","status":"ssl_error","status_checked_at":"2026-01-16T11:55:55.838Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docbook","documentation","qt","qthelp"],"created_at":"2026-01-16T14:04:06.519Z","updated_at":"2026-01-16T14:04:07.244Z","avatar_url":"https://github.com/dkrajzew.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![License: GPL](https://img.shields.io/badge/License-GPL-green.svg)](https://github.com/dkrajzew/db2qthelp/blob/main/LICENSE)\n[![PyPI version](https://badge.fury.io/py/db2qthelp.svg)](https://pypi.org/project/db2qthelp/)\n![test](https://github.com/dkrajzew/db2qthelp/actions/workflows/test.yml/badge.svg)\n[![Downloads](https://static.pepy.tech/badge/db2qthelp)](https://pepy.tech/projects/db2qthelp)\n[![Downloads](https://static.pepy.tech/badge/db2qthelp/week)](https://pepy.tech/projects/db2qthelp)\n[![Coverage Status](https://coveralls.io/repos/github/dkrajzew/db2qthelp/badge.svg?branch=main)](https://coveralls.io/github/dkrajzew/db2qthelp?branch=main)\n[![Documentation Status](https://readthedocs.org/projects/db2qthelp/badge/?version=latest)](https://db2qthelp.readthedocs.io/en/latest/?badge=latest)\n\n__db2qthelp__ \u0026mdash; a DocBook book to QtHelp project converter\n\n# Introduction\n\n__db2qthelp__ converts a [DocBook](https://docbook.org/) [book](https://tdg.docbook.org/tdg/4.5/book.html) to a [QtHelp](https://doc.qt.io/qt-5/qthelp-framework.html) project. It is written in [Python](https://www.python.org/) and started on the command line.\n\n__db2qthelp__ is in an early stage of development. It works well for me but it may work with my setup only. I try to make it usable nonetheless, so let me know if something does not work. Thanks.\n\n\n# Usage\n\nGiven that your [xsltproc](https://gitlab.gnome.org/GNOME/libxslt) together with your [DocBook](https://docbook.org/) look-up paths are set up and that the [Qt](https://www.qt.io/) applications needed to build [Qt](https://www.qt.io/) Help files are in your executable path, you may convert your [DocBook](https://docbook.org/) book into [Qt](https://www.qt.io/) Help files like this:\n\n```console\ndb2qthelp.py -i userdocs.xml\n```\n\nThat\u0026#39;s all \u0026#x1F603;. You\u0026#39;ll get a .qch and a .qhc file you may use directly in your [Qt](https://www.qt.io/) Help widget\u0026#8230;\n\n## Options\n\nThe script has the following options:\n\n* **--config *\u0026lt;FILE\u0026gt;*** / **-c *\u0026lt;FILE\u0026gt;***: Reads the named configuration file\n* **--input *\u0026lt;INPUT\u0026gt;*** / **-i *\u0026lt;INPUT\u0026gt;***: Defines the DocBook HTML document to parse\n* **--destination *\u0026lt;DESTINATION\u0026gt;* / **-d *\u0026lt;DESTINATION\u0026gt;***: Sets the output folder\n* **--appname *\u0026lt;APPNAME\u0026gt;*** / **-a *\u0026lt;APPNAME\u0026gt;***: Sets the name of the application\n* **--css-definition *\u0026lt;CSS_DEFINITION\u0026gt;***: Defines the CSS definition file to use\n* **--generate-css-definition**: If set, a CSS definition file is generated\n* **--qhp-template *\u0026lt;QHP_TEMPLATE\u0026gt;***: Defines the QtHelp project (.qhp) template to use\n* **--generate-qhp-template**: If set, a QtHelp project (.qhp) template is generated\n* **--qt-path *\u0026lt;QT_PATH\u0026gt;*** / **-Q *\u0026lt;QT_PATH\u0026gt;***: Sets the path to the Qt binaries\n* **--xslt-path *\u0026lt;XSLT_PATH\u0026gt;*** / **-X *\u0026lt;XSLT_PATH\u0026gt;***: Sets the path to xsltproc\n* **--help** / **-h**: show this help message and exit\n* **--version**: show program\u0026#39;s version number and exit\n\n\n## Examples\n\n```shell\ndb2qthelp -i userdocs.xml\n```\n\nGenerates Qt Help files by processing the DocBook book ```userdocs.xml```. The default CSS style sheets will applied, the used binaries are assumed to be in the path.\n\n```shell\ndb2qthelp -i userdocs/ --css-definition my_style.css\n```\n\nWill collect the HTML files located in the folder ```userdocs```, apply the CSS located in ```my_style.css```, and build the Qt Help files from all files found in the given folder.\n\n\n## Documentation\n\n* The complete documentation is located at \u003chttps://db2qthelp.readthedocs.io/en/latest/\u003e\n* The github repository is located at: \u003chttps://github.com/dkrajzew/db2qthelp\u003e\n* Discussions are open at \u003chttps://github.com/dkrajzew/db2qthelp/discussions\u003e\n* The issue tracker is located at: \u003chttps://github.com/dkrajzew/db2qthelp/issues\u003e\n* The PyPI page is located at: \u003chttps://pypi.org/project/db2qthelp/\u003e\n* The code documentation (pydoc) is located at: \u003chttp://www.krajzewicz.de/docs/db2qthelp.html\u003e\n\n\n## Installation\n\nThe current version is 0.4.0. You may install the latest release using pip:\n\n```console\npython -m pip install db2qthelp\n```\n\nOr download the [latest release](https://github.com/dkrajzew/db2qthelp/releases/tag/0.4.0) from github. You may as well clone or download the [db2qthelp git repository](https://github.com/dkrajzew/db2qthelp). There is also a page about [installing db2qthelp](install.md) which lists further options.\n\n\n## License\n\n**db2qthelp** is licensed under the [GPLv3 license](https://raw.githubusercontent.com/dkrajzew/db2qthelp/refs/heads/main/LICENSE).\n\n\n# Examples / Users\n\n**db2qthelp** was used to generate the in-app help for the following applications:\n\n* [PaletteWB](https://www.palettewb.com), an MS Windows application for editing color palettes;\n* [ShaderWB](https://www.krajzewicz.de/blog/shaderwb.php), an MS Windows application for developing GLSL shaders.\n\n# ChangeLog\n\n## db2qthelp-0.4.0 (24.08.2025)\n\n* code\n    * added support for direct processing of [DocBook](https://docbook.org/) books\n    * added suport for processing chuncked [xsltproc](https://gitlab.gnome.org/GNOME/libxslt) HTML output\n    * moved to argparse / configparser\n    * refactoring\n* deployment\n    * added installation as a directly callable console script\n* tests\n    * added coveralls integration (![test](https://github.com/dkrajzew/db2qthelp/actions/workflows/test.yml/badge.svg))\n    * improved tests (![test](https://github.com/dkrajzew/db2qthelp/actions/workflows/test.yml/badge.svg))\n* docs\n    * reworked documentation\n    * added automatic [readthedocs](https://db2qthelp.readthedocs.io/) docs building ([![Documentation Status](https://readthedocs.org/projects/db2qthelp/badge/?version=latest)](https://db2qthelp.readthedocs.io/en/latest/?badge=latest))\n* moved to GPLv3\n\n\n## db2qthelp-0.2 (07.01.2023)\n\n* Initial checkin\n* Adding configuration options\n* Adding a documentation\n* Adding first tests\n\n\n# Summary\n\nWell, have fun. If you have any comments / ideas / issues, please submit them to [db2qthelp's issue tracker](https://github.com/dkrajzew/db2qthelp/issues) on github.\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdkrajzew%2Fdb2qthelp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdkrajzew%2Fdb2qthelp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdkrajzew%2Fdb2qthelp/lists"}