qt5base-lts/doc/global/qt-module-defaults-offline.qdocconf

#The default configuration for a Qt module, including Add-Ons and Tools.
#Include this file for a standard Qt module; builds with the offline style.

#include standard set of macros and C++ defines and ignores
include(macros.qdocconf)
include(qt-cpp-defines.qdocconf)
include(compat.qdocconf)
include(manifest-meta.qdocconf)
include(fileextensions.qdocconf)

include(qt-html-templates-offline.qdocconf)

#extra configuration data such as file extensions
include(config.qdocconf)

# Show Qt version as part of the navigation bar
buildversion = "Qt $QT_VERSION Reference Documentation"
doc/global: Remove references to Qt 5 in comments Change-Id: I15d91e2f593551879b1b3b5adf58c536abf8467b Reviewed-by: Paul Wicking <paul.wicking@qt.io> 2020-11-17 12:42:35 +00:00			`#The default configuration for a Qt module, including Add-Ons and Tools.`
			`#Include this file for a standard Qt module; builds with the offline style.`
Doc: Fixed QDoc's navigation mechanism. The HTML pages need to display minimal navigation such as a link to the module landing page or Qt 5's index.html. -new variables available in qdocconf files: navigation.landingpage navigation.homepage navigation.cppclassespage navigation.qmltypespage buildversion The navigation variables are for the new navigation bar. The buildversion variable is to insert documentation build information into the pages. Note about compatibility with Qt Creator docs: The HTML template files for Qt Creator is retained to keep Qt Creator compatible with 5.0.x and 5.1.x. Change-Id: Ibb4d7cada19644204457d822b6b77b2aa7b70f8d Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com> 2013-02-19 16:54:54 +00:00
			`#include standard set of macros and C++ defines and ignores`
			`include(macros.qdocconf)`
			`include(qt-cpp-defines.qdocconf)`
			`include(compat.qdocconf)`
			`include(manifest-meta.qdocconf)`
			`include(fileextensions.qdocconf)`
Doc: A simplified style for rendering docs with QTextBrowser Add a new documentation template, with simplified CSS rules that work better when using QTextBrowser as a backend for Qt Assistant or Qt Creator Help. Select this new template by default for offline documentation builds, but keep the old offline template as part of the template files; use JavaScript to switch to the 'standard' CSS when the generated files are viewed with a web browser. Task-number: QTBUG-48322 Change-Id: Ib197896200bb482935f6e9f3a38976133a1e804d Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com> 2015-08-31 10:13:01 +00:00
Doc: Improve selection of offline template type Qt 5.6 now includes a version of the offline documentation template with simplified CSS suited for rendering HTML with a QTextBrowser backend. Select the template in qt-html-templates-offline.qdocconf, instead of the higher-level qt-module-defaults-offline.qdocconf. This is better because many projects external to qt5 (including Qt Creator) do not use qt-module-* includes. This way, we can control the template selection for all projects from a config file. Change-Id: I766af422d829f3c9519c5a45093473175363d600 Reviewed-by: Martin Smith <martin.smith@digia.com> 2015-10-20 08:36:57 +00:00			`include(qt-html-templates-offline.qdocconf)`
Doc: Fixed QDoc's navigation mechanism. The HTML pages need to display minimal navigation such as a link to the module landing page or Qt 5's index.html. -new variables available in qdocconf files: navigation.landingpage navigation.homepage navigation.cppclassespage navigation.qmltypespage buildversion The navigation variables are for the new navigation bar. The buildversion variable is to insert documentation build information into the pages. Note about compatibility with Qt Creator docs: The HTML template files for Qt Creator is retained to keep Qt Creator compatible with 5.0.x and 5.1.x. Change-Id: Ibb4d7cada19644204457d822b6b77b2aa7b70f8d Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com> 2013-02-19 16:54:54 +00:00
			`#extra configuration data such as file extensions`
			`include(config.qdocconf)`
Doc: new template for qt.io online style An online documentation template that follows the style of qt.io site. Update the url variable for Qt modules to point to doc.qt.io/qt-5/. Task-number: QTBUG-42086 Change-Id: I5428a02cd503aef2217efd7361f4c8b7b5895a52 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> 2014-10-21 12:57:50 +00:00
			`# Show Qt version as part of the navigation bar`
			`buildversion = "Qt $QT_VERSION Reference Documentation"`