Qt的Assistant制作自定义的软件帮助界面(记录)

最新推荐文章于 2024-05-03 20:45:00 发布
最新推荐文章于 2024-05-03 20:45:00 发布
阅读量1.5k 收藏 6
点赞数 1
分类专栏： C++ Qt学习
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/zj1131190425/article/details/119182863
版权

      首先，需要编写好需要展示的html文档，作为Assistant显示的帮助文档，未提高效率，选择用VSCode配合Live server插件，编写html文档。（VSCode配合Live Server真好用~_~）

                                    

目录结构如下所示：

 CSS目录中存放html文件的css样式，Documents存放html文档，pictures存放html中引用的图片：

book1.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Document</title>
    <link rel="stylesheet" href="../CSS/book1.css">
</head>
<body>
    <div class="outer">
        <div class="header-area">
            <div class="picture-area">
                <img src="../pictures/book1.jpg" alt="">
            </div>
            <div class="book-name">
                <p>红岩</p>
            </div>
        </div>
        <div class="info-table">
            <table border="1" cellspacing="3" cellpading="5">
                <caption>书籍.红岩</caption>
                <thead>
                    <tr align="center" valign="center">
                        <th>书名</th>
                        <th>作者</th>
                        <th>出版时间</th>
                        <th>价格</th>
                        <th>好评度</th>
                    </tr>
                </thead>
               <tbody>
                   <tr align="center" valign="center">
                        <td>Hongyan</td>
                        <td>Lisan</td>
                        <td>1994.6.6</td>
                        <td>￥10</td>
                        <td>90%</td>
                   </tr>
                   <tr align="center" valign="center">
                        <td>红岩</td>
                        <td>张三</td>
                        <td>1994年</td>
                        <td>$6</td>
                        <td>94%</td>
                   </tr>
               </tbody>
            </table>
        </div>
        <div class="summary-area">
            <p>
                文字是人类用符号记录表达信息以传之久远的方式和工具。现代文字大多是记录语言的工具。
                人类往往先有口头的语言后产生书面文字，很多小语种，有语言但没有文字。文字的不同体现了国家和民族的书面表达的方式和思维不同。
                文字使人类进入有历史记录的文明社会。
            </p>
        </div>
    </div>
</body>
</html>

 简单的样式book1.css

div.summary-area
{
    width: 40%;
    height: 120px;
    background-color: antiquewhite;
    align-content: center;
}

div.summary-area p
{
    font-size: 15px;
}

div.outer
{
    width: 65%;
    margin-top: 40px;
}

div.header-area
{
    margin-left: 35px;
    line-height: 65px;
    display: flex;
}

div.book-name
{
    vertical-align: center;
    line-height: 65px;
}

div.book-name p 
{
    font-weight: bold;
    font-size: 20px;
}

div.info-table table
{
    margin-left: 25px;
}

           按照重复的样式新建5个相同的html文件，后期为突出目录结构使用，同时，新建一个简单的index.html作为首页使用:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>首页</title>
    <link rel="stylesheet" href="../CSS/index.css">
</head>
<body>
    <div class="outer">
        <div class="img-area">
            <img src="../pictures/index.jpg" alt="">
        </div>

        <div class="text-area">
            <p>Welcome to the homepage</p>
        </div>
    </div>
</body>
</html>

index.css样式文件：

div.img-area img
{
    height: 150px;
    width: 165px;
    margin-left: 26px;
}

div.outer
{
    margin-top: 30px;
    margin-left: 50px;
}

div.text-area
{
    margin-top: 10px;
    height: 40px;
}

div.text-area p
{
    line-height: 40px;
    font-weight: bold;
}

在编写好基本的html文件之后，需要进行Qt Assistant的相关文件的编写。

其中需要编写两个重要的文件，分别是.qhp文件以及.qhcp文件，分别介绍这两个文件的作用：

1. qhp文件，qhp指Qt Help Project的缩写，格式为xml格式（注意在编写xml文件的时候，一定要保持文件的格式正确），其主要的作用是负责组织Assistant中       需要用到的文档(即前面编写的html文件)，其格式如下所示：

<?xml version="1.0" encoding="UTF-8"?>
<QtHelpProject version="1.0">
	<namespace>ApplicationHelp</namespace>
	<virtualFolder>doc</virtualFolder>
	<filterSection>
		<toc>
			<section title="Simple Application Help" ref="Documents/index.html">
				<section title="第一章 介绍">
					<section title="Book1 Detail" ref="Documents/book1.html"/>
					<section title="Book2 Detail" ref="Documents/book2.html"/>
				</section>
				<section title="第二章 书籍">
					<section title="Book3 Apply" ref="Documents/book3.html"/>
					<section title="book4 Apply" ref="Documents/book4.html"/>
				</section>
				<section title="第三章 应用">
					<section title="Book5" ref="Documents/book5.html"/>
					<section title="Book4" ref="Documents/book4.html"/>
				</section>
			</section>
		</toc>
		<keywords>
			<keyword name="index" ref="Documents/index.html"/>
			<keyword name="book1" ref="Documents/book1.html"/>
			<keyword name="book2" ref="Documents/book2.html"/>
			<keyword name="book3" ref="Documents/book3.html"/>
			<keyword name="book4" ref="Documents/book4.html"/>
			<keyword name="book5" ref="Documents/book5.html"/>
		</keywords>
		<files>
			<file>Documents/*.html</file>
			<file>CSS/*.css</file>
			<file>pictures/*.jpg</file>
		</files>
	</filterSection>
</QtHelpProject>

（1）encoding指编码，如果需要使用中文，需指定为GB2312，如果只有英文，可指定为UTF-8格式的编码。

（2）namespace指qhp文件的命名空间，qhp文件的命名空间必须是唯一的，这个命名空间在Assistant中会作为页面URL的第一部分。

（3）virtualFolder指定虚拟文件夹，此文件夹并不需要创建，只用来区分文件。

（4）filterSection指过滤器。过滤器部分包含了所有的目录，索引和文件列表，可以通过设置过滤器属性，实现在Assistant中指定文档是否显示。

（5）toc指 table of contents,表示目录表，在toc中创建了所有文档的目录，标题，以及文档对应的路径。

（6）keywords用于指定所有搜索的关键字以及指定的文件。在Assistant中进行搜索的时候，会显示相应的页面。

（7）files中包含了Assistant需要引用的所有的文件，图片，可使用通配符来表示。

在编写好qhp文件之后，需要对qhp文件转化为qch文件，才能被Assistant识别。qch是指Qt Compressed Help，为二进制格式的文件，是Assistant能够识别的最小单元。可通过命令

 qhelpgenerator src.qhp -o dest.qch

来生成qch文件，在生成qch文件之后，需要进行注册才能够在Assistant中进行文档的浏览。注册的方法有两种：

第一种：命令行方法 assistant -register dest.qch来进行注册。

第二种：在Assistant中，编辑-->首选项-->文档标签页-->添加/移除

通过上述方法，已经能够在Assistant中显示已经注册的文档。

如果需要在Assistant中仅仅显示我们自己编写的文档，则需要进行一些定制化的操作。

如果需要定制客户化的Assistant,则需要编写qhcp文件，qhcp指Qt help collect project的缩写，文件的格式是xml文档，起主要作用是将二进制文件qch组织成一个collect.

qhcp文件的格式如下所示：

<?xml version="1.0" encoding="utf-8" ?>
<QHelpCollectionProject version="1.0">
	<assistant>
		<title>Application Help</title>
		<startPage>qthelp://ApplicationHelp/doc/Documents/index.html</startPage>
		<homePage>qthelp://ApplicationHelp/doc/Documents/index.html</homePage>
		<applicationIcon>pictures/icon.jpg</applicationIcon>
		<enableFilterFunctionality>false</enableFilterFunctionality>
		<enableDocumentationManager>false</enableDocumentationManager>
		<enableAddressBar visible="true">true</enableAddressBar>
		<cacheDirectory>cache/data</cacheDirectory>
		<aboutMenuText>
			<text>About</text>
		</aboutMenuText>
		<aboutDialog>
			<file>Documents/about.txt</file>
			<icon>pictures/about.jpg</icon>
		</aboutDialog>
	</assistant>
	<docFiles>
		<generate>
			<file>
				<input>ApplicationInst.qhp</input>
				<output>ApplicationInst.qch</output>
			</file>
		</generate>
		<register>
			<file>ApplicationInst.qch</file>
		</register>
	</docFiles>
</QHelpCollectionProject>

(1)assistant标签中的内容是对Assistant进行一些定制化的操作，包括外观与功能，如标题，图标，缓存目录，主页，起始页，about菜单文本/对话框内容/图标。

(2)cacheDirectory表示缓存目录，在Assistant中进行全文检索时会将缓存文件放在指定的缓存目录中。

(3) startPage/homePage分别是设置Assistant的起始页和home页，这里用到Assistant页面的URL，URL的构成格式为:

qthelp://namespace(qhp文件中指定的)/doc(qhp文件中指定的虚拟文件夹)/*html

（4）Assistant可以添加或者删除文档来为多个应用程序提供帮助文档，主要依赖靠文档管理器document mamager,地址栏adress bar, 过滤器filter functionality来实现，这些功能暂时用不到，因此先关闭。

（5）About用于设置跟“关于”菜单以及对话框相关的内容，包括菜单文本，帮助对话框显示内容，图标等信息。

（6）docFiles完成文件的转换以及注册功能。

编写好qhcp文件之后，通过qcollectgenerator将qhcp文件转化为qhc文件，qhcp文件也为二进制文件，在启动assistant的时候，需要指定当前的qch文件，实现文档的注册。

在Qt中通过代码方式调用Assistant:

void ICMainWindow::slotShowInstructionBook()
{
	// 此处自定义一个说明文档，借助Qt中的assistant
	if (!m_processor)
	{
		m_processor = new QProcess();
	}

#ifdef WIN32
	// windows版本
	QString appDir = QCoreApplication::applicationDirPath();
	appDir.replace("\\", "/");
	appDir = appDir.left(appDir.indexOf("x64/Debug"));
	appDir = appDir.endsWith("/") ? appDir : appDir.append("/");

	QString cmd = appDir + "QtApp/qcollectiongenerator.exe";

	QStringList args;
	args << appDir + "doc/ApplicationInst.qhcp";

	if (m_processor->state() == QProcess::Running)
	{
		m_processor->waitForFinished();
	}

	m_processor->start(cmd, args);
	m_processor->waitForFinished();

	QString cmdAssistant = appDir + "QtApp/assistant.exe";
	args.clear();

	QString docPath = appDir + "doc/ApplicationInst.qhc";
	QFile docfile(docPath);
	if (!docfile.exists())
		return;

	QString url("qthelp://ApplicationHelp/doc/Documents/index.html");

	args << "-enableRemoteControl"; 
	args << "-collectionFile";
	args << docPath;
	args << "-showUrl";
	args << url;
	//args << "-hide" << "search";
	//args << "-hide" << "bookmarks";

	if (m_processor->state() == QProcess::Running)
	{
		QMessageBox::warning(this, tr("Warning"), tr("The Process is running, please wait for finished"));
		return;
	}

	m_processor->start(cmdAssistant, args);
	
	if (!m_processor->waitForStarted(5000))
	{
		return;
	}
	
#elif
	// linux版本
#endif
	
}

调用效果如下所示：

Alpha205
关注
  • 1
    点赞
  • 踩
  • 6
    收藏
    觉得还不错? 一键收藏
  • 5
    评论
专栏目录
Qt中文帮助文档
wx微信公众号“码农总动员”，获取更多编程知识
01-27 5396
截图   下载 获取方式一：CSDN积分下载 获取方式二：扫描下方微信公众号，回复 “112428046” ，立即获取链接。   关注 笔者 - jxd 微信公众号搜索 “码农总动员” 了解更多你不知道的XX，O(∩_∩)O ...
qt_assistant中文版
12-14
qt_assistant中文版本，可以通过中文方便地查看QT官方所提供的接口， 当然对英文特别好的，就没什么必要了。
自定义软件帮助文档（qt assistant实现）
biao2488890051的博客
02-11 1237
qt creator本身也是通过后台外部进程来调用qt assistant实现的技术文档浏览功能（可以指定一些配置参数，从而实现控制这个文档浏览软件的图标，菜单栏等，从而匹配自己的软件风格是一体的，此外设置这个进程的的父窗口为我们的软件窗口，就能实现融合一体。这里主要了解了一下qt assistant，这个是通过当作后台外部进程的方式来使用的， 如果我们想要看它的源码，也是可以的，），但是可能改动了其源码，使得界面控件显示都不一样了的，当然我们也可以按照上面说的源码进行改动来实现我们自己的文件浏览器。
初识QT助手和语言家
最新发布
qq_52137592的博客
05-03 812
Qt助手（Qt Assistant）是一款针对Qt框架及其各种组件说明的在线文档工具，它提供了关于Qt框架和各种组件的详细信息，包括类和函数的文档、示例代码和教程等，可以方便快速地查找和浏览，对于学习和使用Qt非常有帮助Qt Linguist（Qt语言家）用于管理和翻译Qt应用程序，它提供一个图形用户界面，开发者可以在其中查看和编辑应用程序的翻译文件，方便地为应用程序添加多语言支持。
Qt Assistant介绍
weixin_33690963的博客
12-06 955
简介 Qt Assistant也就是我们常说的Qt助手，是一款用于呈现在线文档的工具。 简介 一分钟学会使用 Qt参考文档 Qt Assistant详解 命令行选项 工具窗口 文档窗口 工具栏 菜单 文件菜单 编辑菜单 查看菜单 前往菜单 书签菜单 帮助菜单 对话框 打印对话框 首选项对话框 查找文本控制 ...
QT Assistant 开发自己的帮助文档
Beyond欣
08-09 4001
QT Assistant 开发自己的帮助文档QT Assistant使用QT Assistant开发自己软件帮助文档创建文档并自定义Qt助手为Qt助手组织文档自定义qt助手通过助手类控制qt助手主窗口类findFileDialog类总结 QT Assistant使用 qt自带Qt Assistant，大家叫 qt助手，写的很全面，很实用，当你需要什么功能时候按下F1，打开看看你会发现qt官方基本上...
第47篇 进阶（七） 定制Qt帮助系统
林中静月下仙的博客
12-13 796
使用Qt定制帮助系统，可以制作功能强大的上下文相关的帮助文档，而对于一个优秀的软件而言，帮助菜单是必须有的。
QT_assistant_简体中文.zip
07-02
QTAssistant是Qt开发框架中的一个重要组件，它是Qt的官方文档查看工具，为用户提供方便的API文档浏览和搜索功能。在“QT_assistant_简体中文.zip”这个压缩包中，包含的是Qt Assistant的简体中文版本，对于那些不...
Qt_assistant简体中文版
10-07
【Qt Assistant简体中文版】是Qt开发框架中不可或缺的一部分，它是Qt官方提供的一款强大的帮助文档查看工具。在Qt的开发过程中，理解并熟练运用各种类库和函数至关重要，而Qt Assistant正好为开发者提供了这样的便利...
QT 帮写软件帮助文档
05-10
6. **Qt Assistant API**：理解和使用Qt Assistant的API可以帮助开发者自定义帮助系统的外观和行为，比如添加自定义的搜索过滤器或扩展功能。 7. **QMake或CMake**：这两个是常用的构建系统，用于管理QT项目的依赖...
Qt_assistant中文版手册.chm
10-31
Qt Assistant 是一个强大的帮助系统，是Qt库的一部分，用于提供对应用程序或开发框架的文档支持。它可以帮助开发者快速查找、理解和学习Qt库的各种功能，提高开发效率。这个`.chm`（Compiled HTML Help）文件是微软...
qt_assistant.zip
10-11
6. **自定义界面**：用户可以根据个人喜好调整字体大小、颜色主题等，提升阅读体验。 在"qt_assistant.zip"压缩包内，`qt_assistant.chm`是主程序文件，通常为帮助文件的格式，用户解压后双击即可打开QT Assistant...
qt生成帮助文档过程
qiushangren的专栏
09-08 4157
qt生成帮助文档过程 .qdocconf .qhp .qhc .qch .qhcp
Qt 项目用 doxygen 生成 .qch，嵌入文档到 Assistants
03-09 1672
文章目录背景简洁流程具体例子系统环境书写注释设置 doxygen 参数生成 html + qhp注册 .qch下载地址：集成 DTK 开发手册到 Qt Assistants参考 简 述：　想着，将项目 API 的文档，能够生成离线版嵌入 Qt 助手 那样就方便很多，或者直接在 Qt Creator 里面点击帮助查看。 ​ 本文讲述如何将 Qt / C++ 代码函数注释，解析生成 html 网页，生成 .qhp 后转换为 .qch，然后注册到 Qt Assistants 里面查看。附上集成 DTK
Qt学习——利用Qt Assistant 定制帮助文档
偷得浮生半日闲
10-13 3371
环境：windows10+Qt5.10.1 一、概述 Qt可以通过QtAssistant为自己的应用程序编制帮助文档，文件目录架构如下： helpdocument │ about.txt //说明 │ assistant.exe │ help.qch // .qhp生成 │ help.qhc // .qhcp生成 │ help.qhcp// 帮助文档窗口界面描述 │ he...
Qt入门学习——Qt Creator的使用
热门推荐
顺其自然~专栏
05-02 1万+
Qt Creator介绍 通过前面《Qt快速入门（vim纯代码编写）》的学习得知，只有搭建好了 Qt 环境（Qt库和开发工具），即可通过 vim 纯代码编写 Qt 程序，再借助 Qt 里的 qmake 工具编译 Qt 代码，具体流程如下： 1）编写 Qt 代码 2）通过 qmake -project 生成工程文件 3）工程文件中添加所需模块：QT += widgets 4）根据工程文件用 qmake 命令生成 Makefile 5）通过 make 编译代码生成所需可执行程序 6）通过..
Qt—帮助系统
Half-up的博客
04-13 2331
一个完善的应用程序应该提供尽可能丰富的帮助信息。Qt中可以使用工具提示、状态提示以及“What’s This”等简单的帮助提示,也可以使用Qt Assistant来提供强大的在线帮助。 简单的帮助提示 已经讲到了工具提示和状态提示,这里简单介绍“What’s This”帮助提示运行一个对话框窗口时会看到,在标题栏中有一个“?”图标,按下它就会进入“WhatThis”模式,这时如果哪个部件设置了“What’s This”帮助提示,那么当鼠标移动到它面时就会弹出一个悬浮的文本框显示相应的帮助提示。下面来看一个具
利用qt制作帮助文档
yanchong_RD的专栏
04-29 8065
<br />利用qt制作帮助文档<br /> 创建文档和自定义的qt assistant<br />1.         创建文档即是一些html文件，这里可以使用qt提供的工具像是qdoc 和Doxygen生成帮助的html文档。<br />2.         组织文档结构用于qt assistant<br />a)         创建qt help project(.qhp)<br />                         i.              定义命名空间命名空间必须是唯一的
关于利用Qt编写应用程序的帮助文档
流浪汉
08-30 3710
转载请注明出处！ 关于利用Qt编写应用程序的帮助文档 首先推荐Qt官网的example 官网的例子讲的很细致很全面，不过官网的例子全是英文的。百度文库里有对这个例子的翻译，我也看了一下，感觉还不如去看英文的。好的言归正传。 讲一下大概的步骤 1、准备.html文件（里面就是我们大家经常看到的关于应用程序的文字说明） 2、编写.qhp文件（来管理你的html文件） 3、调用qhe
qt assistant制作自己的帮助文档
12-16
Qt Assistant可以用来制作自己的帮助文档，以下是制作步骤： 1. 准备文档内容：首先，需要准备好帮助文档的内容。这些内容应该包括软件的功能说明、操作指南、常见问题解答等。 2. 编写文档：使用Qt Assistant提供的编辑器，可以方便地进行帮助文档的编写。可以使用Markdown等格式进行排版，并插入图片、链接等元素。 3. 构建帮助文档：在Qt Assistant中，选择菜单中的“文件”->“新建项目”，然后选择“帮助文档集合”。通过添加帮助文档和索引条目，来构建整个帮助文档集合。可以将不同的主题分成不同的帮助文档，并为每个主题添加索引条目，以方便用户查找。 4. 样式设计：Qt Assistant提供了一些默认的样式，可以根据自己的需求进行调整。可以修改文本字体、颜色、背景等，以使帮助文档更符合自己的品牌形象。 5. 导出帮助文档：在构建完成后，可以选择导出帮助文档。可以选择导出为CHM格式、HTML格式或者Qt Assistant专属的QCH格式。根据需要选择合适的导出格式，并保存到相应的位置。 通过以上步骤，我们可以使用Qt Assistant制作出符合自己需求的帮助文档。制作好的文档可以方便地嵌入到自己的软件中，提供给用户操作指南和解决问题的帮助。同时，Qt Assistant还提供了一些高级功能，比如全文搜索、自定义链接等，进一步提升了用户的使用体验。
评论 5
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值