[gst-devel] documentation wiki

[Stefan Kost]

Hi Zaher,

> i) the docbook manuals
> ii) the wiki
> iii) the annotated/commentable api docs
> 
> Regarding merging to/from CVS, I looked at the commits we had to the
> docs in the last month and it was very little.  So the merging from
> docbook in CVS to wiki would be small.  The time I was going to propose
> for wiki updates to be merged into CVS would be at freeze times (like
> now).  That would allow us to hack on the code when everyone else can
> hack on it without time being taken for merging.
> 
> Talking about the wiki, I only have a few more chapters left to import
> in of the Application Developers Guide.  Then I was planning to sort out
> all the cross refencing that is in the guide.  Johan, do you know of
> anything in mediawiki that can automatically find where stuff is being
> crossreferenced?

I was rereading the PWG these days and one of the things I would like to commit
after the feature freeze is fixed references to the API-docs. I use jEdit as my
editor and therewith can easilly fix those across multiple files. I have also
done some spellchecking on the docbook-files using aspell.
It would be nice, if we can generate a aspell ignore database out of the API
docs, so that is is not suggesting me funny replacements for things like
'GstElement' all the time ;-).
Apart see my other mail about the docs (splitting). IMHo this is a cruicial
change towards making them more maintainable (and before starting to let people
edit details in the wiki). I belive I can do the changes within a few days.

Stefan
-- 
      \|/            Stefan Kost
     <@ @>           private            business
+-oOO-(_)-OOo------------------------------------------------------ - - -  -   -
|       __  Address  Simildenstr. 5     HTWK Leipzig, Fb IMN, Postfach 301166
|      ///           04277 Leipzig      04251 Leipzig
| __  ///            Germany            Germany
| \\\///    Phone    +49341 2253538     +49341 30766101
|  \__/     EMail    st_kost_at_gmx.net kost_at_imn.htwk-leipzig.de
|           WWW      www.sonicpulse.de  www.imn.htwk-leipzig.de/~kost/about.html
===-=-=--=---=---------------------------------- - - -  -    -
-------------- next part --------------
A non-text attachment was scrubbed...
Name: kost.vcf
Type: text/x-vcard
Size: 345 bytes
Desc: not available
URL: <http://lists.freedesktop.org/archives/gstreamer-devel/attachments/20040719/72798221/attachment.vcf>