mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-28 03:00:35 +00:00
Code Issues 1 Projects Releases Wiki Activity
gstreamer/docs/manual
History
David I. Lehn 387ae96dd5 Add css and magic* to dist. 
Original commit message from CVS:
Add css and magic* to dist.
Remove CONFIG_CLEAN_FILES that removes doc source on a make distclean.
2002-01-09 04:54:04 +00:00
..
images Fix .cvsignores 2000-12-31 14:02:32 +00:00
.gitignore Fix .cvsignores 2000-12-31 14:02:32 +00:00
advanced-autoplugging.xml conversion to docbook-xml. i don't have to ask that this be testing, because not ionly is it perfect, but i'm sure yo... 2001-12-15 23:13:04 +00:00
advanced-threads.xml global s/disksrc/filesrc/, but edited by me 2002-01-06 04:26:37 +00:00
advanced.xml conversion to docbook-xml. i don't have to ask that this be testing, because not ionly is it perfect, but i'm sure yo... 2001-12-15 23:13:04 +00:00
appendix-checklist.xml conversion to docbook-xml. i don't have to ask that this be testing, because not ionly is it perfect, but i'm sure yo... 2001-12-15 23:13:04 +00:00
appendix-debugging.xml conversion to docbook-xml. i don't have to ask that this be testing, because not ionly is it perfect, but i'm sure yo... 2001-12-15 23:13:04 +00:00
appendix-programs.xml global s/disksrc/filesrc/, but edited by me 2002-01-06 04:26:37 +00:00
appendix-quotes.xml typo 2002-01-03 14:34:29 +00:00
autoplugging.xml conversion to docbook-xml. i don't have to ask that this be testing, because not ionly is it perfect, but i'm sure yo... 2001-12-15 23:13:04 +00:00
base.css conversion to docbook-xml. i don't have to ask that this be testing, because not ionly is it perfect, but i'm sure yo... 2001-12-15 23:13:04 +00:00
basics-bins.xml global s/disksrc/filesrc/, but edited by me 2002-01-06 04:26:37 +00:00
basics-data.xml conversion to docbook-xml. i don't have to ask that this be testing, because not ionly is it perfect, but i'm sure yo... 2001-12-15 23:13:04 +00:00
basics-elements.xml conversion to docbook-xml. i don't have to ask that this be testing, because not ionly is it perfect, but i'm sure yo... 2001-12-15 23:13:04 +00:00
basics-helloworld.xml global s/disksrc/filesrc/, but edited by me 2002-01-06 04:26:37 +00:00
basics-pads.xml conversion to docbook-xml. i don't have to ask that this be testing, because not ionly is it perfect, but i'm sure yo... 2001-12-15 23:13:04 +00:00
basics-plugins.xml conversion to docbook-xml. i don't have to ask that this be testing, because not ionly is it perfect, but i'm sure yo... 2001-12-15 23:13:04 +00:00
bin-element-ghost.fig Updates and additions to the manual 2001-01-04 23:35:50 +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 global s/disksrc/filesrc/, but edited by me 2002-01-06 04:26:37 +00:00
buffers.xml conversion to docbook-xml. i don't have to ask that this be testing, because not ionly is it perfect, but i'm sure yo... 2001-12-15 23:13:04 +00:00
BUILD notes updates 2002-01-04 18:28:17 +00:00
components.xml conversion to docbook-xml. i don't have to ask that this be testing, because not ionly is it perfect, but i'm sure yo... 2001-12-15 23:13:04 +00:00
connected-elements.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
connections.xml conversion to docbook-xml. i don't have to ask that this be testing, because not ionly is it perfect, but i'm sure yo... 2001-12-15 23:13:04 +00:00
cothreads.xml conversion to docbook-xml. i don't have to ask that this be testing, because not ionly is it perfect, but i'm sure yo... 2001-12-15 23:13:04 +00:00
debugging.xml conversion to docbook-xml. i don't have to ask that this be testing, because not ionly is it perfect, but i'm sure yo... 2001-12-15 23:13:04 +00:00
dynamic.xml global s/disksrc/filesrc/, but edited by me 2002-01-06 04:26:37 +00:00
elements.xml conversion to docbook-xml. i don't have to ask that this be testing, because not ionly is it perfect, but i'm sure yo... 2001-12-15 23:13:04 +00:00
factories.xml conversion to docbook-xml. i don't have to ask that this be testing, because not ionly is it perfect, but i'm sure yo... 2001-12-15 23:13:04 +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
goals.xml conversion to docbook-xml. i don't have to ask that this be testing, because not ionly is it perfect, but i'm sure yo... 2001-12-15 23:13:04 +00:00
gstreamer-manual.xml conversion to docbook-xml. i don't have to ask that this be testing, because not ionly is it perfect, but i'm sure yo... 2001-12-15 23:13:04 +00:00
hello-world.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
helloworld.xml global s/disksrc/filesrc/, but edited by me 2002-01-06 04:26:37 +00:00
helloworld2.xml global s/disksrc/filesrc/, but edited by me 2002-01-06 04:26:37 +00:00
highlevel-components.xml conversion to docbook-xml. i don't have to ask that this be testing, because not ionly is it perfect, but i'm sure yo... 2001-12-15 23:13:04 +00:00
highlevel-xml.xml global s/disksrc/filesrc/, but edited by me 2002-01-06 04:26:37 +00:00
init.xml conversion to docbook-xml. i don't have to ask that this be testing, because not ionly is it perfect, but i'm sure yo... 2001-12-15 23:13:04 +00:00
intro-motivation.xml conversion to docbook-xml. i don't have to ask that this be testing, because not ionly is it perfect, but i'm sure yo... 2001-12-15 23:13:04 +00:00
intro-preface.xml conversion to docbook-xml. i don't have to ask that this be testing, because not ionly is it perfect, but i'm sure yo... 2001-12-15 23:13:04 +00:00
intro.xml conversion to docbook-xml. i don't have to ask that this be testing, because not ionly is it perfect, but i'm sure yo... 2001-12-15 23:13:04 +00:00
magic-pdf conversion to docbook-xml. i don't have to ask that this be testing, because not ionly is it perfect, but i'm sure yo... 2001-12-15 23:13:04 +00:00
magic-png conversion to docbook-xml. i don't have to ask that this be testing, because not ionly is it perfect, but i'm sure yo... 2001-12-15 23:13:04 +00:00
Makefile.am Add css and magic* to dist. 2002-01-09 04:54:04 +00:00
mime-world.fig Docs updates 2001-01-05 18:50:41 +00:00
motivation.xml conversion to docbook-xml. i don't have to ask that this be testing, because not ionly is it perfect, but i'm sure yo... 2001-12-15 23:13:04 +00:00
outline.txt More docs (most of them just empty...) 2000-08-22 21:18:18 +00:00
pads.xml conversion to docbook-xml. i don't have to ask that this be testing, because not ionly is it perfect, but i'm sure yo... 2001-12-15 23:13:04 +00:00
plugins.xml conversion to docbook-xml. i don't have to ask that this be testing, because not ionly is it perfect, but i'm sure yo... 2001-12-15 23:13:04 +00:00
programs.xml global s/disksrc/filesrc/, but edited by me 2002-01-06 04:26:37 +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 global s/disksrc/filesrc/, but edited by me 2002-01-06 04:26:37 +00:00
quotes.xml typo 2002-01-03 14:34:29 +00:00
README notes updates 2002-01-04 18:28:17 +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 conversion to docbook-xml. i don't have to ask that this be testing, because not ionly is it perfect, but i'm sure yo... 2001-12-15 23:13:04 +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 global s/disksrc/filesrc/, but edited by me 2002-01-06 04:26:37 +00:00
typedetection.xml global s/disksrc/filesrc/, but edited by me 2002-01-06 04:26:37 +00:00
utility.xml conversion to docbook-xml. i don't have to ask that this be testing, because not ionly is it perfect, but i'm sure yo... 2001-12-15 23:13:04 +00:00
xml.xml global s/disksrc/filesrc/, but edited by me 2002-01-06 04:26: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.

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.