Qt (8)-2 How to create QtHelp Files.

Published on| June 26th, 2009 | No Comment.

Categories:Qt |

Description:
In Qt, Windows as a change in the HTML Help QtAssistant.

(Listed in the article.

)
QtAssistant this, the original file (SQLite3 format) files and qhc qch file is required.

(Windows in the HTML equivalent to chm Help file.

)

In this article, the HELP file for QtAssistant (qch files, qhc file) that describes how to create.

Articles: Qt (8) QtAssistant the GUI of the Japanese
Articles: http://doc.trolltech.com/4.5/qthelp.html

Sample source code you used here:

Sample 12 Qt

HELP QtAssistant for files

HELP QtAssistant for the file, there are two types of files.

File Type

Commentary

. qch file

Q t C ompressed H elp ie files, HTML documents are written in (including attached images and other information) to the SQLite3 database file is a summary.

Commpressed say, in fact, zlib compression and the like seems like it is not.

(However, I personally feel, good, great size.

)

Create qhelpgenerator command.

. qhc file

Q t H elp C ollection simply files,. Qch more files, SQLite3 files are compiled into a database.

HTML entities in the document, only,. Qch file.

This file,. Qch makes file management, as search and use.

Create qcollectiongenerator command.

Furthermore, these two original files exist for each file type.

File Type

Commentary

. qhp file

Q t H elp P roject file
Documents written in HTML (including images and information included) for managing a single project as an XML-based file.

Commpressed say, in fact, zlib compression and the like seems like it is not.

(However, I personally feel, good, great size.

)

qhelpgenerator command. qch into files.

. qhcp file

Q t H elp P roject C ollection multiple files (or one). Qch files, one for the management of a collection of XML-based file.

Here, QtAssistant You can also customize some parts of the screen.

qcollectiongenerator command. qhc into files.

When you organize, you will see the following.

HELP project file (.qhp) ->.qch
HELP project Collection file (.qhcp) ->.qhc

Hey, it's complicated.

But here, as if caught, you may be able to understand somehow.

HTML Project Management
Management of the entire collection

Window in the HTML Help, and was organized as follows.

. hhc file (File Index)
. hhk file (Summary Administration)
. hhp file (Project Management)

These two files,. Chm files (HTML Help file) is created.

ini file format and XML format differences and, where writing is different, the basic information necessary for creating HTML help files, Qt good idea if you need any help.

Later, so please have a detailed description of the item.

Qt will help the former, HELP project file (. Qhp), HELP project Collection file(.qhcp) later explained the structure of a simple, Qt Let's create a Help file.

About HELP project file (. Qhp)

HELP project file (. Qhp) is, XML format, typically written in UTF8.

First, let's look at a simple example.

<?xml version="1.0" encoding="UTF-8"?>
    <QtHelpProject version="1.0">
    <namespace>Sample_Help</namespace>
    <virtualFolder>doc</virtualFolder>
    <customFilter name="Sample Help 1.0">
        <filterAttribute>Sample Help Application</filterAttribute>
        <filterAttribute>1.0</filterAttribute>
    </customFilter>
    <filterSection>
        <filterAttribute>Test Help Application</filterAttribute>
        <filterAttribute>1.0</filterAttribute>
        <toc>
            <section title="Sample Help" ref="index.html">
                <section title="Chapter 1" ref="doc1.html"/>
                <section title="Chapter 2" ref="doc2.html"/>
                <section title="Chapter 3" ref="doc3.html"/>
            </section>
        </toc>
        <keywords>
            <keyword name="keyword1" id="TestHelp::key1" ref="doc1.html"/>
            <keyword name="keyword2" ref="doc2.html"  />
            <keyword id="TestHelp::key2" ref="doc3.html"/>
        </keywords>
        <files>
            <file>index.html</file>
            <file>doc1.html</file>
            <file>doc2.html</file>
            <file>doc3.html</file>
            <file>img1.png</file>
            <file>img2.png</file>
            <file>img3.png</file>
        </files>
    </filterSection>
</QtHelpProject>

Here, the following four are described as HTML in the document already.

index.html
doc1.html
doc2.html
doc3.html

The first line, XML declaration and the letter code specifying the format.

The second line, Qt is the specified version of the Help project.

At 2009.6, "1.0" is the latest.

Looking at this, the Qt help recently, you'll see that it was introduced.

3 for each subsequent tag line, easily explained in the following table.

HELP project file (. Qhp)

TAG Name	Commentary
Namespace	The name of this project (the address for access to this project)
virtualFolder	Virtual directory name (Namespace will continue to addresses)
filterSection	Filter definition You define the default filter. To define this filter, you can set the tag of the following more detailed. filterAttribute Tags: filter name, and defines the version. toc Tags: Defines the content tree. Here, section by using the tag information to display the tab content and specify the order by the hierarchy. keywords tags: Define the index. Here, keyword tags are used to specify the keywords to display the Index tab. files Tag: HTML to define the file is used in the document. Here, file that uses tags, HTML defines all files used in the document.
customFilter	Define custom filters filterSection tags can be defined as a filter to select the bar, or just to show the definition here.

Here, the point is to note, HTML is that you have to define all the files used in the document.

Related to files and images, CSS files, js must be aware that you must specify all the files.

If you specified only the HTML file with the HTML Help Workshop of Windows, the tool will take the file related to the HTML file automatically specified.
But Qt's Help command do not work.

As might be expected, this has a sense of closure.

(Soon, I want to improve.

)

Continues, HELP Project Collection file(.qhcp) I would like to discuss.

Pages: 1 2

Recent Posts

Qt (8)-2 How to create QtHelp Files.

You might also like:

Contents

Tag Cloud

Links

Site Description

Add to your favorites(bookmarks)