Stjepan Rajko wrote: > Hi Peter, > > On 7/17/07, Peter Foley <[EMAIL PROTECTED]> wrote: >> All, >> >> I have a question on what you feel the order of precedence is for the >> Admonitions; specifically for Important, Caution and Warning. >> >> Do you feel that the order is Important --> Warning --> Caution >> (from least strong to strongest). >> > > I'd rank them Important -> Caution -> Warning. Personally it seems > like "warning" is the only one that can cut it for a real screamer - > something reserved for exceptional cases like "Potential catastrophy: > you may erase your hard drive by calling this function". > > BTW, I really like docs that lay out their use of admonitions, like > all of the spirit libs. It would be nice to settle on some simple > universal guidelines for when to use which admonition (sometimes when > I write docs I feel like I'm drawing from a hat when picking an > admonition).
Me too, looking around the web I found these guidelines: http://developers.cogentrts.com/cogent/prepdoc/pd-admonitions.html which seem to follow the default Docbook XSL image conventions as well BTW. They don't mention caution, but the default Docbook icons make this yellow, the same as an "important". >> Also is it safe to say that if these icons were coloured Yellow --> >> Orange --> Red. That this would help convey the strength of each >> state? >> If it fits the sign. Just thinking off the top of my head, how about if: The red-triangular sign was the warning (that's it road traffic meaning right?) The red-octagonal sign was re-coloured orange and used as a caution (might look auful of course, you'd have to try it and see). Not sure what to use for "important" then, maybe something more like the default docbook XSL one? Alternatively, we could use the same sign for all of these, and just change the colour: maybe the octagonal one with a "!" in the middle (like the docbook version). I assume that messing around with the colours is just a case of hacking the SVG-XML rather than any heavy duty editing? HTH, John. ------------------------------------------------------------------------- This SF.net email is sponsored by DB2 Express Download DB2 Express C - the FREE version of DB2 express and take control of your XML. No limits. Just data. Click to get it now. http://sourceforge.net/powerbar/db2/ _______________________________________________ Boost-docs mailing list [email protected] Unsubscribe and other administrative requests: https://lists.sourceforge.net/lists/listinfo/boost-docs
