rfc-2119 - Revision history

Tantek: fix deadname

2018-06-21T00:53:15Z

fix deadname

← Older revision		Revision as of 00:53, 21 June 2018
Line 36:		Line 36:
	On this wiki, the above templates help facilitate the use of the markup pattern from the W3C Manual of Style.		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://~~edward~~.oconnor.cx/2007/08/marking-up-rfc2119-text proposed] by ~~[[User:EdwardOConnor\|Edward~~ O'Connor]]:		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:

	<p>		<p>
Line 51:		Line 51:
	Some have suggested considering a new microformat for marking up use of <nowiki>RFC 2119</nowiki> terms.		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 ~~Edward~~ O'Connor's POSH suggestion for the initial paragraph, appears to be sufficient.		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.

Tantek: prevent autolink to html version

2008-01-07T20:32:32Z

prevent autolink to html version

← Older revision		Revision as of 20:32, 7 January 2008
Line 1:		Line 1:
	<h1><nowiki>RFC 2119</nowiki></h1>		<h1><nowiki>RFC 2119</nowiki></h1>

	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 ~~RFC 2119~~] and {{may}} include a link to this page, or directly to http://www.ietf.org/rfc/rfc2119.txt.		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.

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

	== Markup suggestions ==		== Markup suggestions ==
	When using RFC 2119 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.		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.		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, [http://edward.oconnor.cx/2007/08/marking-up-rfc2119-text proposed] by [[User:EdwardOConnor\|Edward O'Connor]]:		In addition, for marking up the commonly used initial paragraph declaring <nowiki>RFC 2119</nowiki> terms in documents, consider using the following markup, [http://edward.oconnor.cx/2007/08/marking-up-rfc2119-text proposed] by [[User:EdwardOConnor\|Edward O'Connor]]:

	<p>		<p>
Line 45:		Line 45:
	in this document are to be interpreted as described in <a		in this document are to be interpreted as described in <a
	href="http://www.ietf.org/rfc/rfc2119.txt"		href="http://www.ietf.org/rfc/rfc2119.txt"
	rel="help glossary">RFC 2119</a>.		rel="help glossary"><nowiki>RFC 2119</nowiki></a>.
	</p>		</p>

	== microformat thoughts ==		== microformat thoughts ==
	Some have suggested considering a new microformat for marking up use of RFC 2119 terms.		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 Edward O'Connor's POSH suggestion for the initial paragraph, appears to be sufficient.		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.

EdwardOConnor: /* Markup suggestions */ linked 'proposed'

2007-08-28T23:25:50Z

Markup suggestions: linked 'proposed'

← Older revision		Revision as of 23:25, 28 August 2007
Line 36:		Line 36:
	On this wiki, the above templates help facilitate the use of the markup pattern from the W3C Manual of Style.		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 [[User:EdwardOConnor\|Edward O'Connor]]:		In addition, for marking up the commonly used initial paragraph declaring RFC 2119 terms in documents, consider using the following markup, [http://edward.oconnor.cx/2007/08/marking-up-rfc2119-text proposed] by [[User:EdwardOConnor\|Edward O'Connor]]:

	<p>		<p>

EdwardOConnor: /* Markup suggestions */ Incorporated boilerplate markup proposal

2007-08-28T23:24:20Z

Markup suggestions: Incorporated boilerplate markup proposal

← Older revision		Revision as of 23:24, 28 August 2007
Line 36:		Line 36:
	On this wiki, the above templates help facilitate the use of the markup pattern from the W3C Manual of Style.		On this wiki, the above templates help facilitate the use of the markup pattern from the W3C Manual of Style.

	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~~.		In addition, for marking up the commonly used initial paragraph declaring RFC 2119 terms in documents, consider using the following markup, proposed by [[User:EdwardOConnor\|Edward O'Connor]]:

			<p>
			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">RFC 2119</a>.
			</p>

	== microformat thoughts ==		== microformat thoughts ==

Tantek: fixed links that mention RFC 2119 in context to not autolink

2007-08-27T01:49:42Z

fixed links that mention RFC 2119 in context to not autolink

← Older revision		Revision as of 01:49, 27 August 2007
Line 29:		Line 29:
	*<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 RFC 2119].		These adhere to the [http://www.w3.org/2001/06/manual/#RFC W3C Manual of Style guidelines for RFC 2119].


	== Markup suggestions ==		== Markup suggestions ==
Line 37:		Line 36:
	On this wiki, the above templates help facilitate the use of the markup pattern from the W3C Manual of Style.		On this wiki, the above templates help facilitate the use of the markup pattern from the W3C Manual of Style.

	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.		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 ==		== microformat thoughts ==

Tantek: restored synthetic h1 heading to eliminate unnecessary TOC level, simplified headings

2007-08-27T01:32:15Z

restored synthetic h1 heading to eliminate unnecessary TOC level, simplified headings

← Older revision		Revision as of 01:32, 27 August 2007
Line 1:		Line 1:
	=RFC 2119=		<h1><nowiki>RFC 2119</nowiki></h1>

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

Line 10:		Line 12:
	# '''{{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.)		# '''{{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==~~		== Templates ==

	Often, microformat specifications (and their drafts) will 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 RFC 2119] and {{may}} include a link to this page, or directly to http://www.ietf.org/rfc/rfc2119.txt.

	=== Templates ===

	The following templates are available for use on this wiki:		The following templates are available for use on this wiki:

	*<nowiki>{{~~rfc2119~~-intro}}</nowiki> - see [[template:~~rfc2119~~-intro]]		*<nowiki>{{rfc-2119-intro}}</nowiki> - see [[template:rfc-2119-intro]]

	*<nowiki>{{must}}</nowiki> = {{must}}		*<nowiki>{{must}}</nowiki> = {{must}}
Line 34:		Line 31:
	These adhere to the [http://www.w3.org/2001/06/manual/#RFC W3C Manual of Style guidelines for RFC 2119].		These adhere to the [http://www.w3.org/2001/06/manual/#RFC W3C Manual of Style guidelines for RFC 2119].

	~~==On other web pages==~~

	=== Markup suggestions ===		== Markup suggestions ==
			When using RFC 2119 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.

	~~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~~.		On this wiki, the above templates help facilitate the use of the markup pattern from the W3C Manual of Style.

	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.		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 thoughts ==

	Some have suggested considering a new microformat for marking up use of RFC 2119 terms.		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.		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.

AndyMabbett: /* On this wiki */ expose URL

2007-08-27T00:40:56Z

On this wiki: expose URL

← Older revision		Revision as of 00:40, 27 August 2007
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}}", "{{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]~~.		Often, microformat specifications (and their drafts) will 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 RFC 2119] and {{may}} include a link to this page, or directly to http://www.ietf.org/rfc/rfc2119.txt.

	=== Templates ===		=== Templates ===

AndyMabbett: tempalte

2007-08-27T00:23:32Z

tempalte

← Older revision		Revision as of 00:23, 27 August 2007
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}}", "{{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].		Often, microformat specifications (and their drafts) will 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 RFC 2119] and {{may}} include a link to this page, or directly to [http://www.ietf.org/rfc/rfc2119.txt the RFC].

	=== Templates ===		=== Templates ===

AndyMabbett: /* On this wiki */ not-recommended

2007-08-27T00:20:03Z

On this wiki: not-recommended

← Older revision		Revision as of 00:20, 27 August 2007
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 RFC 2119] and '''MAY''' include a link to this page, or directly to [http://www.ietf.org/rfc/rfc2119.txt the RFC].		Often, microformat specifications (and their drafts) will 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 RFC 2119] and '''MAY''' include a link to this page, or directly to [http://www.ietf.org/rfc/rfc2119.txt the RFC].

	=== Templates ===		=== Templates ===

AndyMabbett: /* Templates */

2007-08-27T00:19:15Z

Templates

← Older revision		Revision as of 00:19, 27 August 2007
Line 28:		Line 28:
	*<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}}