summaryrefslogtreecommitdiffstats
path: root/doc/global/macros.qdocconf
diff options
context:
space:
mode:
authorThibaut Cuvelier <cuvelier.thibaut@gmail.com>2022-10-05 00:48:49 +0200
committerThibaut Cuvelier <cuvelier.thibaut@gmail.com>2022-10-05 18:14:09 +0000
commitfd28c970750e0570bf1d107922fa29eae161e93d (patch)
tree6bfe81432fecafa00a0f3b30e6806d4e0974aecc /doc/global/macros.qdocconf
parentbc1e0e92aaac024ad6b8c42c7b827a5ba9cf5f33 (diff)
qdoc: improve \youtube documentation for DocBook images
The same kind of line is required for DocBook as HTML or QHP. This change makes that requirement clear. It was suggested by Nicholas Bennett in a change in existing configuration for this exact line. Change-Id: I664300f229bac9931c6f1ac4a08bd7c8c42bf37c Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
Diffstat (limited to 'doc/global/macros.qdocconf')
-rw-r--r--doc/global/macros.qdocconf7
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/global/macros.qdocconf b/doc/global/macros.qdocconf
index e79ed161ff..f504f4584a 100644
--- a/doc/global/macros.qdocconf
+++ b/doc/global/macros.qdocconf
@@ -57,10 +57,11 @@ macro.QtMajorVersion.match = "^(\\d+)\\."
macro.QtMinorVersion.match = "\\d+\\.(\\d+)"
# Embed YouTube content by video ID - Example: \youtube dQw4w9WgXcQ
-# Also requires a <ID>.jpg thumbnail for offline docs. In .qdocconf, add:
+# Also requires a <ID>.jpg thumbnail for offline docs. By default, qdoc doesn't copy the thumbnail
+# along with the offline docs, you must specify it manually. In .qdocconf, to do it for all formats
+# at once, add:
#
-# HTML.extraimages += images/dQw4w9WgXcQ.jpg
-# qhp.ProjectName.extraFiles += images/dQw4w9WgXcQ.jpg
+# {HTML.extraimages,qhp.QtDoc.extraFiles, DocBook.extraimages} += images/dQw4w9WgXcQ.jpg
#
macro.youtube.HTML = "<div class=\"video\">\n" \
"<a href=\"https://www.youtube.com/watch/?v=\1\">\n"\