gstreamer/docs/manual
Tim-Philipp Müller 0b60f83664 docs/: Fix typo (#400987).
Original commit message from CVS:
* docs/manual/manual.xml:
* docs/pwg/pwg.xml:
Fix typo (#400987).
2007-01-26 13:07:36 +00: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 Extract the manual examples again like we used to do. 2006-09-16 10:49:47 +00:00
advanced-clocks.xml docs/manual/: Update (until threads/scheduling) Application Development Manual; remove GstThread, add GstBus, add sim... 2005-06-29 09:25:51 +00:00
advanced-dataaccess.xml docs/manual/advanced-dataaccess.xml: Fix buffer probe example compilation in 2006-06-23 10:30:09 +00:00
advanced-dparams.xml docs/manual/advanced-dparams.xml: Fix typo (g_object_control_properties() doesn't exist). 2006-12-19 15:06:42 +00:00
advanced-interfaces.xml docs/manual/: Update (until threads/scheduling) Application Development Manual; remove GstThread, add GstBus, add sim... 2005-06-29 09:25:51 +00:00
advanced-metadata.xml docs/manual/: Update (until threads/scheduling) Application Development Manual; remove GstThread, add GstBus, add sim... 2005-06-29 09:25:51 +00:00
advanced-position.xml docs/manual/advanced-position.xml: Fix typo in sample code. 2006-09-05 14:11:06 +00:00
advanced-threads.xml docs/manual/: Update (until threads/scheduling) Application Development Manual; remove GstThread, add GstBus, add sim... 2005-06-29 09:25:51 +00:00
appendix-checklist.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-integration.xml docs/manual/appendix-integration.xml: Update GNOME integration section to use gst_init_get_option_group() instead of ... 2006-01-13 19:17:05 +00:00
appendix-licensing.xml small fix to the proposed license clause 2006-01-17 16:39:23 +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 another quote 2006-03-06 14:23:56 +00:00
appendix-win32.xml docs/manual/appendix-win32.xml: Remove mention of popt, we don't depend on that any longer (#353136). Add some commen... 2006-08-28 11:06:05 +00:00
base.css Small updates to the manual 2002-03-31 15:28:51 +00:00
basics-bins.xml docs/manual/: Fix typos and minor errors in sample code (#341856). 2006-05-16 16:10:38 +00:00
basics-bus.xml docs/manual/basics-bus.xml: Fix example code, gst_element_unref() doesn't exist any longer. 2007-01-22 14:30:27 +00:00
basics-data.xml docs/manual/: Try 2. This time, include a short preface as a "general introduction", also add code blocks around all ... 2004-12-15 17:32:49 +00:00
basics-elements.xml audiotestsrc is not part of core, fakesrc is 2006-09-22 14:30:49 +00:00
basics-helloworld.xml docs/manual/basics-helloworld.xml: Add a cast in example to fix compile warning 2006-10-18 19:43:46 +00:00
basics-init.xml docs/manual/: Fix typos and minor errors in sample code (#341856). 2006-05-16 16:10:38 +00:00
basics-pads.xml docs/manual/basics-pads.xml: Expand a bit on caps and filtered links and update examples that were still using the no... 2006-05-10 15:00:32 +00:00
basics-plugins.xml added docs for the TAG defines 2005-01-18 14:15:30 +00:00
bin-element-ghost.fig Updates and additions to the manual 2001-01-04 23:35:50 +00:00
bin-element-noghost.fig Added missing image 2002-12-12 21:02:51 +00:00
bin-element.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
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
hello-world.fig Small updates to the manual 2002-03-31 15:28:51 +00:00
highlevel-components.xml docs/manual/: Don't leak bus reference in sample code. 2006-06-16 09:39:54 +00:00
highlevel-xml.xml docs/manual/: Try 2. This time, include a short preface as a "general introduction", also add code blocks around all ... 2004-12-15 17:32:49 +00:00
intro-basics.xml docs/: describe dparams (controller) for plugins unify docs a little more 2006-02-02 11:24:19 +00:00
intro-motivation.xml docs/: add a gdp image 2006-06-13 19:24:34 +00:00
intro-preface.xml docs/: describe dparams (controller) for plugins unify docs a little more 2006-02-02 11:24:19 +00:00
linked-elements.fig typos and style fixes 2003-10-09 12:42:49 +00:00
Makefile.am move upload.mak to common 2006-04-29 00:36:47 +00:00
manual.xml docs/: Fix typo (#400987). 2007-01-26 13:07:36 +00:00
mime-world.fig docs/manual/mime-world.fig: Let's try this again, this time with a file that is actually in XFig format. 2005-12-11 19:35:02 +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
queue.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
README releasing 0.10.4 2006-03-10 19:03:13 +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 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
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.

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.