gstreamer/docs/manual
Wim Taymans bd0eb629bf pwg: flesh out allocation docs
Add more examples.
Add example for implementing new metadata.
Add programs to the docs (again?), it seems to contain useful info.
2012-10-02 11:34:47 +02:00
..
images
.gitignore
advanced-autoplugging.xml manual: fix up the manual 2012-09-25 14:45:15 +02:00
advanced-clocks.xml docs, gst: typo fixes 2011-09-07 18:03:17 +01:00
advanced-dataaccess.xml manual: fix up the manual 2012-09-25 14:45:15 +02:00
advanced-dparams.xml manual: update controller documentation 2012-09-21 21:13:27 +02:00
advanced-interfaces.xml manual: fix up the manual 2012-09-25 14:45:15 +02:00
advanced-metadata.xml replace gst_tag_list_free with gst_tag_list_unref 2012-09-14 17:52:14 +02:00
advanced-position.xml manual: update for position/duration query API change 2011-07-28 12:01:58 +01:00
advanced-threads.xml manual: fix up the manual 2012-09-25 14:45:15 +02:00
appendix-checklist.xml manual: fix up the manual 2012-09-25 14:45:15 +02:00
appendix-integration.xml manual: fix up the manual 2012-09-25 14:45:15 +02:00
appendix-licensing.xml
appendix-porting.xml manual: fix up the manual 2012-09-25 14:45:15 +02:00
appendix-programs.xml pwg: flesh out allocation docs 2012-10-02 11:34:47 +02:00
appendix-quotes.xml
base.css
basics-bins.xml manual: fix up the manual 2012-09-25 14:45:15 +02:00
basics-bus.xml manual: fix up the manual 2012-09-25 14:45:15 +02:00
basics-data.xml manual: fix up the manual 2012-09-25 14:45:15 +02:00
basics-elements.xml manual: fix up the manual 2012-09-25 14:45:15 +02:00
basics-helloworld.xml manual: fix up the manual 2012-09-25 14:45:15 +02:00
basics-init.xml docs, gst: typo fixes 2011-09-07 18:03:17 +01:00
basics-pads.xml docs: updates 2012-09-25 17:06:45 +02:00
basics-plugins.xml
bin-element-ghost.png
bin-element-noghost.png
bin-element.png
clocks.png
communication.png images: strip images of extra text tags 2011-06-21 15:15:44 +02:00
diagrams-clocks.svg
diagrams-general.svg docs, gst: typo fixes 2011-09-07 18:03:17 +01:00
diagrams-pipelines.svg
filter-element-multi.png
filter-element.png
gstreamer-overview.png
hello-world.png
highlevel-components.xml manual: fix up the manual 2012-09-25 14:45:15 +02:00
highlevel-xml.xml docs: update 'XML in GStreamer' section in application developer's manual 2010-06-30 13:16:35 +01:00
intro-basics.xml manual: fix up the manual 2012-09-25 14:45:15 +02:00
intro-gstreamer.xml docs: gst-python is no more 2012-09-25 14:45:15 +02:00
intro-motivation.xml
intro-preface.xml
linked-elements.png
Makefile.am docs, gst: typo fixes 2011-09-07 18:03:17 +01:00
manual.xml pwg: flesh out allocation docs 2012-10-02 11:34:47 +02:00
mime-world.png
outline.txt
README
simple-player.png
sink-element.png
src-element.png
state-diagram.fig
thread-buffering.png
thread-synchronizing.png
titlepage.xml

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.

Ensonic's comments on the doc build system :
--------------------------------------------
In case you like to share files between the manual and the pwg - it's
not trivial.
Before anything is done, the build-system copies all xml files into the build
subdir and this breaks including shared docs via entities.

The examples should be updated in the xml. We run a perlscript in
tests/examples/manual that extracts them.

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.