18 Jun
2005
18 Jun
'05
1:59 p.m.
Hi,
Jim Stuttard a écrit :
In this case we probably need some "automated" copy when we release a
offline wiki database. Thanks to Jeremi's work, we might be able to
package the documentation as an XWiki Application which would mean we
could also upgrade them.
Is that for user doc or developer doc ? It could actually apply to both..
For users then the next step is: comments, attachements, versioning,
interact with specific applications
For developers then the next step is: Create forms, create templates,
access priviledged API, create macros & functions, write plugins
Hi,
Thanks Ludovic for the roadmap and the diagrams.
AFAIR you mentioned that you were using IntelliJ. Is that your
XWiki.com default tool? How many of us like me will be using Eclipse
and or Rose and or AspectJ? Or some other suggestion.
Currently we are maintaining compatibility with IntelliJ and Eclipse +
building with ant for the automated build. We are looking at maven or
maven2 for future automated build.
We have an open source licence for XWiki developpement for IntelliJ. I
still prefer IntelliJ because of productivity reasons (I even payed my
licence before they created the open source program).
If we were round-trip engineering then there would be
a question to
discuss about diagram import/export between tools. I am a committed
automatic documentalist. Round-trip seems to me the sensible way to
meet the demand for learning materials
with guaranteed accuracy and currency.
You're current class diagrams are jpegs. We have Graphviz as a built
in tool.
WDYT?
I've very open to that.. I don't have much experience on this so I would
need help setting up things like that.
I'm currently pushing the javadoc and junit results on the automated
build platform:
See http://build.xpertnet.biz/doc/
I'm not
sure the XWiki documentation should be copied over to the
offline wiki install. I'm more a fan of a link to the online
documentation.
Sorry to disagree but I want full documentation for my own experiments
on my own offline wiki so I need a downloadable documentation framework.
Now I think we
should move the documentation to the xwiki.org web site
in a specific area. Using some XWiki classes, we can mark the
documentation articles that are specific to XWiki.com.
We can definitively open the default wiki to developer's editing so that
people can contribute to it's improvement. We can then have an automated
export to XML so that we can release it on ObjectWeb regularly.
Documentation is a weak part of XWiki. We are definitively looking for
people that can help in this area.
I have started listing some of the use cases. They appear to start
something like:
__UC__1. Render XWiki Documents
__UC__1. Verify Authorisation and Rights
__UC__1. Read Documents
__UC__1. Access and Modify Documents, Objects
__UC__1. Search Documents and Objects
__UC__1. Read User and Rights
__UC__1. Read/Write Object/Classes
There are plenty turning up nearly every day on Jira but they are
technical.
IMHO The current (largely implicit) business use case hierarchy
doesn't quite seem abstract enough or explicitly and correctly
nested. It just seems that way, I have no examples cos I'm talking
about a missing level or lack of separation of levels.
Are you talking about the FAQ, Jira, the web site ? For the FAQ we start
to have a good number of documents. Indeed we can start reorganizing,
nesting, etc.. It's part of the plan to redo the web site (both
XWiki.com which should show the business value of XWiki and xwiki.org
which should help user's and developer's find everything they need and
allow them to interact.
IMHO The classes seem too large to me and seems to mix
model content
and model management functions in the same class.
Is that unfair?
It's probably not that good to mix that.. That will probably need some
refactoring for XWiki 2.0. It's going to be tough to fix that for the
first release.
Regards
Jim
PS As an ex editor I volunteer to correct the english on the XWiki
sites if that's any use? If you want to mail me any drafts offline I
will happily try and correct those.
------------------------------------------------------------------------
--
You receive this message as a subscriber of the xwiki-dev(a)objectweb.org mailing list.
To unsubscribe: mailto:xwiki-dev-unsubscribe@objectweb.org
For general help: mailto:sympa@objectweb.org?subject=help
ObjectWeb mailing lists service home page: http://www.objectweb.org/wws
--
Ludovic Dubost
XPertNet: http://www.xpertnet.fr/
Blog: http://www.ludovic.org/blog/
XWiki: http://www.xwiki.com
Skype: ldubost AIM: nvludo Yahoo: ludovic