Re: API documentation and improving interactivity

Hi Alexandro,

thanks for picking up this topic immediately.

Whatever we think will be an appropriate solution to provide an easier 
way how users can give feedback. I would suggest that we create a tool 
that use the input from the IDLs (the generated type library) as input 
and produce based on this info whatever is necessary.

Follow up please only on one list -> [email protected]

Juergen


On 9/5/10 10:37 AM, Alexandro Colorado wrote:
> Hi during OOoCon a conversation started about the lack of examples on the
> API documentation as far as contributions goes. Basically there are several
> places where to go to:
> - API Documentation
> - CodeSnippets
> - Developer Guide
> - OOo Wiki
>
> The main issue is that users and readers have low accessibility to introduce
> examples or comments on the documentation. There have been some possible
> solutions discussed:
> - Move the API Docs to the Wiki
> - Version the API Docs depending on the OOo version
> - Close codeSnippets or move it to a technology that allow users to just
> paste snippets directly on the site
>
> As always the issue becomes lack of resources, time and information. My
> feeling is that if we air this topic with possible solutions would help us
> find better solutions. I do have a small script that allow me to clean off
> the documentation from the collabnet HTML and just isolate the HTML snippet.
> My next step could be to find a converter from HTML to a wikilang that allow
> us to easy publish it on the wiki and publish it on the wiki as a service
> (batch upload).
>
> Help is welcomed.
>