7 Nov
2008
7 Nov
'08
3:42 p.m.
Hello,
On 07.11.2008, at 15:32, Sergiu Dumitriu wrote:
Hi,
It was not a RTFM answer, one that doesn't help at all, but an answer
that points you to the right location where the answer is. It is our
policy to make the documentation as useful as possible, so that when
somebody has a question, the answer should be available online. If our
online documentation does not cover a question frequently asked, we'd
rather improve the documentation and point to it than answer the same
question over and over again. Answering questions is time consuming
both
for the developer that takes time away from writing useful code, and
the
user that has to wait several hours for an answer, instead of quickly
reading the documentation. If somebody reads the documentation and
still
doesn't find the answer to his problem, then we need to know what
exactly is not clear, and how could we improve the documentation. We
would appreciate if you told us what exactly isn't clear in our
documentation?
One main point is, that the information I was expecting to be part of
the programming
guide was in the Adminitrator's Guide. It's a little confusing because
one expects it there.
I think the Programmer's Guide needs some work. For instance: there
was no obvious
link over to the dev guide, where more or less the stuff I expected in
the Programmer's
Guide is found, such as the API docs.
You don't have to download the whole repository.
If you use maven (and
you should), just write a short pom.xml, declare a dependency on the
xwiki-core module, and run:
mvn install eclipse:eclipse
This will download all the dependencies and create an eclipse project
you can open with File -> Import -> Existing project into workspace
If you also want the javadocs or sources, use:
mvn install eclipse:eclipse -DdownloadSources=true -
DdownloadJavadocs=true
The first time you run this, it will take a while, since lots of
dependencies must be downloaded.
Most helpful. Thanks a lot!