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 9491 - Suggested wording improvement for <section> and <article> definitions
Summary: Suggested wording improvement for <section> and <article> definitions
Status: CLOSED FIXED
Alias: None
Product: HTML WG
Classification: Unclassified
Component: pre-LC1 HTML5 spec (editor: Ian Hickson) (show other bugs)
Version: unspecified
Hardware: PC All
: P2 normal
Target Milestone: ---
Assignee: Ian 'Hixie' Hickson
QA Contact: HTML WG Bugzilla archive list
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2010-04-11 23:33 UTC by Maciej Stachowiak
Modified: 2010-10-04 14:31 UTC (History)
4 users (show)

See Also:


Attachments

Description Maciej Stachowiak 2010-04-11 23:33:10 UTC
According to this study, when developers are show then definitions of <section> and <article> without the element names, they often confuse which goes with which: <http://adactio.com/journal/1654/>

I suspect this may just be due to awkward wording. The section definition says:
"The section element represents a generic document or application section."

If you're skimming and the element name is removed, this can easily look like: "The ____ element represents a document".

I think wording similar to this may be more clear:
"The section element represents a generic section of a document or application."

Maybe even drop the word "generic" from the first sentence. That way, the sentence more strongly conveys the impression that the section element is a section.

The article element, in turn, says:
"The article element represents a component of a page that consists of a self-contained composition in a document, page, application, or site and that is intended to be independently distributable or reusable, e.g. in syndication."

Again, reading quick, this might look like: "The _____ element represents a component of a page".

Here's a suggestion for possible better wording:
"The article element represents a self-contained composition in a document, page, application, or site that is intended to be independently distributable or reusable, e.g. in syndication."

That puts the "self-contained concept" concept front and center, instead of "component of a page", which is secondary. An article could be substantially all of the content of a page, it doesn't have to be just part.

I think wording changes along these lines may reduce confusion.
Comment 1 Ian 'Hixie' Hickson 2010-04-13 08:49:14 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: Partially Accepted
Change Description: see diff given below
Rationale: I left "generic" on the basis that we need something to distinguish it from <nav> and <aside>. Other than that, agreed.
Comment 2 contributor 2010-04-13 08:50:15 UTC
Checked in as WHATWG revision r5031.
Check-in comment: fine tune <section> and <article> descriptions some more.
http://html5.org/tools/web-apps-tracker?from=5030&to=5031
Comment 3 Maciej Stachowiak 2010-04-13 09:50:54 UTC
Works for me.