rfc-2119

(Difference between revisions)

Jump to: navigation, search
(templates sub section)
m (merge with existing page)
Line 1: Line 1:
-
<h1><nowiki>RFC 2119</nowiki></h1>
+
#REDIRECT[[rfc2119]]
-
 
+
-
[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.
+
-
 
+
-
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 [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-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}}
+
-
 
+
-
These adhere to the above W3C style guidelines.
+

Revision as of 19:05, 26 August 2007

  1. REDIRECTrfc2119
rfc-2119 was last modified: Wednesday, December 31st, 1969

Views