Hi,
I m going to read a large part of the DevGuide Wiki. Right at the beginning I
noticed, that this DevGuide needs some updates and maybe reformatting. It
would be easy for me to add some changes to the document here and there while
reading it.
I am no OOo expert, which is the reason to read the DevGuide and try out some
of the examples -- which limits the contributions I am able to make.
After reading a couple of sections I already noticed some things which I would
like to get your opinion about.
(1) The Getting Started section describes how to use the NetBeans IDE. I
already dared to add a corresponding description about the Eclipse IDE.
(2) The files of a standard installation of OOo 3.0 / OOo SDK 3.0 are found at
different locations than those mentioned in the DevGuide. I changed that
already as well.
(3) All headings in the DevGuide start at level 3, i.e., they are given as
=== Heading ===. The headings of other documents of the OOo Wiki start with
level 1 or 2, respectively . I think the text is much easier to read if the
headings start out at level 1. I didn't find any recommendations about
headings in the style guide.
Although it might not be the proper way to do it, I could move all headings
two levels up while reading the DevGuide.
(4) The Wiki software creates an anchor for every heading with the name of the
heading. So the heading == This is some particular heading == creates an
anchor with the name "This is some particular heading". If someone changes
the text of the heading, he/she breaks all links to this chapter, which is
pretty bad, in particular since the API reference links to the DevGuide. I
didn't find anything about his problem in the Editing:Help or the style
guide. The MediaWiki suggests to add an anchor to every heading, so one may
change the text of headings and anchors separately. Some Wikis even offer an
{{Anchor}} and an {{Anchors}} template.
How do you think about this problem?
(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?
(6) One can also find a version of the DevGuide at the link
http://api.openoffice.org/docs/DevelopersGuide/DevelopersGuide.xhtml
How is this document related to the Wiki? The DevGuide on api.openoffice.org
contains links to the example programs (see point 5 above), but they are
broken.
Thanks for reading this long mail -- and for any suggestions about how I can
improve the DevGuide.
-Karl
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@documentation.openoffice.org
For additional commands, e-mail: dev-h...@documentation.openoffice.org
