Version 18 (modified by 15 years ago) ( diff ) | ,
---|
- Improving Boost Docs
- About this project
- Boost docs repository
- Unified look and feel project
- Helping Boost authors
- 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 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:
- The Tango Desktop project which provides icons using the SVG format. This project is licensed under the Creative Commons Attribution Share-Alike license.
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.
Navigation icons
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 | (svg available) | (svg available) | (svg available) | (svg available) | Creative Commons Attribution Share-Alike license |
Admonitions
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 | (svg available) | (svg available) | (svg available) | (svg available) | (svg available) | Creative Commons Attribution Share-Alike license |
Custom Icons 1 | (svg available) | (svg available) | Creative Commons Attribution Share-Alike license | |||
Custom Icons 2 | (svg available) | (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
- Improving Boost Docs
- About this project
- Boost docs repository
- Unified look and feel project
- Helping Boost authors
- 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
Attachments (23)
-
info_v1.png
(1.7 KB
) - added by 15 years ago.
Custom Icon - Info, Blue Circle, Letter i
-
info_v2.png
(2.3 KB
) - added by 15 years ago.
Custom Icon - Info, Blue Circle, Magnifying Glass
-
tip_v1.png
(2.5 KB
) - added by 15 years ago.
Custom Icon - Tip, Black Circle, Light Globe (on)
-
tip_v2.png
(2.5 KB
) - added by 15 years ago.
Custom Icon - Tip, Light Globe (on)
-
circle_blue_i_tip.png
(1.7 KB
) - added by 15 years ago.
Circle, Colour Blue, Letter i
-
circle_green_i_tip.png
(1.6 KB
) - added by 15 years ago.
Circle, Colour Green, Letter i
-
circle_blue_light_on.png
(2.5 KB
) - added by 15 years ago.
Circle, Colour Blue, light on
-
circle_green_light_on.png
(2.3 KB
) - added by 15 years ago.
Circle, Colour Green, light on
-
circle_blue_mag_page_tip.png
(2.2 KB
) - added by 15 years ago.
Circle, Colour Blue, Magnifying Glass and Page
-
circle_green_mag_page_tip.png
(2.0 KB
) - added by 15 years ago.
Circle, Colour Green, Magnifying Glass and Page
-
circle_blue_pen_page_tip.png
(2.2 KB
) - added by 15 years ago.
Circle, Colour Blue, Pen and Page
-
circle_green_pen_page_tip.png
(2.1 KB
) - added by 15 years ago.
Circle, Colour Green, Pen and Page
-
circle_black_i_bw.png
(692 bytes
) - added by 15 years ago.
Circle, Black and White, Letter i
-
circle_black_light_bw.png
(1.1 KB
) - added by 15 years ago.
Circle, Black and White, Light Globe
-
hexagon_black_stop_bw.png
(1.6 KB
) - added by 15 years ago.
Hexagon, Black and White, Word Stop
-
triangle_black_exclamation_bw.png
(1.5 KB
) - added by 15 years ago.
Triangle, Black and White, Exclamation Mark
-
hexagon_red_stop.png
(2.1 KB
) - added by 15 years ago.
Hexagon, Colour Red, Word Stop
-
triangle_orange_exclamation.png
(1.4 KB
) - added by 15 years ago.
Triangle, Colour Orange, Exclamation Mark
-
square_yellow_star.png
(1.3 KB
) - added by 15 years ago.
Square, Yellow, Star
-
square_black_star.png
(1.5 KB
) - added by 15 years ago.
Square, Black, Star
-
circle_black_light_on.png
(2.7 KB
) - added by 15 years ago.
Circle, Black, light on
-
square_black_star_bw.png
(872 bytes
) - added by 15 years ago.
Square, Black and White, Star
-
circle_black_pen_page_bw.png
(1.6 KB
) - added by 15 years ago.
Circle, Black and White, Pen Notebook
Download all attachments as: .zip