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

qdoc: Support offline search in .html files

    XMLWordPrintable

Details

    • User Story
    • Status: In Progress
    • P3: Somewhat important
    • Resolution: Unresolved
    • 6.3.1
    • None
    • Build tools: qdoc
    • None
    • DaVinci 69, DaVinci 70

    Description

      Allow a project to embed a search bar in the generated documentation (.html) that works locally.

      Use Case

      This is useful for offline documentation, where the user opens the .HTML files on local disk.

      In the Qt world, offline search is so far only available as part of Qt Help / Qt Assistant. Anyhow, this requires a) shipping and installing the tool, and b) limits the generated .HTML to the dialect Assistant supports. It would be arguably better to provide such a search also in a browser.

      Also, Squish, TestCenter local documentation does feature such a search so far, so customers will also expect it to continue to be available.

      Restrictions

      Compared to an online search, the results could be limited to one help project. That is, search doesn't have to work across help project boundaries (like they are in the case of the Qt framework documentation).

      Attachments

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

        Activity

          People

            treinio Topi Reiniö
            kkohne Kai Köhne
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:

              Gerrit Reviews

                There are no open Gerrit changes