Uploaded image for project: 'Qt'
  1. Qt
  2. QTBUG-24425

Define \ditamap and \topicref in qdoc for creating ditamaps when generating DITA XML output

    XMLWordPrintable

Details

    • Task
    • Resolution: Done
    • P2: Important
    • 5.0.0
    • None
    • Documentation
    • None
    • 3f64785e093df69b5458ac0eef79c0f7dee86c3a ea6dcc365834e53d2249f228d695a3847cf70d95 38de75aebe3b4d30ad7e78d3332491d6e7ee12c7 5884d31cf638af5bb60879251443f69321762ed2 87259301e6415f403be304b65768ad7c3ddba10f

    Description

      I think what we need a new page command: \ditamap
      and a \topicref \endtopicref command pair.

      /*!
      \ditamap
      \title Table of Contents for Creator

      \topicref

      {navtitletext here}

      {href of xml file here}
      \topicref {navtitle text here} {href of xml file here}

      \endtopicref
      \endtopicref

      */

      We also need \mapref, which in DITA is a <topicref format="ditamap">. The \mapref will be used to create a ditamap of ditamaps. The vision here is to let each repository contain one \ditamap qdoc file that specifies the table of contents for the repository. There can be multiple \ditamap files in a repository.

      There will also be a \ditamap somewhere that is "The Lord of the ditamaps," which specifies the ordering of all the repository ditamaps in an all-encompassing ditamap. This master ditamap will be used to create the <toc> element in the qhp file created by qdoc. There can be multiple master ditamaps as well, but the one qdoc uses will be specified in a new "toc" variable in the qdocconf file.

      For the DITA-impaired, \toc, \tocentry, and \tocref can be used in qdoc files instead of \ditamap, \topicref, and \mapref respectively.

      Attachments

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

        Activity

          People

            gbk Martin Smith (Qt)
            gbk Martin Smith (Qt)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes