Hello Ariel, Am Sonntag, 15. Februar 2009 17:44 schrieb Ariel Constenla-Haile: > Hello Karl, > > On Saturday 14 February 2009 10:42, Karl Weber wrote:
[...] > >(5) The DevGuide mentions different example programs, e.g., > > > >> FirstConnection.java. I cannot find these example programs anywhere. The > >> DevGuide only shows some excerpts. Where are these example programs? I > >> think, one should include complete and runnable programs into the > >> DevGuide. Are there any guidelines about how to do this -- or why this > >> is verboten? > > > >O.K. in the meantime I noticed, that the source code files ship with the > > SDK and are located at <SDK_HOME>/examples/DevelopersGuide/. > > > >Is there a way to browse the source code files (of the examples) in the > > cvs / svn repository on-line? > > I have answered this on your mail to d...@openoffice.org. > > > If yes, one could easily add appropriate links to > > the DevGuide Wiki. > > Not sure if this is a good idea. > > All Java examples on the SDK are being ported to NetBeans projects by > myself http://api.openoffice.org/source/browse/api/examples/java/netbeans/ > right now only the ones with UNO components are ported and work. > > I don't know what plans has Jürgen Schmidt with the Java SDK examples, but > IMHO once I finish my work (I hope for April) there is no sense to keep the > SDK Java examples because they are *very* unmantained, and some of them > have serious issues (just an example > http://api.openoffice.org/servlets/ReadMsg?listName=dev&msgNo=18860); the > NB projects, on the other side, are very easy to maintain (and I commit > myself to do the job), easy for API user to contribute if they find issues, > etc. > > I first thought about submiting issues against the SDK examples for every > error I found and every enhancenment I make, but that would be too much > overwork for me. 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. 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). 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. (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. 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. Even more so, since "Sun has no plans to return to a closed-development model" (Quote from the FAQ). (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. 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. -Karl --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@documentation.openoffice.org For additional commands, e-mail: dev-h...@documentation.openoffice.org
