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

[gabucino at mplayerhq.hu]

>  > * "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
How could it be outdated? :o Why remove?


> 0 Introduction
> 1 Installation
No way.. IMHO only "How to read" should be section 0, interpreted as
"before you start reading the real docs.."


> I'd say stick to "-" and lowercase.
Agreed.


>  > * Added table heads to some tables.
Only if needed and looks nice.


>  > * Moved "Developer cries" into the appendix.
> OK.
At first I though NO, but let's see.. Users should read it, that's the
important.


>  > * Converted some unnumbered "sections" into numbered sections.
> Depends, probably OK.
Probably not OK :) But depends.

I think it would be nice if we could trace the evolving of the XML DOCS
in CVS. Why not commit it? Like DOCS/SGML. (that should be removed, BTW)


>  > * The sound card list is actually a list (not a table, as in the HTML
>  >   docs).
> Sounds OK, show us some code.
Yea tables suck


>  > * Some examples use very long lines (>80 chars), especially in the
>  >   MEncoder section.  I used \ to break them in half.  I should have
>  >   left them as they were...
> Yes, probably.
Absolutely, don't break them. Hmm, they are supposed to be moved to the
manpage, nay?


>  > That's all for now.  Which of the above should go in the CVS?
> I'd say most of them, as explained above.  Some could use some further
> discussion, but a complete review of the structure of the docs is due
> anyway.
Yes. However, it would be nice to see the patch here before it gets
commited.

-- 
Gabucino

/ Worshipping Niedermayer 4ever /
"Do you always look at it encoded?" (C) D. R. F.
"minden lehet. ez nem." (c) A'rpi
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 232 bytes
Desc: not available
URL: <http://lists.mplayerhq.hu/pipermail/mplayer-dev-eng/attachments/20020823/bda62efe/attachment.pgp>