示例清单文件

QDoc 生成包含关于所有文档示例信息的 example-manifest.xml 文件。这些文件由 Qt Creator 用于在欢迎屏幕中展示示例列表并将文档链接到它们。

清单 XML 结构

清单文件具有以下结构

<?xml version="1.0" encoding="UTF-8"?>
<instructionals module="QtGui">
    <examples>
        <example
            name="Analog Clock Window"
            docUrl="qthelp://org.qt-project.qtgui.502/qtgui/analogclock.html"
            projectPath="gui/analogclock/analogclock.pro"
            imageUrl="qthelp://org.qt-project.qtgui.502/qtgui/images/analogclock-window.png">
            <description><![CDATA[The Analog Clock Window example shows how
                to draw the contents of a custom window.]]></description>
            <tags>analog,clock,window</tags>
            <fileToOpen>gui/analogclock/main.cpp</fileToOpen>
        </example>
        ...
    </examples>
</instructionals>

每个 <example> 元素包含关于名称、描述、项目文件和文档的位置以及与示例相关联的标签列表信息。

清单元内容

可以使用 manifestmeta 配置命令向清单文件添加额外的元内容，即针对所选示例的额外属性和标签。

元内容的一个用途是突出显示多个重要示例。另一个用途是通过为某个类的示例添加相关关键词作为标签来改进搜索功能。

应用于哪些示例的元内容是通过一个或多个过滤器指定的。根据名称进行匹配，每个示例名称前缀为模块名称和一个正斜杠。支持简单的通配符匹配；使用 * 作为结尾，可以匹配多个与单个字符串匹配的示例。

示例

manifestmeta.filters                = highlighted sql webkit global

manifestmeta.highlighted.names      = "QtGui/Analog Clock Window" \
                                      "QtWidgets/Analog Clock"
manifestmeta.highlighted.attributes = isHighlighted:true

manifestmeta.sql.names              = "QtSql/*"
manifestmeta.sql.tags               = database,sql

manifestmeta.webkit.names           = "QtWebKitExamples/*"
manifestmeta.webkit.tags            = webkit

manifestmeta.global.names           = *
manifestmeta.global.tags            = qt6

在上文中，向两个示例中添加了 isHighlighted 属性。如果省略属性值，QDoc 默认使用字符串 true。为 Qt WebKit 和 Qt SQL 示例添加了额外标签，并使用 * 只作为匹配字符串将另一个标签应用于所有示例。

支持衍生项目