QDoc Project Templates: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
h1. QDoc Project Templates | |||
This page is part of the [[QtWritingGuidelines|Qt Writing Guidelines]]. | This page is part of the [[QtWritingGuidelines | Qt Writing Guidelines]]. | ||
QDoc configuration may be imported by using '''include()'''. The templates may be referenced using environment variables, relevant paths, or absolute paths. | QDoc configuration may be imported by using '''include()'''. The templates may be referenced using environment variables, relevant paths, or absolute paths. | ||
| Line 7: | Line 7: | ||
'''Note''' This feature is only supported in Qt 5 that is not shadow-built. | '''Note''' This feature is only supported in Qt 5 that is not shadow-built. | ||
==Qt 5 Module Defaults== | == Qt 5 Module Defaults == | ||
Projects that are part of Qt 5 as an Essential or Add-On can simply include the templates in Qt | Projects that are part of Qt 5 as an Essential or Add-On can simply include the templates in Qt 5's ''qtbase/doc/global'' directory. These projects should receive the '''QT_INSTALL_DOCS''' variable from QMake. See [[Checklist for Adding Documentation for a New Module]] | ||
There are several templates in Qt 5, but the basic one which all Qt 5 modules should include is '''qt-module-defaults.qdocconf''':<br /> | There are several templates in Qt 5, but the basic one which all Qt 5 modules should include is '''qt-module-defaults.qdocconf''':<br /><code><br />include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)<br /></code> | ||
This template will include the necessary | This template will include the necessary HTML templates, C++ macros, and other QDoc configurations.<br />Note that this include should be at the top of the .qdocconf file. | ||
'''Note''' Including this template also applies the Qt Project copyright notices which may not be appropriate for some projects. | '''Note''' Including this template also applies the Qt Project copyright notices which may not be appropriate for some projects. | ||
==Projects Outside of Qt 5== | == Projects Outside of Qt 5 == | ||
For projects outside of Qt 5, the includes can vary, depending on which configuration is desired. For a typical project, the following should suffice:<br /> | For projects outside of Qt 5, the includes can vary, depending on which configuration is desired. For a typical project, the following should suffice:<br /><code><br />include($QT_INSTALL_DOCS/global/macros.qdocconf) #macros for QDoc commands<br />include($QT_INSTALL_DOCS/global/qt-cpp-defines.qdocconf) #needed by C++ projects<br />include($QT_INSTALL_DOCS/global/compat.qdocconf) #compatibility macros<br />include($QT_INSTALL_DOCS/global/fileextensions.qdocconf) #configuration common among QDoc projects<br />include($QT_INSTALL_DOCS/global/qt-html-templates-offline.qdocconf) #offline HTML template for documentation shipped to Qt Creator<br /></code> | ||
===Customizing the | === Customizing the HTML template === | ||
It is possible to customize the look-and-feel of the | It is possible to customize the look-and-feel of the HTML template by including different templates. | ||
# For projects that package documentation to Qt Assistant or Qt Creator:<br /> | # For projects that package documentation to Qt Assistant or Qt Creator:<br /><code><br />include($QT_INSTALL_DOCS/global/qt-html-templates-offline.qdocconf) #offline HTML template for documentation shipped to Qt Creator<br /></code> | ||
# For projects that wish to look like the documentation snapshots (doc-snapshot.qt.io)<br /> | # For projects that wish to look like the documentation snapshots (doc-snapshot.qt.io)<br /><code><br />include($QT_INSTALL_DOCS/global/qt-html-templates-online.qdocconf)<br /></code> | ||
To further customize, the templates in '''1''' and '''2''' include several other<br / | To further customize, the templates in '''1''' and '''2''' include several other<br />HTML-related configurations. | ||
Revision as of 10:59, 24 February 2015
h1. QDoc Project Templates
This page is part of the Qt Writing Guidelines.
QDoc configuration may be imported by using include(). The templates may be referenced using environment variables, relevant paths, or absolute paths.
Note This feature is only supported in Qt 5 that is not shadow-built.
Qt 5 Module Defaults
Projects that are part of Qt 5 as an Essential or Add-On can simply include the templates in Qt 5's qtbase/doc/global directory. These projects should receive the QT_INSTALL_DOCS variable from QMake. See Checklist for Adding Documentation for a New Module
There are several templates in Qt 5, but the basic one which all Qt 5 modules should include is qt-module-defaults.qdocconf:
<br />include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)<br />
This template will include the necessary HTML templates, C++ macros, and other QDoc configurations.
Note that this include should be at the top of the .qdocconf file.
Note Including this template also applies the Qt Project copyright notices which may not be appropriate for some projects.
Projects Outside of Qt 5
For projects outside of Qt 5, the includes can vary, depending on which configuration is desired. For a typical project, the following should suffice:
<br />include($QT_INSTALL_DOCS/global/macros.qdocconf) #macros for QDoc commands<br />include($QT_INSTALL_DOCS/global/qt-cpp-defines.qdocconf) #needed by C++ projects<br />include($QT_INSTALL_DOCS/global/compat.qdocconf) #compatibility macros<br />include($QT_INSTALL_DOCS/global/fileextensions.qdocconf) #configuration common among QDoc projects<br />include($QT_INSTALL_DOCS/global/qt-html-templates-offline.qdocconf) #offline HTML template for documentation shipped to Qt Creator<br />
Customizing the HTML template
It is possible to customize the look-and-feel of the HTML template by including different templates.
- For projects that package documentation to Qt Assistant or Qt Creator:
<br />include($QT_INSTALL_DOCS/global/qt-html-templates-offline.qdocconf) #offline HTML template for documentation shipped to Qt Creator<br />
- For projects that wish to look like the documentation snapshots (doc-snapshot.qt.io)
<br />include($QT_INSTALL_DOCS/global/qt-html-templates-online.qdocconf)<br />
To further customize, the templates in 1 and 2 include several other
HTML-related configurations.