OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

bdxr-comment message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]


Subject: FW: [bdxr-comment] TAB comments on Exchange Header Envelope (XHE) V1.0


Thank you Patrick, for your always insightful and constructive comments. We will review and address them.

Best regards,

Kenneth



On 5/29/18, 6:16 PM, "Patrick Durusau" <bdxr-comment@lists.oasis-open.org on behalf of patrick@durusau.net> wrote:

    Greetings!
    
    Members of the Technical Advisory Board endeavor to comment on all 30 day public review drafts.
    
    Comments on:
    
    Exchange Header Envelope (XHE) V1.0
    
    are attached.
    
    It isn't necessary to acknowledge each comment separately.
    
    A single email acknowledging this email will be sufficient.
    
    If the TC chooses to ?defer? resolution of an issue to a later version, please choose Defer Issue under Available Workflow Actions (after opening the issue).
    
    When the TC has acted on these issues, I would appreciate a pointer to the TCs resolution as the TAB is tracking the resolution of comments from TAB members.
    
    Hope everyone is at the start of a great weekend!
    
    Patrick
    
    -- 
    Patrick Durusau
    patrick@durusau.net
    Technical Advisory Board, OASIS (TAB)
    Editor, OpenDocument Format TC (OASIS), Project Editor ISO/IEC 26300
    Co-Editor, ISO/IEC 13250-1, 13250-5 (Topic Maps)
    
    Another Word For It (blog): http://tm.durusau.net
    Homepage: http://www.durusau.net
    Twitter: patrickDurusau 
    
    

Issue key,Issue id,Summary,Affects Version/s,Custom field (Proposal),Issue Type
TAB-1592,46633,6.4 Another conflict between the schema and conformance clause,Exchange Header Envelope (XHE) Version 1.0,"If the goal is to allow for non-XML content (i.e., string, say a LaTeX document), again, xsd:choice with some restructuring offers a machine readable way to achieve the same result.

Not to mention avoiding a conflict between your conformance clause and your schema.",Bug
TAB-1591,46632,6.3 Conflict between text and schema - fatal,Exchange Header Envelope (XHE) Version 1.0,"An xsd:choice element would fix and drop the need for an awkward conformance clause.

Otherwise you have a conflict between the schema and your document, in which case the schema wins.",Bug
TAB-1590,46631,Annotated versus Runtime? base and common schemas,Exchange Header Envelope (XHE) Version 1.0,"Cited for this version or in general? If in general, use the latest version. 

So long as the schemas are re-named, there's nothing wrong with having an annotated and non-annotated versions, but make them complete sets for both versions.",Bug
TAB-1589,46629,1.4 Information References - [XMLEnc] outdated,Exchange Header Envelope (XHE) Version 1.0,"Cited for this version or in general? If in general, use the latest version. ",Bug
TAB-1588,46628,1.4 Informative References [PGP] incorrect format,Exchange Header Envelope (XHE) Version 1.0,"Correct as indicated.

PS: For future reference, check RFC citations against: [http://docs.oasis-open.org/templates/ietf-rfc-list/ietf-rfc-list.html] its a free resource from OASIS that provides the correct citations for RFCs.

 ",Bug
TAB-1587,46627,1.4 Informative References - CMS - incorrect format,Exchange Header Envelope (XHE) Version 1.0,Correct as indicated.,Bug
TAB-1586,46626,"6.2 ""not extension content""",Exchange Header Envelope (XHE) Version 1.0,"Try: Conforming extensions to XHE are defined by
 * *{{[XHE-ExtensionContentDataType-1.0.xsd|http://docs.oasis-open.org/bdxr/xhe/v1.0/csprd01/xsd/common/XHE-ExtensionContentDataType-1.0.xsd]}}* and *{{[XHE-PayloadContentDataType-1.0.xsd|http://docs.oasis-open.org/bdxr/xhe/v1.0/csprd01/xsd/common/XHE-PayloadContentDataType-1.0.xsd]}}* Any other extension or modification of the XHE schemas results in a non-conformant XHE header document instance.",Bug
TAB-1585,46625,6.2 Any XML element that is not extension content SHALL NOT be empty.,Exchange Header Envelope (XHE) Version 1.0,"Reformulate to say what elements are supposed to have as their content, saying not empty isn't helpful.",Bug
TAB-1584,46624,5.6.1 Modifiable schema fragments - repetitious,Exchange Header Envelope (XHE) Version 1.0,"Suggest 5.6 Content data type common schemas (surely incorrect anyway, there are others) with Extension / Payload Constraints, then bump 5.6.2 to 5.6.1 and 5.6.3 to 5.6.2 and you have a meaningful header, plus two meaningful sub-sections.",Bug
TAB-1583,46623,"5.5 ""read-only schema fragments""",Exchange Header Envelope (XHE) Version 1.0,The schema fragments that compose a header envelope are:,Bug
TAB-1582,46622,Repeated duplicate schema naming 5.4 The header envelope schema,Exchange Header Envelope (XHE) Version 1.0,Correct the references in 5.4 when you rename the schemas.,Bug
TAB-1581,46621,"Description of ""common files""",Exchange Header Envelope (XHE) Version 1.0,"Suggest: schema fragments used to complete a header envelope.

I would lose the ""common"" and replace with ""envelope fragments"" or some such.

Oh, I see, you are saying common to the runtime and annotation. Unnecessary and confusing. Give the annotated version a new name and its own set of fragment files.",Bug
TAB-1580,46616,4 Document model expression - Informative?,Exchange Header Envelope (XHE) Version 1.0,"Label 4 Document Model Expression as informative or better, move to an appendix labeled as informative.",Bug
TAB-1579,46615,Annotated and Runtime schemas have identical names,Exchange Header Envelope (XHE) Version 1.0,Perhaps: XHE-1.0-annotated.xsd for example.,Bug
TAB-1578,46612,Document model expression - Informative?,Exchange Header Envelope (XHE) Version 1.0,Clause 4 is Informative only.,Bug
TAB-1577,46611,"3 XHE digital signature - one informative, the other normative material",Exchange Header Envelope (XHE) Version 1.0,"Label 3 as information, lose the 3.1 or label 3 as informative and split into 3.1 and 3.2 as indicated before.",Bug
TAB-1576,46610,2.9.2 Payload item information - bad reference? ,Exchange Header Envelope (XHE) Version 1.0,I would remove the references to validation and just point to 2.10 Extension information.,Bug
TAB-1575,46609,"2.2 Header envelope information - 2.9.2 Payload item information - ""includes the following""",Exchange Header Envelope (XHE) Version 1.0,"Better to say:

""Documentation of one criterion of the scope of business or other contextual detail useful to understand the purpose of the envelope and its contents:""

In cases where the content can be extended:

2.9.2

""Information about an individual payload within the set of payloads:""

after your table:

Information about individual payloads MAY be extended by users, 2.10 Extension Information.

 ",Bug
TAB-1574,46608,2.1 XHE class diagram - Normative?,Exchange Header Envelope (XHE) Version 1.0,Suggest marking 2.1 XHE class diagram - Informative,Bug
TAB-1573,46607,"Inconsistent marking of ""informative"" text",Exchange Header Envelope (XHE) Version 1.0," 

Choose informative or non-normative and label content consistent with the description of separating normative and non-normative text. (Re-positioning your Normative Markings text.)",Bug
TAB-1572,46606,1.1 Conveying information about payloads - mixture of normative and informative content,Exchange Header Envelope (XHE) Version 1.0,"Suggestion: Clearly separate normative from non-normative content into separate clauses. That is in an informative clause, only information information appears, however many sub-clauses it may have.

The say: All clauses, unless marked as ""informative,"" are normative.

BTW, ISO says: ""The foreword is an informative element. It shall not contain requirements, permissions or recommendations.""

Apply that rule and you should be able to fairly easily isolate your informative content.

 

PS: 1.2 Terminology also occurs in Clause 1, being additional normative content that is mixed with informative content.",Bug


[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]