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

As a developer of Qt, esp. of examples, I'd like to have a larger \note

XMLWordPrintable

    • 2
    • Foundation Sprint 125, Foundation Sprint 126, Foundation Sprint 127, Foundation Sprint 128, Foundation Sprint 129, Foundation Sprint 130, Foundation Sprint 131, Foundation Sprint 132, Foundation Sprint 133, Foundation Sprint 134, Foundation Sprint 135

      Sometimes, you want to expand on a tangent in documentation, but not visually break the flow of the main text too much. Traditional printing has footnotes for that, but those don't work online very well, so you see side-bars / box-outs used instead.

      We have something similar: \note, but it's restricted to a single paragraph, and javyas showed me the new \details command, but that seems to be hiding the text by default. What I'm looking for is a \note-like box, preferably flush-right with main text flowing around it (but using \note formatting for now would be ok, too), and, yes, potentially with a \details-like See more... expanding, if it's too long:

      Lorem ipsum dolor sit amet,     +---------Note-------+
      consectetur adipisici elit, sed | Excepteur sint     |
      eiusmod tempor incidunt ut      | obcaecat cupiditat |
      labore et dolore magna aliqua.  | non proident       |
      Ut enim ad minim veniam, quis   +---[see more...]----+
      nostrud exercitation ullamco laboris nisi ut aliquid ex
      ea commodi consequat. Quis aute iure reprehenderit in
      voluptate velit esse cillum dolore eu fugiat nulla
      pariatur.
      

      treinio showed me \div, but that's not scalable, as it leads to CSS classes strewn randomly across the documentation source, violating the DRY principle.

      So, I guess I'm asking for a new command \boxout/\endboxout (or maybe it's what \details should be) for this use-case.

      References:

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

            Unassigned Unassigned
            mmutz Marc Mutz
            Vladimir Minenko Vladimir Minenko
            Alex Blasche Alex Blasche
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved:

                There are no open Gerrit changes