From b2793a9b7f14508be5cf14bb19127e886b8f1492 Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Thu, 4 Nov 2010 13:26:25 +0100
Subject: qdoc: Added the <related-links> element to the <topic>

This contains the next, previous, and start links for
pages that have them.

Task-number: QTBUG-14980
---
 tools/qdoc3/ditaxmlgenerator.cpp | 59 ++++++++++++++++++++++++++++++++++++++--
 tools/qdoc3/ditaxmlgenerator.h   |  2 ++
 2 files changed, 59 insertions(+), 2 deletions(-)

diff --git a/tools/qdoc3/ditaxmlgenerator.cpp b/tools/qdoc3/ditaxmlgenerator.cpp
index 4bc08a3..b69e731 100644
--- a/tools/qdoc3/ditaxmlgenerator.cpp
+++ b/tools/qdoc3/ditaxmlgenerator.cpp
@@ -2036,7 +2036,7 @@ void DitaXmlGenerator::writeXrefListItem(const QString& link, const QString& tex
   Generate the html page for a qdoc file that doesn't map
   to an underlying c++ file.
  */
-void DitaXmlGenerator::generateFakeNode(const FakeNode *fake, CodeMarker *marker)
+void DitaXmlGenerator::generateFakeNode(const FakeNode* fake, CodeMarker* marker)
 {
     SubTitleSize subTitleSize = LargeSubTitle;
     QList<Section> sections;
@@ -2054,7 +2054,6 @@ void DitaXmlGenerator::generateFakeNode(const FakeNode *fake, CodeMarker *marker
     }
 
     generateHeader(fake, fullTitle);
-    
     generateBrief(fake, marker); // <shortdesc>
     xmlWriter().writeStartElement("body");
     if (fake->subType() == Node::Module) {
@@ -2115,10 +2114,65 @@ void DitaXmlGenerator::generateFakeNode(const FakeNode *fake, CodeMarker *marker
         }
     }
     xmlWriter().writeEndElement(); // </body>
+    writeRelatedLinks(fake, marker);
     xmlWriter().writeEndElement(); // </topic>
 }
 
 /*!
+  This function writes a \e{<link>} element inside a
+  \e{<related-links>} element.
+
+  \sa writeRelatedLinks()
+ */
+void DitaXmlGenerator::writeLink(const Node* node,
+                                 const QString& text,
+                                 const QString& role)
+{
+    if (node) {
+        QString link = fileName(node) + "#" + node->guid();
+        xmlWriter().writeStartElement("link");
+        xmlWriter().writeAttribute("href", link);
+        xmlWriter().writeAttribute("role", role);
+        xmlWriter().writeStartElement("linktext");
+        xmlWriter().writeCharacters(text);
+        xmlWriter().writeEndElement(); // </linktext>
+        xmlWriter().writeEndElement(); // </link>
+    }
+}
+
+/*!
+  This function writes a \e{<related-links>} element, which
+  contains the \c{next}, \c{previous}, and \c{start}
+  links for topic pages that have them. Note that the
+  value of the \e role attribute is \c{parent} for the
+  \c{start} link.
+ */
+void DitaXmlGenerator::writeRelatedLinks(const FakeNode* node, CodeMarker* marker)
+{
+    const Node* linkNode = 0;
+    QPair<QString,QString> linkPair;
+    if (node && !node->links().empty()) {
+        xmlWriter().writeStartElement("related-links");
+        if (node->links().contains(Node::PreviousLink)) {
+            linkPair = node->links()[Node::PreviousLink];
+            linkNode = findNodeForTarget(linkPair.first, node, marker);
+            writeLink(linkNode, linkPair.second, "previous");
+        }
+        if (node->links().contains(Node::NextLink)) {
+            linkPair = node->links()[Node::NextLink];
+            linkNode = findNodeForTarget(linkPair.first, node, marker);
+            writeLink(linkNode, linkPair.second, "next");
+        }
+        if (node->links().contains(Node::StartLink)) {
+            linkPair = node->links()[Node::StartLink];
+            linkNode = findNodeForTarget(linkPair.first, node, marker);
+            writeLink(linkNode, linkPair.second, "parent");
+        }
+        xmlWriter().writeEndElement(); // </related-links>
+    }
+}
+
+/*!
   Returns "xml" for this subclass of class Generator.
  */
 QString DitaXmlGenerator::fileExtension(const Node * /* node */) const
@@ -2231,6 +2285,7 @@ void DitaXmlGenerator::generateHeader(const Node* node,
     xmlWriter().writeStartElement(nameElement); // <title> or <apiName>
     xmlWriter().writeCharacters(name);
     xmlWriter().writeEndElement(); // </title> or </apiName> 
+
 }
 
 /*!
diff --git a/tools/qdoc3/ditaxmlgenerator.h b/tools/qdoc3/ditaxmlgenerator.h
index aa8ca77..de949c2 100644
--- a/tools/qdoc3/ditaxmlgenerator.h
+++ b/tools/qdoc3/ditaxmlgenerator.h
@@ -136,6 +136,8 @@ class DitaXmlGenerator : public PageGenerator
                      CodeMarker* marker,
                      const QString& attribute = QString());
     void writePropertyParameter(const QString& tag, const NodeList& nlist);
+    void writeRelatedLinks(const FakeNode* fake, CodeMarker* marker);
+    void writeLink(const Node* node, const QString& tex, const QString& role);
 
  private:
     enum SubTitleSize { SmallSubTitle, LargeSubTitle };
-- 
cgit v0.12