docs/manual/BUILD

   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
  29 Wtay's original comments :
  30 --------------------------
  31
  32 For now use:
  33
  34   db2html gstreamer-manual
  35
  36 (On debian, db2html is in the cygnus-stylesheets package)
  37
  38 You will need the png support for docbook (see GNOME documentation project)
  39
  40 convert the fig images to png with:
  41
  42   fig2dev -L png -s 16 fig/<input file>.fig images/<input file>.png
  43
  44 Put a link in the gstreamer-manual directory with
  45
  46   ln -s ../images gstreamer-manual/images
  47
  48 point your browser to gstreamer-manual/gstreamer.html
  49
  50 Fix typing errors and correct bad english.
  51 Let me know about the stuff that needs some more explanation.
  52 Let me know about the structure of the document.