W3C home > Mailing lists > Public > public-cdf@w3.org > August 2005

[WICD-oT-8] WICD review - define "compound document" earlier

From: olivier Thereaux <ot@w3.org>
Date: Wed, 24 Aug 2005 12:02:58 +0900
Message-Id: <E93F879B-0A7E-411F-AEA1-64D624EEE373@w3.org>
To: public-cdf@w3.org

Dear CDF working group.

This is a comment on the W3C Working Draft Dated 09 August 2005 of  
"Compound Document Framework 1.0 and WICD Profiles"
http://www.w3.org/TR/2005/WD-WICD-20050809/

Section 1.2.1 "Reference and Inclusion", albeit non-normative, is  
where the concept of a compound document is first introduced. The  
term is defined in the glossary (Annex A Definitions) as:
> The compound document is a document that combines separate  
> component languages either by reference or by inclusion.

I see several issues with this:
- an actual definition of a compound document early in the document,  
possibly normative, would probably be a good idea
- reference and inclusion are not defined normatively. The definition  
of compound document in annex A is therefore lacking.

Suggestion:

- add a section before 1.2 defining a compound document, inclusion  
and reference, as well as other key concepts (root, parent, child).  
Having definitions in a final glossary is an excellent practice, but  
defining terms as they are introduced is a good practice, too.

See:
http://www.w3.org/TR/qaframe-spec/#define-terms-principle
http://www.w3.org/TR/qaframe-spec/#define-terms-inline-gp

This comment is related to:
[WICD-oT-6] WICD review - give (even) more definitions, or references  
to definitions

regards,
-- 
olivier
Received on Wednesday, 24 August 2005 03:03:05 GMT

This archive was generated by hypermail 2.2.0+W3C-0.50 : Tuesday, 8 January 2008 14:10:40 GMT