gstreamer/docs/manual
Thomas Vander Stichele 1adc2281fd been long enough without an update
Original commit message from CVS:
been long enough without an update
2003-11-23 12:50:27 +00:00
..
images
.gitignore images are important to us 2003-10-08 14:53:18 +00:00
advanced-autoplugging.xml typos and style fixes 2003-10-09 12:42:49 +00:00
advanced-clocks.xml
advanced-dparams.xml
advanced-schedulers.xml typos and style fixes 2003-10-09 12:42:49 +00:00
advanced-threads.xml typos and style fixes 2003-10-09 12:42:49 +00:00
appendix-checklist.xml
appendix-debugging.xml
appendix-gnome.xml Fix GNOMEProgram to the correct capitalisation: GnomeProgram 2003-10-09 22:21:51 +00:00
appendix-integration.xml Fix GNOMEProgram to the correct capitalisation: GnomeProgram 2003-10-09 22:21:51 +00:00
appendix-programs.xml typos and style fixes 2003-10-09 12:42:49 +00:00
appendix-quotes.xml been long enough without an update 2003-11-23 12:50:27 +00:00
autoplugging.xml typos and style fixes 2003-10-09 12:42:49 +00:00
base.css
basics-bins.xml typos and style fixes 2003-10-09 12:42:49 +00:00
basics-data.xml typos and style fixes 2003-10-09 12:42:49 +00:00
basics-elements.xml typos and style fixes 2003-10-09 12:42:49 +00:00
basics-helloworld.xml typos and style fixes 2003-10-09 12:42:49 +00:00
basics-pads.xml typos and style fixes 2003-10-09 12:42:49 +00:00
basics-plugins.xml
bin-element-ghost.fig
bin-element-noghost.fig
bin-element.fig
bins.xml typos and style fixes 2003-10-09 12:42:49 +00:00
buffers.xml typos and style fixes 2003-10-09 12:42:49 +00:00
BUILD
clocks.xml
components.xml
cothreads.xml typos and style fixes 2003-10-09 12:42:49 +00:00
debugging.xml
dparams-app.xml
dynamic.xml typos and style fixes 2003-10-09 12:42:49 +00:00
elements.xml typos and style fixes 2003-10-09 12:42:49 +00:00
factories.xml typos and style fixes 2003-10-09 12:42:49 +00:00
filter-element-multi.fig typos and style fixes 2003-10-09 12:42:49 +00:00
filter-element.fig typos and style fixes 2003-10-09 12:42:49 +00:00
gnome.xml Fix GNOMEProgram to the correct capitalisation: GnomeProgram 2003-10-09 22:21:51 +00:00
goals.xml typos and style fixes 2003-10-09 12:42:49 +00:00
hello-world.fig
helloworld.xml typos and style fixes 2003-10-09 12:42:49 +00:00
helloworld2.xml entitize the version 2003-10-08 18:21:41 +00:00
highlevel-components.xml
highlevel-xml.xml typos and style fixes 2003-10-09 12:42:49 +00:00
init.xml typos and style fixes 2003-10-09 12:42:49 +00:00
intro-motivation.xml typos and style fixes 2003-10-09 12:42:49 +00:00
intro-preface.xml typos and style fixes 2003-10-09 12:42:49 +00:00
intro.xml typos and style fixes 2003-10-09 12:42:49 +00:00
linked-elements.fig typos and style fixes 2003-10-09 12:42:49 +00:00
links.xml typos and style fixes 2003-10-09 12:42:49 +00:00
Makefile.am renaming base documentation names 2003-10-08 14:38:48 +00:00
manual.xml typos and style fixes 2003-10-09 12:42:49 +00:00
mime-world.fig
motivation.xml typos and style fixes 2003-10-09 12:42:49 +00:00
outline.txt + changed connection/connect/conn/disconnect/connected/... to link/link/link/unlink/linked/... and moved connectish f... 2003-01-24 18:08:39 +00:00
pads.xml typos and style fixes 2003-10-09 12:42:49 +00:00
plugins.xml
programs.xml typos and style fixes 2003-10-09 12:42:49 +00:00
queue.fig
queues.xml typos and style fixes 2003-10-09 12:42:49 +00:00
quotes.xml been long enough without an update 2003-11-23 12:50:27 +00:00
README
schedulers.xml typos and style fixes 2003-10-09 12:42:49 +00:00
sink-element.fig typos and style fixes 2003-10-09 12:42:49 +00:00
src-element.fig typos and style fixes 2003-10-09 12:42:49 +00:00
state-diagram.fig
states.xml typos and style fixes 2003-10-09 12:42:49 +00:00
thread.fig typos and style fixes 2003-10-09 12:42:49 +00:00
threads.xml typos and style fixes 2003-10-09 12:42:49 +00:00
typedetection.xml typos and style fixes 2003-10-09 12:42:49 +00:00
xml.xml typos and style fixes 2003-10-09 12:42:49 +00:00

Current requirements for building the docs :
--------------------------------------------

libxslt >= 1.0.6
libxml2 >= 2.4.12


These are not included with RH72.  They are in debian.  GDE has good rpms.

To build pdf's from xslt stuff, you need xmltex and (on redhat) 
passivetex.  They are not known to have been built on either redhat or 
debian yet though.

Wingo's new comments on the doc building :
------------------------------------------
* Well he should add them soon here since he overhauled it. And did a good 
  job on it too ;)

Thomas's new comments on the doc building :
-------------------------------------------
* originally the manual was written with DocBook 3.0 in mind, which 
  supported the graphic tag.  That is now deprecated, so I changed it to 
  the new mediaobject tag set.

* eps files in images/ should be generated from the makefile.  You need to 
  have fig2dev installed for that.


Wtay's original comments :
--------------------------

For now use:

  db2html gstreamer-manual 

(On debian, db2html is in the cygnus-stylesheets package)

You will need the png support for docbook (see GNOME documentation project)

convert the fig images to png with:

  fig2dev -L png -s 16 fig/<input file>.fig images/<input file>.png

Put a link in the gstreamer-manual directory with

  ln -s ../images gstreamer-manual/images

point your browser to gstreamer-manual/gstreamer.html

Fix typing errors and correct bad english.
Let me know about the stuff that needs some more explanation.
Let me know about the structure of the document.