summaryrefslogtreecommitdiffstats
path: root/src/doc/config
diff options
context:
space:
mode:
authorSamuli Piippo <samuli.piippo@theqtcompany.com>2016-01-13 15:58:52 +0200
committerSamuli Piippo <samuli.piippo@theqtcompany.com>2016-01-13 15:59:46 +0200
commit6217a1cae7e0f5fcfa93d80051237fa835412903 (patch)
tree2f2d93b8aa0160c00e323da24636e91455d0b155 /src/doc/config
parent9bad5168e006b37e5b1634ac68085b587846febb (diff)
parent1145b7fe7db9dc2ae216aa90d4c99473a25a838e (diff)
Merge remote-tracking branch 'origin/5.5' into dev
* origin/5.5: docs: add note about need for kontron's Yocto BSP Doc: Bump version to 5.5.1 Doc: Add ChangeLog for 5.5.1 doc: add documentation for Kontron SMARC-sAMX6i Doc: Add a custom note on the online landing page doc: instructions how to use BD's 1280x800 panels Doc: Clarify the network type for Emulator Conflicts: src/doc/config/b2qt-project.qdocconf src/doc/src/devices/qtee-supported-devices.qdoc src/doc/src/qtee-index.qdoc Change-Id: I912a1175965a44c5ff5d68ca5ea9be2d6928b595
Diffstat (limited to 'src/doc/config')
-rw-r--r--src/doc/config/b2qt-online.qdocconf6
-rw-r--r--src/doc/config/html-offline.qdocconf3
2 files changed, 9 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> &gt; <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" \