rfc-2119: Difference between revisions
m (noted RFC2119 class name used by W3C) |
AndyMabbett (talk | contribs) No edit summary |
||
| Line 4: | Line 4: | ||
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in such documents are to be interpreted as described in RFC 2119. | The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in such documents are to be interpreted as described in RFC 2119. | ||
The following templates are avaialable: | |||
*<nowiki>{{must}}</nowiki> = {{must}} | |||
*<nowiki>{{must not}}</nowiki> = {{must not}} | |||
*<nowiki>{{required}}</nowiki> = {{required}} | |||
*<nowiki>{{shall}}</nowiki> = {{shall}} | |||
*<nowiki>{{shall not}}</nowiki> = {{shall not}} | |||
*<nowiki>{{should}}</nowiki> = {{should}} | |||
*<nowiki>{{should not}}</nowiki> = {{should not}} | |||
*<nowiki>{{recommended}}</nowiki> = {{recommended}} | |||
*<nowiki>{{may}}</nowiki> = {{may}} | |||
*<nowiki>{{optional}}</nowiki> = {{optional}} | |||
== markup suggestions == | == markup suggestions == | ||
Revision as of 17:15, 26 August 2007
RFC 2119
RFC 2119 is often used for expressing requirements in documents by IETF, W3C, microformats.org, and others.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in such documents are to be interpreted as described in RFC 2119.
The following templates are avaialable:
- {{must}} = MUST
- {{must not}} = MUST NOT
- {{required}} = REQUIRED
- {{shall}} = SHALL
- {{shall not}} = Template:shall not
- {{should}} = SHOULD
- {{should not}} = SHOULD NOT
- {{recommended}} = RECOMMENDED
- {{may}} = MAY
- {{optional}} = OPTIONAL
markup suggestions
When using RFC 2119 terms, consider re-using the mark-up pattern from the W3C Manual of Style (in particular class="RFC2119" - note capitalization), and perhaps their suggested style rule as well.
In addition, see Edward O’Connor POSH suggestion for marking up the commonly used initial paragraph declaring RFC 2119 terms in documents.
microformat thoughts
Some have suggested considering a new microformat for marking up use of RFC 2119 terms.
It appears there is no need for such a new microformat however. Following W3C's established practice, and Edward O'Connor's POSH suggestion for the initial paragraph, appears to be sufficient.