[MPlayer-dev-eng] [PATCH] Docs fixes

[Diego Biurrun]

Arpi writes:
 > > >  > there are better ways to bring the reader's attention to something,
 > > >  > for instance, by better structuring.
 > > > 
 > > > The problem here is that ASCII structuring techniques are mixed with
 > > > HTML structure throughout the docs.  In plain text docs it is ok to
 > > > use some kind of email/IRC style with ALL CAPS, _underlined_ and such
 > > > for stuff that is *really* IMPORTANT!!!  HTML does offer markup like
 > > > <i> and <b> or even better <em> and <strong> for this and in the HTML
 > > > documentation these should be the preferred method of putting emphasis
 > > > on certain aspects.
 > > 
 > > I agree. <em> and <strong> would do just fine.  Very important notes
 > > could be displayed in separate blocks with large margins (similar to the
 > > way DocBook formats notes/warnings/tips).  But it would be an impossible
 > > search & replace mission. :-)
 > 
 > ok i'm not against doing !!! -> <strong> or such conversion, but just
 > removing !!! and changing uppercase to lowercase is not acceptable,
 > they were done uppercase && !!! to sign it's a very important sentence of
 > the paragraph and if the user wants to skip reading it, at least that
 > sentence should be readed with caution.

I found most changes quite reasonable.  If it currently says:

  Don't do X because of Y! Read the man page for details!

Then it's OK to change that to

  Don't do X because of Y! Read the man page for details.

"!" should be used sparingly, else they loose their effect.

Diego