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

65 lines
2.7 KiB
Plaintext
Raw Normal View History

Update macros to work with DocBook support Related to https://codereview.qt-project.org/c/qt/qttools/+/276759 Change-Id: Iac9e43ea06b0ef19018094407cde907b38d7c547 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2019-10-08 17:28:16 +00:00
macro.aacute.HTML = "&aacute;"
macro.Aring.HTML = "&Aring;"
macro.aring.HTML = "&aring;"
macro.Auml.HTML = "&Auml;"
macro.author = "\\b{Author:}"
macro.BR.HTML = "<br />"
macro.copyright.HTML = "&copy;"
macro.eacute.HTML = "&eacute;"
macro.gui = "\\b"
macro.HR.HTML = "<hr />"
macro.iacute.HTML = "&iacute;"
macro.key = "\\b"
macro.macos = "macOS"
macro.menu = "\\b"
macro.oslash.HTML = "&oslash;"
macro.ouml.HTML = "&ouml;"
macro.nullptr = "\\c{nullptr}"
macro.QA = "\\e{Qt Assistant}"
macro.QD = "\\e{Qt Designer}"
macro.QL = "\\e{Qt Linguist}"
Merge remote-tracking branch 'origin/dev' into merge-dev Change-Id: I31b761cfd5ea01373c60d02a5da8c33398d34739
2020-01-22 12:47:08 +00:00
macro.Q_OBJECT = "Q_OBJECT"
Update macros to work with DocBook support Related to https://codereview.qt-project.org/c/qt/qttools/+/276759 Change-Id: Iac9e43ea06b0ef19018094407cde907b38d7c547 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2019-10-08 17:28:16 +00:00
macro.QQV = "\\e{Qt QML Viewer}"
macro.QtVersion = "$QT_VERSION"
macro.QtVer = "$QT_VER"
macro.param = "\\e"
macro.raisedaster.HTML = "<sup>*</sup>"
macro.raisedaster.DocBook = "\\sup{*}"
macro.rarrow.HTML = "&rarr;"
macro.reg.HTML = "<sup>&reg;</sup>"
macro.rego.DocBook = "\\sup{&#174;}"
macro.return = "Returns"
macro.starslash = "\\c{*/}"
macro.begincomment = "\\c{/*}"
macro.endcomment = "\\c{*/}"
macro.uuml.HTML = "&uuml;"
macro.mdash.HTML = "&mdash;"
macro.pi.HTML = "&Pi;"
macro.beginqdoc.HTML = "/*!"
macro.endqdoc.HTML = "*/"
Doc: Add a custom \borderedimage macro This macro is used similarly to the \image command; it wraps the image in a div with class attribute 'border' that allows additional styling in CSS. Change-Id: I94271074378d79f0e52f1f5a4715a1f84e0254dc Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
2016-09-20 12:13:56 +00:00
macro.borderedimage = "\\div {class=\"border\"} \\image \1\n\\enddiv"
Doc: Adding base macros and other QDoc definitions The module documentation require these definitions. Change-Id: Iecef3df5edad761d8c5f67b14783e13952ab2dbb Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 10:39:04 +00:00
macro.beginfloatleft.HTML = "<div style=\"float: left; margin-right: 2em\">"
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>"
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>
2017-03-03 09:31:56 +00:00
Doc: Add a macro that returns the minor version Add a global QDoc macro \QtMinorVersion that expands into the minor version of Qt, or more specifically, the minor version contained in the QT_VER environment variable. The main use case for the new macro is to document the QML modules whose minor versions track the minor version of Qt: \qmlmodule QtQuick 2.\QtMinorVersion Task-number: QTBUG-67818 Change-Id: I2b4fcbb18de0f8f95718099309090017c237622f Reviewed-by: Martin Smith <martin.smith@qt.io>
2018-09-09 10:39:53 +00:00
# Expands to the minor version based on the QT_VER environment variable
macro.QtMinorVersion = "$QT_VER"
macro.QtMinorVersion.match = "\\d+\\.(\\d+)"
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>
2017-03-03 09:31:56 +00:00
# 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"
Reference in New Issue Copy Permalink