Reviewing the use of admonitions

[Paul W. Frields]

On Tue, 2008-07-22 at 12:07 +1000, David O'Brien wrote:
> The use of admonitions - their scope and definition - was raised as part 
> of a style bug (Bugzilla 456026) and has developed a life of its own. 
> Keeping Fedora and Red Hat doc policies in sync is generally considered 
> A Good Thing, so I'm posting (almost) the complete list of comments here 
> for further discussion:
[...snip...]

> Comment #4 <https://bugzilla.redhat.com/show_bug.cgi?id=456026#c4> From 
> Karsten Wade (kwade at redhat.com <mailto:kwade at redhat.com>) 	on 2008-07-21 
> 03:14 EST 	[reply 
> <https://bugzilla.redhat.com/show_bug.cgi?id=456026#add_comment>] 	Private
> 
> Not to keep the hijacking up :), but here is something to add to your new bug
> report regarding redefining admonitions.
> 
> There *are* differences between a note and a tip.  There is a difference between
> offering warning and shouting caution.
> 
> https://fedoraproject.org/wiki/Help:Editing#Admonition_examples
> 
> Take it or leave it, but it is going to make it more difficult to integrate
> documentation from/to Fedora if the policies are not in sync.  Thus, you might
> want to take the discussion to fedora-docs-list.  You might find many receptive,
> since the GNOME style guide is otherwise respected, and they agree with your
> combination:
> 
> http://library.gnome.org/devel/gdp-style-guide/2.22/infodesign-18.html.en

I think the GNOME methodology makes the most sense.  A tip offers
helpful but possibly unsolicited advice.  The info and note admonitions
are far closer in meaning, and could easily be combined.  Same goes for
caution and warning; the warning is simply a caution on steroids, so to
speak.

FWIW, I vote we go the GDP way.

-- 
Paul W. Frields
  gpg fingerprint: 3DA6 A0AC 6D58 FEC4 0233  5906 ACDB C937 BD11 3717
  http://paul.frields.org/   -  -   http://pfrields.fedorapeople.org/
  irc.freenode.net: stickster @ #fedora-docs, #fedora-devel, #fredlug
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 189 bytes
Desc: This is a digitally signed message part
URL: <http://listman.redhat.com/archives/fedora-docs-list/attachments/20080722/bc96ce65/attachment.sig>