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

Organize help contents as a tree in Qt Assistant and Qt Creator

    XMLWordPrintable

    Details

      Description

      Problem
      =======

      When you open the Contents view in Qt Assistant or in the Qt Creator help mode, you get a long list of help files for Qt modules and tools. This is even worse in Qt Creator, where the documents for each installed Qt version are listed in a seemingly arbitrary order.

      Solution
      =======

      Organize the help contents in alphabetic order in an expandable tree structure.

      Possible Structure
      ===============

      The structure should have several levels. Below is a possible structure that follows the installer structure. However, it might be useful to add "Getting Started" documentation or product-specific documentation (Qt for Device Creation, Qt for Automotive, and so on) at the top level:

      Contents
      Qt (Level 1)

      __Qt <version number> (L2)
      __Qt <module name> (L3)
      __Qt <module name> (L3)
      _...
      __Qt Tools (L2)
      __Qt Assistant (L3)
      __<version number> (L4)
      __...
      __Qt Creator (L3)
      __Qt Creator <plugin name> (L4)
      __Qt Creator <plugin name> (L4)
      __Qt Enterprise Add-Ons (L2)
      __Qt Embedded (L2)

      3rd Party Documentation (L1)

      __Documentation Set (L2)
      __Documentation Set (L2)

        Attachments

        1. customfilters.png
          295 kB
        2. nofilter.png
          341 kB
        3. qtassistant-contents.png
          qtassistant-contents.png
          171 kB
        4. qtbug59364.zip
          4 kB
        5. qtcreator-contents-view.png
          qtcreator-contents-view.png
          225 kB

          Issue Links

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

            Activity

              People

              Assignee:
              jkobus Jarek Kobus
              Reporter:
              leenam Leena Miettinen
              Votes:
              4 Vote for this issue
              Watchers:
              9 Start watching this issue

                Dates

                Created:
                Updated:

                  Gerrit Reviews

                  There are no open Gerrit changes