mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-26 19:51:11 +00:00
Code Issues 1 Projects Releases Wiki Activity
gstreamer/docs/manual
History
Thomas Vander Stichele 1ad4c7a804 make upload work for both gtk-doc and docbook docs 
Original commit message from CVS:
make upload work for both gtk-doc and docbook docs
2004-01-28 12:16:51 +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 typos and style fixes 2003-10-09 12:42:49 +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 typos and style fixes 2003-10-09 12:42:49 +00:00
advanced-threads.xml typos and style fixes 2003-10-09 12:42:49 +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 Fix GNOMEProgram to the correct capitalisation: GnomeProgram 2003-10-09 22:21:51 +00:00
appendix-integration.xml Fix GNOMEProgram to the correct capitalisation: GnomeProgram 2003-10-09 22:21:51 +00:00
appendix-programs.xml typos and style fixes 2003-10-09 12:42:49 +00:00
appendix-quotes.xml been long enough without an update 2003-11-23 12:50:27 +00:00
autoplugging.xml typos and style fixes 2003-10-09 12:42:49 +00:00
base.css Small updates to the manual 2002-03-31 15:28:51 +00:00
basics-bins.xml reorganizing manual so that concepts are explained before code is shown. 2003-12-29 14:15:02 +00:00
basics-data.xml typos and style fixes 2003-10-09 12:42:49 +00:00
basics-elements.xml reorganizing manual so that concepts are explained before code is shown. 2003-12-29 14:15:02 +00:00
basics-helloworld.xml typos and style fixes 2003-10-09 12:42:49 +00:00
basics-init.xml reorganizing manual so that concepts are explained before code is shown. 2003-12-29 14:15:02 +00:00
basics-pads.xml reorganizing manual so that concepts are explained before code is shown. 2003-12-29 14:15:02 +00:00
basics-plugins.xml reorganizing manual so that concepts are explained before code is shown. 2003-12-29 14:15:02 +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-api.xml reorganizing manual so that concepts are explained before code is shown. 2003-12-29 14:15:02 +00:00
bins.xml reorganizing manual so that concepts are explained before code is shown. 2003-12-29 14:15:02 +00:00
buffers-api.xml reorganizing manual so that concepts are explained before code is shown. 2003-12-29 14:15:02 +00:00
buffers.xml typos and style fixes 2003-10-09 12:42:49 +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 typos and style fixes 2003-10-09 12:42:49 +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 typos and style fixes 2003-10-09 12:42:49 +00:00
elements-api.xml reorganizing manual so that concepts are explained before code is shown. 2003-12-29 14:15:02 +00:00
elements.xml reorganizing manual so that concepts are explained before code is shown. 2003-12-29 14:15:02 +00:00
factories.xml typos and style fixes 2003-10-09 12:42:49 +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
gnome.xml Fix GNOMEProgram to the correct capitalisation: GnomeProgram 2003-10-09 22:21:51 +00:00
goals.xml 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
helloworld.xml typos and style fixes 2003-10-09 12:42:49 +00:00
helloworld2.xml entitize the version 2003-10-08 18:21:41 +00:00
highlevel-components.xml new parser that uses flex and bison 2002-04-07 23:32:16 +00:00
highlevel-xml.xml typos and style fixes 2003-10-09 12:42:49 +00:00
init-api.xml reorganizing manual so that concepts are explained before code is shown. 2003-12-29 14:15:02 +00:00
intro-motivation.xml typos and style fixes 2003-10-09 12:42:49 +00:00
intro-preface.xml typos and style fixes 2003-10-09 12:42:49 +00:00
intro.xml typos and style fixes 2003-10-09 12:42:49 +00:00
linked-elements.fig typos and style fixes 2003-10-09 12:42:49 +00:00
links-api.xml reorganizing manual so that concepts are explained before code is shown. 2003-12-29 14:15:02 +00:00
links.xml reorganizing manual so that concepts are explained before code is shown. 2003-12-29 14:15:02 +00:00
Makefile.am make upload work for both gtk-doc and docbook docs 2004-01-28 12:16:51 +00:00
manual.xml reorganizing manual so that concepts are explained before code is shown. 2003-12-29 14:15:02 +00:00
mime-world.fig Docs updates 2001-01-05 18:50:41 +00:00
motivation.xml typos and style fixes 2003-10-09 12:42:49 +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-api.xml reorganizing manual so that concepts are explained before code is shown. 2003-12-29 14:15:02 +00:00
pads.xml reorganizing manual so that concepts are explained before code is shown. 2003-12-29 14:15:02 +00:00
plugins-api.xml reorganizing manual so that concepts are explained before code is shown. 2003-12-29 14:15:02 +00:00
plugins.xml reorganizing manual so that concepts are explained before code is shown. 2003-12-29 14:15:02 +00:00
programs.xml typos and style fixes 2003-10-09 12:42:49 +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 typos and style fixes 2003-10-09 12:42:49 +00:00
quotes.xml been long enough without an update 2003-11-23 12:50:27 +00:00
README fixing make distcheck 2002-01-14 14:04:14 +00:00
schedulers.xml typos and style fixes 2003-10-09 12:42:49 +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
states-api.xml reorganizing manual so that concepts are explained before code is shown. 2003-12-29 14:15:02 +00:00
states.xml reorganizing manual so that concepts are explained before code is shown. 2003-12-29 14:15:02 +00:00
thread.fig typos and style fixes 2003-10-09 12:42:49 +00:00
threads.xml typos and style fixes 2003-10-09 12:42:49 +00:00
typedetection.xml typos and style fixes 2003-10-09 12:42:49 +00:00
xml.xml typos and style fixes 2003-10-09 12:42:49 +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.