Hi,
I mark your words, and followed all the corrections you suggested.
i think that accessing objects attached to an XWiki page from inside a
plufgin is somthing very basic, that should be documented. I guess its ok to
redirect to the API guide, which has examples for velocity, since there is a
direct mapping from Velocity to Java. Developers should hopefully figure it
out without problems. So there should be a few more lines in the velocity
snippet of the API Guide, not just to set but also to get fields. Having the
java perspective as well might help, so you could have both a velocity and
java snippets on the guide.
Its a good idea to have an API guide, so as to structure the documentation
(instead of having everything in one huge page :-) )
i guess the most useful thing regarding API for plugins would be to have
the javadoc fully documented (one sentence for each method), but i dont know
what are your documentation standards
And do you think that documenting DWR in a tutorial is a good idea, since
it fulfills a basic need for xwiki developers ? Are you ok with that ? Its
not something from xpn, after all.
LMKYT, R (Let me know your thoughts, regards :-) )
And i will probably contribute some tutorials for plugins, since i am
working on xwiki for my final internship, and i ll have to write a report
anyway. So i might as well write info available for the community, instead
of putting together a useless report that nobody will reuse at my school.
