[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]
Subject: [OASIS Issue Tracker] Updated: (OBIX-12) Section 2, Lines 114-115: "document" used to refer to multiple types of documents, needs clarification
[ http://tools.oasis-open.org/issues/browse/OBIX-12?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Craig Gemmill updated OBIX-12:
-------------------------------
Description:
Up to this point, "document" has referred to the oBIX specification documents (oBIX V1.1, Encodings, REST, SOAP), yet "document" in line 115 seems to reference a different type of document.
It is suggested that clarification be made to differentiate from the oBIX specification documents. Similar clarification should be considered throughout the specification document.
was:Up to this point, "document" has referred to the oBIX specification documents (oBIX V1.1, Encodings, REST, SOAP), yet "document" in line 115 seems to reference a different type of document.
Proposal:
Propose to add the following text to 1.1.1 as a new paragraph:
Data objects are represented in XML by XML documents. It is important to distinguish the usage of the term document in this context from references to this specification document. When "this document" is used, it references this specification document. When "oBIX document" or "XML document" is used, it references an oBIX object, encoded in XML, as per the convention for this (specification) document.
Also, inspect the entire spec to ensure clarity - several instances of "this document" changed to "this specification", and instances of "the document" changed to "the oBIX document".
was:It is suggested that clarification be made to differentiate from the oBIX specification documents. Similar clarification should be considered throughout the specification document.
Appended original Proposal to Description for reference.
Provided proposal to address the distinction.
> Section 2, Lines 114-115: "document" used to refer to multiple types of documents, needs clarification
> ------------------------------------------------------------------------------------------------------
>
> Key: OBIX-12
> URL: http://tools.oasis-open.org/issues/browse/OBIX-12
> Project: OASIS Open Building Information Exchange (oBIX) TC
> Issue Type: Bug
> Components: OBIX 1.1 Specification
> Environment: Ludo Bertsch, Horizon Technologies Inc. (250) 592-1488
> Representing CABA (Continental Automated Buildings Association)
> Reporter: Toby Considine
> Assignee: Craig Gemmill
> Fix For: oBIX 1.1 PR01
>
>
> Up to this point, "document" has referred to the oBIX specification documents (oBIX V1.1, Encodings, REST, SOAP), yet "document" in line 115 seems to reference a different type of document.
> It is suggested that clarification be made to differentiate from the oBIX specification documents. Similar clarification should be considered throughout the specification document.
--
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]