rfc-2119: Difference between revisions
AndyMabbett (talk | contribs) m (-) |
AndyMabbett (talk | contribs) (templates sub section) |
||
| Line 5: | Line 5: | ||
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 | == markup suggestions == | ||
When using RFC 2119 terms, consider re-using the [http://www.w3.org/2001/06/manual/#RFC mark-up pattern from the W3C Manual of Style] (in particular <code>class="RFC2119"</code> - <strong>note capitalization</strong>), and perhaps their suggested style rule as well. | |||
In addition, see [http://edward.oconnor.cx/2007/08/marking-up-rfc2119-text 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. | |||
==templates== | |||
The following templates are available for use on this wiki: | |||
*<nowiki>{{must}}</nowiki> = {{must}} | *<nowiki>{{must}}</nowiki> = {{must}} | ||
| Line 18: | Line 32: | ||
*<nowiki>{{optional}}</nowiki> = {{optional}} | *<nowiki>{{optional}}</nowiki> = {{optional}} | ||
These adhere to the above W3C style guidelines. | |||
Revision as of 17:18, 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.
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.
templates
The following templates are available for use on this wiki:
- {{must}} = MUST
- {{must-not}} = MUST NOT
- {{required}} = REQUIRED
- {{shall}} = SHALL
- {{shall-not}} = SHALL NOT
- {{should}} = SHOULD
- {{should-not}} = SHOULD NOT
- {{recommended}} = RECOMMENDED
- {{may}} = MAY
- {{optional}} = OPTIONAL
These adhere to the above W3C style guidelines.