diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2017-03-03 10:31:56 +0100 |
|---|---|---|
| committer | Topi Reiniö <topi.reinio@qt.io> | 2017-03-06 13:43:58 +0000 |
| commit | 8a1880029d080d63d5cf7e02c164925e34a0a718 (patch) | |
| tree | 712c6c45c2f8a67c2ad2bcb61035bf110b66f692 /doc/global/macros.qdocconf | |
| parent | d6330a19b29ebff359a6746250c78437dbcaf77d (diff) | |
Doc: Add macro for embedding YouTube videos
This macro adds a \youtube <ID> command that embeds a YouTube link
into the documentation.
The video container scales to a specified percentage of the available
horizontal area. It assumes a source aspect ratio of 16:9, but looks
acceptable with other ratios.
For backends that do not support <iframe> (e.g. QTextBrowser), shows
a clickable video thumbnail that open the YouTube link in an external
browser window. Unfortunately, QTextBrowser cannot load images from
a remote URL, so we need to store a thumbnail image in the .qch file.
Change-Id: I3a3a0c5a20dd90e5cec6357ba70a23ee47dbe825
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
Diffstat (limited to 'doc/global/macros.qdocconf')
| -rw-r--r-- | doc/global/macros.qdocconf | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/global/macros.qdocconf b/doc/global/macros.qdocconf index 1182af14e9..5544da425a 100644 --- a/doc/global/macros.qdocconf +++ b/doc/global/macros.qdocconf @@ -38,3 +38,17 @@ macro.beginfloatright.HTML = "<div style=\"float: right; margin-left: 2em\">" macro.endfloat.HTML = "</div>" macro.clearfloat.HTML = "<br style=\"clear: both\" />" macro.emptyspan.HTML = "<span></span>" + +# Embed YouTube content by video ID - Example: \youtube dQw4w9WgXcQ +# Also requires a <ID>.jpg thumbnail for offline docs. In .qdocconf, add: +# +# HTML.extraimages += images/dQw4w9WgXcQ.jpg +# 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" |