View Issue Details
| ID | Project | Category | View Status | Date Submitted | Last Update |
|---|---|---|---|---|---|
| 0001470 | ardour | documentation | public | 2007-02-06 00:30 | 2008-11-20 23:58 |
| Reporter | timbyr | Assigned To | timbyr | ||
| Priority | low | Severity | minor | Reproducibility | N/A |
| Status | closed | Resolution | fixed | ||
| Summary | 0001470: Admonition graphics are needed for the manual. | ||||
| Description | Admonition graphics help draw the readers attention to important sections of the manual. I refer to the note, tip, important, warning and caution admonitions similar to what is described on this page(likely to change address): http://fedora.redhat.com/docs/documentation-guide/s1-xml-admon.html It should be fairly easy to find some appropriately licensed icons to use, perhaps even from the tango project http://www.tango-project.org | ||||
| Additional Information | It should be possible to have some consitancy between the admonitions in the manual and notification icons ardour by overriding the icon theme but I'm not sure whether that is a good idea. | ||||
| Tags | No tags attached. | ||||
|
|
The documentation currently doesn't define the Caution, Warning and Important admonitions (which would be helpful for contributors as well as users!). Is there a clear distinction between a Caution and a Warning in the context of the Ardour manual? |
|
|
The five admonition types are what docbook supports and it doesn't try and define any symantics for there use. At the time I couldn't think of any appropriate definition so I just put in that placeholder text. There is no requirement to use them all and caution and warning are fairly similar. I believe that in some documentation caution may used for things that might cause damage to the system whereas warning is used for things that may cause damage to the user. Ardour isn't exactly heavy machinery :) so perhaps using just one of the two so that there is less confusion to the user and to the content authors? What do you think of the following definitions: Important: "The Important admonition is used to draw attention to parts of the interface that may be overlooked or certain settings that are vital in determining the behaviour of the Ardour." Some examples of this might be dithering settings on export or monitoring options etc. Warning: "The Warning admonition is used where an action may result in consequences that are unintended or permanent such as changes to the session that can not be undone or the removal of files." |
|
|
Those definitions look good to me, and not using more than we need makes sense. Including some examples, probably just in comments in the source for contributors, might be helpful to clarify the intent of each one. (I'd probably put dithering options as a Tip or Note - but I do know there are people who would rank it up there with personal injury or death! :-) ) As for graphics, if you don't already have something in mind, I wouldn't mind trying to put something together in Inkscape. If the icons were to be used in the GUI, what pixel dimensions would you be looking at? |
|
|
I added some of the tango icons as admonition graphics. You will need to build the documentation from source to see the change. Let me know what you think. |
|
|
The Tango icons look good to me. I'd spotted all but the "!" icon when I had a look recently. Closed? |
| Date Modified | Username | Field | Change |
|---|---|---|---|
| 2007-02-06 00:30 | timbyr | New Issue | |
| 2007-02-06 09:50 | timbyr | Status | new => assigned |
| 2007-02-06 09:50 | timbyr | Assigned To | => timbyr |
| 2007-02-13 22:16 | screwtop | Note Added: 0003238 | |
| 2007-02-14 01:05 | timbyr | Note Added: 0003239 | |
| 2007-02-14 07:43 | screwtop | Note Added: 0003242 | |
| 2007-02-14 13:58 | timbyr | Note Added: 0003244 | |
| 2007-02-15 07:48 | screwtop | Note Added: 0003294 | |
| 2007-02-15 09:31 | timbyr | Status | assigned => resolved |
| 2007-02-15 09:31 | timbyr | Fixed in Version | => SVN |
| 2007-02-15 09:31 | timbyr | Resolution | open => fixed |
| 2008-11-20 23:58 | seablade | Status | resolved => closed |
