mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-23 10:11:08 +00:00
Code Issues 1 Projects Releases Wiki Activity
gstreamer/docs/manual
History
Thomas Vander Stichele 4033722b99 renaming base documentation names 
Original commit message from CVS:
renaming base documentation names
2003-10-08 14:38:48 +00:00
..
images Fix .cvsignores 2000-12-31 14:02:32 +00:00
.gitignore adding images 2002-12-26 18:56:18 +00:00
advanced-autoplugging.xml fix docs build for good 2003-10-08 14:34:09 +00:00
advanced-clocks.xml Small updates to the manual 2002-03-31 15:28:51 +00:00
advanced-dparams.xml fix nonvalidation, now for the png problems ! 2002-12-12 18:03:16 +00:00
advanced-schedulers.xml language updates from cameron 2002-09-14 14:13:34 +00:00
advanced-threads.xml fix docs build for good 2003-10-08 14:34:09 +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-gnome.xml update example - config.h isn't included anymore 2003-06-29 14:36:31 +00:00
appendix-integration.xml update example - config.h isn't included anymore 2003-06-29 14:36:31 +00:00
appendix-programs.xml + changed connection/connect/conn/disconnect/connected/... to link/link/link/unlink/linked/... and moved connectish f... 2003-01-24 18:08:39 +00:00
appendix-quotes.xml doh 2002-09-14 14:18:55 +00:00
autoplugging.xml + changed connection/connect/conn/disconnect/connected/... to link/link/link/unlink/linked/... and moved connectish f... 2003-01-24 18:08:39 +00:00
base.css Small updates to the manual 2002-03-31 15:28:51 +00:00
basics-bins.xml fix docs build for good 2003-10-08 14:34:09 +00:00
basics-data.xml language updates from cameron 2002-09-14 14:13:34 +00:00
basics-elements.xml fix docs build for good 2003-10-08 14:34:09 +00:00
basics-helloworld.xml fix docs build for good 2003-10-08 14:34:09 +00:00
basics-pads.xml first pass of connect->link gst-plugins and other stuff compiles without change at this point 2003-01-09 14:15:37 +00:00
basics-plugins.xml scrubbed cameron patches 2002-09-06 16:10:31 +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
bins.xml fix docs build for good 2003-10-08 14:34:09 +00:00
buffers.xml language updates from cameron 2002-09-14 14:13:34 +00:00
BUILD fixing make distcheck 2002-01-14 14:04:14 +00:00
clocks.xml Small updates to the manual 2002-03-31 15:28:51 +00:00
components.xml new parser that uses flex and bison 2002-04-07 23:32:16 +00:00
cothreads.xml language updates from cameron 2002-09-14 14:13:34 +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 fix nonvalidation, now for the png problems ! 2002-12-12 18:03:16 +00:00
dynamic.xml first pass of connect->link gst-plugins and other stuff compiles without change at this point 2003-01-09 14:15:37 +00:00
elements.xml fix docs build for good 2003-10-08 14:34:09 +00:00
factories.xml fix docs build for good 2003-10-08 14:34:09 +00:00
filter-element-multi.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.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
gnome.xml update example - config.h isn't included anymore 2003-06-29 14:36:31 +00:00
goals.xml + changed connection/connect/conn/disconnect/connected/... to link/link/link/unlink/linked/... and moved connectish f... 2003-01-24 18:08:39 +00:00
hello-world.fig Small updates to the manual 2002-03-31 15:28:51 +00:00
helloworld.xml fix docs build for good 2003-10-08 14:34:09 +00:00
helloworld2.xml Fix pkg-config module name suffixes (-0.7). Closes #116089 2003-06-30 07:13:24 +00:00
highlevel-components.xml new parser that uses flex and bison 2002-04-07 23:32:16 +00:00
highlevel-xml.xml first pass of connect->link gst-plugins and other stuff compiles without change at this point 2003-01-09 14:15:37 +00:00
init.xml thanks cameron 2002-09-07 09:22:14 +00:00
intro-motivation.xml scrubbed cameron patches 2002-09-06 16:10:31 +00:00
intro-preface.xml + changed connection/connect/conn/disconnect/connected/... to link/link/link/unlink/linked/... and moved connectish f... 2003-01-24 18:08:39 +00:00
intro.xml + changed connection/connect/conn/disconnect/connected/... to link/link/link/unlink/linked/... and moved connectish f... 2003-01-24 18:08:39 +00:00
linked-elements.fig + changed connection/connect/conn/disconnect/connected/... to link/link/link/unlink/linked/... and moved connectish f... 2003-01-24 18:08:39 +00:00
links.xml fix docs build for good 2003-10-08 14:34:09 +00:00
Makefile.am renaming base documentation names 2003-10-08 14:38:48 +00:00
manual.xml renaming base documentation names 2003-10-08 14:38:48 +00:00
mime-world.fig Docs updates 2001-01-05 18:50:41 +00:00
motivation.xml scrubbed cameron patches 2002-09-06 16:10:31 +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
pads.xml first pass of connect->link gst-plugins and other stuff compiles without change at this point 2003-01-09 14:15:37 +00:00
plugins.xml scrubbed cameron patches 2002-09-06 16:10:31 +00:00
programs.xml + 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
queues.xml fix docs build for good 2003-10-08 14:34:09 +00:00
quotes.xml doh 2002-09-14 14:18:55 +00:00
README fixing make distcheck 2002-01-14 14:04:14 +00:00
schedulers.xml language updates from cameron 2002-09-14 14:13:34 +00:00
sink-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
src-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
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
states.xml + changed connection/connect/conn/disconnect/connected/... to link/link/link/unlink/linked/... and moved connectish f... 2003-01-24 18:08:39 +00:00
thread.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
threads.xml fix docs build for good 2003-10-08 14:34:09 +00:00
typedetection.xml + changed connection/connect/conn/disconnect/connected/... to link/link/link/unlink/linked/... and moved connectish f... 2003-01-24 18:08:39 +00:00
xml.xml first pass of connect->link gst-plugins and other stuff compiles without change at this point 2003-01-09 14:15:37 +00:00

README 

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.