Re: CDR: style and precision problems in definitions appendix

Maceij

Comments below with [KEK]

Please let us know within two weeks if this reply doesn't satisfy your 
comments. 

Thanks,
Kevin
On behalf of the CDF WG

This addresses 
http://lists.w3.org/Archives/Public/public-cdf/2006Jan/0018.html
Action 367 http://www.w3.org/2004/CDF/Group/track/actions/367




Maciej Stachowiak <mjs@apple.com> 
Sent by: public-cdf-request@w3.org
01/02/2006 05:03 AM

To
public-cdf@w3.org
cc

Subject
CDR: style and precision problems in definitions appendix








A.

"Compound Document

The compound document is a document that combines separate component 
languages either by reference or by inclusion."

- I think this would be better written as:

    "Compound Document

     A compound document is a document that combines multiple 
document formats by reference, by inclusion or both."

   Or it may be even better to say "one or more document formats"

[KEK] Changed "The Compound Document is a document that combines separate 
component languages either by reference or by inclusion." To "A Compound 
Document is a document that combines mutliple document formats either by 
reference, by inclusion or both."





"A parent document represents a document that has a DOM as defined by 
DOM Level 3 Core and reference another document. The DOM that is 
formed must be tree-based."

- That should be "references another document".

[KEK] "reference" was changed to "references"

- Stating that "The DOM that is formed must be tree-based" is vacuous 
- the DOM is always tree-based.

[KEK] No change was with respect to this comment.







"The document that is referenced is called Child document. If the 
Child document references other documents, it is also called Parent 
document."

- Suggest rewriting for style to say "The document that is referenced
   is called a child document. If a child document itself references
   other documents, then it is also a parent document."

[KEK] Change accepted and made.



"Component Language

Component language refers to an XML-based language (like XHTML and 
SVG) with its own elements and attributes."

- Perhaps the term "XML Application" would be sufficient to express 
this, instead of the novel term "Component Language".

- Is non-X HTML meant to be explicitly included by this 
specification? I would prefer if it were included as a valid format 
that can participate in CDR.

[KEK] This term was removed since a previous change to the COmpound 
Document definition made this unreferenced.





"CDR
A document which logically includes other documents via a hypertext 
reference.

For example: XML 1.1 or HTML documents tied through hypertext 
reference producing as many DOM linked to one another."

- The example doesn't make sense as English. No correction offered 
because I am not sure what it is supposed to mean.

- CDR expands to Compound Document by Reference, it may be worth 
including this expansion in the definition.

[KEK] CDR expanded to define acronym
[KEK] Example removed.





"CDI
A document which includes other documents by-value.

For example: A single XML 1.1 document making use of XML grammars
defined independently, normally making use of multiple namespaces."

- Instead of "by-value" it may help to use a more clear term, like 
"textually include" or "directly include".

- CDR expands to Compound Document by Inclusion, it may be worth 
including this expansion in the definition.

[KEK] CDI expanded to define acronym
[KEK] definition changed to "A document which directly includes other 
documents and or namespace markup within the same physical document."

Regards,
Maciej