Re: PROV-ISSUE-540: Notation Section 3, structure of documentation [prov-n]

Dear all,

Find below a proposed response to this issue. Feedback welcome.

Luc

>
>       ISSUE-540 (Production Documentation)
>
>   * Original
>     email:http://lists.w3.org/Archives/Public/public-prov-wg/2012Sep/0134.html
>   * Tracker:http://www.w3.org/2011/prov/track/issues/540
>   * Group Response:
>       o The comment refers to the previous working draft.
>       o For each production, the latest working draft includes a table
>         mapping each subterm with a prov-dm attribute.
>       o Narrative is intentionally left terse. The purpose of the
>         prov-n document is to define a syntax for the data model
>         defined in prov-dm.
>   * References:
>   * Changes to the document: none
>   * Original author's acknowledgement:
>
>
>     [edit
>     <http://www.w3.org/2011/prov/wiki/index.php?title=ResponsesToPublicComments&action=edit&section=54>]
>



On 10/09/12 10:59, Provenance Working Group Issue Tracker wrote:
> PROV-ISSUE-540: Notation Section 3, structure of documentation [prov-n]
>
> http://www.w3.org/2011/prov/track/issues/540
>
> Raised by: Paolo Missier
> On product: prov-n
>
> The EBNF form is the complete expression, but it lacks documentation to explain the components. To understand what each means, one needs to read the example text, map the text to the example expression, then map the example expression to the EBNF form. Trying to start with the EBNF form is even more challenging. It would help to have documentation within the EBNF sections.
>
>
>
>

-- 
Professor Luc Moreau
Electronics and Computer Science   tel:   +44 23 8059 4487
University of Southampton          fax:   +44 23 8059 2865
Southampton SO17 1BJ               email: l.moreau@ecs.soton.ac.uk
United Kingdom                     http://www.ecs.soton.ac.uk/~lavm