使用Qt Assistant

您可以在“文档”窗口中阅读文档。要在新标签页中打开某个主题，请在“目录”窗口中右键单击该主题以打开上下文菜单，然后选择“在新标签页中打开链接”。所有已打开的主题都会列在“打开的页面”窗口中。选择一个主题即可在“文档”窗口中查看。

若希望“文档”窗口尽可能占据更多空间，您可以轻松地对侧边栏窗口进行分组、移动或隐藏。要分组窗口，请将一个窗口拖动到另一个窗口上方，然后松开鼠标。如果一个或所有侧边栏窗口未显示，请使用键盘快捷键将其显示出来。您可以在“视图”菜单中查看键盘快捷键。

侧边栏窗口可停靠在主窗口上，因此您可以将它们拖动到主窗口的顶部、左侧、右侧或底部；或者将它们拖出Qt Assistant 范围，使其作为独立窗口悬浮显示。

若要更改显示文档的浏览器窗口或应用程序本身的字体家族和字号，请选择“编辑”>“首选项”>“字体”。

若要在“文档”窗口中临时增大或减小字体大小，请选择“视图”>“放大”或“缩小”。要恢复字体大小，请选择“视图”>“正常大小”。

要在页面之间导航，请选择“转到”>“上一页”或“下一页”。这将带您转到历史记录中的上一页或下一页。要返回主页，请选择“转到”>“主页”。要指定主页，请选择“编辑”>“首选项”>“选项”。

若要将“目录”窗口与“文档”窗口中当前显示的页面同步，请选择“转到”>“与目录同步”。

地址工具栏提供了一种快速输入文档文件特定 URL 的方法。要显示地址工具栏，请选择“视图”>“工具栏”>“地址工具栏”。

从页面内容中搜索

要在当前页面中查找文本，请选择“编辑”>“在文本中查找”。在字段中输入搜索词。该搜索支持增量搜索，即在字段中输入字符时，会显示最相关的结果。

如果选中“区分大小写”复选框，搜索将考虑搜索词的大小写。例如，如果搜索“spin”，则会匹配“spin”，但不会匹配“Spin”。

若要从当前页面位置向前或向后搜索，请单击“上一项”或“下一项”。

要隐藏查找控件，请单击“关闭”或按下Esc 键。

全文搜索

Qt Assistant 搜索菜单的截图，用于浏览文档" src="images/assistant-search.png" title="Qt Assistant 搜索菜单的截图，用于浏览文档"/>

Qt Assistant 提供了一个强大的全文搜索引擎。您可以在“搜索”窗口中搜索特定的单词或文本。输入要查找的文本，然后按Enter 键或单击“搜索”。搜索不区分大小写。例如，“Foo”、“fOo”和“FOO”都被视为相同。

您可以使用FTS 查询语法创建复杂的查询。

以下是常见搜索模式的示例：

• deep – 列出所有包含单词deep的文档
• deep* – 列出所有包含以deep开头的单词的文档
• deep copy – 列出同时包含“deep ”和 “copy”的所有文档
• "deep copy" – 列出所有包含短语“deep copy”的文档

检索到的文档列表会根据其中搜索文本的出现次数进行排序，出现次数最多的文档排在最前面。只需点击列表中的任何文档，即可在“文档”窗口中显示该文档。

如果文档发生了变化（例如，添加或删除了文档），Qt Assistant 将重新对其进行索引。

筛选帮助内容

Qt Assistant 允许您安装任何类型的文档，只要它们以 Qt 压缩帮助文件 (*.qch) 的形式组织即可。例如，您可以同时查看多个 Qt 版本的 Qt 参考文档。 从许多方面来看，这非常方便，因为只需一个版本的Qt Assistant 即可。然而，在执行索引搜索等任务时，情况会变得更为复杂，因为大多数关键词在多个 Qt 版本中都有定义。这意味着Qt Assistant 总是会要求用户选择应显示哪个版本。

我们使用文档过滤器来解决这个问题。过滤器通过其名称进行标识，并包含一组过滤器属性。属性只是一个字符串，可以自由选择。属性由文档本身定义，这意味着每个文档集通常都有一个或多个属性。

例如，Qt Assistant 文档集定义了assistant 和tools 这两个属性，而Qt Widgets Designer 则定义了designer 和tools 。若要显示所有工具，过滤器只需定义tools 这一属性，因为该属性同时存在于这两个文档集中。 若将属性assistant 添加到筛选器中，则只会显示Qt Assistant 中的文档，因为Qt Widgets Designer 中的文档不包含该属性。筛选器中的属性列表为空时，将匹配所有文档。也就是说，这相当于请求未经过筛选的文档。

要创建和删除文档过滤器，请选择“编辑”>“首选项”>“过滤器”。

要添加新过滤器，请单击“添加”，指定过滤器名称，然后单击“确定”。接着在“属性”字段中选择过滤器属性。

要删除过滤器，请选中该过滤器并单击“删除”。

通过筛选器工具栏，您可以对当前安装的文档应用筛选器。要显示筛选器工具栏，请选择“视图”>“工具栏”>“筛选器工具栏”。

添加文档

要安装和删除压缩帮助文件，请选择“编辑”>“首选项”>“文档”。

单击“安装”按钮，然后选择要安装的压缩帮助文件（*.qch）的路径。要删除帮助文件，请在列表中选择一组文档，然后单击“删除”。

指定主页

要指定点击“主页”按钮时Qt Assistant 显示的主页，请选择“编辑”>“首选项”>“选项”。

输入主页的 URL，或选择“当前页面”将当前显示的页面设为主页。若要将主页留空，请选择“空白页面”。选择“恢复为默认值”可将主页重置为默认主页。

使用命令行选项

Qt Assistant 支持以下命令行选项：