summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJaishree Vyas <Jaishree.Vyas@qt.io>2023-02-20 16:41:21 +0100
committerJaishree Vyas <Jaishree.Vyas@qt.io>2023-03-02 12:34:04 +0100
commit384fd011b346a8eb570dfe240c550cd44723daec (patch)
tree7ea25c517ca41d1769147e06c176c7384d0de5ef
parent985f2c0a8ae9282aed9b9ddb1ae9fc933f012e28 (diff)
downloadqtdoc-384fd011b346a8eb570dfe240c550cd44723daec.tar.gz
Doc: XML processing overview
Changed the location from QtBase to QDoc for the consistency of overviews Fixes: QTBUG-83872 Pick-to: 6.4 6.5 Change-Id: I0e5b8e2ec149925da302299136f297ef978ba40a Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
-rw-r--r--doc/src/topics.qdoc4
-rw-r--r--doc/src/xml-overview.qdoc32
2 files changed, 33 insertions, 3 deletions
diff --git a/doc/src/topics.qdoc b/doc/src/topics.qdoc
index eb37d4dd..7bd071a6 100644
--- a/doc/src/topics.qdoc
+++ b/doc/src/topics.qdoc
@@ -19,9 +19,7 @@ functionality and can be used as a starting point for learning how to to get the
\li \l{Mobile Development}
\li \l{QML Applications}
\li \l{Platform Integration}
-\endlist
-
-\list
+\li \l{XML Processing}
\li \l {Scripting}
\li \l {Internationalization with Qt}
\li \l {Testing and Debugging}
diff --git a/doc/src/xml-overview.qdoc b/doc/src/xml-overview.qdoc
new file mode 100644
index 00000000..06a1e040
--- /dev/null
+++ b/doc/src/xml-overview.qdoc
@@ -0,0 +1,32 @@
+// Copyright (C) 2023 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
+
+/*!
+ \page xml-processing.html
+ \title XML Processing
+ \brief An Overview of the XML processing facilities in Qt.
+
+ Qt provides two sets of APIs to read and write well-formed XML: \l{XML Streaming}{stream based} and
+ \l{Working with the DOM Tree}{DOM based}.
+
+ Qt also provides specific support for some XML dialects. The Qt SVG module
+ provides the QSvgRenderer and QSvgGenerator classes to read
+ and write a subset of SVG, an XML-based file format. Qt also provides helper
+ functions that may be useful to those working with XML and XHTML:
+ see Qt::escape() and Qt::convertFromPlainText().
+
+ \section1 Topics:
+
+ \list
+ \li \l {Classes for XML Processing}
+ \li \l {An Introduction to Namespaces}
+ \li \l {XML Streaming}
+ \li \l {Working with the DOM Tree}
+ \endlist
+
+ \section1 Classes for XML Processing
+
+ These classes are relevant to XML users.
+
+ \annotatedlist xml-tools
+*/