Hi Karl,
let me describe what i have in mind ...
First of all i would like to reduce the size of the SDK and i would like
to remove most of the examples. In case of the Java examples it
definitely makes sense to provide NetBeans or Eclipse projects because
it simplifies the whole stuff a lot (easy building and debugging through
the code).
So the idea is to provide in a first step NB projects for the Java
examples of SDK (more or less done by Ariel -> many thanks again,
http://wiki.services.openoffice.org/wiki/API/Samples/Java) and document
them in the wiki. Well the wiki should explain the examples in general
and on potential subpages the specific details for NB or Eclipse
projects are explained. Ideally we will have the examples available not
only in Java but alos in C++ and Python. That means MS Visual Studio
projects, maybe XCode projects, etc.
The DevGuide will still present related code snippets and of course
should provide links to the main example wiki page. Java as the
preferred example language should remain in the DevGuide. But as
mentioned before we would ideally have the examples in different
languages available.
Users can easy checkout the example sources from the code repository and
can use them in there preferred IDE. Currently they can be easy
downloaded as zips.
The advantage of this approach is that we can reach more potential
users. And of course advanced users can easier help to improve the
examples, fix problems etc.
It's still a lot of work to provide good example that are well
documented ...
Often the developers don't focus on developer documentation and
examples. But we need it and it is a good opportunity for new developers
to get started. Working on examples, understanding the concepts and help
others to understand what they have learned etc.
Later on the next step to work on or with the real office code should
become easier...
Juergen
Karl Weber wrote:
Hi,
Clayton Cornell from [email protected] referred me to discuss a
point on this list.
You can already find some arguments in the thread >DevGuide Wiki< on
[email protected]. Ariel Constenla-Haile mentioned in this thread,
that Juergen Schmidt already has some plans pertaining to this point.
So let me give a summary:
The DevGuide contains a lot of code to explain how to do things, but it almost
always limits the code shown to some excerpt, hence focussing on one
particular (and probably the most important) point.
At least as far as I am concerned I almost always wonder about how a
particular piece of code is used and I want to look at the class file as a
whole. Since it doesn't make sense to copy the whole source code into the
Wiki, a link into the source code repository would make sense and be great.
It would be cumbersome to always look things up in an IDE -- instead of just
clicking on a link.
A first idea was to use, e.g., a link of the form
http://svn.services.openoffice.org/opengrok/xref/Current%20
(trunk)/odk/examples/DevelopersGuide/FirstSteps/FirstUnoContact.java
to refer to the class FirstUnoContact.java.
As Ariel mentioned (in the thread quoted above) Juergen seems to have an idea
about a more far-reaching structural change of the DevGuide Wiki concerning
the discussion of the SDK examples.
Since I am currently reading a larger part of the DevGuide and having a closer
look at the SDK examples, I could readily apply some changes to the Wiki.
But, on the face of it, I should only do it after the desired outcome has
been clearly specified by the community.
I am looking forward to any suggestion.
-Karl
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
