Details
-
Suggestion
-
Resolution: Unresolved
-
P2: Important
-
5.9.0 Alpha
-
All
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
Issue Links
- is required for
-
QTBUG-81857
Qt Documentation UX improvements
-
- In Progress
-
- relates to
-
QTCREATORBUG-17949 Duplication of help topics
-
- Closed
-
-
-
- Closed
-
Gerrit Reviews
| For Gerrit Dashboard: QTBUG-59364 | ||||||
|---|---|---|---|---|---|---|
| # | Subject | Branch | Project | Status | CR | V |
| 224060,7 | Order contents items alphabetically by title | dev | qt/qttools | Status: MERGED | +2 | 0 |