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

Generating unique link target IDs for page elements automatically

    XMLWordPrintable

Details

    • Suggestion
    • Resolution: Unresolved
    • P3: Somewhat important
    • None
    • None
    • None

    Description

      Solving ambiguous links in QDoc documentation currently requires a manual insertion of a user-defined target name for the \target command.

      Allowing user-defined target names for the \target command poses a risk of the same target name(s) being used on different pages, which can lead to additional broken/ambiguous links in the long run.

      Would it be possible to (automatically) generate unique link target IDs for different elements on the page? The \section element seems to be a commonly used link target (perhaps the only internal link target currently used?) , so as a first step it might be enough to generate the target IDs for the \section elements. 

      In some modular documentation/component content management systems the system generates the unique IDs for all the elements on a page when the page is saved. Some systems also include an additional "Generate IDs" function/button that the writer can use to generate the IDs.   

       

         

      Attachments

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

        Activity

          People

            docinfrastructure Documentation Infrastructure Team
            estorman Esa Törmänen
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

            Dates

              Created:
              Updated:

              Gerrit Reviews

                There are no open Gerrit changes