QT系列——幫助文檔

Qt可以使用自帶工具生成定制化的幫助文檔。

本文主要是說明如何將html格式的幫助文件生成定制化幫助文檔的過程。html格式的文件由手動寫或者通過轉換工具進行轉換獲得，這里不包含此過程的內容。

想創建幫助文檔，需要了解四種文件，分別是qhp和qch、qhcp和qhc。初看這些名字很容易懵，跟隨下述步驟，分別了解這四種文件。

1.創建qhp文件。

qhp：全稱Qt Help Project，Qt幫助項目文件。

該文件是XML格式，用于組織HTML格式的幫助文檔。

該文件需要設置命名空間，命名空間作為標識符必須唯一，用于幫助引擎能夠檢索到給定鏈接的適當文檔。設置虛擬文件夾，使文檔集可以共享虛擬文件夾。該文件中列出了所有html的路徑，以及目錄結構，建議不要嵌套過度。

qch：全稱Qt Compressed Help，QT壓縮幫助文件。

該文件由qhp文件通過工具qhelpgenerator生成。

該文件是二進制格式， 包含幫助項目文件中指定的所有信息以及所有壓縮文檔文件。。

qhp示例：

demo.help doc

2.創建qhcp文件

qhcp：全稱Qt Help Collection Project，Qt幫助集合項目文件。

該文件是xml格式。該文件支持標題、首頁、圖表等設置，用于定制化。

qhc：全稱Qt Help Collection，是Qt幫助收集文件。

該文件由qhcp文件通過工具qcollectiongenerator生成。

該文件是二進制文件，包含對任意數量的壓縮幫助文件的引用以及附加信息，。

qhcp示例：

image/圖標.png cache/demohelp qthelp://demo.help /doc/幫助文檔.html qthelp://demo.help /doc/幫助文檔.html 關于 ./about.txt image/圖標.png false false false demohelp.qch

3.生成qhc文件和qch文件。

使用qhelpgenerator工具可以將qhp文件生成qch文件：

qhelpgenerator demohelp.qhp –o demohelp.qch

使用qcollectiongenerator工具可以將qhcp文件生成qhc文件:

qcollectiongenerator demohelp.qhcp –o demohelp.qhc

4打開qhc文件

通過Qt Assistant工具打開qhc文件。

總結：

Qt可以使用自帶工具進行定制化制作幫助文件，步驟總結如下：

先制作qhp文件；

再制作qhcp文件，

通過工具可以分別生成qhc文件和qch文件。

最后打開qch文件，就可以看見制作完成的幫助文檔啦。

Qt

版權聲明：本文內容由網絡用戶投稿，版權歸原作者所有，本站不擁有其著作權，亦不承擔相應法律責任。如果您發現本站中有涉嫌抄襲或描述失實的內容，請聯系我們jiasou666@gmail.com 處理，核實后本網站將在24小時內刪除侵權內容。