#43 Use of color in doc example boxes

open
nobody
None
5
2017-10-07
2006-11-13
Dave Yost
No

The use of the four background colors to distinguish different types of
examples is good.

It would be nice if the doc had a key to the use of each color (shell, .i, .cc,
script).

The PDF of the doc does not use these colors, presumably to save ink
(good idea). A good compromise would be if the PDF would draw an
outline box around each example using these colors. This would use very
little ink but would help in identifying the type of each example.

Discussion

  • William Fulton

    William Fulton - 2006-11-13

    Logged In: YES
    user_id=242951

    The pdf documentation is generated by the htmldoc tool. I
    believe they intend to add support for CSS stylesheets - the
    colour comes from stylesheets. I suggest you contact them in
    order to improve the pdf output to recognise simple
    stylesheets. (We've got a slightly modified version of
    htmldoc in Doc/Manual/margin-left.patch to improve CSS support).

     
  • Olly Betts

    Olly Betts - 2007-05-13

    Logged In: YES
    user_id=14972
    Originator: NO

    There's no patch here, so moving from the "patch" tracker to the "feature request" tracker.

     
  • Olly Betts

    Olly Betts - 2017-10-07

    The PDF is now generated with a different tool and has the same coloured boxes as the HTML.

    Something explaining the coloured box styles in the "Preface" might be nice, though I suspect most people drop into the manual online via a search engine, so probably wouldn't actually see that.

     

Log in to post a comment.