docs/manual/README

   1 Current requirements for building the docs :
   2 --------------------------------------------
   3
   4 libxslt >= 1.0.6
   5 libxml2 >= 2.4.12
   6
   7
   8 These are not included with RH72.  They are in debian.  GDE has good rpms.
   9
  10 To build pdf's from xslt stuff, you need xmltex and (on redhat)
  11 passivetex.  They are not known to have been built on either redhat or
  12 debian yet though.
  13
  14 Wingo's new comments on the doc building :
  15 ------------------------------------------
  16 * Well he should add them soon here since he overhauled it. And did a good
  17   job on it too ;)
  18
  19 Thomas's new comments on the doc building :
  20 -------------------------------------------
  21 * originally the manual was written with DocBook 3.0 in mind, which
  22   supported the graphic tag.  That is now deprecated, so I changed it to
  23   the new mediaobject tag set.
  24
  25 * eps files in images/ should be generated from the makefile.  You need to
  26   have fig2dev installed for that.
  27
  28 Ensonic's comments on the doc build system :
  29 --------------------------------------------
  30 In case you like to share files between the manual and the pwg - it's
  31 not trivial.
  32 Before anything is done, the build-system copies all xml files into the build
  33 subdir and this breaks including shared docs via entities.
  34
  35 The examples should be updated in the xml. We run a perlscript in
  36 tests/examples/manual that extracts them.
  37
  38 Wtay's original comments :
  39 --------------------------
  40
  41 For now use:
  42
  43   db2html gstreamer-manual
  44
  45 (On debian, db2html is in the cygnus-stylesheets package)
  46
  47 You will need the png support for docbook (see GNOME documentation project)
  48
  49 convert the fig images to png with:
  50
  51   fig2dev -L png -s 16 fig/<input file>.fig images/<input file>.png
  52
  53 Put a link in the gstreamer-manual directory with
  54
  55   ln -s ../images gstreamer-manual/images
  56
  57 point your browser to gstreamer-manual/gstreamer.html
  58
  59 Fix typing errors and correct bad english.
  60 Let me know about the stuff that needs some more explanation.
  61 Let me know about the structure of the document.