View source for Template:Cite IETF/doc

{{Documentation subpage}}
<!-- Please, add categories where indicated at the bottom of this page. -->
{{CS1 wrapper |type=source |base=citation }}
{{Lua|Module:Citation mode|Module:Template wrapper}}
This is a template to cite [[Internet Engineering Task Force|IETF]] documents<ref>{{Cite IETF |title=The Tao of IETF: A novice's guide to the Internet Engineering Task Force |rfc=4677 |fyi=17 |last1=Hoffman |first1=Paul |authorlink1=Paul Hoffman (engineer) |last2=Harris |first2=Susan |date=September 2006 |publisher=[[Internet Engineering Task Force|IETF]] |access-date=November 2, 2009 |doi=10.17487/RFC4677 }}</ref><ref>{{Cite IETF |title=A primer on Internet and TCP/IP tools |rfc=1739 |sectionname=Internet documentation |section=4 |last1=Kessler |first1=Gary C. |last2=Shepard |first2=Steven D. |date=December 1994 |publisher=[[Internet Engineering Task Force|IETF]] |access-date=November 2, 2009 |doi=10.17487/RFC1739 |ref=ietf }}</ref> including:
* [[Request for Comments]] (RFC)<ref>{{Cite IETF |rfc=1739 |title=A primer on Internet and TCP/IP tools |sectionname=Request for comments (RFCs) |section=4.1 |pages=36–38 |idanchor=ietf }}</ref>
* [[For Your Information]] (FYI)<ref>{{Cite IETF |title=F.Y.I. on F.Y.I.: Introduction to the F.Y.I. notes |rfc=1150 |fyi=1 |last1=Malkin |first1=Gary Scott |last2=Reynolds |first2=Joyce K. |authorlink2=Joyce K. Reynolds |date=March 1990 |publisher=[[Internet Engineering Task Force|IETF]] |access-date=November 2, 2009 |doi=10.17487/RFC1150 }}</ref><ref>{{Cite IETF |rfc=1739 |title=A primer on Internet and TCP/IP tools |sectionname=For your information documents |section=4.3 |page=39 |idanchor=ietf }}</ref>
* [[Internet Draft]] (I-D)
* [[Internet Standard]] (STD)<ref>{{Cite IETF |title=The Internet standards process -- Revision 3 |rfc=2026 |bcp=9 |last=Bradner |first=Scott O. |authorlink=Scott Bradner |date=October 1996 |publisher=[[Internet Engineering Task Force|IETF]] |access-date=November 2, 2009 |doi=10.17487/RFC2026 }}</ref><ref>{{Cite IETF |rfc=1739 |title=A primer on Internet and TCP/IP tools |sectionname=Internet standards |section=4.2 |pages=38–39 |idanchor=ietf }}</ref>
* [[Best current practice]] (BCP)<ref>{{Cite IETF |title=Best current practices |rfc=1818 |bcp=1 | last1=Postel |first1=Jon |authorlink1=Jon Postel |last2=Rekhter |first2=Yakov |authorlink2=Yakov Rekhter |last3=Li |first3=Tony |date=August 1995 |publisher=[[Internet Engineering Task Force|IETF]] |access-date=November 2, 2009 |doi=10.17487/RFC1818 }}</ref>
* [[Internet Experiment Note]] (IEN)
* [[Réseaux Associés pour la Recherche Européenne|RARE]] Technical Reports (RTR)<ref>{{Cite IETF |rfc=1739 |title=A primer on Internet and TCP/IP tools |sectionname=RARE technical reports |section=4.4 |page=40 |idanchor=ietf }}</ref>

{{TOC limit|3}}

== Usage ==

This template supports most of the parameters available to {{Tlx|Citation}}.  For information about those parameters see that template's documentation.

'''''Note''''': All parameter names {{strong|must}} be in [[lowercase]].

=== Cite IETF specific parameters ===
* {{Para|appendix}} – Appendix number of the document. {{Para|appendix|A.1}} produces "sec. A.1" Also used to create an anchor link for the document's URL.
* {{Para|autolink}} – {{Para|autolink|<var>yes</var>}} or {{Para|autolink|<var>no</var>}} Automatically generate a link to ietf.org for documents specified with {{Para|rfc}}, {{Para|std}}, {{Para|bcp}}, {{Para|fyi}}, {{Para|draft}}, {{Para|ien}}, or {{Para|rtr}}. (enabled by default)
* {{Para|bcp}} – Number of the [[Best Current Practice]] (BCP) document. Also used to automatically generate a link to ietf.org.
* {{Para|draft}} – Name of the [[Internet Draft]] (I-D) document, including the leading draft-. Also used to automatically generate a link to ietf.org.
* {{Para|fyi}} – Number of the [[For Your Information]] (FYI) document. Also used to automatically generate a link to ietf.org.
* {{Para|idanchor}} – Anchor link target. By default, no anchor link is generated. The special value {{Para|idanchor|ietf}} generates an anchor link suitable for use with this template's {{Para|ref}} parameter. Requires one of {{Para|id}}, {{Para|rfc}}, {{Para|std}}, {{Para|bcp}}, {{Para|fyi}}, {{Para|draft}}, {{Para|ien}} or {{Para|rtr}} fields to be present for the anchor link text.
* {{Para|idlink}} – Internal document anchor or title of a Wikipedia article to link via the document identifier. Article should already exist. Must not be wikilinked itself. Do not use this on its own, but along with {{Para|id}}, {{Para|rfc}}, {{Para|std}}, {{Para|bcp}}, {{Para|fyi}}, {{Para|draft}}, {{Para|ien}} or {{Para|rtr}}.
* {{Para|idlinktype}} – One of the values: {{Para|id}}, {{Para|rfc}}, {{Para|std}}, {{Para|bcp}}, {{Para|fyi}}, {{Para|draft}}, {{Para|ien}} or {{Para|rtr}} can be given to {{Para|idlinktype}} to force the template to use the specified document identifier as the link text for {{Para|idanchor}} or {{Para|idlink}}. Do not use this on its own, but along with {{Para|idanchor}} or {{Para|idlink}} and {{Para|id}}, {{Para|rfc}}, {{Para|std}}, {{Para|bcp}}, {{Para|fyi}}, {{Para|draft}}, {{Para|ien}} or {{Para|rtr}}.
* {{Para|ien}} – Number of the [[Internet Experiment Note]] (IEN) document. Also used to automatically generate a link to ietf.org.
* {{Para|nosec}} – Using {{Para|section}}, {{Para|sections}}, or {{Para|appendix}} automatically places the sec. notation. Se {{Para|nosec|y}} to hide the sec. notation.
* {{Para|referenceid}} – Reference id for the document. Used to create an anchor link for the document's URL.
* {{Para|rfc}} – Number of the [[Request for Comments]] (RFC) document. Also used to automatically generate a link to ietf.org.
* {{Para|rtr}} – Number of the [[Réseaux Associés pour la Recherche Européenne|RARE]] Technical Reports (RTR) document. Also used to automatically generate a link to ietf.org.
* {{Para|section}} – Section number of the document. {{para|section|4.3.1}} produces "sec. 4.3.1" Also used to create an anchor link for the document's URL. Can also be used in combination with {{Para|sections}} to link to the first section in the given section range.
* {{Para|sections}} – Section range of the document. {{Para|sections|4.3-4.7}} produces "sec. 4.3–4.7"
* {{Para|sectionname}} – The section name or section title of the document, written in full; displays before {{Para|title}} and enclosed in quotes.
* {{Para|std}} – Number of the [[Internet Standard]] (STD) document. Also used to automatically generate a link to ietf.org.
* {{Para|style}} – Override the style of link used for RFC and Internet Draft. Effective values are "html" (default for RFC), "text" (default for Internet Draft).

As with all cs1|2 templates, {{Para|title}} is required.  If omitted, the template will attempt to auto-generate a title using the first of {{Para|rfc}}, {{Para|std}}, {{Para|bcp}}, {{Para|fyi}}, {{Para|draft}}, {{Para|ien}}, {{Para|rtr}} or {{Para|id}} document identifier parameters, in that order.

Copy a blank version to use. Remember to use the "|" (pipe) character between each parameter. Please delete any unused parameters to avoid clutter in the edit window.

{| class="wikitable"
|-
! colspan="3" | Full version (copy and paste text below and delete parameters you don't need)
|- width="50%" style="vertical-align:top;"
| colspan="3" |
:<syntaxhighlight lang="wikitext">{{Cite IETF |title= |rfc= |std= |bcp= |fyi= |draft= |ien= |rtr= |sectionname= |section= |sections= |appendix= |referenceid= |page= |pages= |last1= |first1= |authorlink1= |last2= |first2= |authorlink2= |authormask= |editor1-last= |editor1-first= |editor1-link= |others= |date= |year= |orig-date= |publisher=[[Internet Engineering Task Force|IETF]] |location= |language= |format= |access-date= |url= |section-url= |page-url= |autolink= |id= |idanchor= |idlink= |idlinktype= |doi= |doi-broken-date= |issn= |archive-url= |archive-date= |quote= |nopp= |nosec= |ref= |postscript= |last-author-amp= |style=}}</syntaxhighlight>
|- width="50%" style="vertical-align:top;"
! colspan="3" | Most commonly used parameters (use this and you won't have to delete as much)
|- width="50%" style="vertical-align:top;"
| colspan="3" |
:<syntaxhighlight lang="wikitext">{{Cite IETF |title= |rfc= |sectionname= |section= |page= |last= |first= |author-link= |date= |publisher=[[Internet Engineering Task Force|IETF]] |access-date= |doi=}}</syntaxhighlight>
|- width="50%" style="vertical-align:top;"
! Example 1
| style="vertical-align: top;" |
<syntaxhighlight lang="wikitext">{{Cite IETF |title=The Tao of IETF: A novice's guide to the Internet Engineering Task Force |rfc=4677 |fyi=17 |last1=Hoffman |first1=P. |authorlink1=Paul Hoffman (engineer) |last2=Harris |first2=S. |date=September 2006 |publisher=[[Internet Engineering Task Force|IETF]] |access-date=October 20, 2009 |doi=10.17487/RFC4677}}</syntaxhighlight>
| style="vertical-align: top;" |
{{Cite IETF |title=The Tao of IETF: A novice's guide to the Internet Engineering Task Force |rfc=4677 |fyi=17 |last1=Hoffman |first1=P. |author-link1=Paul Hoffman (engineer) |last2=Harris |first2=S. |date=September 2006 |publisher=[[Internet Engineering Task Force|IETF]] |access-date=October 20, 2009 |doi=10.17487/RFC4677}}
|- width="50%" style="vertical-align:top;"
! Example 2
| style="vertical-align: top;" |<syntaxhighlight lang="wikitext">{{Cite IETF |title=Telnet protocol specification |rfc=854 |std=8 |sectionname=Are you there (AYT) |page=8 |last1=Postel |first1=J. |author-link1=Jon Postel |last2=Reynolds |first2=J. |author-link2=Joyce K. Reynolds |date=May 1983 |publisher=[[Internet Engineering Task Force|IETF]] |access-date=October 20, 2009 |doi=10.17487/RFC0854 }}</syntaxhighlight>
| style="vertical-align: top;" |
{{Cite IETF |title=Telnet protocol specification |rfc=854 |std=8 |sectionname=Are you there (AYT) |page=8 |last1=Postel |first1=J. |author-link1=Jon Postel |last2=Reynolds |first2=J. |author-link2=Joyce K. Reynolds |date=May 1983 |publisher=[[Internet Engineering Task Force|IETF]] |access-date=October 20, 2009 |doi=10.17487/RFC0854 }}
|}

== Examples ==

* <syntaxhighlight lang="wikitext" inline>{{Cite IETF |title=JSON |rfc=7159 |sectionname=IANA considerations |section=11 |author=T. Bray |authorlink=Tim Bray |date=March 2014 |publisher=[[Internet Engineering Task Force|IETF]] |access-date=November 26, 2017 |doi=10.17487/RFC7159 }}</syntaxhighlight>
*:→ <span style="background:white">{{Cite IETF |title=JSON |rfc=7159 |sectionname=IANA considerations |section=11 |author=T. Bray |authorlink=Tim Bray |date=March 2014 |publisher=[[Internet Engineering Task Force|IETF]] |access-date=November 26, 2017 |doi=10.17487/RFC7159 }}</span>
* <syntaxhighlight lang="wikitext" inline>{{Cite IETF |title=Hypertext transfer protocol -- HTTP/1.1 |rfc=2616 |first1=R. |last1=Fielding |authorlink1=Roy Fielding |first2=J. |last2=Gettys |authorlink2=Jim Gettys |first3=J. |last3=Mogul |first4=H. |last4=Frystyk |authorlink4=Henrik Frystyk Nielsen |first5=L. |last5=Masinter |first6=P. |last6=Leach |first7=T. |last7=Berners-Lee |authorlink7=Tim Berners-Lee |date=June 1999 |publisher=[[Internet Engineering Task Force|IETF]] |doi=10.17487/RFC2616 }}</syntaxhighlight>
*:→ <span style="background:white">{{Cite IETF |title=Hypertext transfer protocol -- HTTP/1.1 |rfc=2616 |first1=R. |last1=Fielding |authorlink1=Roy Fielding |first2=J. |last2=Gettys |authorlink2=Jim Gettys |first3=J. |last3=Mogul |first4=H. |last4=Frystyk |authorlink4=Henrik Frystyk Nielsen |first5=L. |last5=Masinter |first6=P. |last6=Leach |first7=T. |last7=Berners-Lee |authorlink7=Tim Berners-Lee |date=June 1999 |publisher=[[Internet Engineering Task Force|IETF]] |doi=10.17487/RFC2616 }}</span>
* <syntaxhighlight lang="wikitext" inline>{{Cite IETF |title=Domain names - concepts and facilities |rfc=1034 |sectionname=Name space specifications and terminology |section=3.1 |author=P. Mockapetris |authorlink=Paul Mockapetris |date=November 1987 |publisher=[[Internet Engineering Task Force|IETF]] |access-date=August 3, 2008|doi=10.17487/RFC1034 |quote=A domain is a subdomain of another domain if it is contained within that domain. This relationship can be tested by seeing if the subdomain's name ends with the containing domain's name. For example, A.B.C.D is a subdomain of B.C.D, C.D, D, and ' '. }}</syntaxhighlight>
*:→ <span style="background:white">{{Cite IETF |title=Domain names - concepts and facilities |rfc=1034 |sectionname=Name space specifications and terminology |section=3.1 |author=P. Mockapetris |authorlink=Paul Mockapetris |date=November 1987 |publisher=[[Internet Engineering Task Force|IETF]] |access-date=August 3, 2008
|doi=10.17487/RFC1034 |quote=A domain is a subdomain of another domain if it is contained within that domain. This relationship can be tested by seeing if the subdomain's name ends with the containing domain's name. For example, A.B.C.D is a subdomain of B.C.D, C.D, D, and ' '. }}</span>

== Technical notes ==

=== Regression testing ===

[[Regression testing|Regression tests]] are available here:

* {{Tl|Cite IETF/regression tests}}

=== Subtemplates ===

{{Tl|Cite IETF}} uses the following subtemplates:

* {{Tl|Cite IETF/doctypes}}
* {{Tl|Cite IETF/makelink}}
* {{Tl|Cite IETF/refanchor}}

===URL generation===

[[Request for Comments]] (RFC), [[For Your Information]] (FYI), and [[Internet Draft]] (I-D) documents are stored by <code><nowiki>https://datatracker.ietf.org/doc/html/</nowiki></code> and are linked in the following way:

: <code><nowiki>https://datatracker.ietf.org/doc/html/rfc</nowiki><var><document number></var></code> (only if {{para|Style]}} is not "html" or "empty")
: <code><nowiki>https://datatracker.ietf.org/doc/fyi</nowiki><var><document number></var></code>
: <code><nowiki>https://datatracker.ietf.org/doc/html/draft-</nowiki><var><draft name></var></code> (only if {{para|Style}} is "text" or empty)

[[Request for Comments]] (RFC), [[Internet Standard]] (STD), [[Best Current Practice]] (BCP),  [[Internet Experiment Note]] (IEN), and [[Réseaux Associés pour la Recherche Européenne|RARE]] Technical Reports (RTR)  documents are stored by <code><nowiki>https://rfc-editor.org</nowiki></code> and are linked in the following way:

: <code><nowiki>https://www.rfc-editor.org/rfc/rfc</nowiki><var><document number></var></code> (only if {{para|Style}} is "html" or "empty")
: <code><nowiki>https://www.rfc-editor.org/info/std</nowiki><var><document number></var></code>
: <code><nowiki>https://www.rfc-editor.org/info/bcp</nowiki><var><document number></var></code>
: <code><nowiki>https://rfc-editor.org/in-notes/ien/ien</nowiki><var><document number>.txt</var></code>
: <code><nowiki>https://rfc-editor.org/in-notes/museum/RAREreports/rtr</nowiki><var><document number>.txt</var></code>

The HTML rendering of [[Internet Draft]] (I-D) pages can be requested via {{para|Style|html}} (technically any value that is not empty or "text"). This produces the following URL:

: <code><nowiki>https://www.ietf.org/archive/id/</nowiki><var><draft name>.html</var></code>

This URL provides a pretty HTML rendering for newer I-D documents, but returns 404 Not Found for the older files.

=== URL anchor generation ===

Anchors are generated for the URL using four parameters:

: {{Para|section|<var>number</var>}} generates <code>#section-<var><number></var></code>
: {{Para|appendix|<var>number</var>}} generates <code>#appendix-<var><number></var></code>
: {{Para|referenceid|<var>id</var>}} generates <code>#ref-<var><id></var></code>
: {{Para|page|<var>number</var>}} generates <code>#page-<var><number></var></code>

The template will give priority to the first of the parameters: {{Para|section}}, {{Para|appendix}}, {{Para|referenceid}}, or {{Para|page}} in this order and create an anchor using the first matching parameter.

== See also ==

* {{Tl|Ref RFC}} &ndash; pre-populated citations
* {{Tl|IETF RFC}} &ndash; direct links to RFCs

== References ==

{{Reflist|2}}

== Further reading ==

* {{Cite IETF |title=Internet official protocol standards |rfc=5000 |std=1 |date=May 2008 |publisher=[[Internet Engineering Task Force|IETF]] |access-date =November 2, 2009 |doi=10.17487/RFC5000 }}
* {{Cite IETF |title=Not all RFCs are standards |rfc=1796 |last1=Huitema |first1=Christian |authorlink1=Christian Huitema|last2=Postel |first2=Jon |authorlink2=Jon Postel |last3=Crocker |first3=Steve |authorlink3=Steve Crocker |date=April 1995 |publisher=[[Internet Engineering Task Force|IETF]] |access-date=November 2, 2009 |doi=10.17487/RFC1796 }}
* {{Cite web |url=http://www.livinginternet.com/i/ia_rfc_ref.htm |title=Related RFC's, BCP, FYI, IEN, RTR, STD |access-date=November 2, 2009 |last=Stewart |first=William |website=livinginternet.com }}

{{Citation Style 1}}
{{Wikipedia referencing}}
{{UF-COinS}}

<includeonly>{{Sandbox other|
| <!-- Categories below this line, please: -->
[[Category:Citation Style 1 specific-source templates]]
[[Category:Computer networking templates]]
[[Category:Specific-source templates]]
[[Category:Templates generating COinS]]
}}</includeonly>