rfc-2119: Difference between revisions

From Microformats Wiki
Jump to navigation Jump to search
m (restored this page per better naming per naming-conventions (hyphenation))
m (fix deadname)
 
(13 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<h1><nowiki>RFC 2119</nowiki></h1>
<h1><nowiki>RFC 2119</nowiki></h1>


[http://www.ietf.org/rfc/rfc2119.txt RFC 2119] is often used for expressing requirements in documents by IETF, W3C, [http://microformats.org microformats.org], and others.
Microformat specifications (and their drafts) use the key words "{{must}}", "{{must-not}}", "{{required}}", "{{shall}}", "{{shall-not}}", "{{should}}", "{{should-not}}", "{{recommended}}", "{{not-recommended}}", "{{may}}", and "{{optional}}". These are to be interpreted as described in [http://www.ietf.org/rfc/rfc2119.txt RFC2119] and {{may}} include a link to this page, or directly to http://www.ietf.org/rfc/rfc2119.txt.  


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.
== Definitions ==
<nowiki>RFC 2119</nowiki> gives the following definitions:


== markup suggestions ==
# '''{{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.)


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.
== Templates ==
 
The following templates are available for use on this wiki:
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>{{rfc-2119-intro}}</nowiki> - see [[template:rfc-2119-intro]]


*<nowiki>{{must}}</nowiki> = {{must}}
*<nowiki>{{must}}</nowiki> = {{must}}
Line 29: Line 25:
*<nowiki>{{should-not}}</nowiki> = {{should-not}}
*<nowiki>{{should-not}}</nowiki> = {{should-not}}
*<nowiki>{{recommended}}</nowiki> = {{recommended}}
*<nowiki>{{recommended}}</nowiki> = {{recommended}}
*<nowiki>{{not-recommended}}</nowiki> = {{not-recommended}}
*<nowiki>{{may}}</nowiki> = {{may}}
*<nowiki>{{may}}</nowiki> = {{may}}
*<nowiki>{{optional}}</nowiki> = {{optional}}
*<nowiki>{{optional}}</nowiki> = {{optional}}


These adhere to the above W3C style guidelines.
These adhere to the [http://www.w3.org/2001/06/manual/#RFC W3C Manual of Style guidelines for RFC&#32;2119].
 
== Markup suggestions ==
When using <nowiki>RFC 2119</nowiki> terms on 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.
 
On this wiki, the above templates help facilitate the use of the markup pattern from the W3C Manual of Style.
 
In addition, for marking up the commonly used initial paragraph declaring <nowiki>RFC 2119</nowiki> terms in documents, consider using the following markup, [http://theresa.oconnor.cx/2007/08/marking-up-rfc2119-text proposed] by Theresa O'Connor:
 
    &lt;p&gt;
      The key words "<dfn>MUST</dfn>", "<dfn>MUST NOT</dfn>",
      "<dfn>REQUIRED</dfn>", "<dfn>SHALL</dfn>", "<dfn>SHALL NOT</dfn>",
      "<dfn>SHOULD</dfn>", "<dfn>SHOULD NOT</dfn>",
      "<dfn>RECOMMENDED</dfn>", "<dfn>MAY</dfn>", and "<dfn>OPTIONAL</dfn>"
      in this document are to be interpreted as described in <a
      href="http://www.ietf.org/rfc/rfc2119.txt"
      rel="help glossary"><nowiki>RFC 2119</nowiki></a>.
    &lt;/p&gt;
 
== microformat thoughts ==
Some have suggested considering a new microformat for marking up use of <nowiki>RFC 2119</nowiki> terms.
 
It appears there is no need for such a new microformat however. Following W3C's established practice, and Theresa O'Connor's POSH suggestion for the initial paragraph, appears to be sufficient.

Latest revision as of 00:53, 21 June 2018

RFC 2119

Microformat specifications (and their drafts) use the key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL". These are to be interpreted as described in RFC2119 and MAY include a link to this page, or directly to http://www.ietf.org/rfc/rfc2119.txt.

Definitions

RFC 2119 gives the following definitions:

  1. MUST This word, or the terms "REQUIRED" or "SHALL", mean that the definition is an absolute requirement of the specification.
  2. MUST NOT This phrase, or the phrase "SHALL NOT", mean that the definition is an absolute prohibition of the specification.
  3. 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.
  4. 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.
  5. 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.)

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
  • {{not-recommended}} = NOT RECOMMENDED
  • {{may}} = MAY
  • {{optional}} = OPTIONAL

These adhere to the W3C Manual of Style guidelines for RFC 2119.

Markup suggestions

When using RFC 2119 terms on 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.

On this wiki, the above templates help facilitate the use of the markup pattern from the W3C Manual of Style.

In addition, for marking up the commonly used initial paragraph declaring RFC 2119 terms in documents, consider using the following markup, proposed by Theresa O'Connor: 

   <p>
     The key words "MUST", "MUST NOT",
     "REQUIRED", "SHALL", "SHALL NOT",
     "SHOULD", "SHOULD NOT",
     "RECOMMENDED", "MAY", and "OPTIONAL"
     in this document are to be interpreted as described in <a
     href="http://www.ietf.org/rfc/rfc2119.txt"
     rel="help glossary">RFC 2119</a>.
   </p>

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 Theresa O'Connor's POSH suggestion for the initial paragraph, appears to be sufficient.

Retrieved from "http://microformats.org/wiki/index.php?title=rfc-2119&oldid=66846"