Qt6 Help Framework

Table of Contents

Index keywords

The index allows mapping keywords to an HTML file and section, so contextual help can be activated based on what the user is doing.

HTML documents

Help text consists of HTML5

Compressed archive

Documentation is compressed in to projects and then bundled in to collections.

Project files

Namespace

Identifier for the archive. Embedded inside, intended to be indexed at runtime and separates the file name.

Virtual folder

Mechanism for virtually merging help files together.

Treated as the root of all help files referenced by this help file.

All referenced help files with the same virtual folder are merged virtually. Files are first matched in the local help, then the foreign helps if not found. This allows you to use relative links in the documentation--treating it as though you had put all the help files in one big folder on a web erver to begin with.

Filter sections

Hold table of contents, mapping of keywords to filenames and header anchors, and a list of files stored within the section.

Help collections

Stores multiple compressed help files (the product of project files.)