[Bug 11466] New: Reword 4.4.7 The hgroup element

http://www.w3.org/Bugs/Public/show_bug.cgi?id=11466

           Summary: Reword 4.4.7 The hgroup element
           Product: HTML WG
           Version: unspecified
          Platform: Macintosh
        OS/Version: All
            Status: NEW
          Severity: normal
          Priority: P2
         Component: HTML5 spec (editor: Ian Hickson)
        AssignedTo: ian@hixie.ch
        ReportedBy: jbdoug2@gmail.com
         QAContact: public-html-bugzilla@w3.org
                CC: mike@w3.org, public-html-wg-issue-tracking@w3.org,
                    public-html@w3.org


With respect to comments concerning hgroup in the HTML WG Public List threads

    hgroup and ARIA outline in ISSUE-129

and

    suggestion for abolition of <hgroup>.

It appears the hgroup element concept may not be readily appraent to authors.
Reword the hgroup element definition to emphasize it is a group of heading
elements. Keep the function of the h1-h6 elements the same, but emphasize that
the highest ranking h1-h6 element implies a new section or that there must be
an explicit parent section for an hgroup element.

The name of the hgroup element should be more descriptive to avoid confusion
for authors. Suggestions are

<headinggroup>    two g's not readable and prone to typing errors, wordy
<headingblock>    states this is a heading and acts as a whole, wordy
<hblock>        'block' to me better conveys that the combination contained
therein is treated as one whole (from the authors' view). The 'h' highlights
the association to the h1-h6 elements.


I propose the following text change to 4.4.7 The hgroup element.

Currently

4.4.7 The hgroup element

The hgroup element represents the heading of a section. The element is used to
group a set of h1–h6 elements when the heading has multiple levels, such as
subheadings, alternative titles, or taglines.

For the purposes of document summaries, outlines, and the like, the text of
hgroup elements is defined to be the text of the highest ranked h1–h6 element
descendant of the hgroup element, if there are any such elements, and the first
such element if there are multiple elements with that rank. If there are no
such elements, then the text of the hgroup element is the empty string.

Other elements of heading content in the hgroup element indicate subheadings or
subtitles.

The rank of an hgroup element is the rank of the highest-ranked h1–h6 element
descendant of the hgroup element, if there are any such elements, or otherwise
the same as for an h1 element (the highest rank).

The section on headings and sections defines how hgroup elements are assigned
to individual sections.

Proposed

4.4.7 The hblock element

The hblock element represents the heading of a section. The element is used to
group a set of h1–h6 elements when the heading has multiple levels, such as
subheadings, alternative titles, or taglines.

The hblock element is considered the alias of the first highest ranking h1-h6
element that is its direct descendent. Therefore, the hblock element assumes
the text, rank, and any implied section start that the first occurrence of the
highest ranking h1-h6 element descendent to it would represent. Any other h1-h6
elements of equal or lower rank descendent of the hblock are removed from the
document summary, outline, and the like and do not start implied sections.

If there is no h1-h6 element descendent of the hblock element, then the text of
the hblock element is the empty string and the rank is the same as an h1
element (the highest rank).

The section on headings and sections defines how hblock elements are assigned
to individual sections.

Examples:

In the following, the <hblock> is a direct descendent of the explicit <section>
element. The <hblock> takes on the semantic properties of the <h1> element and
neither does not imply the start of a new section.

<section>
    <hblock>
        <h2>Winter Wonderland</h2>
        <h1>The Seasons of the Mountains</h1>
    </hblock>
    <p>Written mountain stuff here.</p>
</section>

Below, the <hblock> does not belong to any explicit section, so begins an
implied section with the rank of the enclosed <h1> element. The <h1> element
does not start another implied section.

<section>
    <h1>Seasoning Geology</h1>
    <p>Written stuff here.</p>
</section>
<hblock>
    <h2>Winter Wonderland</h2>
    <h1>The Seasons of the Mountains</h1>
</hblock>
<p>Written mountain stuff here.</p>

In the following, there is no content in the hblock element, but the hblock
element starts an implied section with the highest rank (rank of 1).

<section>
    <h1>Seasoning Geology</h1>
    <p>Written stuff here.</p>
</section>
<hblock>
</hblock>
<p>Written stuff here.</p>

I propose the following text addition to 4.4.11.1 Creating an outline.

Currently

The outline for a sectioning content element or a sectioning root element
consists of a list of one or more potentially nested sections. A section is a
container that corresponds to some nodes in the original DOM tree. Each section
can have one heading associated with it, and can contain any number of further
nested sections. (The sections in the outline aren't section elements, though
some may correspond to such elements — they are merely conceptual sections.)

The following markup fragment:

<body>
 <h1>A</h1>
 <p>B</p>
 <h2>C</h2>
 <p>D</p>
 <h2>E</h2>
 <p>F</p>
</body>
...results in the following outline being created for the body node (and thus
the entire document):

Section created for body node.
Associated with heading "A".
Also associated with paragraph "B".
Nested sections:
Section implied for first h2 element.
Associated with heading "C".
Also associated with paragraph "D".
No nested sections.
Section implied for second h2 element.
Associated with heading "E".
Also associated with paragraph "F".
No nested sections.

Append the following

The following markup fragment:

<body>
 <h1>A</h1>
 <p>B</p>
 <hblock>
     <h2>C</h2>
     <h3>CC</h3>
 </hblock>
 <p>D</p>
 <h2>E</h2>
 <p>F</p>
</body>
...results in the same outline as immediately above.

-- 
Configure bugmail: http://www.w3.org/Bugs/Public/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the QA contact for the bug.

Received on Friday, 3 December 2010 20:23:25 UTC