AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doc: Add DocBook version of youtube macro

Browse Source 
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>
This commit is contained in:
Luca Di Sera 2023-05-24 15:50:43 +02:00
parent 787b4c1506
commit 5c66c08bed
2 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/global/macros-online.qdocconf
View File

@ -2,5 +2,11 @@ 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"
macro.youtube.DocBook = "<db:mediaobject>\n" \
"<db:videoobject>\n" \
"<db:videodata fileref=\"\1\">\n" \
"</db:videodata>\n" \
"</db:videoobject>\n" \
"</db:mediaobject>\n"
include(htmltabs.qdocconf)

10
doc/global/macros.qdocconf
View File

@ -90,6 +90,16 @@ macro.youtube.HTML = "<div class=\"video\">\n" \
"<img src=\"images/\1.jpg\"" \
"title=\"Click to play in a browser\" /></a>\n" \
"</div>\n"
macro.youtube.DocBook = "<db:mediaobject>\n" \
"<db:videoobject>\n" \
"<db:videodata fileref=\"\1\">\n" \
"</db:videodata>\n" \
"</db:videoobject>\n" \
"<db:imageobject>\n" \
"<db:imagedata fileref=\"images/\1.jpg\">\n" \
"</db:imagedata>\n" \
"</db:imageobject>\n" \
"</db:mediaobject>\n"
macro.excludefromcreator = "\\meta tag broken"