mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-13 04:41:16 +00:00
Code Issues 1 Projects Releases Wiki Activity
gstreamer/docs/manual
History
Steve Lhomme faf76178b3 update documentation with the clean version of dependencies 
Original commit message from CVS:
update documentation with the clean version of dependencies
2004-08-03 15:19:34 +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-schedulers.xml fix manual id's 2004-01-28 15:08:17 +00:00
appendix-checklist.xml fix debugging info in manual 2004-02-25 17:38:53 +00:00
appendix-debugging.xml fix debugging info in manual 2004-02-25 17:38:53 +00:00
appendix-gnome.xml add GstPoptOption to work around evil poptOption struct def make sure popt is i18n'd expand gnome example 2004-02-03 14:59:32 +00:00
appendix-integration.xml add GstPoptOption to work around evil poptOption struct def make sure popt is i18n'd expand gnome example 2004-02-03 14:59:32 +00:00
appendix-programs.xml fix manual id's 2004-01-28 15:08:17 +00:00
appendix-quotes.xml docs/manual/quotes.xml: Keep the quotes file alive 2004-07-12 13:48:46 +00:00
appendix-win32.xml update documentation with the clean version of dependencies 2004-08-03 15:19:34 +00:00
autoplugging.xml cleanup of unused and forgoten sections fixed links from the manual and the pwg to the API docs added more notes to R... 2004-07-27 15:01:10 +00:00
base.css Small updates to the manual 2002-03-31 15:28:51 +00:00
basics-init.xml docs/manual/init-api.xml: Grammar fix 2004-07-15 17:04:23 +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 cleanup of unused and forgoten sections fixed links from the manual and the pwg to the API docs added more notes to R... 2004-07-27 15:01:10 +00:00
bins.xml fix manual id's 2004-01-28 15:08:17 +00:00
buffers-api.xml fix manual id's 2004-01-28 15:08:17 +00:00
buffers.xml cleanup of unused and forgoten sections fixed links from the manual and the pwg to the API docs added more notes to R... 2004-07-27 15:01:10 +00:00
BUILD fixing make distcheck 2002-01-14 14:04:14 +00:00
clocks.xml fix manual id's 2004-01-28 15:08:17 +00:00
components.xml fix manual id's 2004-01-28 15:08:17 +00:00
cothreads.xml cleanup of unused and forgoten sections fixed links from the manual and the pwg to the API docs added more notes to R... 2004-07-27 15:01:10 +00:00
debugging.xml fix debugging info in manual 2004-02-25 17:38:53 +00:00
dparams-app.xml docs/manual/dparams-app.xml: Fix to handle double dparams. (bug #134863) 2004-03-09 20:36:18 +00:00
dynamic.xml fix manual id's 2004-01-28 15:08:17 +00:00
elements-api.xml cleanup of unused and forgoten sections fixed links from the manual and the pwg to the API docs added more notes to R... 2004-07-27 15:01:10 +00:00
elements.xml cleanup of unused and forgoten sections fixed links from the manual and the pwg to the API docs added more notes to R... 2004-07-27 15:01:10 +00:00
factories.xml docs/manual/: fixes for out of date info, incorrect info and grammar 2004-07-16 00:43:57 +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 add GstPoptOption to work around evil poptOption struct def make sure popt is i18n'd expand gnome example 2004-02-03 14:59:32 +00:00
goals.xml docs/manual/goals.xml: Grammar fix 2004-07-15 14:09:08 +00:00
hello-world.fig Small updates to the manual 2002-03-31 15:28:51 +00:00
helloworld.xml cleanup of unused and forgoten sections fixed links from the manual and the pwg to the API docs added more notes to R... 2004-07-27 15:01:10 +00:00
helloworld2.xml fix manual id's 2004-01-28 15:08:17 +00:00
init-api.xml docs/manual/init-api.xml: Grammar fix 2004-07-15 17:04:23 +00:00
intro.xml fix manual id's 2004-01-28 15:08:17 +00:00
linked-elements.fig typos and style fixes 2003-10-09 12:42:49 +00:00
links-api.xml cleanup of unused and forgoten sections fixed links from the manual and the pwg to the API docs added more notes to R... 2004-07-27 15:01:10 +00:00
links.xml fix manual id's 2004-01-28 15:08:17 +00:00
Makefile.am and now the fix to make buildbot work 2004-02-16 15:57:17 +00:00
manual.xml cleanup of unused and forgoten sections fixed links from the manual and the pwg to the API docs added more notes to R... 2004-07-27 15:01:10 +00:00
mime-world.fig Docs updates 2001-01-05 18:50:41 +00:00
motivation.xml docs/manual/motivation.xml: Bonobo is no longer "emerging" and added sentence regarding tcp plugins 2004-07-15 13:36:26 +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 cleanup of unused and forgoten sections fixed links from the manual and the pwg to the API docs added more notes to R... 2004-07-27 15:01:10 +00:00
pads.xml cleanup of unused and forgoten sections fixed links from the manual and the pwg to the API docs added more notes to R... 2004-07-27 15:01:10 +00:00
plugins-api.xml fix manual id's 2004-01-28 15:08:17 +00:00
plugins.xml fix manual id's 2004-01-28 15:08:17 +00:00
programs.xml fix manual id's 2004-01-28 15:08:17 +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 manual id's 2004-01-28 15:08:17 +00:00
quotes.xml docs/manual/quotes.xml: Keep the quotes file alive 2004-07-12 13:48:46 +00:00
README fixing make distcheck 2002-01-14 14:04:14 +00:00
schedulers.xml fix manual id's 2004-01-28 15:08:17 +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 fix manual id's 2004-01-28 15:08:17 +00:00
states.xml docs/manual/states.xml: Fix inconsistent information 2004-07-15 16:26:23 +00:00
thread.fig typos and style fixes 2003-10-09 12:42:49 +00:00
threads.xml cleanup of unused and forgoten sections fixed links from the manual and the pwg to the API docs added more notes to R... 2004-07-27 15:01:10 +00:00
typedetection.xml fix manual id's 2004-01-28 15:08:17 +00:00
win32.xml update documentation with the clean version of dependencies 2004-08-03 15:19:34 +00:00
xml.xml fix manual id's 2004-01-28 15:08:17 +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.