[MPlayer-dev-eng] [PATCH] Another DOCS patch

[Andras Mohari]

On Thu, Aug 22, 2002 at 11:20:09 +0200, Diego Biurrun wrote:
>  > * "How to read this documentation" is not numbered. :-)
>  >   (It's a <preface>).
> 
> Actually, I want to remove that section (outdated, wrong and full of
> errors) and start with
> 
> 0 Introduction
> 1 Installation

Good idea. ;)

>  > * Important notes/warnings/hints are displayed in separate blocks
>  >   (I've put everything starting with NOTE:/WARNING:/HINT: between
>  >   <note>/<warning>/<tip>/<important> tags).
> 
> I've been thinking about using something like the em.note and em.warn
> styles from skin-en.html throughout the HTML docs.  Ideas welcome.

Or div.note, div.warn (or the same with <p>) when they should be
separated from other text?

>  > * Made key captions uppercase (i.e. h -> H, so capital H would be
[...]
> I think we should stick to "-", "+" seems to be more common with
> Windows apps.  I am not completely sure whether capitals are a good
> idea.  Since Unix is case sensitive this may confuse people, this
> sounds a bit like a Windowsism again.  I looked at a few apps, XEmacs
> and GNOME control center (Unix) use Ctrl-j, Mozilla (cross platform)
> uses Ctrl+F.  I'd say stick to "-" and lowercase.

Hm, I borrowed the Ctrl+F style from GTK. :)  And I used capitals
because I could not determine at first sight if "l" was the "L", "I" or
"1" key.  As I wrote, the other reason was that key captions (for
letters) are in uppercase.  I think it's fine to use "f" and "F" if
the user has to type in some text, but it's better to use "F" and
"Shift-F" in case of keys.  But I'm NOT against lowercase.


I'll try to create a patch soon.
-- 
Andras Mohari
mayday at mail.nagyatad.hu