Title: CSS Generated Content Module Level 3
Status: ED
Work Status: Exploring
Shortname: css-content
Level: 3
Group: csswg
TR: https://www.w3.org/TR/css-content-3/
ED: https://drafts.csswg.org/css-content-3/
Previous Version: https://www.w3.org/TR/2016/WD-css-content-3-20160602/
Editor: Elika J. Etemad / fantasai, W3C Invited Expert, http://fantasai.inkedblade.net/contact, w3cid 35400
Editor: Mike Bremford, BFO, mike@bfo.com, w3cid 118053
Former Editor: Dave Cramer, Hachette Livre, dauwhe@gmail.com, w3cid 65283
Former Editor: Håkon Wium Lie, Opera Software, howcome@opera.com
Former Editor: Ian Hickson, Google, ian@hixie.ch
Ignored Terms: , leader(), string(), target-counter(), target-counters(), target-text()
Abstract: This CSS3 Module describes how to insert content in a document.
Link Defaults: css2 (type) , css-display-3 (value) inline
Status Text: This is a very rough draft, and is not ready for implementation.
Default Highlight: css
Introduction
Authors sometimes want user agents to render content that does not come from the document tree.
One familiar example of this is numbered headings;
the author does not want to mark the numbers up explicitly,
they want the user agent to generate them automatically.
Counters and markers are used to achieve these effects.
h1::before { content: counter(section) ": "; }
Similarly, authors may want the user agent to insert the word "Figure" before the caption of a figure,
or "Chapter 7" on a line before the seventh chapter title.
Another common effect is replacing elements with images or other multimedia content.
Since not all user agents support all multimedia formats,
fallbacks may have to be provided.
/* Replace <logo> elements with the site's logo, using a format
* supported by the UA */
logo { content: url(logo.mov), url(logo.mng), url(logo.png), none; }
/* Replace <figure> elements with the referenced document, or,
* failing that, with either the contents of the alt attribute or the
* contents of the element itself if there is no alt attribute */
figure[alt] { content: attr(href url), attr(alt); }
figure:not([alt]) { content: attr(href url), contents; }
Value Definitions
This specification follows the CSS property definition conventions from [[!CSS2]]
using the value definition syntax from [[!CSS-VALUES-3]].
Value types not defined in this specification are defined in CSS Values & Units [[!CSS-VALUES-3]].
Combination with other CSS modules may expand the definitions of these value types.
In addition to the property-specific values listed in their definitions,
all properties defined in this specification
also accept the CSS-wide keywords as their property value.
For readability they have not been repeated explicitly.
Inserting and Replacing Content: the 'content' property
Name: content
Value: normal | none | [ <> | <> ] [/ [ <> | <> | <> ]+ ]?
Initial: normal
Applies To: all elements, tree-abiding pseudo-elements, and page margin boxes
Inherited: no
Percentages: n/a
Computed Value: See prose below
Animation type: discrete
User agents are expected to support this property on all media, including non-visual ones.
The 'content' property dictates what is rendered inside an element or pseudo-element.
For elements, it has only one purpose:
specifying that the element renders as normal,
or replacing the element with an image
(and possibly some associated "alt text").
For pseudo-elements and margin boxes,
it is more powerful.
It controls whether the element renders at all,
can replace the element with an image,
or replace it with arbitrary inline content
(text and images).
normal
For an element or page margin box, this computes to ''content/contents''.
For ''::before'' and ''::after'', this computes to ''content/none''.
For ''::marker'',
''::placeholder'',
and
''::file-selector-button'',
this computes to itself (''content/normal'').
none
On elements, this behaves as ''content/normal''.
On [=pseudo-elements=] it inhibits the creation of the pseudo-element
as if it had ''display: none''.
In neither case does it prevent any pseudo-elements which have this element or pseudo-element as an originating element from being generated.
<>
Equal to:
<>
Makes the element or pseudo-element a replaced element,
filled with the specified <>.
Its normal contents are suppressed
and do not generate boxes,
as if they were ''display: none''.
If the <> represents an invalid image,
then it must be treated as instead representing an image with zero [=natural dimensions|natural=] width and height,
filled with transparent black.
Issue: The above invalid image behavior appears to be what Chrome is doing.
Is this okay?
Is there a better behavior we can/should use?
Note: Replaced elements use different layout rules than normal elements.
(In effect, it becomes equivalent to an HTML <{img}> element.)
Note: Replaced elements do not have ''::before'' or ''::after'' pseudo-elements;
the 'content' property replaces their entire contents.
ISSUE(2889): This value has historically been treated as <> on ''::before'' and ''::after''.
Presumably there's a Web-compat requirement on this,
so these pseudo-elements might need an exception.
<>
Replaces the element's contents with one or more anonymous inline boxes
corresponding to the specified values,
in the order specified.
Its normal contents are suppressed
and do not generate boxes,
as if they were ''display: none''.
Each value contributes an inline box to the element's contents.
For <>, this is an inline anonymous replaced element;
for the others, it's an anonymous inline run of text.
If an <> represents an invalid image,
the user agent must do one of the following:
* "Skip" the <>, generating nothing for it.
* Display some indication that the image can't be displayed in place of the <>,
such as a "broken image" icon.
This specification intentionally does not define which behavior a user agent must use,
but it must use one or the other consistently.
Note: If the value of <> is a single <>,
it must instead be interpreted as a <>.
/ [ <> | <> | <> ]+
Specifies the "alt text" for the element.
See [[#alt]] for details.
If omitted,
the element has no "alt text".
Issue: Should the contents keyword be replaced with ''content()''?
Accessibility of Generated Content
Generated content should be searchable, selectable, and available to assistive technologies.
The 'content' property applies to speech
and generated content must be rendered for speech output. [[!CSS3-SPEECH]]
Issue: Start work on an AAM for CSS.
Alternative Text for Accessibility
Content intended for visual media sometimes needs alternative text for speech output or other non-visual mediums.
The 'content' property thus accepts alternative text
to be specified after a slash (''/'') after the last <>.
If such alternative text is provided,
it must be used for speech output instead.
This allows, for example, purely decorative text to be elided in speech output
(by providing the empty string as alternative text),
and allows authors to provide more readable alternatives
to images, icons, or text-encoded symbols.
Here the content property is an image, so the alt value is required to provide alternative text.
.new::before {
content: url(./img/star.png) / "New!";
/* or a localized attribute from the DOM: attr("data-alt") */
}
If the pseudo-element is purely decorative and its function is covered elsewhere, setting alt to the empty string can avoid reading out the decorative element. Here the ARIA attribute will be spoken as "collapsed". Without the empty string alt value, the content would also be spoken as "Black right-pointing pointer".
.expandable::before {
content: "\25BA" / "";
/* a.k.a. ► */
/* aria-expanded="false" already in DOM,
so this pseudo-element is decorative */
}
Generated Content Values: the <> type
The <> value is used in 'content'
to fill an element with one or more anonymous inline boxes,
including images, strings, the values of counters, and the text value of elements.
In this section we enumerate the possibilities.
The syntax of <> is defined as:
Represents an anonymous inline box filled with the specified text.
Note: White space in the string is handled the same as in literal text,
and controlled by the properties in [[CSS-TEXT-3]] and elsewhere.
In particular, white space character can collapse,
even across multiple strings,
such as in ''content: "First " " Second";'',
which by default will render similar to "First Second"
(with a single visible space between the two words).
<>
The attr() functional notation represents
the string stored as the specified attribute’s value.
Its argument is a [=CSS qualified name=] (qname)
representing the attribute name and namespace, if any.
See [[!CSS3-NAMESPACE]].
Note: As in [[selectors-4#attrnmsp|attribute selectors]],
attribute names without an explicit namespace
do not associate with any default namespace.
2D Images: <> values
<>
Represents an anonymous inline replaced element
filled with the specified <>.
If the <> represents an invalid image,
this value instead represents nothing.
(No inline content is added to the element,
as if this value were "skipped".)
Issue: CSS2.1 explicitly allowed the UA to substitute a broken image icon
if the image was invalid.
However, no browser appears to do this.
Is this removal okay?
Elemental Content: the ''contents'' keyword
contents
The element's descendants.
Since this can only be used once per element
(you can't duplicate the children if, e.g., one is a plugin or form control),
it is handled as follows:
: If set on the element:
:: Always honoured.
Note that this is the default,
since the initial value of 'content' is ''content/normal''
and ''content/normal'' computes to ''content/contents'' on an element.
: If set on one of the element's other pseudo-elements:
:: Check to see that it is not set on a "previous" pseudo-element, in the following order, depth first:
1. the element itself
2. ::before
3. ::after
Issue: Should this behave as an empty string on pseudo-elements?
If it is already used, then it evaluates to nothing (like ''content/none'').
Only pseudo-elements that are actually generated are checked.
In the following case:
foo { content: normal; } /* this is the initial value */
foo::after { content: contents; }
...the element's 'content' property would compute to ''content/contents''
and the after pseudo element would have no contents
(equivalent to ''content/none'')
and thus would not appear.
But in this example, the ::after pseudo-element will contain the contents of the foo element.
ISSUE: Use cases for suppressing the content on the element and using it in a pseudo-element would be welcome.
Note: While it is useless to include ''content/contents'' twice in a single 'content' property,
that is not a parse error.
The second occurrence simply has no effect,
as it has already been used.
It is also not a parse error to use it on a ''::marker'' pseudo-element,
it is only during the rendering stage that it gets treated like ''content/none''.
Issue: Do we need the statement about marker pseudo-elements here? Or is this legacy from the old version of the spec?
Quotation Marks
The ''quotes'' property, which defines the [=quotation mark system=] of an
element,
in conjunction with the various ''*-quote'' values of the 'content' property,
which insert corresponding quotation marks as generated content,
can be used to automatically insert opening and closing quotation marks,
such as for the HTML <{q}> element.
Quotation Mark System: the 'quotes' property
Name: quotes
Value: auto | none | match-parent | [ <> <> ]+
Initial: auto
Applies To: all elements
Inherited: yes
Percentages: n/a
Computed Value: the keyword ''quotes/none'', the keyword ''quotes/auto'' or ''quotes/match-parent'', or a list, each item a pair of string values
Animation type: discrete
User agents are expected to support this property on all media, including non-visual ones.
This property specifies the quotation mark system for the element,
defining how the 'content' property’s
''content/open-quote'' and ''content/close-quote'' values behave.
See [[#quote-values]].
Values have the following meanings:
none
The ''open-quote'' and ''close-quote'' values of the 'content' property
produce no quotations marks,
as if they were ''no-open-quote'' and ''no-close-quote'' respectively.
auto
A typographically appropriate [=quotation mark system=]
is automatically chosen by the UA
based on the [=content language=] of the parent
(or, if there is no parent, of the element itself).
Note: The Unicode Common Locale Data Repository [[CLDR]]
maintains information on typographically appropriate quotation marks.
UAs can use other sources of information as well,
particularly as typographic preferences can vary;
however it is encouraged to submit any improvements to Unicode
so that the entire software ecosystem can benefit.
match-parent
Specifies the same [=quotation mark system=] as the the parent.
In general this is equivalent to inheriting the parent's [=computed value=],
except that ''quotes/auto'' it resolves
using the same [=content language=] that the parent used.
Issue: Two possible approaches here, currently speccing the latter:
a) this computes to the relevant string values, and inherits as such.
b) this value effectively inherits as a keyword + a language code,
meaning ''quotes/auto'', but with this language.
[ <> <> ]+
The [=quotation mark system=] is defined as
the specified list of pairs of quotation marks (opening and closing).
The first pair represents the outermost level of quotation,
the second pair the next level of embedding, etc.
Within a pair,
the ''open-quote'' value refers to the first <>,
''close-quote'' refers to the second.
Inserting Quotation Marks: the ''*-quote'' keywords
These values are replaced by the appropriate string
as defined by the 'quotes' property,
and increments (for ''no-open-quote'')
or decrements (for ''no-close-quote'')
the level of nesting for quotes.
no-open-quote
no-close-quote
Inserts nothing (as in ''content/none''),
but increments (for ''no-open-quote'')
or decrements (for ''no-close-quote'')
the level of nesting for quotes.
Quotation marks can be inserted in appropriate places in a document
with the ''open-quote'' and ''close-quote'' values of the 'content' property.
Each occurrence of ''open-quote'' or ''close-quote''
is replaced by a quotation mark string
as defined by the [=quotation mark system=] specified by the 'quotes' property,
based on the [=quote depth|depth of nesting=].
Which pair of quotes is used depends on the nesting level of quotes
(the quote depth):
the number of occurrences of ''open-quote'' in all generated text before the current occurrence,
minus the number of occurrences of ''close-quote'' in all generated text before and including the current occurence.
If the depth is 0, the first pair is used,
if the depth is 1, the second pair is used, etc.
If the depth is greater than the number of pairs,
the last pair is repeated.
Note: [=Quote depth=] is independent of
the nesting of the source document or the formatting structure.
Also, like [[css-lists-3#inheriting-counters|counter inheritance]],
it operates on the “flattened element tree”
in the context of the [[DOM]].
A ''close-quote'' or ''no-close-quote'' that would make the [=quote depth=] negative
is in error and is ignored (at rendering time):
the depth stays at 0 and no quote mark is inserted
(although the rest of the 'content' property's value is still inserted).
Some typographic styles require open quotation marks to be repeated
before every paragraph of a quote spanning several paragraphs,
but only the last paragraph ends with a closing quotation mark.
In CSS, this can be achieved by inserting "phantom" closing quotes.
The keyword ''no-close-quote'' decrements the quoting level,
but does not insert a quotation mark.
The following style sheet puts opening quotation marks on every paragraph in a blockquote,
and inserts a single closing quote at the end:
For symmetry, there is also a ''no-open-quote'' keyword,
which inserts nothing,
but increments the quotation depth by one.
Note: If a quotation is in a different language than the surrounding text,
it is customary to quote the text with the quote marks of the language of the surrounding text,
not the language of the quotation itself.
For example, French inside English:
The device of the order of the garter is “Honi soit qui mal y pense.”
English inside French:
Il disait: « Il faut mettre l’action en ‹ fast forward ›. »
A style sheet like the following will set the 'quotes' property
so that ''open-quote'' and ''close-quote'' will work correctly on all elements.
These rules are for documents that contain only English, French, or both.
One rule is needed for every additional language.
Note the use of the child combinator (">")
to set quotes on elements based on the language of the surrounding text:
<html lang="no">
<head>
<title>Quotes</title>
</head>
<body>
<p><q>Trøndere gråter når <q>Vinsjan på kaia</q> blir deklamert.</q></p>
</body>
</html>
would produce:
«Trøndere gråter når ’Vinsjan på kaia’ blir deklamert.»
Leaders
A leader, sometimes known as a tab leader or a dot leader,
is a repeating pattern used to visually connect content across horizontal spaces.
They are most commonly used in tables of contents,
between titles and page numbers.
The ''leader()'' function,
as a value for the content property,
is used to create leaders in CSS.
This function takes a string (the leader string),
which describes the repeating pattern for the leader.
The ''leader()'' function
leader( <> )
Inserts a leader.
See the section on leaders for more information.
Table of Contents
1. Loomings.....................1
2. The Carpet-Bag...............9
3. The Spouter-Inn.............13
Issue: Do leaders depend on the assumption that the content after the leader is right-aligned (end-aligned)?
Rendering leaders
Consider a line which contains the content before the leader (the “before content”),
the leader,
and the content after the leader (the “after content”).
Leaders obey the following rules:
1. The leader string must appear in full at least once.
2. The leader should be as long as possible
3. Visible characters in leaders should vertically align with each other when possible.
4. Line break characters in the leader string must be ignored.
5. White space in the leader string follows normal CSS rules.
6. A leader only appears between the start content and the end content.
7. A leader only appears on a single line, even if the before content and after content are on different lines.
8. A leader can’t be the only thing on a line.
Procedure for rendering leaders
1. Lay out the before content,
until reaching the line where the before content ends.
BBBBBBBBBB
BBB
2. The leader string consists of one or more glyphs,
and is thus an inline box.
A leader is a row of these boxes,
drawn from the end edge to the start edge,
where only those boxes not overlaid by the before or after content.
On this line,
draw the leader string,
starting from the end edge,
repeating as many times as possible until reaching the start edge.
BBBBBBBBBB
..........
3. Draw the before and after content on top of the leader.
If any part of the before content or after content
overlaps a glyph in a leader string box,
that glyph is not displayed.
BBBBBBBBBB
BBB....AAA
4. If one full copy of the leader string is not visible:
BBBBBBB
BBBBBBA
Insert a line break after the before content,
draw the leader on the next line,
and draw the after content on top,
and hide any leader strings that are not fully displayed.
BBBBBBB
BBBBBB
......A
Issue: what to do if after content is wider than the line box?
Issue: Leaders don't quite work in table layouts. How can we fix this?
Procedure for drawing leadersProcedure for drawing leaders when the content doesn’t fit on a single line
Cross References
Many documents contain internal references:
* See chapter 7
* in section 4.1
* on page 23
Three new values for the content property
are used to automatically create these types of cross-references:
''target-counter()'', ''target-counters()'', and ''target-text()''.
Each of these displays information obtained from the target end of a link.
The ''target-counter()'' function retrieves the value
of the innermost counter with a given name.
The required arguments are the url of the target
and the name of the counter.
An optional counter-style argument can be used to format the result.
These functions only take a fragment URL
which points to a location in the current document.
If there’s no fragment,
if the ID referenced isn't there,
or if the URL points to an outside document,
the user agent must treat that as an error.
Issue: what should error handling be?
Issue: restrict syntactically to local references for now.
HTML:
…which will be discussed on page <a href="#chapter4_sec2"></a>.
This functions fetches the value of all counters of a given name
from the end of a link,
and formats them by inserting a given string between the value of each nested counter.
I have not found a compelling example for target-counters() yet.
Issue: found a compelling example, in CSS specs. Do something.
The ''target-text()'' function
The ''target-text()'' function retrieves
the text value of the element referred to by the URL.
An optional second argument specifies what content is retrieved,
using the same values as the 'string-set' property above.
target-text() = target-text( [ <> | <> ] , [ content | before | after | first-letter ]? )
…which will be discussed <a href="#chapter_h1_1">later</a>.
a::after { content: ", in the chapter entitled " target-text(attr(href url)) }
Result: …which will be discussed later, in the chapter entitled Loomings.
Named Strings
This section introduces named strings,
which are the textual equivalent of counters
and which have a distinct namespace from counters.
Named strings follow the same nesting rules as counters.
The 'string-set' property accepts values similar to the 'content' property,
including the extraction of the current value of counters.
Named strings are a convenient way to pull metadata out of the document
for insertion into headers and footers.
In HTML, for example,
META elements contained in the document HEAD
can set the value of named strings.
In conjunction with attribute selectors,
this can be a powerful mechanism:
Name: string-set
Value: none | [ <> <>+ ]#
Initial: none
Applies to: all elements, but not pseudo-elements
Inherited: no
Percentages: N/A
Computed value: the keyword ''string-set/none'' or a list, each item an identifier paired with a list of string values
Animation type: discrete
User agents are expected to support this property on all media, including non-visual ones.
The 'string-set' property copies the text content of an element into a ''named string'',
which functions as a variable.
The text content of this named string can be retrieved using the ''string()'' function.
Since these variables may change on a given page,
an optional second value for the ''string()'' function
allows authors to choose which value on a page is used.
none
The element does not set any named strings.
[ <> <>+ ]#
The element establishes one or more named strings,
corresponding to each comma-separated entry in the list.
For each entry, the <> gives the name of the named string.
It's followed by one or more <> values,
which are concatenated together to form the value of the named string.
If an element has style containment,
the 'string-set' property must have no effects on descendants of that element.
The following example captures the contents of H1 elements,
which represent chapter names in this hypothetical document.
H1 { string-set: chapter contents; }
When an H1 element is encountered,
the ''chapter'' string is set to the element's textual contents,
and the previous value of ''chapter'', if any, is overwritten.
Inserting Named Strings: the ''string()'' function
string() = string( <> , [ first | start | last | first-except ]? )
The ''string()'' function is used to copy the value of a named string to the document,
via the 'content' property.
This function requires one argument,
the name of the named string.
Since the value of a named string may change several times on a page
(as multiple elements defining the string can appear)
an optional second argument indicates which value of the named string should be used.
The second argument of the ''string()'' function is one of the following keywords:
first
The value of the first assignment on the page is used.
If there is no assignment on the page,
the entry value is used.
If no second argument is provided,
this is the default value.
start
If the element is the first element on the page,
the value of the first assignment is used.
Otherwise the entry value is used.
The entry value may be empty if the named string hasn’t yet appeared.
This is identical to ''string()/first'',
except that the empty string is used on the page where the value is assigned.
Issue: we may need to kill the entire content string. Is this necessary?
The content values of named strings
are assigned at the point when the content box of the element is first created
(or would have been created if the element’s display value is none).
The entry value for a page
is the assignment in effect at the end of the previous page.
The exit value for a page
is the assignment in effect at the end of the current page.
The following figures show the first, start, and last assignments
of the “heading” string on various pages.
The ''string-set/start'' value is empty,
as the string had not yet been set at the start of the page.Since the page starts with an h2,
the ''string-set/start'' value is the value of that head.Since there’s not an h2 at the top of this page,
the ''string-set/start'' value is the exit value of the previous page.
The ''content()'' function
content() = content( [ text | before | after | first-letter | marker ]? )
text
The string value of the element.
If no value is specified in ''content()'',
it acts as if ''content()/text'' were specified.
before
The string value of the ''::before'' pseudo-element.
after
The string value of the ''::after'' pseudo-element.
first-letter
The first letter of the element, as defined for the ''::first-letter'' pseudo-element
marker
The string value of the ''::marker'' pseudo-element.
The value of the named string “header” will be “Chapter 1: Loomings”.
HTML:
<section title="Loomings">
CSS:
section { string-set: header attr(title) }
The value of the “header” string will be “Loomings”.
Automatic Counters and Numbering
See [[css-lists-3#auto-numbering]].
Issue: Should this move back to CSS Content?
Bookmarks
Some document formats,
most notably PDF,
allow the use of bookmarks as an aid to navigation.
Bookmarks provide a list of links to document elements,
as well as text to label the links and a level value.
A bookmark has three properties:
'bookmark-level', 'bookmark-label', and 'bookmark-state'.
When a user activates a bookmark,
the user agent must bring that reference point to the user's attention,
exactly as if navigating to that element by fragment URL.
This will also trigger matching the '':target'' pseudo-class.
If an element has style containment, the
'bookmark-level', 'bookmark-label', and 'bookmark-state' properties
must have no effect on descendants of the element.
Setting a Bookmark: the 'bookmark-level' property
The 'bookmark-level' property determines if a bookmark is created,
and at what level.
If this property is absent,
or has value ''bookmark-level/none'',
no bookmark should be generated,
regardless of the values of 'bookmark-label' or 'bookmark-state'.
Name: bookmark-level
Value: none | <>
Initial: none
Applies to: all elements
Inherited: no
Percentages: N/A
Computed value: the keyword ''bookmark-level/none'' or the specified integer
Animation type: by computed value type
<>
defines the level of the bookmark, with the top level being 1 (negative and zero values are invalid).
Note: Bookmarks do not need to create a strict hierarchy of levels.
Issue: Should a bookmark be created for elements with display: none?
Labelling a Bookmark: the 'bookmark-label' property
Name: bookmark-label
Value: <>
Initial: content(text)
Applies to: all elements
Inherited: no
Percentages: N/A
Computed value: specified value
Animation type: discrete
<>
<> is defined above, in the section on the 'string-set' property. The value of <> becomes the text content of the bookmark label.
Initial Bookmark Toggle State: the 'bookmark-state' property
The 'bookmark-state' may be open or closed. The user must be able to toggle the bookmark state.
Name: bookmark-state
Value: open | closed
Initial: open
Applies to: block-level elements
Inherited: no
Percentages: N/A
Computed value: specified keyword
Animation type: discrete
open
Subsequent bookmarks with 'bookmark-level' greater than the given bookmark are displayed,
until reaching another bookmark of the same level or lower.
If one of subsequent bookmark is closed,
apply the same test to determine if its subsequent bookmarks should be displayed.
closed
Subsequent bookmarks of bookmark-level greater than the given bookmark are not displayed,
until reaching another bookmark of the same level or lower.
Issue: Is the initial bookmark state,
or the bookmark state updated by the UA as appropriate?