[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]
Subject: [OASIS Issue Tracker] Updated: (ODATA-174) Core Part 2: 1 Introduction, 1.1 Terminology, 1.2 Normative References and 3 ServiceRootURL somehow mixed up in view "final version"
[ http://tools.oasis-open.org/issues/browse/ODATA-174?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Stefan Drees updated ODATA-174:
-------------------------------
Summary: Core Part 2: 1 Introduction, 1.1 Terminology, 1.2 Normative References and 3 ServiceRootURL somehow mixed up in view "final version" (was: Core Part 2: 1 Introduction, 1.1 Terminology and 1.2 Normative References somehow mixed up in view "final version")
Description:
The workproduct [odata-core-v1.0-wd01-part2-url-conventions-2012-11-21.doc](https://www.oasis-open.org/committees/download.php/47524/odata-core-v1.0-wd01-part2-url-conventions-2012-11-21.doc) opened in the MS Word change mode "final with markup" (translated from german labels) the content of page 4 of 30 appears well sorted w.r.t sections 1, 1.1 and 1.2.
When switching to "final" also everything looks as expected (the funny change coloring and inline insertions go away) and one wants to produce a printout / pdf.
At the very moment I choose to print and cancel that, the page 4 is destroyed and shows (starting at 1):
"""
1 Introduction
The Open Data Protocol (OData) enables the creation of REST-based data services, which allow resources, identified using Uniform Resource Identifiers (URLs) and defined in a data model, to be published and edited by Web clients using simple HTTP messages. This specification defines a set of recommended (but not required) rules for constructing URLs to identify the data and metadata exposed by an OData service as well as a set of reserved URL query string operators, which if accepted by an OData service, MUST be implemented as required by this document.
The [OData-Atom] and [OData-CSDL] OData Protocol Version 1.0 Part 3: CSDL. DD Month 2012. OASIS Committee Specification Draft 01. http://docs.oasis-
open.org/odata/odata/v1.0/csd01/odata-v1.0-csd01.doc
[OData-JSON] documents specify the format of the resource representations that are exchanged using OData and the [OData-Core] document describes the actions that can be performed on the URLs (optionally constructed following the conventions defined in this document) embedded in those representations.
Servers are encouraged to follow the URL construction conventions defined in this specification when possible as consistency promotes an ecosystem of reusable client components and libraries.
1.1 Terminology
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD
NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
interpreted as described in [OData-ABNF] OData ABNF Construction
Rules Version 1.0. DD Month 2012. OASIS Committee Specification Draft 01.
http://docs.oasis-open.org/odata/odata-abnf-construction-
rules/v1.0/csd01/abnf/odata-v1.0-abnf.txt.
...
[RFC2119].
1.2 Normative References
[OData-ABNF] ...
"""
i.e. mixes up the wrong content. (Observe also that besides the usual mixup in 1.1 Terminology, there is now the mixin
"[OData-Atom] and [OData-CSDL] OData Protocol Version 1.0 Part 3: CSDL. DD Month 2012. OASIS Committee Specification Draft 01. http://docs.oasis-
open.org/odata/odata/v1.0/csd01/odata-v1.0-csd01.doc"
into the second paragraph of 1. Introduction which should instead read:
"The [OData-Atom] and [OData-JSON] documents specify the format of the resource representations that are exchanged using OData and the [OData-Core] document describes the actions that can be performed on the URLs (optionally constructed following the conventions defined in this document) embedded in those representations."
Section 3 ServiceRootURL looks like this (layout imitated in issue text field):
"""
3 ServiceRootURL
The service root URL identifies the root of an OData service. This URL MUST point to an AtomPub Service Document (as specified in [RFC5023]).
Per default this service document MUST follow the OData conventions for AtomPub Service
Documents. If a different format has been explicitly requested, a corresponding
alternate representation of an AtomPub Service Document MUST be delivered.
[OData-CSDL] OData Protocol Version 1.0 Part 3: CSDL. DD Month 2012.
OASIS Committee Specification Draft 01. http://docs.oasis-
open.org/odata/odata/v1.0/csd01/odata-v1.0-csd01.doc
[OData-JSON] specifies such an alternate JSON-based representation of a service document.
...
"""
with the last line given above shifted halfway up into the second last line. Here again a reference entry (with definition, not the label) is inserted
into the second paragraph. The false placed ref entry above is:
"""
[OData-CSDL] OData Protocol Version 1.0 Part 3: CSDL. DD Month 2012.
OASIS Committee Specification Draft 01. http://docs.oasis-
open.org/odata/odata/v1.0/csd01/odata-v1.0-csd01.doc
"""
System Info (in case this helps):
* Mac BookPro (8 GB RAM) and OS X 10.8.2
* Microsoft Word for Mac 2011 Version 14.2.5 (121010)
was:
The workproduct [odata-core-v1.0-wd01-part2-url-conventions-2012-11-21.doc](https://www.oasis-open.org/committees/download.php/47524/odata-core-v1.0-wd01-part2-url-conventions-2012-11-21.doc) opened in the MS Word change mode "final with markup" (translated from german labels) the content of page 4 of 30 appears well sorted w.r.t sections 1, 1.1 and 1.2.
When switching to "final" also everything looks as expected (the funny change coloring and inline insertions go away) and one wants to produce a printout / pdf.
At the very moment I choose to print and cancel that, the page 4 is destroyed and shows (starting at 1):
"""
1 Introduction
The Open Data Protocol (OData) enables the creation of REST-based data services, which allow resources, identified using Uniform Resource Identifiers (URLs) and defined in a data model, to be published and edited by Web clients using simple HTTP messages. This specification defines a set of recommended (but not required) rules for constructing URLs to identify the data and metadata exposed by an OData service as well as a set of reserved URL query string operators, which if accepted by an OData service, MUST be implemented as required by this document.
The [OData-Atom] and [OData-CSDL] OData Protocol Version 1.0 Part 3: CSDL. DD Month 2012. OASIS Committee Specification Draft 01. http://docs.oasis-
open.org/odata/odata/v1.0/csd01/odata-v1.0-csd01.doc
[OData-JSON] documents specify the format of the resource representations that are exchanged using OData and the [OData-Core] document describes the actions that can be performed on the URLs (optionally constructed following the conventions defined in this document) embedded in those representations.
Servers are encouraged to follow the URL construction conventions defined in this specification when possible as consistency promotes an ecosystem of reusable client components and libraries.
1.1 Terminology
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD
NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
interpreted as described in [OData-ABNF] OData ABNF Construction
Rules Version 1.0. DD Month 2012. OASIS Committee Specification Draft 01.
http://docs.oasis-open.org/odata/odata-abnf-construction-
rules/v1.0/csd01/abnf/odata-v1.0-abnf.txt.
...
[RFC2119].
1.2 Normative References
[OData-ABNF] ...
"""
i.e. mixes up the wrong content. (Observe also that besides the usual mixup in 1.1 Terminology, there is now the mixin
"[OData-Atom] and [OData-CSDL] OData Protocol Version 1.0 Part 3: CSDL. DD Month 2012. OASIS Committee Specification Draft 01. http://docs.oasis-
open.org/odata/odata/v1.0/csd01/odata-v1.0-csd01.doc"
into the second paragraph of 1. Introduction which should instead read:
"The [OData-Atom] and [OData-JSON] documents specify the format of the resource representations that are exchanged using OData and the [OData-Core] document describes the actions that can be performed on the URLs (optionally constructed following the conventions defined in this document) embedded in those representations."
System Info (in case this helps):
* Mac BookPro (8 GB RAM) and OS X 10.8.2
* Microsoft Word for Mac 2011 Version 14.2.5 (121010)
Found out about section 3 mixup.
> Core Part 2: 1 Introduction, 1.1 Terminology, 1.2 Normative References and 3 ServiceRootURL somehow mixed up in view "final version"
> ------------------------------------------------------------------------------------------------------------------------------------
>
> Key: ODATA-174
> URL: http://tools.oasis-open.org/issues/browse/ODATA-174
> Project: OASIS Open Data Protocol (OData) TC
> Issue Type: Bug
> Components: OData Protocol v1.0
> Affects Versions: WD01
> Reporter: Stefan Drees
> Assignee: Ralf Handl
> Priority: Trivial
> Fix For: WD01
>
>
> The workproduct [odata-core-v1.0-wd01-part2-url-conventions-2012-11-21.doc](https://www.oasis-open.org/committees/download.php/47524/odata-core-v1.0-wd01-part2-url-conventions-2012-11-21.doc) opened in the MS Word change mode "final with markup" (translated from german labels) the content of page 4 of 30 appears well sorted w.r.t sections 1, 1.1 and 1.2.
> When switching to "final" also everything looks as expected (the funny change coloring and inline insertions go away) and one wants to produce a printout / pdf.
> At the very moment I choose to print and cancel that, the page 4 is destroyed and shows (starting at 1):
> """
> 1 Introduction
> The Open Data Protocol (OData) enables the creation of REST-based data services, which allow resources, identified using Uniform Resource Identifiers (URLs) and defined in a data model, to be published and edited by Web clients using simple HTTP messages. This specification defines a set of recommended (but not required) rules for constructing URLs to identify the data and metadata exposed by an OData service as well as a set of reserved URL query string operators, which if accepted by an OData service, MUST be implemented as required by this document.
> The [OData-Atom] and [OData-CSDL] OData Protocol Version 1.0 Part 3: CSDL. DD Month 2012. OASIS Committee Specification Draft 01. http://docs.oasis-
> open.org/odata/odata/v1.0/csd01/odata-v1.0-csd01.doc
> [OData-JSON] documents specify the format of the resource representations that are exchanged using OData and the [OData-Core] document describes the actions that can be performed on the URLs (optionally constructed following the conventions defined in this document) embedded in those representations.
> Servers are encouraged to follow the URL construction conventions defined in this specification when possible as consistency promotes an ecosystem of reusable client components and libraries.
> 1.1 Terminology
> The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD
> NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
> interpreted as described in [OData-ABNF] OData ABNF Construction
> Rules Version 1.0. DD Month 2012. OASIS Committee Specification Draft 01.
> http://docs.oasis-open.org/odata/odata-abnf-construction-
> rules/v1.0/csd01/abnf/odata-v1.0-abnf.txt.
> ...
> [RFC2119].
> 1.2 Normative References
> [OData-ABNF] ...
> """
> i.e. mixes up the wrong content. (Observe also that besides the usual mixup in 1.1 Terminology, there is now the mixin
> "[OData-Atom] and [OData-CSDL] OData Protocol Version 1.0 Part 3: CSDL. DD Month 2012. OASIS Committee Specification Draft 01. http://docs.oasis-
> open.org/odata/odata/v1.0/csd01/odata-v1.0-csd01.doc"
> into the second paragraph of 1. Introduction which should instead read:
> "The [OData-Atom] and [OData-JSON] documents specify the format of the resource representations that are exchanged using OData and the [OData-Core] document describes the actions that can be performed on the URLs (optionally constructed following the conventions defined in this document) embedded in those representations."
> Section 3 ServiceRootURL looks like this (layout imitated in issue text field):
> """
> 3 ServiceRootURL
> The service root URL identifies the root of an OData service. This URL MUST point to an AtomPub Service Document (as specified in [RFC5023]).
> Per default this service document MUST follow the OData conventions for AtomPub Service
> Documents. If a different format has been explicitly requested, a corresponding
> alternate representation of an AtomPub Service Document MUST be delivered.
> [OData-CSDL] OData Protocol Version 1.0 Part 3: CSDL. DD Month 2012.
> OASIS Committee Specification Draft 01. http://docs.oasis-
> open.org/odata/odata/v1.0/csd01/odata-v1.0-csd01.doc
> [OData-JSON] specifies such an alternate JSON-based representation of a service document.
> ...
> """
> with the last line given above shifted halfway up into the second last line. Here again a reference entry (with definition, not the label) is inserted
> into the second paragraph. The false placed ref entry above is:
> """
> [OData-CSDL] OData Protocol Version 1.0 Part 3: CSDL. DD Month 2012.
> OASIS Committee Specification Draft 01. http://docs.oasis-
> open.org/odata/odata/v1.0/csd01/odata-v1.0-csd01.doc
> """
> System Info (in case this helps):
> * Mac BookPro (8 GB RAM) and OS X 10.8.2
> * Microsoft Word for Mac 2011 Version 14.2.5 (121010)
--
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
[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]