Commit graph

29 commits

Author SHA1 Message Date
Wim Taymans
bd0eb629bf pwg: flesh out allocation docs
Add more examples.
Add example for implementing new metadata.
Add programs to the docs (again?), it seems to contain useful info.
2012-10-02 11:34:47 +02:00
Wim Taymans
7c24fc7450 manual: fix up the manual
MIME-type -> media types
Fix up the manual in various places with the 1.0 way of doing things
such as probes, static elements, scheduling, ...
Add porting from 0.10 to 1.0 chapter.
Add probe example to build.
Remove some docs for remove components such as GstMixer and
GstPropertyProbe, XML...
2012-09-25 14:45:15 +02:00
Michael Bunk
a646c9b2ca docs: fix some typos and add some missing links in the app dev manual
Fixes #624164.
2010-07-16 18:37:24 +01:00
Luc Pionchon
498cda94b5 docs/manual/manual.xml: - Reorganised the previous "introduction" bundle into Foreword,
Original commit message from CVS:
patch by: Luc Pionchon  <luc.pionchon@nokia.com>
* docs/manual/manual.xml:
- Reorganised the previous "introduction" bundle into Foreword,
Introduction, and About GStreamer. The two first are <preface>
docbook elements. The later is the first part of the book.
- added intro-gstreamer.xml (content partially from
intro-preface.xml)
- moved appendix-win32.xml into appendix-integration.xml
* docs/manual/intro-preface.xml: gstreamer section moved...
* docs/manual/intro-gstreamer.xml: ...here. new file.
* docs/manual/appendix-win32.xml: removed file. Content moved...
* docs/manual/appendix-integration.xml: ...here.
* docs/manual/highlevel-components.xml: section about GstEditor moved...
* docs/manual/appendix-checklist.xml: ...here.
2008-06-25 14:44:52 +00:00
Thomas Vander Stichele
2f0f37ee73 add quote
Original commit message from CVS:
add quote
2007-05-22 10:21:31 +00:00
Tim-Philipp Müller
0b60f83664 docs/: Fix typo (#400987).
Original commit message from CVS:
* docs/manual/manual.xml:
* docs/pwg/pwg.xml:
Fix typo (#400987).
2007-01-26 13:07:36 +00:00
Maciej Katafiasz
f1f513c333 Avoid CORBA & Bonobo references (#340598)
Original commit message from CVS:
Avoid CORBA & Bonobo references (#340598)
2006-05-05 14:09:21 +00:00
Stefan Kost
523041b533 docs/: describe dparams (controller) for plugins unify docs a little more
Original commit message from CVS:
* docs/README:
* docs/manual/intro-basics.xml:
* docs/manual/intro-preface.xml:
* docs/manual/manual.xml:
* docs/pwg/advanced-dparams.xml:
* docs/pwg/intro-basics.xml:
* docs/pwg/intro-preface.xml:
* docs/pwg/pwg.xml:
describe dparams (controller) for plugins
unify docs a little more
2006-02-02 11:24:19 +00:00
Stefan Kost
a768c44689 docs/manual/advanced-dparams.xml: describe controller
Original commit message from CVS:
* docs/manual/advanced-dparams.xml:
describe controller
* docs/manual/advanced-position.xml:
* docs/manual/basics-init.xml:
* docs/manual/manual.xml:
* docs/manual/titlepage.xml:
* docs/pwg/pwg.xml:
* docs/pwg/titlepage.xml:
cleanup xml (more to come)
* libs/gst/controller/gstcontroller.c:
fix typo
2006-01-30 21:11:38 +00:00
Tim-Philipp Müller
30cfab511a docs/manual/: Update for 0.10: s/0.9/0.10/; s/audioscale/audiorsample/; add converters in front of pipelines; remove ...
Original commit message from CVS:
* docs/manual/advanced-dataaccess.xml:
* docs/manual/appendix-checklist.xml:
* docs/manual/appendix-programs.xml:
* docs/manual/basics-pads.xml:
* docs/manual/highlevel-components.xml:
* docs/manual/manual.xml:
Update for 0.10: s/0.9/0.10/; s/audioscale/audiorsample/;
add converters in front of pipelines; remove curly
brackets for threads stuff, they no longer exist; use
GST_TYPE_FRACTION for framerates; update some pieces of
code to 0.10, but there's plenty more to do.
* docs/manual/appendix-porting.xml:
Expand on asynchroneous state changes; s/0.9/0.10/;
mention disappearance of gst_init_get_popt_table()
(fixes #322916).
2005-12-11 17:49:10 +00:00
Ronald S. Bultje
2abdd0bfda docs/manual/: Update (until threads/scheduling) Application Development Manual; remove GstThread, add GstBus, add sim...
Original commit message from CVS:
* docs/manual/advanced-clocks.xml:
* docs/manual/advanced-interfaces.xml:
* docs/manual/advanced-metadata.xml:
* docs/manual/advanced-position.xml:
* docs/manual/advanced-schedulers.xml:
* docs/manual/advanced-threads.xml:
* docs/manual/appendix-porting.xml:
* docs/manual/basics-bins.xml:
* docs/manual/basics-bus.xml:
* docs/manual/basics-elements.xml:
* docs/manual/basics-helloworld.xml:
* docs/manual/basics-pads.xml:
* docs/manual/highlevel-components.xml:
* docs/manual/manual.xml:
* docs/manual/thread.fig:
Update (until threads/scheduling) Application Development Manual;
remove GstThread, add GstBus, add simple porting checklist, add
documentation for tag writing, clocks, make all examples until this
part compile and run.
* examples/manual/Makefile.am:
Update from changes to Application Development Manual; add bus
example, remove thread example.
2005-06-29 09:25:51 +00:00
Christian Schaller
55434541f1 adding licensing advisory to application writers guide
Original commit message from CVS:
adding licensing advisory to application writers guide
2005-01-31 11:30:14 +00:00
Ronald S. Bultje
9cf219a6c3 docs/manual/manual.xml: Re-enable dataaccess docs (oops).
Original commit message from CVS:
* docs/manual/manual.xml:
Re-enable dataaccess docs (oops).
2005-01-17 15:08:51 +00:00
Ronald S. Bultje
39ca8fc483 docs/manual/manual.xml: Add dataaccess part (doh!).
Original commit message from CVS:
* docs/manual/manual.xml:
Add dataaccess part (doh!).
2005-01-03 15:10:48 +00:00
Ronald S. Bultje
1fef270158 docs/manual/advanced-dataaccess.xml: Add section on how to use fakesrc/fakesink/identity in your application, plus se...
Original commit message from CVS:
* docs/manual/advanced-dataaccess.xml:
Add section on how to use fakesrc/fakesink/identity in your
application, plus section on how to embed plugins. Also mention
probes.
* docs/manual/appendix-checklist.xml:
* docs/manual/appendix-debugging.xml:
* docs/manual/appendix-gnome.xml:
* docs/manual/appendix-integration.xml:
Debug -> checklist, GNOME -> integration, add sections on Linux,
KDE integration and add other things useful for application
development.
* docs/manual/manual.xml:
Remove some fixmes, update some file pointers.
* docs/pwg/appendix-checklist.xml:
Fix typo.
* docs/pwg/building-boiler.xml:
Remove ugly header and add commented fixme.
* docs/pwg/pwg.xml:
Add fixme.
* examples/manual/Makefile.am:
Add example for added docs.
2004-12-23 14:26:14 +00:00
Thomas Vander Stichele
48c7d4dbc5 don't reference file that doesn't exist
Original commit message from CVS:
don't reference file that doesn't exist
2004-12-16 19:31:19 +00:00
Ronald S. Bultje
d0bcc34dad docs/manual/: Try 2. This time, include a short preface as a "general introduction", also add code blocks around all ...
Original commit message from CVS:
* docs/manual/advanced-autoplugging.xml:
* docs/manual/advanced-clocks.xml:
* docs/manual/advanced-interfaces.xml:
* docs/manual/advanced-metadata.xml:
* docs/manual/advanced-position.xml:
* docs/manual/advanced-schedulers.xml:
* docs/manual/advanced-threads.xml:
* docs/manual/appendix-gnome.xml:
* docs/manual/appendix-programs.xml:
* docs/manual/appendix-quotes.xml:
* docs/manual/autoplugging.xml:
* docs/manual/basics-bins.xml:
* docs/manual/basics-data.xml:
* docs/manual/basics-elements.xml:
* docs/manual/basics-helloworld.xml:
* docs/manual/basics-init.xml:
* docs/manual/basics-pads.xml:
* docs/manual/basics-plugins.xml:
* docs/manual/bins-api.xml:
* docs/manual/bins.xml:
* docs/manual/buffers-api.xml:
* docs/manual/buffers.xml:
* docs/manual/clocks.xml:
* docs/manual/components.xml:
* docs/manual/cothreads.xml:
* docs/manual/debugging.xml:
* docs/manual/dparams-app.xml:
* docs/manual/dynamic.xml:
* docs/manual/elements-api.xml:
* docs/manual/elements.xml:
* docs/manual/factories.xml:
* docs/manual/gnome.xml:
* docs/manual/goals.xml:
* docs/manual/helloworld.xml:
* docs/manual/helloworld2.xml:
* docs/manual/highlevel-components.xml:
* docs/manual/highlevel-xml.xml:
* docs/manual/init-api.xml:
* docs/manual/intro-basics.xml:
* docs/manual/intro-motivation.xml:
* docs/manual/intro-preface.xml:
* docs/manual/intro.xml:
* docs/manual/links-api.xml:
* docs/manual/links.xml:
* docs/manual/manual.xml:
* docs/manual/motivation.xml:
* docs/manual/pads-api.xml:
* docs/manual/pads.xml:
* docs/manual/plugins-api.xml:
* docs/manual/plugins.xml:
* docs/manual/programs.xml:
* docs/manual/queues.xml:
* docs/manual/quotes.xml:
* docs/manual/schedulers.xml:
* docs/manual/states-api.xml:
* docs/manual/states.xml:
* docs/manual/threads.xml:
* docs/manual/typedetection.xml:
* docs/manual/win32.xml:
* docs/manual/xml.xml:
Try 2. This time, include a short preface as a "general
introduction", also add code blocks around all code samples
so they get compiled. We still need a way to tell readers
the filename of the code sample. In some cases, don't show
all code in the documentation, but do include it in the generated
code. This allows for focussing on specific bits in the docs,
while still having a full test application available.
* examples/manual/Makefile.am:
Fix up examples for new ADM. Add several of the new examples that
were either added or were missing from the build system.
* examples/manual/extract.pl:
Allow nameless blocks.
2004-12-15 17:32:49 +00:00
Thomas Vander Stichele
e4383150e1 put back old manual structure before integrating ronald's changes
Original commit message from CVS:
put back old manual structure before integrating ronald's changes
2004-12-15 07:30:55 +00:00
Ronald S. Bultje
5700e439fa docs/manual/: First try at rewriting the ADM. Needs lotsamore work, but some parts might already be somewhat useful.
Original commit message from CVS:
* docs/manual/advanced-autoplugging.xml:
* docs/manual/advanced-clocks.xml:
* docs/manual/advanced-dparams.xml:
* docs/manual/advanced-interfaces.xml:
* docs/manual/advanced-metadata.xml:
* docs/manual/advanced-position.xml:
* docs/manual/advanced-schedulers.xml:
* docs/manual/advanced-threads.xml:
* docs/manual/appendix-debugging.xml:
* docs/manual/appendix-gnome.xml:
* docs/manual/appendix-programs.xml:
* docs/manual/appendix-quotes.xml:
* docs/manual/appendix-win32.xml:
* docs/manual/autoplugging.xml:
* docs/manual/basics-bins.xml:
* docs/manual/basics-data.xml:
* docs/manual/basics-elements.xml:
* docs/manual/basics-helloworld.xml:
* docs/manual/basics-init.xml:
* docs/manual/basics-pads.xml:
* docs/manual/basics-plugins.xml:
* docs/manual/bins-api.xml:
* docs/manual/bins.xml:
* docs/manual/buffers-api.xml:
* docs/manual/buffers.xml:
* docs/manual/clocks.xml:
* docs/manual/components.xml:
* docs/manual/cothreads.xml:
* docs/manual/debugging.xml:
* docs/manual/dparams-app.xml:
* docs/manual/dynamic.xml:
* docs/manual/elements-api.xml:
* docs/manual/elements.xml:
* docs/manual/factories.xml:
* docs/manual/gnome.xml:
* docs/manual/goals.xml:
* docs/manual/helloworld.xml:
* docs/manual/helloworld2.xml:
* docs/manual/highlevel-components.xml:
* docs/manual/highlevel-xml.xml:
* docs/manual/init-api.xml:
* docs/manual/intro-motivation.xml:
* docs/manual/intro-preface.xml:
* docs/manual/intro.xml:
* docs/manual/links-api.xml:
* docs/manual/links.xml:
* docs/manual/manual.xml:
* docs/manual/motivation.xml:
* docs/manual/pads-api.xml:
* docs/manual/pads.xml:
* docs/manual/plugins-api.xml:
* docs/manual/plugins.xml:
* docs/manual/programs.xml:
* docs/manual/queues.xml:
* docs/manual/quotes.xml:
* docs/manual/schedulers.xml:
* docs/manual/states-api.xml:
* docs/manual/states.xml:
* docs/manual/threads.xml:
* docs/manual/typedetection.xml:
* docs/manual/win32.xml:
* docs/manual/xml.xml:
First try at rewriting the ADM. Needs lotsamore work, but some
parts might already be somewhat useful.
* docs/pwg/advanced-interfaces.xml:
Remove properties interface, it never actually existed (except for
on my HD...).
2004-12-14 23:35:09 +00:00
Thomas Vander Stichele
bba6ac4b74 docs/: restructure so that common stuff is shown first
Original commit message from CVS:
* docs/Makefile.am:
* docs/manual/elements-api.xml:
restructure so that common stuff is shown first
* docs/manual/init-api.xml:
convert to examples
* docs/manual/manual.xml:
* docs/manuals.mak:
* docs/url.entities:
link to API on the website, possibly override later in build
* examples/manual/.cvsignore:
ignore more
* examples/manual/Makefile.am:
add more examples
* examples/manual/extract.pl:
error out on failure
2004-09-08 23:18:55 +00:00
Stefan Kost
626cbdc8b2 cleanup of unused and forgoten sections fixed links from the manual and the pwg to the API docs added more notes to R...
Original commit message from CVS:
cleanup of unused and forgoten sections
fixed links from the manual and the pwg to the API docs
added more notes to README
2004-07-27 15:01:10 +00:00
Thomas Vander Stichele
2754a4bb4b add win32 chapter. #142422
Original commit message from CVS:
add win32 chapter.  #142422
2004-07-06 13:23:42 +00:00
Stéphane Loeuillet
6d23d85c69 fix link to OPL license (only direct link works, the rest of the site is apache docs)
Original commit message from CVS:
fix link to OPL license (only direct link works, the rest of the site is apache docs)
2004-05-01 20:00:44 +00:00
Thomas Vander Stichele
e8a2e56e81 put version in documentation
Original commit message from CVS:
put version in documentation
2004-02-12 13:04:02 +00:00
Thomas Vander Stichele
e978887fca fix manual id's
Original commit message from CVS:
fix manual id's
2004-01-28 15:08:17 +00:00
Thomas Vander Stichele
abe422b141 reorganizing manual so that concepts are explained before code is shown.
Original commit message from CVS:
reorganizing manual so that concepts are explained before code is shown.
needs some proofreading, will get to it.
2003-12-29 14:15:02 +00:00
Thomas Vander Stichele
3b7659725f typos and style fixes
Original commit message from CVS:
typos and style fixes
2003-10-09 12:42:49 +00:00
Thomas Vander Stichele
e44c8f032b entitize the version
Original commit message from CVS:
entitize the version
2003-10-08 18:21:41 +00:00
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
Renamed from docs/manual/gstreamer-manual.xml (Browse further)