Re: Gnome Developer Documentation: how to make 'some' money, Re: Gnome Developer Documentation: how to make 'some' money

[Sander Vesik <sander_traveling yahoo co uk>]

 --- Mathieu Lacage <mathieu_lacage realmagic fr> wrote: > Hi all,
> 
> I am currently interested in getting top-notch developer documentation
> for the Gnome 2.x platform and I am willing to support financially those
> who may be interested in working on this. More precisely, I am
> interested in supporting the development of the framework for the
> documentation.
> 
> Some may not agree with me but to me, the key problem with the current
> state of things is twofold:
>  - lack of a good developer documentation browser: must be lightweight,
> must have indexing, fast keyword search, full-text search, must be able
> to browse the documentation in its native form (ie: not the
> HTML-converted version).

Soudns like yelp, execpt for the indexing part - but really, yelp should 
also have indexing and full body search (imho). I undersatand that not all 
people agree to my 'yelp, the one help browser for user and develoepr docs'
vision though.

>  - lack of cross-indexing framework. ie: in GTK documentation, you want
> to refer to some glib function. in libart doc, you refer to some gdk
> function... Ideally, cross-indexing should work in both the pdf version
> of the docs, in the documentation-browser version of the docs and in the
> html version of the docs (for the Gnome website). I am mostly interested
> in a solution working in the documentation browser though.
>

This is a problem of many parts - you need to be able to do the crossrefs in
gtk-doc in a menaingful way and onthe tools side you need to be able to 
preserve the links. In case of pdf you ave to also figure out where the link
needs to point to (local file? web site?). 
 
> Whoever might be interested should keep in mind that the solution should
> use existing Gnome frameworks as much as possible. ie: scrollkeeper, the
> gnome help browser.
> 
> Maybe the solution is merely a matter of writing a manual on how to
> write docs, how to install them, how to build them. If so, I'd be happy
> to pay someone to write the needed documentation.
>

Unfortunately its not that as simple as writing new additional docs 8-(
 
> If you are interested, feel free to mail me mathieu gnome org for any
> financial arrangements. I am not rich and I have no real idea of how
> much it would cost me but I could pay up to 1000 USD/EUR to get this
> done.
> 
> regards,
> Mathieu
> -- 
> Mathieu Lacage <mathieu_lacage realmagic fr>
> #p: +33 1 69 19 61 97
> 


__________________________________________________
Do You Yahoo!?
Everything you'll ever need on one web page
from News and Sport to Email and Music Charts
http://uk.my.yahoo.com