gstreamer/docs/manual
Christian Schaller f4559e5917 Various fixes:
Original commit message from CVS:
Various fixes:
- Fixing the doc problems in the SPEC
- Adding more content to the intro.xml
2002-06-11 16:06:10 +00:00
..
images
.gitignore
advanced-autoplugging.xml commit to make gstreamer follow the gtk function/macro naming conventions: 2002-04-11 20:35:18 +00:00
advanced-clocks.xml
advanced-dparams.xml commit to make gstreamer follow the gtk function/macro naming conventions: 2002-04-11 20:35:18 +00:00
advanced-schedulers.xml Some random docs updates I had lying around 2002-05-08 20:06:20 +00:00
advanced-threads.xml commit to make gstreamer follow the gtk function/macro naming conventions: 2002-04-11 20:35:18 +00:00
appendix-checklist.xml commit to make gstreamer follow the gtk function/macro naming conventions: 2002-04-11 20:35:18 +00:00
appendix-debugging.xml commit to make gstreamer follow the gtk function/macro naming conventions: 2002-04-11 20:35:18 +00:00
appendix-programs.xml new parser that uses flex and bison 2002-04-07 23:32:16 +00:00
appendix-quotes.xml
autoplugging.xml commit to make gstreamer follow the gtk function/macro naming conventions: 2002-04-11 20:35:18 +00:00
base.css
basics-bins.xml commit to make gstreamer follow the gtk function/macro naming conventions: 2002-04-11 20:35:18 +00:00
basics-data.xml new parser that uses flex and bison 2002-04-07 23:32:16 +00:00
basics-elements.xml commit to make gstreamer follow the gtk function/macro naming conventions: 2002-04-11 20:35:18 +00:00
basics-helloworld.xml commit to make gstreamer follow the gtk function/macro naming conventions: 2002-04-11 20:35:18 +00:00
basics-pads.xml commit to make gstreamer follow the gtk function/macro naming conventions: 2002-04-11 20:35:18 +00:00
basics-plugins.xml new parser that uses flex and bison 2002-04-07 23:32:16 +00:00
bin-element-ghost.fig
bin-element.fig
bins.xml commit to make gstreamer follow the gtk function/macro naming conventions: 2002-04-11 20:35:18 +00:00
buffers.xml new parser that uses flex and bison 2002-04-07 23:32:16 +00:00
BUILD
clocks.xml
components.xml new parser that uses flex and bison 2002-04-07 23:32:16 +00:00
connected-elements.fig
connections.xml new parser that uses flex and bison 2002-04-07 23:32:16 +00:00
cothreads.xml new parser that uses flex and bison 2002-04-07 23:32:16 +00:00
debugging.xml commit to make gstreamer follow the gtk function/macro naming conventions: 2002-04-11 20:35:18 +00:00
dparams-app.xml commit to make gstreamer follow the gtk function/macro naming conventions: 2002-04-11 20:35:18 +00:00
dynamic.xml doc fixes as per bugzilla bug 2002-06-10 08:29:27 +00:00
elements.xml commit to make gstreamer follow the gtk function/macro naming conventions: 2002-04-11 20:35:18 +00:00
factories.xml commit to make gstreamer follow the gtk function/macro naming conventions: 2002-04-11 20:35:18 +00:00
filter-element-multi.fig
filter-element.fig
goals.xml new parser that uses flex and bison 2002-04-07 23:32:16 +00:00
gstreamer-manual.xml new parser that uses flex and bison 2002-04-07 23:32:16 +00:00
hello-world.fig
helloworld.xml commit to make gstreamer follow the gtk function/macro naming conventions: 2002-04-11 20:35:18 +00:00
helloworld2.xml commit to make gstreamer follow the gtk function/macro naming conventions: 2002-04-11 20:35:18 +00:00
highlevel-components.xml new parser that uses flex and bison 2002-04-07 23:32:16 +00:00
highlevel-xml.xml commit to make gstreamer follow the gtk function/macro naming conventions: 2002-04-11 20:35:18 +00:00
init.xml new parser that uses flex and bison 2002-04-07 23:32:16 +00:00
intro-motivation.xml new parser that uses flex and bison 2002-04-07 23:32:16 +00:00
intro-preface.xml Various fixes: 2002-06-11 16:06:10 +00:00
intro.xml Various fixes: 2002-06-11 16:06:10 +00:00
magic-pdf
magic-png
Makefile.am
mime-world.fig
motivation.xml new parser that uses flex and bison 2002-04-07 23:32:16 +00:00
outline.txt
pads.xml commit to make gstreamer follow the gtk function/macro naming conventions: 2002-04-11 20:35:18 +00:00
plugins.xml new parser that uses flex and bison 2002-04-07 23:32:16 +00:00
programs.xml new parser that uses flex and bison 2002-04-07 23:32:16 +00:00
queue.fig
queues.xml commit to make gstreamer follow the gtk function/macro naming conventions: 2002-04-11 20:35:18 +00:00
quotes.xml
README
schedulers.xml Some random docs updates I had lying around 2002-05-08 20:06:20 +00:00
sink-element.fig
src-element.fig
state-diagram.fig
states.xml new parser that uses flex and bison 2002-04-07 23:32:16 +00:00
thread.fig
threads.xml commit to make gstreamer follow the gtk function/macro naming conventions: 2002-04-11 20:35:18 +00:00
typedetection.xml commit to make gstreamer follow the gtk function/macro naming conventions: 2002-04-11 20:35:18 +00:00
xml.xml commit to make gstreamer follow the gtk function/macro naming conventions: 2002-04-11 20:35:18 +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.