These are proposed typographic conventions for W3C Recommendations. These conventions are established through the use of markup in the document and specific class names. The class names and markup selectors are styled by including a reference to a supplementary CSS stylesheet. Note that the element-level markup is important for accessibility affordance; user stylesheets specifically for particular accessibility needs may also be designed.
These are general conventions for discrete aspects of a specification.
The defining instance of a term is marked up like this: term. Uses of that term are marked up like this.
Aspects of markup are styled like this:
Variables are marked up like this: var.
Other code fragments are marked up like this.
This convention is used to indicate that special attention should be paid to a section that may not be immediately intuitive. This is often used to indicate why a particular decision was made when other alternatives were examined during the course of designing the feature, and may be informative.
Note: This is a block note.
This is some prefatory material before the note. Note: This is an inline note.
This is some prefatory material before the example. Note: This is an inline note which spans several lines. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
This convention is used to mark security concerns or deprecated features.
Warning: This is a block warning.
This is some prefatory material before the warning. Warning: This is an inline warning.
This is some prefatory material before the example. Note:Warning: This is an inline warning which spans several lines. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Example: This is a block example.
Example: This is a block example, with some code:
function Init(event)
{
var el = event.target;
if ( null == el ) {
el = document.createElement("foo");
}
}
This is some prefatory material before the example. For example, this is an inline example.
This is some prefatory material before the example. For example, this is an inline example which spans several lines. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
// this is an IDL example interface BaseInterface : DerivedInterface { // ConstCode const unsigned long UNICORN = 0x00; const unsigned long PONY = 0x01; const unsigned long DAHUT = 0x02; readonly attribute boolean isInvisible; readonly attribute DOMString pink; readonly attribute unsigned long sparkly; boolean methodName(in DOMString string); void methodNameAlso(in DOMString stringArg, in boolean isBooleanArg, in interface::InterfaceName interfaceArg); };
These are typographic conventions for W3C Working Drafts, intended to call out specific features for commenters. These conventions and styles are intended to be temporary, abd will be removed before the specification goes to Recommendation status.
This convention is used to indicate a feature or section of the specification which is unresolved, either because an adequate solution has not been found, because a choice has not be made between multiple options, or because a reviewer has objected to some aspect of the section in question. All sections marked as issues must be resolved before the specification moves to Candidate Recommendation status.
Issue: This is a block issue.
This is some prefatory material before the issue. Issue: This is an inline issue, with a link.
This is some prefatory material before the example. Issue: This is an inline issue which spans several lines. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
This convention is used for Commit-Then-Review specification editing, where the editor updates the specification for reviewers to see the proposed prose in context and possibly veto it, as opposed to Review-Then-Commit editing where the editor must first get group consensus before including the prose in the specification. All sections marked as proposals must be resolved before the specification moves to Candidate Recommendation status.
This is a block proposal.
This is a block proposal, with some code:
function Init(event)
{
var el = event.target;
if ( null == el ) {
el = document.createElement("foo");
}
}
This is some prefatory material before the proposal. This is an inline proposal.
This is some prefatory material before the proposal. This is an inline proposal which spans several lines. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
This convention is used for features or sections that are proposed to be dropped or deprecated. A section may be marked at-risk before moving into Candidate Recommendation phase pending implementer feedback, and may be dropped if there are not sufficient interoperable implementations to exit CR without the specification having to return to Last Call. All sections marked as at-risk must be resolved before the specification moves to Candidate Recommendation status.
This is a block at-risk feature.
This is a block at-risk feature, with some code:
function Init(event)
{
var el = event.target;
if ( null == el ) {
el = document.createElement("foo");
}
}
This is some prefatory material before the at-risk feature. This is an inline at-risk feature.
This is some prefatory material before the at-risk feature. This is an inline at-risk feature which spans several lines. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.