gstreamer/docs/manual
Tim-Philipp Müller 0a5fbd4d3b docs: manual: improve advanced metadata example a bit
Accept both filename and a URI as argument, and print
the error from the error message if there's an error.

https://bugzilla.gnome.org/show_bug.cgi?id=756630
2015-10-16 12:00:22 +01: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 manual: add something about uridecodebin 2012-10-10 13:16:22 +02:00
advanced-buffering.xml Don't compare booleans for equality to TRUE and FALSE 2014-12-01 09:51:37 +01:00
advanced-clocks.xml docs: Fix typos in function/object descriptions 2013-12-07 17:11:12 +00:00
advanced-dataaccess.xml gstreamer: Fix memory leaks when context parse fails 2015-10-02 17:31:11 +03:00
advanced-dparams.xml manual: improve the controller docs a little more 2013-02-28 23:00:46 +01:00
advanced-interfaces.xml manual: fix up the manual 2012-09-25 14:45:15 +02:00
advanced-metadata.xml docs: manual: improve advanced metadata example a bit 2015-10-16 12:00:22 +01:00
advanced-position.xml manual: update for position/duration query API change 2011-07-28 12:01:58 +01:00
advanced-threads.xml manual: update elements to match the rest of "Boost priority of a thread" section 2013-06-01 20:10:38 +01:00
appendix-checklist.xml core: Fix max DEBUG_LEVEL incongruence on 5 vs 9 2013-10-10 13:06:14 -07:00
appendix-compiling.xml manual: move embedding elements to separate chapter 2012-10-12 13:13:32 +02:00
appendix-integration.xml gstreamer: Fix memory leaks when context parse fails 2015-10-02 17:31:11 +03:00
appendix-licensing.xml docs/manual/: Typo and formatting fixes (#538594). 2008-06-24 19:56:51 +00:00
appendix-porting.xml docs: update porting guides to mention new device probing API 2015-05-02 17:16:38 +01:00
appendix-programs.xml tests: Add missing unrefs of objects after use 2014-08-06 13:47:11 +02: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 manual: add some text about bin state change order 2012-10-11 17:07:39 +02:00
basics-bus.xml manual: small tweaks 2012-10-11 17:10:04 +02:00
basics-data.xml manual: fix up the manual 2012-09-25 14:45:15 +02:00
basics-elements.xml doc: fix forward reference about ghost pads 2013-10-29 22:06:31 +00:00
basics-helloworld.xml manual: fix up the manual 2012-09-25 14:45:15 +02:00
basics-init.xml gstreamer: Fix memory leaks when context parse fails 2015-10-02 17:31:11 +03:00
basics-pads.xml docs: manual: fix name reversal in basics-pads 2015-06-12 00:18:52 +01: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 manual: update graphics 2012-10-12 10:35:43 +02: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 manual: update graphics 2012-10-12 10:35:43 +02:00
diagrams-pipelines.svg manual: update graphics 2012-10-12 10:35:43 +02: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 manual: update graphics 2012-10-12 10:35:43 +02: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-playback.xml manual: talk about playsink 2012-10-10 16:43:58 +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 manual: small tweaks 2012-10-11 17:10:04 +02:00
intro-motivation.xml docs: Fix some reference URIs 2013-10-10 13:15:45 +02: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, gst: typo fixes 2011-09-07 18:03:17 +01:00
manual.xml docs: Fix some reference URIs 2013-10-10 13:15:45 +02:00
mime-world.png manual: update graphics 2012-10-12 10:35:43 +02:00
outline.txt docs: Fix typos in function/object descriptions 2013-12-07 17:11:12 +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.svg Add SVG versions of .fig file 2012-11-19 11:45:07 +01:00
thread-buffering.png manual: update graphics 2012-10-12 10:35:43 +02: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.