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

Diego Biurrun diego at biurrun.de
Wed Aug 14 12:51:18 CEST 2002


Andras Mohari writes:
 > On Wed, Aug 14, 2002 at 12:22:23 +0200, Arpi wrote:
 > > > Here's a patch to fix some things in the documentation:
 > > > * Reduces the number of '!' chars...
 > > what is it good for??????
 > > they are there by reason.
 > 
 > Every single one?  Some sentences simply do not require '!'. If someone
 > takes the time to read the DOCS, he/she is not interested in shouting,
 > IMHO.  Using '!' even when not necessary just reduces its effect.

agreed

 > Anyway, I haven't touched '!!!!!!! BUT STAY TUNED !!!!!!!!' although
 > 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.

Who knows, once we have XML, maybe we can make a stylesheet that
translates into plaintext with these types of emphasis..

Diego



More information about the MPlayer-dev-eng mailing list