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 13460 - Show more use cases for details/summary elements
Summary: Show more use cases for details/summary elements
Status: RESOLVED NEEDSINFO
Alias: None
Product: HTML WG
Classification: Unclassified
Component: HTML5 spec (show other bugs)
Version: unspecified
Hardware: PC Windows XP
: P2 normal
Target Milestone: ---
Assignee: steve faulkner
QA Contact: HTML WG Bugzilla archive list
URL: http://www.w3.org/TR/2011/WD-html5-20...
Whiteboard:
Keywords: a11y
Depends on:
Blocks:
 
Reported: 2011-07-29 19:39 UTC by Michael Cooper
Modified: 2013-03-30 17:10 UTC (History)
9 users (show)

See Also:


Attachments

Description Michael Cooper 2011-07-29 19:39:36 UTC
It is possible to consider a great many use cases for a feature like <details> with <summary> that shows elided content plus full content. However, the examples and placement in the spec make it look like it's meant to be a particular kind of widget. On the other hand, the content model suggests that it can in fact be used in a wide variety of ways. Additional examples would help clarify this.

Edit details: Add the following examples to the <details> element.

1.) A new site shows a summary of an article with the option to view full content.

<section>
  <h2>Government balances budget</h2>
  <details>
    <summary>The governing party has announced passage of a budget with support from all other parties.</summary>
    <p>The government has announced a budget that will not increase the federal debt for the upcoming budget year. This budget has unprecedented support from opposition parties as well. Though the debate was intense, discussion was clearly motivated by a desire to serve the electorate well, taking priority over serving the individual interests of elected officials and their funders. Analysts predict this budget will increase GDP by 3% over the upcoming budget cycle and eliminate government debt in 5 years.</p>
    <p>etc.</p>
  </details>
</section>

2.) A science site provides an easy-to-read version of technical content.

<details>
  <summary>Special relativity says that space and time our connected. If we move faster through one, we move slower through another to maintain that connection. The faster we travel, the more time for us slows down. If we go really fast, our clocks get so slow that we age less than everybody else.</summary>
  <p>According to the theory of special relativity, we move through 4-dimensional spacetime at a constant rate. This rate is c, also known as the speed of light in a vacuum. As we increase our speed in space, our speed in time slows down correspondingly. The correspondence is given by the famous equation e=mc<sup>2</sup>. This formula makes it possible to calculate the kinetic energy of a mass traveling through space at a given speed in a way that relates it to the constant speed through spacetime c. The speed of that mass through the time dimension slows down correspondingly to achieve a constant speed through spacetime.</p>
  <p>etc.</p>
</details>
Comment 1 Michael[tm] Smith 2011-08-04 05:35:49 UTC
mass-move component to LC1
Comment 2 Ian 'Hixie' Hickson 2011-08-18 00:03:36 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: It _is_ a widget. See the element's definition. The word "widget" is the second word of the definition of what the element represents, the first word being the kind of widget.
Comment 3 Michael Cooper 2013-01-16 14:26:38 UTC
HTML A11Y TF has decided to push this issue off to HTML.next but then no longer to track the bug as a TF priority, so removing the keyword.
Comment 4 Robin Berjon 2013-01-21 16:00:18 UTC
Mass move to "HTML WG"
Comment 5 Robin Berjon 2013-01-21 16:03:02 UTC
Mass move to "HTML WG"
Comment 6 steve faulkner 2013-02-06 23:45:47 UTC
(In reply to comment #0)
> It is possible to consider a great many use cases for a feature like
> <details> with <summary> that shows elided content plus full content.
> However, the examples and placement in the spec make it look like it's meant
> to be a particular kind of widget. On the other hand, the content model
> suggests that it can in fact be used in a wide variety of ways. Additional
> examples would help clarify this.
> 
> Edit details: Add the following examples to the <details> element.
> 
> 1.) A new site shows a summary of an article with the option to view full
> content.
> 
> <section>
>   <h2>Government balances budget</h2>
>   <details>
>     <summary>The governing party has announced passage of a budget with
> support from all other parties.</summary>
>     <p>The government has announced a budget that will not increase the
> federal debt for the upcoming budget year. This budget has unprecedented
> support from opposition parties as well. Though the debate was intense,
> discussion was clearly motivated by a desire to serve the electorate well,
> taking priority over serving the individual interests of elected officials
> and their funders. Analysts predict this budget will increase GDP by 3% over
> the upcoming budget cycle and eliminate government debt in 5 years.</p>
>     <p>etc.</p>
>   </details>
> </section>
> 
> 2.) A science site provides an easy-to-read version of technical content.
> 
> <details>
>   <summary>Special relativity says that space and time our connected. If we
> move faster through one, we move slower through another to maintain that
> connection. The faster we travel, the more time for us slows down. If we go
> really fast, our clocks get so slow that we age less than everybody
> else.</summary>
>   <p>According to the theory of special relativity, we move through
> 4-dimensional spacetime at a constant rate. This rate is c, also known as
> the speed of light in a vacuum. As we increase our speed in space, our speed
> in time slows down correspondingly. The correspondence is given by the
> famous equation e=mc<sup>2</sup>. This formula makes it possible to
> calculate the kinetic energy of a mass traveling through space at a given
> speed in a way that relates it to the constant speed through spacetime c.
> The speed of that mass through the time dimension slows down correspondingly
> to achieve a constant speed through spacetime.</p>
>   <p>etc.</p>
> </details>

Hi Michael,

have you looked at how details/summary is implemented in browsers?  http://caniuse.com/details shows current support and the html to platform accessibility api guide provides implementation advice https://dvcs.w3.org/hg/html-api-map/raw-file/tip/Overview.html#examples-sum

do the examples you provided suit the current implementation? As in is it appropriate to have a multi sentence text label for what is essentially a button?
Comment 7 steve faulkner 2013-03-30 17:10:29 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: needs info
Change Description: no spec change
Rationale: refer to Comment 6