OPS 3.0 doc review - Part 1

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

OPS 3.0 doc review - Part 1

Erik Bruchez
Administrator
All,

Documentation for Orbeon PresentationServer 3.0 (and in particular for
the new XForms engine) has not been entirely written yet, but some
sections are already available, and we think that it could be a good
idea to use help from the community on the mailing-list to review
documentation. The proposed model is to do this in iterations, one
chunk at a time, so that the process remains manageable.

For this first iteration, we suggest that people with a few minutes to
waste specifically look at the new section 3.2, "Repeating with
xforms:repeat":

   http://www.orbeon.com/ops/doc/reference-xforms-ng#repeat

Feedback can include, in no particular order:

o typos and grammatical mistakes

o actual errors of content

o coverage (i.e., does the section cover what it is supposed to cover?)

o clarity (i.e., are the explanations understandable?)

o in short, what's good and (more importantly) what's bad

Note that this section is still incomplete, and the holes are marked
with "TODO".

We are eagerly awaiting feedback and suggestions in the mailing-list!

-Erik



--
You receive this message as a subscriber of the [hidden email] mailing list.
To unsubscribe: mailto:[hidden email]
For general help: mailto:[hidden email]?subject=help
ObjectWeb mailing lists service home page: http://www.objectweb.org/wws
Reply | Threaded
Open this post in threaded view
|

Re: OPS 3.0 doc review - Part 1

danc-3
I rapidly went through it and it looks great so far.

Didn't notice any particular typos or grammar errors.

Examples are clear.  

Suggestion: Would be good if you showed the insert and delete as being used within a TRIGGER.  You may have already planned this as being covered in one the TODO sections, but I thought I would mention it.

Note: If you are as crystal clear with section 3.2.8 'Nested Repeats' as you are with the other sections, I think we'll be in clover.

Just my 2 cents.

- Dan



--
You receive this message as a subscriber of the [hidden email] mailing list.
To unsubscribe: mailto:[hidden email]
For general help: mailto:[hidden email]?subject=help
ObjectWeb mailing lists service home page: http://www.objectweb.org/wws
Reply | Threaded
Open this post in threaded view
|

Re: Re: OPS 3.0 doc review - Part 1

Erik Bruchez
Administrator
[hidden email] wrote:

 > I rapidly went through it and it looks great so far.
 >
 > Didn't notice any particular typos or grammar errors.
 >
 > Examples are clear.

Thanks!

 > Suggestion: Would be good if you showed the insert and delete as
 > being used within a TRIGGER.  You may have already planned this as
 > being covered in one the TODO sections, but I thought I would
 > mention it.

 > Note: If you are as crystal clear with section 3.2.8 'Nested
 > Repeats' as you are with the other sections, I think we'll be in
 > clover.

We have now written something about both those subjects. We'll see if
that's consider clear ;-)

-Erik




--
You receive this message as a subscriber of the [hidden email] mailing list.
To unsubscribe: mailto:[hidden email]
For general help: mailto:[hidden email]?subject=help
ObjectWeb mailing lists service home page: http://www.objectweb.org/wws