summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorThibaut Cuvelier <cuvelier.thibaut@gmail.com>2022-07-11 01:38:06 +0200
committerTopi Reinio <topi.reinio@qt.io>2022-11-04 18:39:03 +0100
commitdd1b21dbf33a7937251f2d1b602f6c43788f1335 (patch)
treeaa9dac94cedca54abe30412f87ebafacca072704 /doc
parent7b9bb698b93e747e02bf6ab8310c439867318f8e (diff)
Adapt qdoc macros and documentation for DocBook
Change-Id: I91e380e7670964937d90e478029f367177bf339b Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
Diffstat (limited to 'doc')
-rw-r--r--doc/global/html-config.qdocconf4
-rw-r--r--doc/global/macros.qdocconf23
-rw-r--r--doc/global/qt-html-templates-offline.qdocconf10
3 files changed, 35 insertions, 2 deletions
diff --git a/doc/global/html-config.qdocconf b/doc/global/html-config.qdocconf
index 9b3b05b7d3..216f3a50cf 100644
--- a/doc/global/html-config.qdocconf
+++ b/doc/global/html-config.qdocconf
@@ -18,7 +18,8 @@ HTML.extraimages += template/images/arrow_bc.png \
#specify which files in the output directory should be packed into the qch file.
#these files are assumed to be in each module's output directory."qtquick/images/ico_out.png" for example.
-qhp.extraFiles += images/arrow_bc.png \
+{qhp.extraFiles,DocBook.extraFiles} += \
+ images/arrow_bc.png \
images/home.png \
images/ico_out.png \
images/ico_note.png \
@@ -29,3 +30,4 @@ qhp.extraFiles += images/arrow_bc.png \
images/bullet_sq.png \
images/bgrContent.png \
images/logo.png
+
diff --git a/doc/global/macros.qdocconf b/doc/global/macros.qdocconf
index f504f4584a..93be93cc69 100644
--- a/doc/global/macros.qdocconf
+++ b/doc/global/macros.qdocconf
@@ -1,19 +1,30 @@
macro.aacute.HTML = "&aacute;"
+macro.aacute.DocBook = "&#225;"
macro.Aring.HTML = "&Aring;"
+macro.Aring.DocBook = "&#197;"
macro.aring.HTML = "&aring;"
+macro.aring.DocBook = "&#229;"
macro.Auml.HTML = "&Auml;"
+macro.Auml.DocBook = "&#196;"
macro.author = "\\b{Author:}"
macro.BR.HTML = "<br />"
+macro.BR.DocBook = ""
macro.copyright.HTML = "&copy;"
+macro.copyright.DocBook = "&#169;"
macro.eacute.HTML = "&eacute;"
+macro.eacute.DocBook = "&#233;"
macro.gui = "\\b"
macro.HR.HTML = "<hr />"
+macro.HR.DocBook = ""
macro.iacute.HTML = "&iacute;"
+macro.iacute.DocBook = "&#237;"
macro.key = "\\b"
macro.macos = "macOS"
macro.menu = "\\b"
macro.oslash.HTML = "&oslash;"
+macro.oslash.DocBook = "&#248;"
macro.ouml.HTML = "&ouml;"
+macro.ouml.DocBook = "&#246;"
macro.nothing = "\\dontdocument ()"
macro.nullptr = "\\c{nullptr}"
macro.QA = "\\e{Qt Assistant}"
@@ -27,15 +38,19 @@ macro.param = "\\e"
macro.raisedaster.HTML = "<sup>*</sup>"
macro.raisedaster.DocBook = "\\sup{*}"
macro.rarrow.HTML = "&rarr;"
+macro.rarrow.DocBook = "&#8594;"
macro.reg.HTML = "<sup>&reg;</sup>"
-macro.rego.DocBook = "\\sup{&#174;}"
+macro.reg.DocBook = "\\sup{&#174;}"
macro.return = "Returns"
macro.starslash = "\\c{*/}"
macro.begincomment = "\\c{/*}"
macro.endcomment = "\\c{*/}"
macro.uuml.HTML = "&uuml;"
+macro.uuml.DocBook = "&#252;"
macro.mdash.HTML = "&mdash;"
+macro.mdash.DocBook = "&#8212;"
macro.pi.HTML = "&Pi;"
+macro.pi.DocBook = "&#928;"
macro.beginqdoc.HTML = "/*!"
macro.endqdoc.HTML = "*/"
macro.borderedimage = "\\div {class=\"border\"} \\image \1\n\\enddiv"
@@ -46,6 +61,12 @@ macro.endfloat.HTML = "</div>"
macro.clearfloat.HTML = "<br style=\"clear: both\" />"
macro.emptyspan.HTML = "<span></span>"
+macro.beginfloatleft.DocBook = ""
+macro.beginfloatright.DocBook = ""
+macro.endfloat.DocBook = ""
+macro.clearfloat.DocBook = ""
+macro.emptyspan.DocBook = ""
+
# Used like \brief, but replicates the sentence also as text.
# Wrap the entire sentence with {}, for example:
# \summary {Creates a build target.}
diff --git a/doc/global/qt-html-templates-offline.qdocconf b/doc/global/qt-html-templates-offline.qdocconf
index 39f49fd3da..0d49376de6 100644
--- a/doc/global/qt-html-templates-offline.qdocconf
+++ b/doc/global/qt-html-templates-offline.qdocconf
@@ -31,6 +31,16 @@ qhp.extraFiles += style/offline.css \
images/bullet_sq.png \
images/bgrContent.png
+DocBook.extraimages += \
+ images/ico_out.png \
+ images/ico_note.png \
+ images/ico_note_attention.png \
+ images/btn_prev.png \
+ images/btn_next.png \
+ images/bullet_dn.png \
+ images/bullet_sq.png \
+ images/bgrContent.png
+
# By default, include override definitions for a simplified template/CSS,
# suited for rendering HTML with QTextBrowser. Comment out this line to
# select the standard CSS.