rfc-2119: Difference between revisions
Jump to navigation
Jump to search
AndyMabbett (talk | contribs) (restore content from merged *& updated page) |
AndyMabbett (talk | contribs) m (minor copy edit) |
||
| Line 1: | Line 1: | ||
= | =RFC 2119= | ||
==Definitions== | ==Definitions== | ||
RFC 2119 gives the following definitions: | |||
# '''MUST''' This word, or the terms "'''REQUIRED'''" or "'''SHALL'''", mean that the definition is an absolute requirement of the specification. | # '''MUST''' This word, or the terms "'''REQUIRED'''" or "'''SHALL'''", mean that the definition is an absolute requirement of the specification. | ||
| Line 12: | Line 12: | ||
==On this wiki== | ==On this wiki== | ||
Often, microformat specifications (and their drafts) will use the key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL". These are to be interpreted as described in [http://www.ietf.org/rfc/rfc2119.txt | Often, microformat specifications (and their drafts) will use the key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL". These are to be interpreted as described in [http://www.ietf.org/rfc/rfc2119.txt RFC 2119] and '''MAY''' include a link to this page, or directly to [http://www.ietf.org/rfc/rfc2119.txt the RFC]. | ||
=== Templates === | === Templates === | ||
| Line 31: | Line 31: | ||
*<nowiki>{{optional}}</nowiki> = {{optional}} | *<nowiki>{{optional}}</nowiki> = {{optional}} | ||
These adhere to the [http://www.w3.org/2001/06/manual/#RFC W3C Manual of Style guidelines for | These adhere to the [http://www.w3.org/2001/06/manual/#RFC W3C Manual of Style guidelines for RFC 2119]. | ||
==On other web pages== | ==On other web pages== | ||
| Line 39: | Line 39: | ||
When using RFC 2119 terms on your own web pages, 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. | When using RFC 2119 terms on your own web pages, 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 | 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 proposal === | === Microformat proposal === | ||
Revision as of 00:02, 27 August 2007
RFC 2119
Definitions
RFC 2119 gives the following definitions:
- MUST This word, or the terms "REQUIRED" or "SHALL", mean that the definition is an absolute requirement of the specification.
- MUST NOT This phrase, or the phrase "SHALL NOT", mean that the definition is an absolute prohibition of the specification.
- SHOULD This word, or the adjective "RECOMMENDED", mean that there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications must be understood and carefully weighed before choosing a different course.
- SHOULD NOT This phrase, or the phrase "NOT RECOMMENDED" mean that there may exist valid reasons in particular circumstances when the particular behavior is acceptable or even useful, but the full implications should be understood and the case carefully weighed before implementing any behavior described with this label.
- MAY This word, or the adjective "OPTIONAL", mean that an item is truly optional. One vendor may choose to include the item because a particular marketplace requires it or because the vendor feels that it enhances the product while another vendor may omit the same item. An implementation which does not include a particular option MUST be prepared to interoperate with another implementation which does include the option, though perhaps with reduced functionality. In the same vein an implementation which does include a particular option MUST be prepared to interoperate with another implementation which does not include the option (except, of course, for the feature the option provides.)
On this wiki
Often, microformat specifications (and their drafts) will use the key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL". These are to be interpreted as described in RFC 2119 and MAY include a link to this page, or directly to the RFC.
Templates
The following templates are available for use on this wiki:
- {{rfc2119-intro}} - see template:rfc2119-intro
- {{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 W3C Manual of Style guidelines for RFC 2119.
On other web pages
Markup suggestions
When using RFC 2119 terms on your own web pages, 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 proposal
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.