RE: [odata-comment] mis-linked items in OData specifications

["Handl, Ralf" <ralf.handl@sap.com>]

Hi Paul,

 

Thanks for catching these issues, we had a few gaps in our link checker which we now closed, and the links have been repaired in the next working draft.

 

Thanks

Ralf

 

 

From: odata-comment@lists.oasis-open.org [mailto:odata-comment@lists.oasis-open.org] On Behalf Of Paul Knight
Sent: Montag, 4. Dezember 2017 23:13
To: odata-comment@lists.oasis-open.org
Cc: Chet Ensign <chet.ensign@oasis-open.org>
Subject: [odata-comment] mis-linked items in OData specifications

 

Hi OData TC members,

 

The Version 4.01 specifications are very nicely done, especially with the use of named bookmarks for cross-references using hyperlinks.

 

In preparing the documents for publication, the TC Administration team noted a few mis-linked items.  Corrections to fix these items would likely be considered "Non-Material Changes"[1] under the TC Process.

 

These items were primarily detected through the use of the W3C link checker [2].

The line numbers listed will be the line numbers of the HTML version of the published specification.

 

Here are the items we noted:

 

OData:

Part 1 - two internal reference problems were detected by W3C link checker:
Broken fragments:
http://docs.oasis-open.org/odata/odata/v4.01/csprd04/part1-protocol/odata-v4.01-csprd04-part1-protocol.html#sec_SystemQueryOptionschemaVersion (lines 3454, 12066)
http://docs.oasis-open.org/odata/odata/v4.01/csprd04/part1-protocol/odata-v4.01-csprd04-part1-protocol.html#sec_SystemQueryOptionstopandskip (lines 6542, 6543)

Part 2 - no link issues noted.

 

OData CSDL XML:

One of the internal references to an item in the Normative references is broken - In Section 4.1, the citation to [OData-VocCore] has a hyperlink to https://d.docs.live.net/17ea5a0da4145c51/OData/odata-v4.01-wd01-part1-protocol.docx#VocCore.

 

OData CSDL JSON:

W3C LInk checker found some internal link issues. The line numbers are the lines of the HTML file:
Broken fragments:
http://docs.oasis-open.org/odata/odata-csdl-json/v4.01/csprd03/odata-csdl-json-v4.01-csprd03.html#ODATAURL (lines 6823, 11812, 12907)
http://docs.oasis-open.org/odata/odata-csdl-json/v4.01/csprd03/odata-csdl-json-v4.01-csprd03.html#ODATAJSON (line 9358)
http://docs.oasis-open.org/odata/odata-csdl-json/v4.01/csprd03/odata-csdl-json-v4.01-csprd03.html#OdataProtocol (lines 5532, 5562, 5642, 7369, 14641)
http://docs.oasis-open.org/odata/odata-csdl-json/v4.01/csprd03/odata-csdl-json-v4.01-csprd03.html#BMURL(lines 12624, 12627)
http://docs.oasis-open.org/odata/odata-csdl-json/v4.01/csprd03/odata-csdl-json-v4.01-csprd03.html#ODataURL (line 12223)

 

OData JSON Format:

There are several instances where "navigationLink" is hyperlinked to "#sec_AssociationLink" instead of "#sec_NavigationLink", as might be expected.
- in Section 20.2, the hyperlink from "nextLink" apparently points to a non-existent address "http://docs.oasis-open.org/odata/odata-json-format/v4.01/csprd04/odata-json-format-v4.01-csprd04.html#sec_ControlInformationnextLinkodatanextLink"
- Suggest that the TC use the link checker at http://validator.w3.org/checklink to detect broken internal links.
Doing so, the following broken internal links were noted (line numbers are those of the HTML file):
Broken fragments:
http://docs.oasis-open.org/odata/odata-json-format/v4.01/csprd04/odata-json-format-v4.01-csprd04.html#ABNF (line 6666)
http://docs.oasis-open.org/odata/odata-json-format/v4.01/csprd04/odata-json-format-v4.01-csprd04.html#sec_ControlInformationdeltaLinkodatadeltaLink (lines 2587, 2651, 2711, 5075, 5172, 5249)
http://docs.oasis-open.org/odata/odata-json-format/v4.01/csprd04/odata-json-format-v4.01-csprd04.html#sec_ControlInformationcontextodatacontext (lines 2625, 2693, 2935, 3254, 3725, 3729, 3895, 4479, 5033, 5069, 5167, 5451, 5676, 5745, 5758, 5766, 5853, 5909, 5946)
http://docs.oasis-open.org/odata/odata-json-format/v4.01/csprd04/odata-json-format-v4.01-csprd04.html#sec_ControlInformationnextLinkodatanextLink (lines 2585, 2645, 2705, 2793, 4483, 5037, 5073, 5103, 5171, 5246, 7063, 7224, 7577)
http://docs.oasis-open.org/odata/odata-json-format/v4.01/csprd04/odata-json-format-v4.01-csprd04.html#sec_ControlInformationeditLinkandreadLinkodataed (lines 2727, 2733, 3618)

 

[1] https://www.oasis-open.org/policies-guidelines/oasis-defined-terms-2017-05-26#dNonmaterialChange

[2] http://validator.w3.org/checklink

 

Best regards,

Paul

--

Paul Knight  - Tel: +1 781-883-1783
OASIS - Advancing open standards for the information society - Document Process Analyst