mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-23 18:21:04 +00:00
Code Issues 1 Projects Releases Wiki Activity
gstreamer/docs/manual
History
Thomas Vander Stichele 50a2f3fb6f clean up docs build a little; have docdir be an overridable install location; separate gtk-doc and docbook bits 
Original commit message from CVS:
clean up docs build a little; have docdir be an overridable install location; separate gtk-doc and docbook bits
2005-09-03 13:49:49 +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 GstElement::new-pad -> pad-added, GstElement::state-change -> state-changed, GstValueFixedList -> GstValueArray, add ... 2005-07-20 17:16:44 +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/: Fix docs to use _bin_add() before _link(), which fixes the examples with recent core versions (reported... 2005-08-16 12:15:46 +00:00
advanced-dparams.xml put back old manual structure before integrating ronald's changes 2004-12-15 07:30:55 +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/: Update (until threads/scheduling) Application Development Manual; remove GstThread, add GstBus, add sim... 2005-06-29 09:25:51 +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/: Fix playbin/decodebin examples, update docs a bit, mention bus instead of signals in various places, me... 2005-06-30 12:32:17 +00:00
appendix-integration.xml docs/manual/: Fix playbin/decodebin examples, update docs a bit, mention bus instead of signals in various places, me... 2005-06-30 12:32:17 +00:00
appendix-licensing.xml fixing line-widths to make thomas happy 2005-01-31 11:42:29 +00:00
appendix-porting.xml docs/: Document new-pad/state-change signal renames and the FixedList type rename. 2005-07-20 17:22:27 +00:00
appendix-programs.xml fix broken pipeline example in doc 2004-12-16 22:32:13 +00:00
appendix-quotes.xml start pulling in base classes and elements for docs 2005-06-24 18:16:14 +00:00
appendix-win32.xml put back old manual structure before integrating ronald's changes 2004-12-15 07:30:55 +00:00
base.css Small updates to the manual 2002-03-31 15:28:51 +00:00
basics-bins.xml docs/manual/: Update (until threads/scheduling) Application Development Manual; remove GstThread, add GstBus, add sim... 2005-06-29 09:25:51 +00:00
basics-bus.xml docs/manual/: Update (until threads/scheduling) Application Development Manual; remove GstThread, add GstBus, add sim... 2005-06-29 09:25:51 +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 docs/manual/: Update (until threads/scheduling) Application Development Manual; remove GstThread, add GstBus, add sim... 2005-06-29 09:25:51 +00:00
basics-helloworld.xml docs/manual/: Fix docs to use _bin_add() before _link(), which fixes the examples with recent core versions (reported... 2005-08-16 12:15:46 +00:00
basics-init.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-pads.xml GstElement::new-pad -> pad-added, GstElement::state-change -> state-changed, GstValueFixedList -> GstValueArray, add ... 2005-07-20 17:16:44 +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/: Fix playbin/decodebin examples, update docs a bit, mention bus instead of signals in various places, me... 2005-06-30 12:32:17 +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/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-motivation.xml docs/manual/intro-motivation.xml: Fix typos. 2004-12-16 10:53:47 +00:00
intro-preface.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
linked-elements.fig typos and style fixes 2003-10-09 12:42:49 +00:00
Makefile.am clean up docs build a little; have docdir be an overridable install location; separate gtk-doc and docbook bits 2005-09-03 13:49:49 +00:00
manual.xml docs/manual/: Update (until threads/scheduling) Application Development Manual; remove GstThread, add GstBus, add sim... 2005-06-29 09:25:51 +00:00
mime-world.fig docs/manual/: Try to get autoplugging working, fix type detection. Fix text in hello-world image. 2005-06-29 11:46:16 +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 fixing make distcheck 2002-01-14 14:04:14 +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

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.