Improving Boost Docs Project


SVG Icons set

The purpose of this subproject is to find SVG icons for use in the generation of Boost's documentation.

Key requirements for the icons include:

  • A compatible license type for use within Boost.
  • Icons that look good, in that they:
    • have a consistent theme based on their logical function (eg, navigation icons should look similar);
    • easily convey their function (this is particularly important for the admonition icons).

License Type

Feedback from the Boost community suggests that the the consensus is:

  • There is no strong preference to ensure the SVG icons are licensed under the Boost Software License (BSL), http://tinyurl.com/2xood5
  • The icons currently in use (the default DocBook? icons) are licensed under a modified MIT/X Consortium license, DocBook? FAQ http://tinyurl.com/3xux36
  • Any SVG icons we use should be licensed under an open source license that is compatible with the BSL

The above points have been extracted from two threads the first from the Boost-Docs list (Archive http://tinyurl.com/28ujla) and the second from the Boost-Dev list (Archive http://tinyurl.com/38l66e). Or search for "Acceptable Licenses for Boost-Doc SVG Icons" posted by Peter Foley on 28 June 2007 at 18:18.

Rationale behind choosing Scalable Vector Graphics (SVG) icons

Key points:

  • It is an open standard
  • It is easy to convert to other formats
  • SVG files scale very well

For more information on the benefits of using SVG-based images, see this Wikipedia article.

Note: It is worth stating that there are various tools and utilities that can easily convert to the PNG format. See this Wikipedia article. This is required as not all web browsers support the SVG format natively.

Currently proposed icons

This area will provide a central location to show each of the proposed icons and to allow the Boost community the opportunity of commenting on them.

Currently proposed icon sets include:

General icon requirements that various members of the Boost community have requested:

  • The icons should look good both in colour and in black-and-white (for printing). This is specifically for the admonitions.

These icons will be used to allow the user to navigate through the produced documentation.

Navigation icon requirements that various members of the Boost community have requested:

  • Currently the preference is to keep the navigation icons green. This will match the currently proposed colour scheme. (See this link)
  • Although the Tango home page icon is not green, it has been suggested that this would be good to stand out more from the arrows. (See this link)
Icon Set Name Previous Page Chapter Start Index Page Next Page License Type
Tango Desktop Project tango_prev (svg available) tango_chap (svg available) tango_indx (svg available) tango_next (svg available) Creative Commons Attribution Share-Alike license

Admonitions

The current choice of icons via consensus on the Boost Docs list are See below for other options

Icon Set Name Note Tip Important Caution Danger License Type
Colour Icon Set colour_note (svg available) colour_tip (svg available) colour_impt (svg available) colour_cutn (svg available) colour_warn (svg available) Creative Commons Attribution Share-Alike license
Black and White Icon Set bw_note (svg available) bw_tip (svg available) bw_impt (svg available) bw_cutn (svg available) bw_warn (svg available) Creative Commons Attribution Share-Alike license

Admonitions icon requirements that various members of the Boost community have requested:

By: Matias Capeletto on Sun, 24 Jun 2007 10:45:55 -0300

mmm... I think a common sense rationale for some of these admonitions will be:

Warning ---> Yellow
Caution ---> Red

Icon Set Name Note Tip Important Caution Waring License Type
Tango Desktop Project tango_note (svg available) tango_tip (svg available) tango_impt (svg available) tango_cutn (svg available) tango_warn (svg available) Creative Commons Attribution Share-Alike license
Custom Icons 1 custom1_note (svg available) custom1_tip (svg available)       Creative Commons Attribution Share-Alike license
Custom Icons 2 custom2_note (svg available) custom2_tip (svg available)       Creative Commons Attribution Share-Alike license
Custom Icons 3 custom3_note (svg available) custom3_tip (svg available)   custom3_cutn (svg available) custom3_warn (svg available) Creative Commons Attribution Share-Alike license
Custom Icons 4 custom4_note (svg available) custom4_tip (svg available)       Creative Commons Attribution Share-Alike license
Custom Icons 5 custom5_note (svg available) custom5_tip (svg available)       Creative Commons Attribution Share-Alike license
Custom Icons 6 custom6_note (svg available) custom6_tip (svg available)       Creative Commons Attribution Share-Alike license
Custom Icons 7 custom7_note (svg available)   custom7_impt (svg available)     Creative Commons Attribution Share-Alike license
Custom Icons 8     custom8_impt (svg available)     Creative Commons Attribution Share-Alike license

Comments so far:

  • Tango Desktop Project
    • Note - It was suggested that the magnifing glass would not be a good choice. Another option is a Blue circle with the letter "i" in it.
    • Tip - The response so far suggests that this is a good icon. There was the suggestion that it would look better if the light were switched on!
    • Important - I think that this one looks better for a caution icon.

Active developers


Peter Foley
boost at ifoley dot id dot au


Last modified 10 years ago Last modified on Aug 19, 2007 8:19:26 AM

Attachments (23)

Download all attachments as: .zip