• Improving Boost Docs
  • About this project
  • Boost docs repository
  • Unified look & feel project
  • Docs translations project
  • Glue docs project
  • Standard C++ Library Docs
  • Documentation Best Practices
  • Documentation Tools
  • Subprojects
    • Boost.DocTest
    • Boost HTML stylesheet
    • Boost Kate support
    • Boost PDF stylesheet
    • Boost specific WikiMacros
    • Boost Trac stylesheet
    • Boostscript
    • Google Search Box project
    • HTML to docbook
    • Quickbook WikiProcessor
    • Quickbook source stylesheet
    • SVG icons set project
    • Syntax highlighting project
    • Trac Syntax Coloring
    • Debugger Visualizers
  • Browser Testing Chart
  • Logo Playground

---

The purpose of this sub project is to find SVG Icons to use in the generation of Boost's documentation.

Key requirements include:

• Have a compatible license type for use within Boost.
• Provide Icon's that look good! By:
  • Using consistent themed icon's for logically grouped icon's
  • Using icons that are visually easy to work out what they mean (this is particularly important for the Admonitions)

License Type

To assist with setting the expectation for this project (ie use existing icons under an open source license or create the icons and license them under the Boost Software License, ​http://tinyurl.com/2xood5) I have sent an e-mail to the Boost Developers list and the Boost Documentation list seeking feedback on the license type.

To find the thread in the archive search for "Acceptable Licenses for Boost-Doc SVG Icons" sent by Peter Foley at 28 Jun 06 1818.

Rationale behind choosing Scalable Vector Graphics (SVG) Icons

See this Wikipedia article: ​http://en.wikipedia.org/wiki/SVG

Key Points:

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

Currently proposed Icons

Currently the Tango Desktop project (​http://tinyurl.com/23tspp) appears to provide promising icons. These icons are licensed under the Creative Commons Attribution Share-Alike license, ​http://creativecommons.org/licenses/by-sa/2.5/

Each icon in this set provides an SVG file. From this we can easily convert it to a PNG, ​http://en.wikipedia.org/wiki/Png file of the appropriate size.

Note: All the below images can be located off this page: ​http://tango.freedesktop.org/Tango_Icon_Gallery

Navigation Icons

The purpose of these icons are to navigate through the produced documentation.

Next Page:
Previous Page:
Chapter Start:
Home Page:

Comments:
(See this thread for more information: ​http://tinyurl.com/yrrmgd)

• Currently the preference is to keep the navigation icons green. This will match the current proposed colour scheme (green).
• Although the Home page icon is not green it was suggested that this would be good to more visually stand out from the arrows.

Admonitions

Note:

Comments:

• 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:

Comments:

• The response so far suggests that this is a good icon. There was the suggestion that it would look better if the light was switched on!

Important:

Comments:

• I think that this one looks better for a caution icon.

Caution:

Waring:

General Comments

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

---

Active Developers

Peter Foley
boost at ifoley dot id dot au

---

• Improving Boost Docs
  • About this project
  • Boost docs repository
  • Unified look & feel project
  • Docs translations project
  • Glue docs project
  • Standard C++ Library Docs
  • Documentation Best Practices
  • Documentation Tools
  • Subprojects
    • Boost.DocTest
    • Boost HTML stylesheet
    • Boost Kate support
    • Boost PDF stylesheet
    • Boost specific WikiMacros
    • Boost Trac stylesheet
    • Boostscript
    • Google Search Box project
    • HTML to docbook
    • Quickbook WikiProcessor
    • Quickbook source stylesheet
    • SVG icons set project
    • Syntax highlighting project
    • Trac Syntax Coloring
    • Debugger Visualizers
  • Browser Testing Chart
  • Logo Playground