Qt Help Proyecto
Un proyecto de Qt Help recopila todos los datos necesarios para generar un archivo de ayuda comprimido. Además de los datos de ayuda propiamente dichos, como el índice, las palabras clave del índice y los documentos de ayuda, contiene información adicional, como un espacio de nombres para identificar el archivo de ayuda. Cada proyecto de Qt Help corresponde a un conjunto de documentación, por ejemplo, el manual de qmake.
Qt Help Formato de archivo del proyecto
El formato de archivo está basado en XML. Para comprender mejor el formato, analizaremos el siguiente ejemplo:
<?xml version="1.0" encoding="UTF-8"?>
<QtHelpProject version="1.0">
<namespace>mycompany.com.myapplication.1.0</namespace>
<virtualFolder>doc</virtualFolder>
<customFilter name="My Application 1.0">
<filterAttribute>myapp</filterAttribute>
<filterAttribute>1.0</filterAttribute>
</customFilter>
<filterSection>
<filterAttribute>myapp</filterAttribute>
<filterAttribute>1.0</filterAttribute>
<toc>
<section title="My Application Manual" ref="index.html">
<section title="Chapter 1" ref="doc.html#chapter1"/>
<section title="Chapter 2" ref="doc.html#chapter2"/>
<section title="Chapter 3" ref="doc.html#chapter3"/>
</section>
</toc>
<keywords>
<keyword name="foo" id="MyApplication::foo" ref="doc.html#foo"/>
<keyword name="bar" ref="doc.html#bar"/>
<keyword id="MyApplication::foobar" ref="doc.html#foobar"/>
</keywords>
<files>
<file>classic.css</file>
<file>*.html</file>
</files>
</filterSection>
</QtHelpProject>Espacio de nombres
Para que el sistema de ayuda de Qt ( QHelpEngine ) pueda recuperar la documentación adecuada para un enlace determinado, cada conjunto de documentación debe tener un identificador único. Un identificador único también permite que la colección de ayuda realice un seguimiento de un conjunto de documentación sin depender de su nombre de archivo. El sistema de Qt Help utiliza un espacio de nombres como identificador, que se define mediante las etiquetas de espacio de nombres obligatorias. En el ejemplo anterior, el espacio de nombres es «mycompany.com.myapplication.1.0».
Carpetas virtuales
Disponer de un espacio de nombres para cada conjunto de documentación implica, naturalmente, que los conjuntos de documentación están bastante separados entre sí. Desde el punto de vista del motor de ayuda, esto resulta beneficioso. Sin embargo, desde el punto de vista del redactor, a menudo es conveniente establecer referencias cruzadas entre determinados temas de un manual a otro sin tener que especificar enlaces absolutos. Para resolver este problema, el sistema de ayuda introdujo el concepto de carpetas virtuales.
Una carpeta virtual se convertirá en el directorio raíz de todos los archivos a los que se hace referencia en un archivo de ayuda comprimido. Cuando dos conjuntos de documentación comparten la misma carpeta virtual, pueden utilizar rutas relativas al definir hipervínculos que apunten entre sí. Si un archivo está presente en ambos conjuntos de documentación, el del conjunto actual tiene prioridad sobre el otro.
...
<virtualFolder>doc</virtualFolder>
...El ejemplo anterior especifica «doc» como carpeta virtual. Si otro manual especifica la misma carpeta, por ejemplo, para una pequeña herramienta auxiliar llamada «My Application», basta con escribir «doc.html#section1» para hacer referencia a la primera sección del manual de «My Application ».
La etiqueta de carpeta virtual es obligatoria y el nombre de la carpeta no debe contener barras (/).
Sección «Filtro»
Una sección de filtro contiene la documentación propiamente dicha. Un archivo de proyecto de Qt Help puede contener más de una sección de filtro. Cada sección de filtro consta de la tabla de contenidos, las palabras clave y la lista de archivos. En teoría, todas las partes son opcionales, pero si no se especifica nada en ellas, el conjunto de documentación quedará vacío.
Índice
...
<toc>
<section title="My Application Manual" ref="index.html">
<section title="Chapter 1" ref="doc.html#chapter1"/>
<section title="Chapter 2" ref="doc.html#chapter2"/>
<section title="Chapter 3" ref="doc.html#chapter3"/>
</section>
</toc>
...Cada etiqueta de sección representa un elemento de la tabla de contenidos. Las secciones pueden anidarse en cualquier nivel, pero desde el punto de vista del usuario no deberían superar los cuatro o cinco niveles. Una sección se define por su título y su referencia. La referencia, al igual que todas las referencias a archivos en un proyecto de ayuda de Qt Help, es relativa al propio archivo del proyecto de ayuda.
Nota: Los archivos a los que se hace referencia deben estar en el mismo directorio que el archivo del proyecto de ayuda (o en un subdirectorio). Tampoco se admite la ruta absoluta de los archivos.
Palabras clave
...
<keywords>
<keyword name="foo" id="MyApplication::foo" ref="doc.html#foo"/>
<keyword name="bar" ref="doc.html#bar"/>
<keyword id="MyApplication::foobar" ref="doc.html#foobar"/>
</keywords>
...La sección de palabras clave enumera todas las palabras clave de esta sección de filtro. Una palabra clave consta básicamente de un nombre y una referencia de archivo. Si se utiliza el atributo «name», la palabra clave especificada allí aparecerá en el índice visible. Es decir, se podrá acceder a ella a través de la clase ` QHelpIndexModel `. Si se utiliza «id», la palabra clave no aparecerá en el índice y solo se podrá acceder a ella mediante ` QHelpEngineCore::documentsForIdentifier()`. Se pueden especificar «name» e «id» al mismo tiempo.
Archivos
...
<files>
<file>classic.css</file>
<file>*.html</file>
</files>
...Por último, hay que enumerar los archivos de documentación propiamente dichos. Asegúrate de que se mencionan todos los archivos necesarios para mostrar la ayuda. Es decir, también deben incluirse las hojas de estilo o archivos similares. Los archivos, al igual que todas las referencias a archivos en un proyecto de Qt Help, son relativos al propio archivo del proyecto de Qt Help. Como muestra el ejemplo, los archivos (pero no los directorios) también pueden especificarse como patrones utilizando comodines. Todos los archivos enumerados se comprimirán y se incluirán en el archivo de ayuda comprimido de Qt. Así pues, al final, un único archivo de ayuda de Qt contiene todos los archivos de documentación, junto con los contenidos y los índices.
Nota: Los archivos a los que se hace referencia deben encontrarse en el mismo directorio que el archivo del proyecto de ayuda (o en un subdirectorio). Tampoco se admiten rutas absolutas a los archivos.
© 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.