From b16f9068c27b69d7fb55ab20920d835c6f91a7f5 Mon Sep 17 00:00:00 2001
From: Topi Reinio <topi.reinio@qt.io>
Date: Fri, 27 Nov 2020 16:31:54 +0100
Subject: [PATCH] Doc: Make \youtube macro work with litehtml help backend

Unlike the QTextBrowser backend, litehtml does not render elements
inside <iframe> correctly. This prevented external links to
YouTube from working in offline documentation.

Move the <iframe> to a macro override specific to online doc builds.

Fixes: QTBUG-88975
Change-Id: Iff7828ddeed353620eaa9ac669a3e0c03749daa2
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
(cherry picked from commit ca8e9ff2ef0a01248e3bdd718ef9fc06419214a4)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
---
 doc/global/macros-online.qdocconf             | 4 ++++
 doc/global/macros.qdocconf                    | 4 +---
 doc/global/qt-module-defaults-online.qdocconf | 3 +++
 3 files changed, 8 insertions(+), 3 deletions(-)
 create mode 100644 doc/global/macros-online.qdocconf

diff --git a/doc/global/macros-online.qdocconf b/doc/global/macros-online.qdocconf
new file mode 100644
index 00000000000..c6f370a7d76
--- /dev/null
+++ b/doc/global/macros-online.qdocconf
@@ -0,0 +1,4 @@
+macro.youtube.HTML = "<div class=\"video\">\n<span class=\"vspan\"></span>\n" \
+                     "<iframe src=\"https://www.youtube.com/embed/\1\"" \
+                     "frameborder=\"0\" allowfullscreen>\n" \
+                     "</iframe></div>\n"
diff --git a/doc/global/macros.qdocconf b/doc/global/macros.qdocconf
index bad7d12816b..9a0ea73cbd7 100644
--- a/doc/global/macros.qdocconf
+++ b/doc/global/macros.qdocconf
@@ -57,12 +57,10 @@ macro.QtMinorVersion.match  = "\\d+\\.(\\d+)"
 # qhp.ProjectName.extraFiles += images/dQw4w9WgXcQ.jpg
 #
 macro.youtube.HTML = "<div class=\"video\">\n<span class=\"vspan\"></span>\n" \
-                     "<iframe src=\"https://www.youtube.com/embed/\1\"" \
-                     "frameborder=\"0\" allowfullscreen>\n" \
                      "<a href=\"https://www.youtube.com/watch/?v=\1\">\n"\
                      "<img src=\"images/\1.jpg\"" \
                      "title=\"Click to play in a browser\" /></a>\n" \
-                     "</iframe></div>\n"
+                     "</div>\n"
 
 macro.excludefromcreator = "\\meta tag broken"
 
diff --git a/doc/global/qt-module-defaults-online.qdocconf b/doc/global/qt-module-defaults-online.qdocconf
index 20453a75063..7a956610b0a 100644
--- a/doc/global/qt-module-defaults-online.qdocconf
+++ b/doc/global/qt-module-defaults-online.qdocconf
@@ -23,6 +23,9 @@ include(manifest-meta.qdocconf)
 include(fileextensions.qdocconf)
 include(qt-html-templates-online.qdocconf)
 
+#override macros for online use
+include(macros-online.qdocconf)
+
 #extra configuration data DITA information
 include(config.qdocconf)