AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
65e977f062
qt5base-lts/doc/global/qt-html-templates-online.qdocconf

14 lines
365 B
Plaintext
Raw 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 16:54:54 +00:00
#include standard set of HTML header and footer.
Doc: Update online documentation template - Online CSS tweaks: Max-width, font-sizes, font-weights to improve readability, other minor fixes - Remove duplicate include statement and unnecessary definitions for online template Change-Id: I713bddd0e175235668c4d9790d0df58b4131d19f Reviewed-by: Martin Smith <martin.smith@digia.com>
2015-01-14 09:03:51 +00:00
HTML.nonavigationbar = "false"
HTML.tocdepth = 2
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(html-header-online.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
include(html-footer-online.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
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 13:14:07 +00:00
defines += onlinedocs
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
#uncomment if navigation bar is not wanted
#HTML.nonavigationbar = "true"
Doc: Adding online styles -Has the Qt logo -For generating the archives and online snapshot Change-Id: I88d1d6335c0ba600a62868a25fadaed8a751f2b4 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2012-11-19 12:45:44 +00:00
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 13:49:47 +00:00
sourcedirs += includes-online \
includes
Reference in New Issue Copy Permalink