All,
I have added custom icon set 7 and 8 which includes an alternate to the
note icon and two "important" admonition icons. There is now at least
one icon for each admonition. Also there are both a colour icon and a
black and white icon for each symbol (see Key Points below).
Key points overall for the icons:
1. Each admonition background is:
1.1 - A different shape (except for Note and Tip (see
footnote 1 below)). They are Circle x2, Square, Triangle and Hexagon.
This should provide a visual guide even for those who are (partially)
colour blind;
1.2 - A different colour (except for Note and Important
(see footnote 2 below)). They are Black, Blue, Black, Orange and Red.
2. Each admonition foreground icon shape is visually
different:
2.1 -Note - is a light globe
2.2 -Tip - is the letter "i"
2.3 -Important - is the star/asterisk character
2.4 -Caution - is an exclamation mark
2.5 -Warning/Danger - is the word stop
A verbal visual description for each Admonition is as follows:
* Note - "Black Circle" background with "light globe
switched on" foreground
* Tip - "Blue Circle" background with "white letter I"
foreground
* Important - "Black Square" background with "white
star/asterisk character" foreground
* Caution - "Orange Triangle Border" background with "black
exclamation mark character" foreground
* Warning/Danger - "Red Hexagon" background with "the white
word stop" foreground
I have taken the liberty of updating the current consensus section
(http://tinyurl.com/2k7mw7) to show my preference for the icons. The
only change from the last update is the different note icon (I changed
it from Custom Icon Set 2 Tip to Custom Icon Set 7 Note (see footnote 1
for the rational of this switch)) and I have added both the colour and
black and white versions for the Important Admonition icons. I have
updated this section for people to more easily view the overall proposed
set.
I believe that besides a couple of minor visual tweaks (fixing up icon
shadows, ensuring that the SVG files are scaled correctly, maybe
slightly increasing the size of the letter "I" for the Tip admonition)
these icons are ready for use!
I am hoping that the title of this post will encourage people to look at
these icons and express what they like or dislike about them and
potentially how to improve them.
As an aside is this something that should have a wider dissemination for
people to express their views on (ie to the Boost Dev list) as these
icons will be used in any Quickbook documentation that library authors
create for their documentation or is a consensus on this list
sufficient?
Let me know what you think.
Thanks,
Peter.
Footnote 1 - I personally think that instead of using the light globe as
shown as Custom Icon Set 2 Tip, we should use the Custom Icon set 7 Note
icon. This will ensure that we have a similar look and feel for all of
the admonition icons (ie they each have a clear background shape
associated with the icon and it will be easier for colour blind people
to see the outline of the shape).
Footnote 2 - Although discussions on the list suggested that the colours
for the Important, Caution and Warning/Danger admonitions be Yellow ->
Orange -> Red I found that I could not get a Yellow icon that would look
right on a page with a white background. I have included one of the
better yellow icons as the Important icon in Custom Icon set 7.
-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2005.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Boost-docs mailing list
[email protected]
Unsubscribe and other administrative requests:
https://lists.sourceforge.net/lists/listinfo/boost-docs
