Hello Karl,

On Sunday 15 February 2009 17:03, Karl Weber wrote:
> I  don't know whether I understand everything you want to tell me, but the
> way I understand it, I would like to answer as follows (please beg my
> pardon, if I did misunderstand you):
>
> (1) I already noticed, that the examples are not well maintained.
>
> (2) Apart from the first example (FirstUnoContact) the DevGuide only shows
> excerpts from the example files. This makes sense, as it focuses on the
> essential part of the code.
>

Jürgen's idea was (correct me if I'm wrong), to create a wiki page for every 
example, with a general explanation, then this pay will have some link to 
download the example, like:

Download this example in
Java (NetBeans)
Java (Eclipse)
C++ (MS Visual Studio)
C++ (xxx)
...

> (3) I could understand, if sun was trying to coerce people to use the
> NetBeans IDE. However, there are people that will not switch the IDE they
> use -- maybe even less so, if they get the impression that someone is
> trying to push them.

you didn't undestand here (and yes, I was not clear):

* I'm a community member, nor working for Sun or other company
* the idea of the NB projects was mine, it wasn't suggested to me by any OOo 
developer from Sun. I choosed the NB IDE because I work with it (never tried 
Eclipse, sorry).

When I planned the structure of the cvs repository, I didn't want people to 
think this was a Sun's intend to promote "their" Java IDE, so I created this 
way:

api/examples/java/netbeans

which means anyone is welcome to contribute

api/examples/java/what_ever_ide

and

api/examples/what_ever_language_binding

> If the SDK examples will only be available as NetBeans projects, lots of
> people will not (be able to) use them. I think, this is a very bad idea, in
> particular for an open source project. 

the idea is that the comunity contribute projects with the IDE they use, in 
the language they program, etc.

> (4) Even if you put all SDK examples in nice NetBeans projects and commit
> yourself to maintain them forever, this will definitely not solve the
> problem of heavy maintenance.
>
> We are talking about the DevGuide Wiki, which discusses these examples and
> contains a lot of code. This needs to be maintained as well and I  don't
> have any idea about how putting the SDK examples in NetBeans projects will
> help to maintain the wiki.

I'm not only "putting" the examples on a NB project, I'm correcting them (and 
hope making them a little better). 
I once asked js what would happen with the changes I make to the examples 
quoted in the Dev's Guide, but can't recall what he answered.


> In spite of all these arguments, I think that we agree on the problem of
> how to maintain the code in the examples -- and the DevGuide. I am looking
> forward to any suggestion about a solution.

*Before* fixing the code quoted in the Dev's Guide, one has obviously to fix 
the 
examples. That's way I told you about my work on the examples (yes, may be I 
wasn't clear): it is useless to start fixing the code snipets on the Dev's 
Guide without fixing first the whole example.

I'm working on that, and once they are done, anyone can take the Java source 
files and create a project for other IDE (the NetBeans project adds *nothing* 
to the Java code, it's just an ant build + configuration).

> On the other hand, 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. It would be annoying, if one could not even do that (see my next
> point).

as said before, there could be
* a link to the Wiki page for that example, or
* a link to the cvs repository with the examples I'm working on, or
* a link to the svn repository with the original examples

Once again, I don't know if Jürgen's planning to keep the Java examples on 
/odk/examples.

The fact is that the examples are unmantained, I'm working on fixing them, 
besides of "putting" them in NB projects.
And I have no time/plans to do twice the same thing.

> I would like to stress, that for a reader of the DevGuide the point of
> interest might be the Java class file as a whole, not the ability to
> actually build and run an example by pressing just one button. Often it is
> enough to just read the code.

Here I disagree. I've been an API user for a long time, and been in 
d...@api.openoffice.org for a long time too; so from my experience I can assure 
that's not the general rule.


Regards
-- 
Ariel Constenla-Haile
La Plata, Argentina


"Aus der Kriegsschule des Lebens
                - Was mich nicht umbringt,
        macht mich härter."
                Nietzsche Götzendämmerung, Sprüche und Pfeile, 8.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@documentation.openoffice.org
For additional commands, e-mail: dev-h...@documentation.openoffice.org

Reply via email to