1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
qtbase/doc/global/qt-html-templates-offline.qdocconf

44 lines
1.6 KiB
Plaintext
Raw Permalink Normal View History

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 17:54:54 +01:00
#include standard set of HTML header and footer.
include(html-config.qdocconf)
include(html-header-offline.qdocconf)
include(html-footer.qdocconf)
Doc: Add a define for online and offline documentation templates The browser backend for offline documentation has fewer capabilities when it comes to CSS and JavaScript support. These defines allow us to use \if conditionals when needed: /*! \if defined(onlinedocs) <Content that is rendered in online documentation> \else <Fallback for offline docs> \endif */ Change-Id: Ia51acb937754f22f2ece2836b4fb1470bf9ade90 Reviewed-by: Martin Smith <martin.smith@qt.io>
2018-06-29 15:14:07 +02:00
defines += offlinedocs
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 17:54:54 +01:00
#uncomment if navigation bar is not wanted
#HTML.nonavigationbar = "true"
Doc: Simplify qtbase qdocconfs. We should be using the global qdocconf for the common variables. This change also allows you to just specify -installdir without using a templatedir. Change-Id: I207d279d9b5199212e896fc5ccab5c212b1896c6 Reviewed-by: Lars Knoll <lars.knoll@nokia.com> Reviewed-by: Frederik Gladhorn <frederik.gladhorn@nokia.com>
2012-08-30 17:51:30 +02:00
Doc: Add a dark offline CSS Which can be used by Qt Creator and Assistant. Task-number: QTBUG-97125 Task-number: QTCREATORBUG-26557 Change-Id: I03e5ac0a15f84101c73887724693e9eb27670754 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Jarek Kobus <jaroslaw.kobus@qt.io>
2022-09-29 16:01:20 +02:00
HTML.stylesheets = template/style/offline.css \
template/style/offline-dark.css
Doc: Restored CSS images for the offline HTML and QCH build Revert "Doc: Removing entry in CSS for adding icons to HTTP links" This reverts commit ceb2799163c7e80148ef0bffafac9b05269514d7. Also: -edited image to use Qt Project brand colors -removed breadcrumbs from CSS Change-Id: I3c2e655f8eac463677b20b68bc2ffa0efd2fd468 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Eike Ziller <eike.ziller@digia.com>
2012-12-06 16:17:43 +01:00
HTML.extraimages += template/images/ico_out.png \
template/images/btn_prev.png \
template/images/btn_next.png \
template/images/bullet_dn.png \
template/images/bullet_sq.png \
template/images/bgrContent.png
Document how to use CMake on Qt Core, Qt GUI's central pages Add documentation on how to use a module from CMake, alongside the existing documentation about qmake. Separate generic info from module-specific examples, to make it possible to use one include file in all modules. While at it, also remove the mentioning of the central include; it is not something we should actively advocate anymore. Instead, the documentation of every class gives the correct include to use. Task-number: QTBUG-73058 Change-Id: I6b3c0e5ea218dd9c06a491c8fb799a7fcf42dd92 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2019-04-01 15:49:47 +02:00
sourcedirs += includes
Doc: Restored CSS images for the offline HTML and QCH build Revert "Doc: Removing entry in CSS for adding icons to HTTP links" This reverts commit ceb2799163c7e80148ef0bffafac9b05269514d7. Also: -edited image to use Qt Project brand colors -removed breadcrumbs from CSS Change-Id: I3c2e655f8eac463677b20b68bc2ffa0efd2fd468 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Eike Ziller <eike.ziller@digia.com>
2012-12-06 16:17:43 +01:00
#specify which files in the output directory should be packed into the qch file.
qhp.extraFiles += style/offline.css \
Doc: Add a dark offline CSS Which can be used by Qt Creator and Assistant. Task-number: QTBUG-97125 Task-number: QTCREATORBUG-26557 Change-Id: I03e5ac0a15f84101c73887724693e9eb27670754 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Jarek Kobus <jaroslaw.kobus@qt.io>
2022-09-29 16:01:20 +02:00
style/offline-dark.css \
Doc: Restored CSS images for the offline HTML and QCH build Revert "Doc: Removing entry in CSS for adding icons to HTTP links" This reverts commit ceb2799163c7e80148ef0bffafac9b05269514d7. Also: -edited image to use Qt Project brand colors -removed breadcrumbs from CSS Change-Id: I3c2e655f8eac463677b20b68bc2ffa0efd2fd468 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Eike Ziller <eike.ziller@digia.com>
2012-12-06 16:17:43 +01:00
images/ico_out.png \
images/btn_prev.png \
images/btn_next.png \
images/bullet_dn.png \
images/bullet_sq.png \
images/bgrContent.png
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 10:36:57 +02:00
Adapt qdoc macros and documentation for DocBook Change-Id: I91e380e7670964937d90e478029f367177bf339b Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2022-07-11 01:38:06 +02:00
DocBook.extraimages += \
images/ico_out.png \
images/btn_prev.png \
images/btn_next.png \
images/bullet_dn.png \
images/bullet_sq.png \
images/bgrContent.png
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 10:36:57 +02:00
# By default, include override definitions for a simplified template/CSS,
# suited for rendering HTML with QTextBrowser. Comment out this line to
# select the standard CSS.
include(qt-html-templates-offline-simple.qdocconf)
Reference in New Issue Copy Permalink