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

Improvement to the Qt Doc

    XMLWordPrintable

Details

    • Task
    • Resolution: Done
    • P2: Important
    • 4.8.2, 4.8.x, 5.0.0
    • None
    • Documentation
    • None
    • b8f7f9b072b337fc648e5f34bf39a140c1b3971c 843719c7ca04964b6a67b23a932e08f166a2fee8

    Description

      1. Table styles 
      create one new style:

      borderless table with the white bgr  

      • class in offline.css is:
        .borderless {
        border-radius: 0px 0px 0px 0px;
        background-color: #fff;
        border: 1px solid #fff;
        }

      the white borderless table is used in home page of the documentation.

      2. New note types NOTE and Attention 
      Introduce 2 different note types to the qdoc command:

      in offline.css we have it now like this:

      .note,.tip,.fastpath{
      background: #F2F2F2 url(../images/ico_note.png);
      background-repeat: no-repeat;
      background-position: top left;
      padding:5px;
      padding-left:40px;
      padding-bottom:10px;
      border:#999 1px dotted;
      color:#666666;
      margin:5px;
      }

      .attention,.caution,.danger,.important,.remember,.restriction{
      background: #F2F2F2 url(../images/ico_note_attention.png);
      background-repeat:no-repeat;
      background-position:top left;
      padding:5px;
      padding-left:40px;
      padding-bottom:10px;
      border:#999 1px dotted;
      color:#666666;
      margin:5px;
      }

      3. Hide table context (toc list) from first page
       The doc list needs to be hide from the first page.
       

      4. Create new class and html structure  for the API pages
       - now there are some classes and structure issues that creates difficulty to style the API pages and documentation.

      The html for API references needs  some change: 
      •Page margins.
      ⁃ Now in API documentation  I can only indicate the page margins trough tag <body>. If I indicate the margins in <body> tag it will increase the margins also in Documentation section. For example, you can see this now in a header of documentation home page. There is 2 pixels margin in left and right side. If I increase the margin in offline.css the documentation header will be messed up. Now in Api page I can't introduce the margin. The text is now to close the border and it is hard to read. Can you please introduce new element after <body> that helps the styling of this pages. I need to tread them separately.
       

      Attachments

        For Gerrit Dashboard: QTBUG-23846
        # Subject Branch Project Status CR V

        Activity

          People

            gbk Martin Smith (Qt)
            vauvinen Virva Emilia Auvinen
            Votes:
            1 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes