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

QDoc: Breadcrumb and next/previous page from the TOC with \generatelist

    XMLWordPrintable

Details

    • Suggestion
    • Resolution: Unresolved
    • P2: Important
    • None
    • None
    • Build tools: qdoc
    • None

    Description

      When topics are added to the TOC, \nextpage and \previouspage values and the breadcrumb navigation are generated automatically from the TOC. However, adding topics to TOC with \generatelist causes the \nextpage, \previouspage, and breadcrumb navigation to work in an unexpected way.

       

      In other words, topics that are listed with \generatelist in the TOC have next/previouspage links to the next/previous high-level topics and the breadcrumb does not show the path to the topic (examples below).

       

      For example, these topics in Qt Creator and Qt Design Studio docs were added to their respective TOCs with \generatelist and navigation does not work as expected:

       

      I expected the navigation to work similarly if I had manually listed all the topics to the TOC. So, the breadcrumb would show the "path" to that topic. And, the \nextpage and \previouspage would link to a next/previous topic in that list.

       

      What I expected the navigation to look like: https://doc.qt.io/qtdesignstudio/studio-3d-editor.html

       

      It would improve usability (for the user and the writer of the docs) if the navigation worked as expected.

      Attachments

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

        Activity

          People

            docinfrastructure Documentation Infrastructure Team
            teeapoldsam Teea Põldsam
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:

              Gerrit Reviews

                There are no open Gerrit changes