32 | | In construction! |
| 32 | The purpose of this sub project is to find SVG Icons to use in the generation of Boost's documentation. |
| 33 | |
| 34 | Key requirements include: |
| 35 | * Have a compatible license type for use within Boost. |
| 36 | * Provide Icon's that look good! By: |
| 37 | * Using consistent themed icon's for logically grouped icon's |
| 38 | * Using icons that are visually easy to work out what they mean (this is particularly important for the Admonitions) |
| 39 | |
| 40 | == License Type == |
| 41 | |
| 42 | 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. |
| 43 | |
| 44 | 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. |
| 45 | |
| 46 | == Rationale behind choosing Scalable Vector Graphics (SVG) Icons == |
| 47 | |
| 48 | See this Wikipedia article: http://en.wikipedia.org/wiki/SVG |
| 49 | |
| 50 | Key Points: |
| 51 | * It is an open standard |
| 52 | * It is easy to convert to other formats |
| 53 | * SVG files scale really well |
| 54 | |
| 55 | == Currently proposed Icons == |
| 56 | |
| 57 | 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/ |
| 58 | |
| 59 | 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. |
| 60 | |
| 61 | ''Note:'' All the below images can be located off this page: http://tango.freedesktop.org/Tango_Icon_Gallery |
| 62 | |
| 63 | === Navigation Icons === |
| 64 | |
| 65 | The purpose of these icons are to navigate through the produced documentation. |
| 66 | |
| 67 | '''Next Page:''' [[Image(http://tango.freedesktop.org/static/cvs/tango-icon-theme/22x22/actions/go-next.png,nolink)]] [[BR]] |
| 68 | '''Previous Page:''' [[Image(http://tango.freedesktop.org/static/cvs/tango-icon-theme/22x22/actions/go-previous.png,nolink)]] [[BR]] |
| 69 | '''Chapter Start:''' [[Image(http://tango.freedesktop.org/static/cvs/tango-icon-theme/22x22/actions/go-up.png,nolink)]] [[BR]] |
| 70 | '''Home Page:''' [[Image(http://tango.freedesktop.org/static/cvs/tango-icon-theme/22x22/actions/go-home.png,nolink)]] [[BR]] |
| 71 | |
| 72 | ''Comments:'' [[BR]] |
| 73 | (See this thread for more information: http://tinyurl.com/yrrmgd) |
| 74 | |
| 75 | * Currently the preference is to keep the navigation icons green. This will match the current proposed colour scheme (green). |
| 76 | * Although the Home page icon is not green it was suggested that this would be good to more visually stand out from the arrows. |
| 77 | |
| 78 | === Admonitions === |
| 79 | |
| 80 | '''Note:''' [[Image(http://tango.freedesktop.org/static/cvs/tango-icon-theme/22x22/actions/system-search.png,nolink)]] [[BR]] |
| 81 | |
| 82 | ''Comments:'' [[BR]] |
| 83 | * 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. |
| 84 | |
| 85 | '''Tip:''' [[Image(http://tango.freedesktop.org/static/cvs/tango-icon-theme/22x22/status/dialog-information.png,nolink)]] [[BR]] |
| 86 | |
| 87 | ''Comments:'' [[BR]] |
| 88 | * 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! |
| 89 | |
| 90 | '''Important:''' [[Image(http://tango.freedesktop.org/static/cvs/tango-icon-theme/22x22/status/dialog-warning.png,nolink)]] [[BR]] |
| 91 | |
| 92 | ''Comments:'' [[BR]] |
| 93 | * I think that this one looks better for a caution icon. |
| 94 | |
| 95 | '''Caution:''' [[Image(http://tango.freedesktop.org/static/cvs/tango-icon-theme/22x22/status/dialog-error.png,nolink)]] [[BR]] |
| 96 | |
| 97 | |
| 98 | '''Waring:''' [[Image(http://tango.freedesktop.org/static/cvs/tango-icon-theme/22x22/actions/process-stop.png,nolink)]] [[BR]] |
| 99 | |
| 100 | ''General Comments'' |
| 101 | |
| 102 | By: Matias Capeletto on Sun, 24 Jun 2007 10:45:55 -0300 |
| 103 | |
| 104 | mmm... I think a common sense rationale for some of these admonitions will be: |
| 105 | |
| 106 | Warning ---> Yellow [[BR]] |
| 107 | Caution ---> Red |
| 108 | |
| 109 | |