En esta página

Ejemplos de archivos de manifiesto

QDoc genera archivos example-manifest.xml que contienen información sobre todos los ejemplos documentados. Qt Creator utiliza estos archivos para mostrar una lista de ejemplos en su pantalla de bienvenida y para enlazar con su documentación.

Estructura XML del manifiesto

Un archivo de manifiesto tiene la siguiente estructura:

<?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>

Cada elemento « <example> » contiene información sobre el nombre, la descripción, la ubicación del archivo del proyecto y la documentación, así como una lista de etiquetas asociadas al ejemplo.

Contenido meta del manifiesto

Es posible ampliar los archivos de manifiesto con metacontento adicional —es decir, atributos y etiquetas adicionales para ejemplos seleccionados— mediante el comando de configuración manifestmeta.

Un caso de uso del metacontento es destacar una serie de ejemplos destacados. Otro es mejorar la funcionalidad de búsqueda añadiendo palabras clave relevantes como etiquetas para una determinada categoría de ejemplos.

Los ejemplos a los que se aplica el metacontenido se especifican mediante uno o varios filtros. La coincidencia de los ejemplos con los filtros se realiza en función de los nombres, y cada nombre de ejemplo va precedido del nombre de un módulo y una barra. Se admite la coincidencia simple con comodines; al utilizar * al final, es posible hacer coincidir varios ejemplos con una sola cadena.

Ejemplo:

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

En el ejemplo anterior, se añade un atributo « isHighlighted » a dos ejemplos. Si se omite el valor del atributo, QDoc utiliza la cadena « true » de forma predeterminada. Se añaden etiquetas adicionales para los ejemplos «Qt WebKit» y « Qt SQL », y se aplica otra etiqueta a todos los ejemplos utilizando simplemente « * » como cadena de coincidencia.

© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.