This is an archived snapshot of W3C's public bugzilla bug tracker, decommissioned in April 2019. Please see the home page for more details.

Bug 5091 - distinguish between normative and non-normative content consistently and clearly in both specs
Summary: distinguish between normative and non-normative content consistently and clea...
Status: RESOLVED FIXED
Alias: None
Product: SML
Classification: Unclassified
Component: Core+Interchange Format (show other bugs)
Version: unspecified
Hardware: PC Windows XP
: P2 normal
Target Milestone: LC
Assignee: Valentina Popescu
QA Contact: SML Working Group discussion list
URL:
Whiteboard:
Keywords: resolved
Depends on:
Blocks: 5098 5099
  Show dependency treegraph
 
Reported: 2007-09-30 14:30 UTC by John Arwe
Modified: 2007-12-13 20:27 UTC (History)
0 users

See Also:


Attachments
SML spec updates (430.13 KB, text/html)
2007-12-12 20:13 UTC, Valentina Popescu
Details
SML-IF spec updates (126.47 KB, text/html)
2007-12-12 20:13 UTC, Valentina Popescu
Details
SML spec changes - doc format (496.50 KB, application/octet-stream)
2007-12-12 20:17 UTC, Valentina Popescu
Details
SMLIF updates - doc format (198.00 KB, application/octet-stream)
2007-12-12 20:19 UTC, Valentina Popescu
Details

Description John Arwe 2007-09-30 14:30:38 UTC
We need to state how readers distinguish between normative and non-normative content consistently and clearly in both specs.  The SML spec currently marks some sections non-normative explicitly, leading a reader to the conclusion that the rest is normative; the SMLIF spec marks some sections normative, some non-normative, and leaves the rest ambiguous (including the schema).

Proposal: add following to Notational Conventions section accompanying the 2119 text (editorial word-smithing by editors explicitly allowed if it improves clarity)

All content in this specification, including but not limited to text, schema, and appendices, is normative except the following:
- content explicitly marked non-normative 
- content referred to as an example

(end of proposed added text) 

Where entire sections are to be marked, they should be marked consistently.  I recommend doing so in the heading, ala SML Appendix C.  This means for example that SML 8 (which is marked in text but not in its heading) must be changed.
Comment 1 John Arwe 2007-09-30 20:10:35 UTC
If this is done, SML appendices A and B could drop "Normative" from their headings
Comment 2 John Arwe 2007-10-01 13:13:23 UTC
again, assuming the proposed style...

SMLIF 
add Non-Normative to headings for Intro, Informal Desc
remove Normative from section 3 SMLIF Def
Comment 3 Valentina Popescu 2007-12-12 20:12:10 UTC
SML and SML-IF spec updated as decribed in the attached documents ( note that changes have been applied to CVS )
Comment 4 Valentina Popescu 2007-12-12 20:13:07 UTC
Created attachment 498 [details]
SML spec updates
Comment 5 Valentina Popescu 2007-12-12 20:13:45 UTC
Created attachment 499 [details]
SML-IF spec updates
Comment 6 Valentina Popescu 2007-12-12 20:17:04 UTC
Created attachment 500 [details]
SML spec changes - doc format

Attaching the doc format; I noticed the html one doesn't show all the updates
if opened inline
Comment 7 Valentina Popescu 2007-12-12 20:19:51 UTC
Created attachment 501 [details]
SMLIF updates - doc format

Attaching the doc format; I noticed the html one doesn't show all the updates
if opened inline
Comment 8 Sandy Gao 2007-12-13 17:55:56 UTC
+1 to changes made for this bug.