Re: [RFC 0/8] Integrate yocto documentation into eclipse

["Timo Müller" <mail@timomueller.eu>]

Hi,

Rifenbark, Scott M wrote, On 18.07.2012 17:03:
> Hi,
>
> This seems like a very cool idea.  What about when things change
 > structurally for the Yocto Docs? For example, right now I am
 > restructuring much of the Eclipse information that is in the ADT
 > manual to move it to the development manual as part of an application
 > development flow.  It looks like your patch here includes the ADT
 > manual and the Quick Start.  The changes I am working on will
 > eventually require the YP development manual as well.

I wanted to make sure that it is possible to generate eclipse help from 
the documentation and integrate it into eclipse. Starting with the 
development manual and the quick start guide was the obvious choice.
But, as I didn't encounter any problems using the docbook eclipse 
stylesheet on the documentation, I suspect that integrating the other 
documents is also possible.
I will give it a try and let you know about the results.

>
> Scott
>
> -----Original Message-----
> From: yocto-bounces@yoctoproject.org [mailto:yocto-bounces@yoctoproject.org] On Behalf Of mail@timomueller.eu
> Sent: Wednesday, July 18, 2012 6:03 AM
> To: yocto@yoctoproject.org
> Cc: Timo Mueller
> Subject: [yocto] [RFC 0/8] Integrate yocto documentation into eclipse
>
> From: Timo Mueller <timo.mueller@bmw-carit.de>
>
> Hi,
>
> the documentation of the yocto project can currently be viewed online
> or as a separate pdf. When using the eclipse ide to develop software
> on base of a yocto sysroot and toolchain it would be convenient to
> access the relevant parts of the documentation from within the ide.
>
> In order to achieve this, I've generated eclipse help from yocto's
> documentation (adt-manual, yocto-project-qs). I have intergrated this
> documentation in the ide and it can now be accessed through the
> eclipse help center (Help -> Help Contents). Please let me know what
> you think about it?
>
> Yocto's documentation is licensed under the Creative Commons
> Attribution-Share Alike 2.0 UK: England & Wales (CCA-SA), which is
> incompatible to the Eclipse Public License 1.0. Thus I've created a
> standalone feature to simply redistribute the documentation avoiding
> licensing issues. Do you agree on the way this is structured?
>
> Cheers,
>    Timo
>
> Timo Mueller (8):
>    plugins/sdk.doc.user: Added plugin for the yocto project
>      documentation
>    plugins/sdk.doc.user: Added empty table of contents
>    feature/sdk.doc: Added feature containing yocto documentation plugins
>    feature/sdk.doc: Added org.yocto.sdk.doc.user plugin
>    plugins/sdk.doc.user: Added yocto quick start guide
>    feature/sdk: Added org.yocto.sdk.doc feature.
>    features/sdk.site: Added eclipse help feature to update site
>    plugins/sdk.doc.user: Added yocto adt manual

<snip>

Cheers,
Timo