diff options
author | Topi Reinio <topi.reinio@digia.com> | 2015-09-03 14:27:16 +0200 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@digia.com> | 2015-09-07 08:46:49 +0000 |
commit | 05a7886e8610fbc33c0b3131f9fe60d4df7993f8 (patch) | |
tree | 69cb8b8f0d9e81f20b533528525d4bf152f799bb /src/doc | |
parent | 64c8514189763aceb3518dbea0781718329761c7 (diff) |
Doc: Add a custom note on the online landing page
The installer now opens a browser with the latest online docs. As
the version the user is installing may not be the very latest one,
add a note on the landing page reminding that version-specific
documentation is available in Qt Creator Help.
This note is shown only when launching from the installer - i.e,
the URL has the 'welcome' query string:
http://doc.qt.io/QtForDeviceCreation/index.html?welcome
Task-number: QTEE-964
Change-Id: Iaf373d97c960d36d206f93ec7d5b61086adda86c
Reviewed-by: Samuli Piippo <samuli.piippo@theqtcompany.com>
Diffstat (limited to 'src/doc')
-rw-r--r-- | src/doc/config/b2qt-online.qdocconf | 6 | ||||
-rw-r--r-- | src/doc/config/html-offline.qdocconf | 3 | ||||
-rw-r--r-- | src/doc/src/qtee-index.qdoc | 1 |
3 files changed, 10 insertions, 0 deletions
diff --git a/src/doc/config/b2qt-online.qdocconf b/src/doc/config/b2qt-online.qdocconf index a75cde2..901d1c1 100644 --- a/src/doc/config/b2qt-online.qdocconf +++ b/src/doc/config/b2qt-online.qdocconf @@ -3,3 +3,9 @@ include(b2qt-project.qdocconf) # sidebar used for online template HTML.stylesheets += style/qt5-sidebar.html + +# Add definition for a custom note, shown on index.html when +# the URL query string matches 'welcome' +macro.welcome.HTML = "<p class=\"welcome\" style=\"display:none;padding:6px;border:2px #e33 solid\"><i><b>Note:</b> This documentation is for the latest release of Qt for Device Creation. If you're using an older version, refer to the documentation in <b>Qt Creator</b> > <b>Help</b> instead.</i></p>\n" + +HTML.headerscripts += " <script type=\"text/javascript\">\$(function(){if (document.location.search.substr(1) == \"welcome\") \$('.welcome').show();})</script>\n" diff --git a/src/doc/config/html-offline.qdocconf b/src/doc/config/html-offline.qdocconf index 142ec46..fb06277 100644 --- a/src/doc/config/html-offline.qdocconf +++ b/src/doc/config/html-offline.qdocconf @@ -5,6 +5,9 @@ include($QT_INSTALL_DOCS/global/fileextensions.qdocconf) HTML.nobreadcrumbs = "true" +# \welcome macro is used in online docs, no output in offline mode +macro.welcome.HTML = "\n" + HTML.footer = \ " <div class=\"ft\">\n" \ " <span></span>\n" \ diff --git a/src/doc/src/qtee-index.qdoc b/src/doc/src/qtee-index.qdoc index 3ea844a..d04ec7f 100644 --- a/src/doc/src/qtee-index.qdoc +++ b/src/doc/src/qtee-index.qdoc @@ -22,6 +22,7 @@ \nextpage qtee-overview.html \title Qt 5.5 for Device Creation + \welcome \e {Qt for Device Creation} is a commercial offering, providing a fully-integrated solution for creating embedded Linux-based products. It provides the complete toolchain required for faster software development, |