![]() Then we ask the engine for the links assigned to the identifier, in this case MyDialog::ChangeButton. The first step is to create an instance of the help engine. Retrieving help data from the file engine does not involve a lot of code. Showing the help in a QTextBrowser is probably the most common way, but embedding it in What's This help is also perfectly possible. The contents can then be retrieved via the QHelpEngine class and can be displayed in nearly any form. Instead of showing the help in an external application such as a web browser, it is also possible to embed the online help in the application. QHelpEngine allows embedding the help contents directly in an application. Of course, it is possible to specify more than one file in the generate or register section, so any number of compressed help files can be generated and registered in one go. After specifying all the relevant information in this file, it needs to be compiled by calling: Once the HTML documents are in place, a Qt Help Project file, with an extension of. It can contain references to any number of compressed help files as well as additional information.īuilding help files for the Qt help system assumes that the HTML documentation files already exist. The help collection file that QHelpEngine operates on. This file can be passed to the help generator for creating a help collection file. This file is passed to the help generator for creating a compressed help file.Ĭontains all the information specified in the help project file along with all the compressed documentation files.Īn XML file that contains references to the compressed help files that should be included in the help collection. It also defines a unique namespace for the documentation. So, in general, there are four files interacting with the help system, two used for generating Qt help and two meant for distribution:Ĭontains the table of contents, indices, and references to the actual documentation files (*.html). ![]() The collection file is optional since any existing collection file, for example from an older release, could be used. Instead, only the compressed help file and, optionally, the collection file have to be distributed. This requires, however, that the attributes have been assigned to the help contents before the generation of the compressed help file.Īs already mentioned, the Qt compressed help file contains all data, so there is no need any longer to ship all the single HTML files. Therefore, the Qt help system offers the possibility to filter the help contents after certain attributes. So, when only seeing a keyword in the index and activating it, you cannot be sure that the expected documentation will be shown. For example, one index keyword may be defined in different documentation sets. ![]() However, having collection files to merge many documentation sets may lead to some problems. Therefore, the Qt help system operates on help collection files, which include any number of compressed help files. Ideally, it should also be possible to reference certain points of interest of one manual to another. Instead, more manuals, which should be accessible at the same time, exist. Since most products are more comprehensive and consist of a number of tools, one manual is rarely enough. So, one such a help file represents usually one manual or documentation set. The actual help data, meaning the table of contents, index keywords, or HTML documents, is contained in Qt compressed help files. In addition, it provides classes for accessing help contents programmatically to be able to integrate online help into Qt applications. The Qt help system includes tools for generating and viewing Qt help files.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |