[[Image(ImprovingBoostDocs:ibdp.png,nolink)]] * [ImprovingBoostDocs Improving Boost Docs] * [ImprovingBoostDocs About this project] * [BoostDocsRepository Boost docs repository] * [UnifiedLookAndFeelProject Unified look and feel project] * [HelpingBoostAuthors Helping Boost authors] * [GlueDocsProject Glue docs project] * [StandardCppLibraryDocumentation Standard C++ Library docs] * [DocumentationBestPractices Documentation best practices] * [DocumentationTools Documentation tools] * [ImprovingBoostDocsSubprojects Subprojects] * [BoostDocTest Boost.DocTest ] * [BoostHtmlStylesheet Boost HTML stylesheet] * [BoostKateSupport Boost Kate support] * [BoostPdfStylesheet Boost PDF stylesheet] * [BoostSpecificWikiMacros Boost-specific WikiMacros] * [BoostTracStylesheet Boost Trac stylesheet] * [BoostscriptProject Boostscript] * [GoogleSearchBoxProject Google Search box project] * [HtmlToDockbookProject HTML to docbook] * [QuickbookWikiProcessor Quickbook WikiProcessor] * [QuickbookSourceStylesheetProject Quickbook source stylesheet] * '''[SvgIconsSetProject SVG icons set project]''' * [SyntaxHighlightingProject Syntax-highlighting project] * [BoostTracSyntaxColoring Trac syntax-coloring] * [DebuggerVisualizers Debugger visualizers] * [BrowserTestingChart Browser-testing chart] * [LibrariesLogos Logo playground] ---- [[Image(ImprovingBoostDocsSubprojects:svg_icons_set.png,nolink)]] 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, [http://en.wikipedia.org/wiki/SVG 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 [http://en.wikipedia.org/wiki/Png 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: * [http://tango.freedesktop.org/ The Tango Desktop project] which provides icons using the SVG format. This project is licensed under the [http://creativecommons.org/licenses/by-sa/2.5/ Creative Commons Attribution Share-Alike license]. See this thread in the Tango newsgroups for more information http://tinyurl.com/3cucu3 what we would have to do to use these icons. '''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 [http://tinyurl.com/yrrmgd 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 [http://tinyurl.com/yrrmgd this link]) {{{ #!rst ================== ================== ================== ================== ================== ================ **Icon Set Name** **Previous Page** **Chapter Start** **Index Page** **Next Page** **License Type** ================== ================== ================== ================== ================== ================ |tango_set|_ |tango_prev| |SVG| |tango_chap| |SVG| |tango_indx| |SVG| |tango_next| |SVG| |ccasal|_ ================== ================== ================== ================== ================== ================ .. Set Name - Tango .. |tango_set| replace:: *Tango Desktop Project* .. _tango_set: http://tinyurl.com/23tspp/ .. |tango_prev| image:: http://tango.freedesktop.org/static/cvs/tango-icon-theme/32x32/actions/go-previous.png .. |tango_chap| image:: http://tango.freedesktop.org/static/cvs/tango-icon-theme/32x32/actions/go-up.png .. |tango_indx| image:: http://tango.freedesktop.org/static/cvs/tango-icon-theme/32x32/actions/go-home.png .. |tango_next| image:: http://tango.freedesktop.org/static/cvs/tango-icon-theme/32x32/actions/go-next.png .. License Types .. |ccasal| replace:: *Creative Commons Attribution Share-Alike license* .. _ccasal: http://creativecommons.org/licenses/by-sa/2.5/ .. Image Type .. |SVG| replace:: *(svg available)* .. |PNG| replace:: *(png available)* }}} === Admonitions === '''The current choice of icons via consensus on the Boost Docs list are''' ''See below for other options'' {{{ #!rst ===================== ===================== ===================== ===================== ===================== ===================== =================== **Icon Set Name** **Note** **Tip** **Important** **Caution** **Danger** **License Type** ===================== ===================== ===================== ===================== ===================== ===================== =================== |colour_set| |colour_note| |SVG| |colour_tip| |SVG| |colour_impt| |SVG| |colour_cutn| |SVG| |colour_warn| |SVG| |ccasal|_ |bw_set| |bw_note| |SVG| |bw_tip| |SVG| |bw_impt| |SVG| |bw_cutn| |SVG| |bw_warn| |SVG| |ccasal|_ ===================== ===================== ===================== ===================== ===================== ===================== =================== .. |colour_set| replace:: *Colour Icon Set* .. |colour_note| image:: http://tango.freedesktop.org/static/cvs/tango-icon-theme/32x32/apps/accessories-text-editor.png?format=raw .. |colour_tip| image:: http://tango.freedesktop.org/static/cvs/tango-icon-theme/32x32/status/dialog-information.png?format=raw .. |colour_impt| image:: http://svn.boost.org/trac/boost/attachment/wiki/SvgIconsSetProject/info_v1.png?format=raw .. |colour_cutn| image:: http://svn.boost.org/trac/boost/attachment/wiki/SvgIconsSetProject/triangle_orange_exclamation.png?format=raw .. |colour_warn| image:: http://svn.boost.org/trac/boost/attachment/wiki/SvgIconsSetProject/hexagon_red_stop.png?format=raw .. |bw_set| replace:: *Black and White Icon Set* .. |bw_note| image:: http://svn.boost.org/trac/boost/attachment/wiki/SvgIconsSetProject/circle_black_pen_page_bw.png?format=raw .. |bw_tip| image:: http://svn.boost.org/trac/boost/attachment/wiki/SvgIconsSetProject/circle_black_light_bw.png?format=raw .. |bw_impt| image:: http://svn.boost.org/trac/boost/attachment/wiki/SvgIconsSetProject/circle_black_i_bw.png?format=raw .. |bw_cutn| image:: http://svn.boost.org/trac/boost/attachment/wiki/SvgIconsSetProject/triangle_black_exclamation_bw.png?format=raw .. |bw_warn| image:: http://svn.boost.org/trac/boost/attachment/wiki/SvgIconsSetProject/hexagon_black_stop_bw.png?format=raw .. License Types .. |ccasal| replace:: *Creative Commons Attribution Share-Alike license* .. _ccasal: http://creativecommons.org/licenses/by-sa/2.5/ .. Image Type .. |SVG| replace:: *(svg available)* .. |PNG| replace:: (png available) }}} '''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 [[BR]] Caution ---> Red {{{ #!rst ===================== ===================== ===================== ===================== ===================== ===================== =================== **Icon Set Name** **Note** **Tip** **Important** **Caution** **Waring** **License Type** ===================== ===================== ===================== ===================== ===================== ===================== =================== |tango_set|_ |tango_note| |SVG| |tango_tip| |SVG| |tango_impt| |SVG| |tango_cutn| |SVG| |tango_warn| |SVG| |ccasal|_ |custom1_set| |custom1_note| |SVG| |custom1_tip| |SVG| |ccasal|_ |custom2_set| |custom2_note| |SVG| |custom2_tip| |SVG| |ccasal|_ |custom3_set| |custom3_note| |SVG| |custom3_tip| |SVG| |custom3_cutn| |SVG| |custom3_warn| |SVG| |ccasal|_ |custom4_set| |custom4_note| |SVG| |custom4_tip| |SVG| |ccasal|_ |custom5_set| |custom5_note| |SVG| |custom5_tip| |SVG| |ccasal|_ |custom6_set| |custom6_note| |SVG| |custom6_tip| |SVG| |ccasal|_ |custom7_set| |custom7_note| |SVG| |custom7_impt| |SVG| |ccasal|_ |custom8_set| |custom8_impt| |SVG| |ccasal|_ ===================== ===================== ===================== ===================== ===================== ===================== =================== .. |tango_set| replace:: *Tango Desktop Project* .. _tango_set: http://tinyurl.com/23tspp/ .. |tango_note| image:: http://tango.freedesktop.org/static/cvs/tango-icon-theme/32x32/actions/system-search.png .. |tango_tip| image:: http://tango.freedesktop.org/static/cvs/tango-icon-theme/32x32/status/dialog-information.png .. |tango_impt| image:: http://tango.freedesktop.org/static/cvs/tango-icon-theme/32x32/status/dialog-warning.png .. |tango_cutn| image:: http://tango.freedesktop.org/static/cvs/tango-icon-theme/32x32/status/dialog-error.png .. |tango_warn| image:: http://tango.freedesktop.org/static/cvs/tango-icon-theme/32x32/actions/process-stop.png .. Set Name - Custom 1 .. |custom1_set| replace:: *Custom Icons 1* .. |custom1_note| image:: http://svn.boost.org/trac/boost/attachment/wiki/SvgIconsSetProject/info_v2.png?format=raw .. |custom1_tip| image:: http://svn.boost.org/trac/boost/attachment/wiki/SvgIconsSetProject/tip_v1.png?format=raw .. Set Name - Custom 2 .. |custom2_set| replace:: *Custom Icons 2* .. |custom2_note| image:: http://svn.boost.org/trac/boost/attachment/wiki/SvgIconsSetProject/info_v1.png?format=raw .. |custom2_tip| image:: http://svn.boost.org/trac/boost/attachment/wiki/SvgIconsSetProject/tip_v2.png?format=raw .. Set Name - Custom 3 .. |custom3_set| replace:: *Custom Icons 3* .. |custom3_note| image:: http://svn.boost.org/trac/boost/attachment/wiki/SvgIconsSetProject/circle_blue_i_tip.png?format=raw .. |custom3_tip| image:: http://svn.boost.org/trac/boost/attachment/wiki/SvgIconsSetProject/circle_green_i_tip.png?format=raw .. |custom3_cutn| image:: http://svn.boost.org/trac/boost/attachment/wiki/SvgIconsSetProject/triangle_orange_exclamation.png?format=raw .. |custom3_warn| image:: http://svn.boost.org/trac/boost/attachment/wiki/SvgIconsSetProject/hexagon_red_stop.png?format=raw .. Set Name - Custom 4 .. |custom4_set| replace:: *Custom Icons 4* .. |custom4_note| image:: http://svn.boost.org/trac/boost/attachment/wiki/SvgIconsSetProject/circle_blue_light_on.png?format=raw .. |custom4_tip| image:: http://svn.boost.org/trac/boost/attachment/wiki/SvgIconsSetProject/circle_green_light_on.png?format=raw .. Set Name - Custom 5 .. |custom5_set| replace:: *Custom Icons 5* .. |custom5_note| image:: http://svn.boost.org/trac/boost/attachment/wiki/SvgIconsSetProject/circle_blue_mag_page_tip.png?format=raw .. |custom5_tip| image:: http://svn.boost.org/trac/boost/attachment/wiki/SvgIconsSetProject/circle_green_mag_page_tip.png?format=raw .. Set Name - Custom 6 .. |custom6_set| replace:: *Custom Icons 6* .. |custom6_note| image:: http://svn.boost.org/trac/boost/attachment/wiki/SvgIconsSetProject/circle_blue_pen_page_tip.png?format=raw .. |custom6_tip| image:: http://svn.boost.org/trac/boost/attachment/wiki/SvgIconsSetProject/circle_green_pen_page_tip.png?format=raw .. Set Name - Custom 7 .. |custom7_set| replace:: *Custom Icons 7* .. |custom7_note| image:: http://svn.boost.org/trac/boost/attachment/wiki/SvgIconsSetProject/circle_black_light_on.png?format=raw .. |custom7_impt| image:: http://svn.boost.org/trac/boost/attachment/wiki/SvgIconsSetProject/square_yellow_star.png?format=raw .. Set Name - Custom 8 .. |custom8_set| replace:: *Custom Icons 8* .. |custom8_impt| image:: http://svn.boost.org/trac/boost/attachment/wiki/SvgIconsSetProject/square_black_star.png?format=raw .. License Types .. |ccasal| replace:: *Creative Commons Attribution Share-Alike license* .. _ccasal: http://creativecommons.org/licenses/by-sa/2.5/ .. Image Type .. |SVG| replace:: *(svg available)* .. |PNG| replace:: (png available) }}} '''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 === [[Image(People:no_picture.png,50)]] [[Br]]'''Peter Foley''' [[Br]]''boost at ifoley dot id dot au'' ---- * [ImprovingBoostDocs Improving Boost Docs] * [ImprovingBoostDocs About this project] * [BoostDocsRepository Boost docs repository] * [UnifiedLookAndFeelProject Unified look and feel project] * [HelpingBoostAuthors Helping Boost authors] * [GlueDocsProject Glue docs project] * [StandardCppLibraryDocumentation Standard C++ Library docs] * [DocumentationBestPractices Documentation best practices] * [DocumentationTools Documentation tools] * [ImprovingBoostDocsSubprojects Subprojects] * [BoostDocTest Boost.DocTest ] * [BoostHtmlStylesheet Boost HTML stylesheet] * [BoostKateSupport Boost Kate support] * [BoostPdfStylesheet Boost PDF stylesheet] * [BoostSpecificWikiMacros Boost-specific WikiMacros] * [BoostTracStylesheet Boost Trac stylesheet] * [BoostscriptProject Boostscript] * [GoogleSearchBoxProject Google Search box project] * [HtmlToDockbookProject HTML to docbook] * [QuickbookWikiProcessor Quickbook WikiProcessor] * [QuickbookSourceStylesheetProject Quickbook source stylesheet] * '''[SvgIconsSetProject SVG icons set project]''' * [SyntaxHighlightingProject Syntax-highlighting project] * [BoostTracSyntaxColoring Trac syntax-coloring] * [DebuggerVisualizers Debugger visualizers] * [BrowserTestingChart Browser-testing chart] * [LibrariesLogos Logo playground]