[OASIS Issue Tracker] Updated: (ODATA-384) Normative text needs to be typographically distinct from examples

[OASIS Issues Tracker <workgroup_mailer@lists.oasis-open.org>]

     [ http://tools.oasis-open.org/issues/browse/ODATA-384?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Ralf Handl updated ODATA-384:
-----------------------------

      Component/s: OData Protocol 
                   OData URL Conventions 
                       (was: OData CSDL)
    Fix Version/s: V4.0_CSD02

I agree that we should type-set the non-normative extracts from the normative ABNF different from the examples. 

On the other hand: the ABNF extracts are only informative in the prose documents and thus comparable to examples; the single source of truth is the machine-readable text file.

> Normative text needs to be typographically distinct from examples
> -----------------------------------------------------------------
>
>                 Key: ODATA-384
>                 URL: http://tools.oasis-open.org/issues/browse/ODATA-384
>             Project: OASIS Open Data Protocol (OData) TC
>          Issue Type: Bug
>          Components: OData Protocol , OData URL Conventions 
>    Affects Versions: V4.0_CSD01
>            Reporter: Patrick Durusau
>             Fix For: V4.0_CSD02
>
>
> In parts 1 and 2 of CSDL, the typography for examples is used for normative text. For example, under 8.2.6.3 of part 1, it is used to report the syntax of odata.include-annotations. 
> In part 2, under 5.1.1.4.1 (and elsewhere), it is used to report the signatures of functions, followed by examples using the same typography. 
> Which confuses the issue of which is the example and which is the signature.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://tools.oasis-open.org/issues/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira