AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
bb2f551b32
qt5base-lts/doc/global/macros-online.qdocconf

13 lines
579 B
Plaintext
Raw Normal View History

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. Pick-to: 6.0 6.0.0 Fixes: QTBUG-88975 Change-Id: Iff7828ddeed353620eaa9ac669a3e0c03749daa2 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2020-11-27 15:31:54 +00:00
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"
Doc: Add DocBook version of youtube macro QDoc allows code-expanding macros to be defined so that the user can abstract away common code in a simple to use command. Furthermore, macros allows for a different expansion based on the currently generated format so that format-specific requirements can be satisfied when required. Due to a certain bug in QDoc, when generating the DocBook format, QDoc would expand an HTML specific macro definition when a DocBook specific one was not provided. As this bug is now being fixed, the DocBook format will lose some of the output that it was previously generating. For example, the "\youtube" macro is defined, for HTML, so that a youtube video can be embedded by reference. To avoid losing the usage of "\youtube" when generating DocBook, an equivalent version expansion of the macro is now provided for the DocBook format. Change-Id: Id74155f2c30b80b5f4490f8451cd8d00535806d6 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2023-05-24 13:50:43 +00:00
macro.youtube.DocBook = "<db:mediaobject>\n" \
"<db:videoobject>\n" \
"<db:videodata fileref=\"\1\">\n" \
"</db:videodata>\n" \
"</db:videoobject>\n" \
"</db:mediaobject>\n"
Doc: Add qdoc macro for tabbed content The macro enables tabbed content in the online style only. It's usage must be gaurded with a conditional block as shown in the following example to handle the offline style usecase: \if(onlinedocs) \tab {build-qt-app}{tab-cmake}{CMake}{selected} \tab {build-qt-app}{tab-qmake}{qmake}{} \tabcontent {tab-cmake} \else \section1 Using CMake \endif CMake-specific instructions go here \if(onlinedocs) \endtabcontent \tabcontent {tab-qmake} \else \section1 Using qmake \endif qmake-specific instructions go here \if(onlinedocs) \endtabcontent \endif Pick-to: 6.2 6.3 Change-Id: I02d50c057280a9ffea913642284e67ddcda7aa94 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2022-04-01 16:21:22 +00:00
include(htmltabs.qdocconf)
Reference in New Issue Copy Permalink