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

Expandable/drill down Table of Contents in online documentation

    XMLWordPrintable

    Details

    • Type: User Story
    • Status: Open
    • Priority: P2: Important
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Build tools: qdoc
    • Labels:

      Description

      As a documentation writer I want the table of contents to be expandable so that I can provide an overview of the content to the users, and allow them to dive deeper into details depending on what they're looking for.

      Acceptance Criteria: (presented as Scenarios)

      Scenario 1: Drill down
      Given the reader is on the first page
      When the reader selects an entry from the table of contents
      Then the topic for the TOC entry loads
      And the TOC shows the TOC for the topic.
      And the TOC does not expand the sub-topics by default

      Scenario 2: selecting elements in the TOC
      Given the reader is on a page
      When the reader selects an entry in the table of contents
      Then the topic for the TOC entry loads
      And the TOC does not change

      Scenario 3: Browsing the TOC
      Given the reader is on a page
      And the table of contents is present
      When the reader clicks a navigational marker in the TOC
      Then the TOC/navigation pane does change
      And the main content does not change.

        Attachments

          Issue Links

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

            Activity

              People

              Assignee:
              treinio Topi Reiniƶ
              Reporter:
              leenam Leena Miettinen
              Votes:
              5 Vote for this issue
              Watchers:
              6 Start watching this issue

                Dates

                Created:
                Updated:

                  Gerrit Reviews

                  There are no open Gerrit changes