ReSpec v2 — W3C Specification Writing Tool

This is the documentation for ReSpec.js, a tool that helps with specification editing primarily within a W3C context.

This is just a blurb.

This is another blurb.

RFC 2119 is not OPTIONAL

There are several RFC 2119 keywords: MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, SHOULD NOT, RECOMMENDED, MAY, and OPTIONAL. They are only recognised in uppercase, so that one may still write normally if one must. Importantly, the MUST NOT fail when happening over line breaks, but:

MUST
NOT
work over element boundaries.

Small Talk about Abbreviations

W3C is no different from other geek outfits, and is therefore full of abbreviations. We don't care about the silly debate going on about abbr and acronym, we just support whatever people use, so that the following all ought to work:

DAHUT and DAHUT
abbr and abbr
srsly and srsly

A Defining Moment

A definition is an element that marks out a term that is defined in the current block.

They can sometimes be definitions with a title so that they can be written in the flow of the sentence without disruption.

Sometimes you will see an AbbrDef, which is an abbreviation-based definition.

One thing that should definitely work is creating definitions over multiple lines in the source.

It is then possible to reuse them. The title trick works both ways so that definitions can be reused fluidly. It would be possible to automatically detect them but for the time being they require an a element.

This should have no problem mixing up with abbr as AbbrDef shows, and a definition with a title works over several lines, just like definitions over multiple lines.

A Good Reference

One can trivially make references to any specification, say for instance [[WIDGETS]], [[WICD]], and even in a normative way [[!REX]] or [[!SVGMOBILE12]]. It's all about I18N, [[ZHMARK]].