use of alerts on the help wiki
Matthew East
mdke at ubuntu.com
Fri Sep 19 12:33:48 UTC 2008
Hi,
On Fri, Sep 19, 2008 at 1:24 PM, Charlie Kravetz
<cjk at teamcharliesangels.com> wrote:
> This would mean we now use some categories, we also have incorporated
> our own tags, which replace some categories, and we will have a third
> macro also? Couldn't these be included in with the tags? That would
> simplify things, yet allow them to be used.
Well, I think that an alert is a totally unrelated concept. A tag
marks a particular page to give the user an idea about potential
issues with the page, for example that it is out of date. A banner
appears at the top in order to communicate that.
On the other hand, it is frequently useful to include an alert in the
middle of a document to communicate an important part of the document
or a warning about running a particular command. We use these in the
system documentation all the time. For examples, see:
https://help.ubuntu.com/8.04/add-applications/C/extra-repositories.html
or
https://help.ubuntu.com/8.04/add-applications/C/extra-repositories-adding.html
--
Matthew East
http://www.mdke.org
gnupg pub 1024D/0E6B06FF
More information about the ubuntu-doc
mailing list