gstreamer/docs/manual
2011-05-16 16:10:49 +02:00
..
images Fix .cvsignores 2000-12-31 14:02:32 +00:00
.gitignore images are important to us 2003-10-08 14:53:18 +00:00
advanced-autoplugging.xml update manual code examples for new _get_caps() 2011-05-16 16:10:49 +02:00
advanced-clocks.xml manual: improve clock docs a little 2010-09-01 11:34:34 +02:00
advanced-dataaccess.xml memory: port code to new buffer data API 2011-03-28 20:08:45 +02:00
advanced-dparams.xml manual: update gst-controller chapter 2010-08-05 10:31:50 +03:00
advanced-interfaces.xml docs: fix some typos and add some missing links in the app dev manual 2010-07-16 18:37:24 +01:00
advanced-metadata.xml docs: fix some typos and add some missing links in the app dev manual 2010-07-16 18:37:24 +01:00
advanced-position.xml docs: fix a couple of typos in the manual 2010-07-01 19:58:09 +01:00
advanced-threads.xml docs: fix spelling of 'threshold' in app dev manual 2011-01-18 22:51:49 +00:00
appendix-checklist.xml docs: fix a couple of typos in the manual 2010-07-01 19:58:09 +01:00
appendix-integration.xml docs: Don't talk about the deprecated libgnome and GNOME-VFS 2009-08-19 16:24:39 +02:00
appendix-licensing.xml docs/manual/: Typo and formatting fixes (#538594). 2008-06-24 19:56:51 +00:00
appendix-porting.xml docs/manual/: Update for 0.10: s/0.9/0.10/; s/audioscale/audiorsample/; add converters in front of pipelines; remove ... 2005-12-11 17:49:10 +00:00
appendix-programs.xml docs/manual/: Update for 0.10: s/0.9/0.10/; s/audioscale/audiorsample/; add converters in front of pipelines; remove ... 2005-12-11 17:49:10 +00:00
appendix-quotes.xml add quote 2007-05-22 10:21:31 +00:00
base.css Small updates to the manual 2002-03-31 15:28:51 +00:00
basics-bins.xml docs: mention that it's necessary to set the state of elements added to an already-running pipeline 2011-02-10 00:04:09 +00:00
basics-bus.xml docs: Fix basics-bus docs 2010-01-26 08:52:16 -03:00
basics-data.xml docs/manual/basics-data.xml: Change "event-event interaction" to "element-element interaction". 2008-10-06 07:13:02 +00:00
basics-elements.xml docs: mention that it's necessary to set the state of elements added to an already-running pipeline 2011-02-10 00:04:09 +00:00
basics-helloworld.xml docs: fix a couple of typos in the manual 2010-07-01 19:58:09 +01:00
basics-init.xml build: sprintf, sscanf need stdio.h 2009-10-07 10:59:54 +03:00
basics-pads.xml docs: mention that it's necessary to set the state of elements added to an already-running pipeline 2011-02-10 00:04:09 +00:00
basics-plugins.xml added docs for the TAG defines 2005-01-18 14:15:30 +00:00
bin-element-ghost.png docs/manual/: Add scale factor for pdf output. 2008-06-27 07:03:05 +00:00
bin-element-noghost.png docs/manual/: Add scale factor for pdf output. 2008-06-27 07:03:05 +00:00
bin-element.png docs/manual/: Add scale factor for pdf output. 2008-06-27 07:03:05 +00:00
clocks.png docs/manual/: Add one more image showing different times together with a describing paragraph. Fixes #547729. 2008-08-14 14:26:20 +00:00
communication.png docs: improve communication picture and section 2010-03-31 11:32:38 +03:00
diagrams-clocks.svg docs/manual/: Add one more image showing different times together with a describing paragraph. Fixes #547729. 2008-08-14 14:26:20 +00:00
diagrams-general.svg docs: improve communication picture and section 2010-03-31 11:32:38 +03:00
diagrams-pipelines.svg docs/manual/: Replace one diagram with two separate ones and updates others. 2008-07-26 12:00:36 +00:00
filter-element-multi.png docs/manual/: Add scale factor for pdf output. 2008-06-27 07:03:05 +00:00
filter-element.png docs/manual/: Add scale factor for pdf output. 2008-06-27 07:03:05 +00:00
gstreamer-overview.png docs/manual/: Add scale factor for pdf output. 2008-06-27 07:03:05 +00:00
hello-world.png docs/manual/: Replace one diagram with two separate ones and updates others. 2008-07-26 12:00:36 +00:00
highlevel-components.xml update manual code examples for new _get_caps() 2011-05-16 16:10:49 +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 docs: fix some typos and add some missing links in the app dev manual 2010-07-16 18:37:24 +01:00
intro-gstreamer.xml docs/manual/: Some Application Development Manual fixes thanks to 2008-11-04 11:55:08 +00:00
intro-motivation.xml docs/manual/intro-motivation.xml: Remove some bits that no longer apply, update others (#551642). 2008-09-11 16:56:48 +00:00
intro-preface.xml docs/manual/: Some Application Development Manual fixes thanks to 2008-11-04 11:55:08 +00:00
linked-elements.png docs/manual/: Replace one diagram with two separate ones and updates others. 2008-07-26 12:00:36 +00:00
Makefile.am docs: Bump common, fix the upload logic inclusion 2009-06-11 13:16:29 +01:00
manual.xml docs: fix some typos and add some missing links in the app dev manual 2010-07-16 18:37:24 +01:00
mime-world.png docs/manual/: Replace one diagram with two separate ones and updates others. 2008-07-26 12:00:36 +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
README docs/README: Document that for plgin-docs we extraxt he short-desc from the element details. 2008-06-25 14:25:49 +00:00
simple-player.png docs/manual/: Add scale factor for pdf output. 2008-06-27 07:03:05 +00:00
sink-element.png docs/manual/: Add scale factor for pdf output. 2008-06-27 07:03:05 +00:00
src-element.png docs/manual/: Add scale factor for pdf output. 2008-06-27 07:03:05 +00:00
state-diagram.fig Misc tweaks to makefile for manual. Moved .figs into same directory so we can have them built appropriately without ... 2000-12-30 04:36:40 +00:00
thread-buffering.png docs/manual/: Replace one diagram with two separate ones and updates others. 2008-07-26 12:00:36 +00:00
thread-synchronizing.png docs/manual/: Replace one diagram with two separate ones and updates others. 2008-07-26 12:00:36 +00:00
titlepage.xml docs/manual/advanced-dparams.xml: describe controller 2006-01-30 21:11:38 +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.

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.