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 10845 - Clarify the difference between @srcdoc documents and @srcdoc value
Summary: Clarify the difference between @srcdoc documents and @srcdoc value
Status: RESOLVED WONTFIX
Alias: None
Product: HTML WG
Classification: Unclassified
Component: pre-LC1 HTML5 spec (editor: Ian Hickson) (show other bugs)
Version: unspecified
Hardware: All All
: P3 normal
Target Milestone: LC
Assignee: Ian 'Hixie' Hickson
QA Contact: HTML WG Bugzilla archive list
URL: http://dev.w3.org/html5/spec/the-ifra...
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2010-09-30 01:33 UTC by Leif Halvard Silli
Modified: 2010-10-04 14:33 UTC (History)
4 users (show)

See Also:


Attachments

Description Leif Halvard Silli 2010-09-30 01:33:09 UTC
Spec says:

]]
The value of the attribute in is an iframe srcdoc document.
For iframe elements in HTML documents, the attribute, if present, must have a value using the HTML syntax [#syntax] that consists of the following syntactic components, in the given order: 
                    [ snipping point 1 to 3]
  4. The root element, in the form of an html element.
                    [ snipping point 5] 
[[

PROBLEM:

A) the text here speaks about the string inside the @srcdoc attribute
     - it does not speak about the DOM when the srcdoc is rendered.
B) while the 'the root element' is listed as a 'syntactic component' which
    the @srcdoc must contain, the code examples in the spec - such as
    the following,

           ]] srcdoc="<p>did you get a cover picture yet?"  [[

    - do not syntactically contain the <html> element ...
    Or, how can one say that the p element, inside an attribute value, 
    embodies the 'the root element'? _That_ only happens in the DOM.

REQUEST: 

Please replace the above quote with the following modification:

]]  [the attribute, if present, must have] as value the following parts of the HTML syntax  [#syntax], in the given order:   [ snipping the 5 point list ]   [[

JUSTIFICATION: 

Ideally, you could - much as you for XML just point to XML's 'document' production - just link to the #syntax (http://dev.w3.org/html5/spec/syntax#syntax) and say that @srcdoc can contain the HTML syntax, with the exception that the DOCTYPE is optional and the BOM is not permitted.

However, since you don't do that,  but still *do* point to [#syntax], it seems beneficial just to skip the undefined term "syntactical components" and instead make the link to [#syntax] stronger by saying "the following parts of/from the HTML syntax". ('part' is a word that you use in the [#syntax] section).

By making the link stronger, readers will more easily understand that the consepts, with regard to ability to skip what is generated in the DOM anyway, is the same when it comes to @srcdoc as it is generally.
Comment 1 Ian 'Hixie' Hickson 2010-09-30 07:47:50 UTC
EDITOR'S RESPONSE: This is an Editor's Response to your comment. If you are satisfied with this response, please change the state of this bug to CLOSED. If you have additional information and would like the editor to reconsider, please reopen this bug. If you would like to escalate the issue to the full HTML Working Group, please add the TrackerRequest keyword to this bug, and suggest title and text for the tracker issue; or you may create a tracker issue yourself, if you are able to do so. For more details, see this document:
   http://dev.w3.org/html5/decision-policy/decision-policy.html

Status: Rejected
Change Description: no spec change
Rationale: "syntactical components" is just English. It means components (aka parts, they mean the same thing in this context) that are syntactical (i.e. that are of syntax). In other words, it means the same as what you are proposing.

Regarding the problems:

A: Why would we speak of the DOM? Attribute values are strings.

B: The syntax section describes that the root <html> element can be syntactically represented by the empty string, since the tags are omittable.