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

Andras Mohari mayday at varoshaza.nagyatad.hu
Thu Aug 22 10:21:32 CEST 2002


On Thu, Aug 22, 2002 at 00:13:33 +0200, Diego Biurrun wrote:
> Nice work, thanks.  BTW, you made some changes while converting to XML.
> Do you remember what they were and could you wrap them up into a patch?

Some of them are already in CVS. ;)  There were some cosmetical and
structural changes, like:

* "How to read this documentation" is not numbered. :-)
  (It's a <preface>).
* Emphasized text is in <em>, since the <emphasis> DocBook tag is
  converted to the <em> HTML tag.
* Many uppercase words are in lowercase and emphasized.
* Important notes/warnings/hints are displayed in separate blocks
  (I've put everything starting with NOTE:/WARNING:/HINT: between
  <note>/<warning>/<tip>/<important> tags).
* Made key captions uppercase (i.e. h -> H, so capital H would be
  written as Shift+H).  The reason is that that's the way they are
  printed on keyboards and they are *more* readable.  BTW, I changed key
  combos to use "+" instead of "-" (e.g.  Ctrl+Alt+F1); we should choose
  one form and stick to it.
* Added table heads to some tables.
* Moved "Developer cries" into the appendix.
* Converted some unnumbered "sections" into numbered sections.
* Procedurized some instructions that were presented as <UL> lists.
  They are numbered in the XML version.
* Options are listed in variable lists instead of tables.
* Replacable option arguments are displayed in italics.
* The sound card list is actually a list (not a table, as in the HTML
  docs).
* 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...

That's all for now.  Which of the above should go in the CVS?

-- 
Andras Mohari
mayday at mail.nagyatad.hu



More information about the MPlayer-dev-eng mailing list