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

Use online style also for stand-alone offline documentation

    XMLWordPrintable

    Details

    • Type: User Story
    • Status: Open
    • Priority: P2: Important
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: 6.4
    • Labels:
      None
    • Sprint:
      DaVinci sprint 52, DaVinci sprint 53, DaVinci sprint 54, DaVinci 55, DaVinci 56, DaVinci 57, DaVinci 58

      Description

      We're currently maintaining two different styles of documentation: online and offline.

      "online" style is what is used on doc.qt.io, and currently developed further with the new article style:

      • can use HTML5 features (JavaScript etc)
      • navigation facilities (TOC) is included

      "offline"style is used in Qt Creator, Qt Assistant, and standalone .html documentation

      • technically restricted by what Qt Assistant, Qt Creator can render
      • TOCis not part of the .html

      Squish, Coco, TestCenter does have a need for offline documentation, too. Anyhow, they are not restricted by limitations of Qt Assistant or Qt Creator.

      Can we therefore have an option to ship documentation that resembles the online style, but offline?

        Attachments

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

          Activity

            People

            Assignee:
            docinfrastructure Documentation Infrastructure Team
            Reporter:
            kkohne Kai Köhne
            Votes:
            1 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated:

                Gerrit Reviews

                There are no open Gerrit changes