Issue 71884 - Free developers guide
Summary: Free developers guide
Status: CLOSED FIXED
Alias: None
Product: App Dev
Classification: Unclassified
Component: api (show other issues)
Version: 3.3.0 or older (OOo)
Hardware: All All
: P3 Trivial
Target Milestone: ---
Assignee: jsc
QA Contact: issues@api
URL:
Keywords:
Depends on: 37034
Blocks:
  Show dependency tree
 
Reported: 2006-11-23 11:38 UTC by maison.godard
Modified: 2013-02-24 21:09 UTC (History)
4 users (show)

See Also:
Issue Type: TASK
Latest Confirmation in: ---
Developer Difficulty: ---


Attachments

Note You need to log in before you can comment on or make changes to this issue.
Description maison.godard 2006-11-23 11:38:38 UTC
Issue to track evolution of the freeing steps for developpers guide
previously discussed on api and documentation mailing lists
seems bounded to legal implications
Comment 1 jsc 2006-11-23 13:21:40 UTC
accepted

The work on open sourcing the DevGuide is ongoing. Besides the open source
question we also think about a new format and also about a wiki solution.
Currently the used format is flat xml (OpenOffice XML not OpenDocument)
Comment 2 jsc 2006-11-23 13:33:30 UTC
set target
Comment 3 rene 2006-11-23 13:48:04 UTC
hmm. wiki would be bad. requires online acess. or do you want to create a pdf?
How do you do that then? How do you keep the pdf up-to-date with every change 
done in the wiki?

I think a xml/latex/whatever-based thing built during the build (or at least 
being able to build it by sopme makefile target/script which can be done 
offline) is best.
Comment 4 frank.thomas.peters 2006-11-24 08:05:14 UTC
We are about to start a pilot that will use wiki as the collaboration
platform. Wikis are much more suited for easy contributions than offline
formats.

Having the wiki published into some other format is an issue that
we also need to cover. Jürgen, I should start to write up a pilot
proposal for that. I would like to place that in the documentation
project, can we link to api.oo.o?

Everyone is invited to comment on the proposal once it's out there.
Comment 5 jsc 2006-11-24 08:11:25 UTC
Frank, starting the proposal is a good idea and of course you can link to the
api project and the currently available DevGuide.
Comment 6 maison.godard 2006-11-24 08:14:07 UTC
thanks a lot for taking care

even if IZ is not for commenting and discussing, here are my views

- wiki may be a convenient way to collaborate, not for the final document
- the one elaborated should be able to handle section translations in other
language (JP, ZN, FR, IT, that mediawiki does not handle natively i think) and
defaulting in a choosen language.
- the same for alternative code snippets

really, this things may be discussed on mailing lists

Please give also update on the legal issue 
Comment 7 Martin Hollmichel 2008-01-25 16:43:46 UTC
set target 3.0
Comment 8 jsc 2008-02-18 14:11:35 UTC
fixed -> a DevGuide is now online available in the wiki
http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OpenOffice.org_Developers_Guide

Before anybody starts with loalization please wait on the official go or better
the guidelines how to do it. I expect this info soon. The strucure of the guide
requires some guidelines to keep the whole document well formed in general and
for future post processing.
Comment 9 jsc 2008-02-18 14:13:28 UTC
closed
Comment 10 maison.godard 2008-02-18 14:35:09 UTC
@jsc: you rock :)