Template:Cite IETF

Template documentation[view] [edit] [history] [purge]

This template employs intricate features of template syntax.

You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages.
You can conduct experiments, and should test all major changes, in either , the general template sandbox, or your user space before changing anything here.

This template uses Lua:

Module:Template wrapper (sandbox)

This is a template to cite IETF documents^[1]^[2] including:

Usage

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

Note: All parameter names must be in lowercase.

Cite IETF specific parameters

|appendix= – Appendix number of the document. |appendix=A.1 produces "sec. A.1" Also used to create an anchor link for the document's URL.
|autolink= – |autolink=yes or |autolink=no Automatically generate a link to ietf.org for documents specified with |rfc=, |std=, |bcp=, |fyi=, |draft=, |ien=, or |rtr=. (enabled by default)
|bcp= – Number of the Best Current Practice (BCP) document. Also used to automatically generate a link to ietf.org.
|draft= – Name of the Internet Draft (I-D) document, including the leading draft-. Also used to automatically generate a link to ietf.org.
|fyi= – Number of the For Your Information (FYI) document. Also used to automatically generate a link to ietf.org.
|idanchor= – Anchor link target. By default, no anchor link is generated. The special value |idanchor=ietf generates an anchor link suitable for use with this template's |ref= parameter. Requires one of |id=, |rfc=, |std=, |bcp=, |fyi=, |draft=, |ien= or |rtr= fields to be present for the anchor link text.
|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 |id=, |rfc=, |std=, |bcp=, |fyi=, |draft=, |ien= or |rtr=.
|idlinktype= – One of the values: |id=, |rfc=, |std=, |bcp=, |fyi=, |draft=, |ien= or |rtr= can be given to |idlinktype= to force the template to use the specified document identifier as the link text for |idanchor= or |idlink=. Do not use this on its own, but along with |idanchor= or |idlink= and |id=, |rfc=, |std=, |bcp=, |fyi=, |draft=, |ien= or |rtr=.
|ien= – Number of the Internet Experiment Note (IEN) document. Also used to automatically generate a link to ietf.org.
|nosec= – Using |section=, |sections=, or |appendix= automatically places the sec. notation. Se |nosec=y to hide the sec. notation.
|referenceid= – Reference id for the document. Used to create an anchor link for the document's URL.
|rfc= – Number of the Request for Comments (RFC) document. Also used to automatically generate a link to ietf.org.
|rtr= – Number of the RARE Technical Reports (RTR) document. Also used to automatically generate a link to ietf.org.
|section= – Section number of the document. |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 |sections= to link to the first section in the given section range.
|sections= – Section range of the document. |sections=4.3-4.7 produces "sec. 4.3-4.7"
|sectionname= – The section name or section title of the document, written in full; displays before |title= and enclosed in quotes.
|std= – Number of the Internet Standard (STD) document. Also used to automatically generate a link to ietf.org.

As with all cs1|2 templates, |title= is required. If omitted, the template will attempt to auto-generate a title using the first of |rfc=, |std=, |bcp=, |fyi=, |draft=, |ien=, |rtr= or |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.

Full version (copy and paste text below and delete parameters you don't need)
{{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=}}
Most commonly used parameters (use this and you won't have to delete as much)
{{Cite IETF \|title= \|rfc= \|sectionname= \|section= \|page= \|last= \|first= \|author-link= \|date= \|publisher=[[Internet Engineering Task Force\|IETF]] \|access-date= \|doi=}}
Example 1	{{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}}	Hoffman, P.; Harris, S. (September 2006). The Tao of IETF: A novice's guide to the Internet Engineering Task Force. IETF. doi:10.17487/RFC4677. FYI 17. RFC 4677. Retrieved October 20, 2009.
Example 2	{{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 }}	Postel, J.; Reynolds, J. (May 1983). "Are you there (AYT)". Telnet protocol specification. IETF. p. 8. doi:10.17487/RFC0854. STD 8. RFC 854. Retrieved October 20, 2009.

Examples

{{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 }}
→ T. Bray (March 2014). "IANA considerations". JSON. IETF. sec. 11. doi:10.17487/RFC7159. RFC 7159. Retrieved November 26, 2017.
{{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 }}
→ Fielding, R.; Gettys, J.; Mogul, J.; Frystyk, H.; Masinter, L.; Leach, P.; Berners-Lee, T. (June 1999). Hypertext transfer protocol -- HTTP/1.1. IETF. doi:10.17487/RFC2616. RFC 2616.
{{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 ' '. }}
→ P. Mockapetris (November 1987). "Name space specifications and terminology". Domain names - concepts and facilities. IETF. sec. 3.1. doi:10.17487/RFC1034. RFC 1034. Retrieved August 3, 2008. 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 ' '.

Technical notes

Regression testing

Regression tests are available here:

{{Cite IETF/regression tests}}

Subtemplates

{{Cite IETF}} uses the following subtemplates:

URL generation

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

https://datatracker.ietf.org/doc/html/rfc<document number>

https://datatracker.ietf.org/doc/fyi<document number>

https://datatracker.ietf.org/doc/html/draft-<draft name>

Internet Standard (STD), Best Current Practice (BCP), Internet Experiment Note (IEN), and RARE Technical Reports (RTR) documents are stored by https://rfc-editor.org and are linked in the following way:

https://www.rfc-editor.org/info/std<document number>

https://www.rfc-editor.org/info/bcp<document number>

https://rfc-editor.org/in-notes/ien/ien<document number>.txt

https://rfc-editor.org/in-notes/museum/RAREreports/rtr<document number>.txt

URL anchor generation

Anchors are generated for the URL using four parameters:

|section=number generates #section-<number>

|appendix=number generates #appendix-<number>

|referenceid=id generates #ref-<id>

|page=number generates #page-<number>

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

References

^ Hoffman, Paul; Harris, Susan (September 2006). The Tao of IETF: A novice's guide to the Internet Engineering Task Force. IETF. doi:10.17487/RFC4677. FYI 17. RFC 4677. Retrieved November 2, 2009.
^ Kessler, Gary C.; Shepard, Steven D. (December 1994). "Internet documentation". A primer on Internet and TCP/IP tools. IETF. sec. 4. doi:10.17487/RFC1739. RFC 1739. Retrieved November 2, 2009.
^ "Request for comments (RFCs)". A primer on Internet and TCP/IP tools. pp. 36–38. sec. 4.1. doi:10.17487/RFC1739. RFC 1739.
^ Malkin, Gary Scott; Reynolds, Joyce K. (March 1990). F.Y.I. on F.Y.I.: Introduction to the F.Y.I. notes. IETF. doi:10.17487/RFC1150. FYI 1. RFC 1150. Retrieved November 2, 2009.
^ "For your information documents". A primer on Internet and TCP/IP tools. p. 39. sec. 4.3. doi:10.17487/RFC1739. RFC 1739.
^ Bradner, Scott O. (October 1996). The Internet standards process -- Revision 3. IETF. doi:10.17487/RFC2026. BCP 9. RFC 2026. Retrieved November 2, 2009.
^ "Internet standards". A primer on Internet and TCP/IP tools. pp. 38–39. sec. 4.2. doi:10.17487/RFC1739. RFC 1739.
^ Postel, Jon; Rekhter, Yakov; Li, Tony (August 1995). Best current practices. IETF. doi:10.17487/RFC1818. BCP 1. RFC 1818. Retrieved November 2, 2009.
^ "RARE technical reports". A primer on Internet and TCP/IP tools. p. 40. sec. 4.4. doi:10.17487/RFC1739. RFC 1739.

v t e Citation Style 1
General templates	{{Cite book}} books {{Cite conference}} conference papers {{Cite document}} short, stand-alone, offline documents {{Cite encyclopedia}} edited collections {{Cite interview}} interviews {{Cite journal}} academic journals {{Cite magazine}} magazines {{Cite mailing list}} public mailing lists {{Cite map}} maps {{Cite news}} news articles {{Cite newsgroup}} online newsgroups {{Cite press release}} press releases {{Cite report}} unpublished reports {{Cite sign}} signs, plaques {{Cite speech}} speeches {{Cite tech report}} technical reports {{Cite thesis}} theses {{Cite web}} web sources
Preprint templates	{{Cite arXiv}} {{Cite bioRxiv}} {{Cite CiteSeerX}} {{Cite medRxiv}} {{Cite SSRN}}
Audiovisual-related	{{Cite AV media}} {{Cite AV media notes}} {{Cite episode}} {{Cite podcast}} {{Cite serial}}
Categories	Citation Style 1 templates Citation Style 1 specific-source templates
Documentation	{{Citation Style documentation}}
Citation Style 1 noticeboard

v t e Wikipedia referencing
Policies and guidelines	Verifiability No original research Biographies of living persons Reliable sources Medicine Citing sources Scientific citations
General advice	Citation needed Combining sources Offline sources Referencing styles
Citing sources	Citation Style 1 Citation Style 2 Bluebook Comics Citation templates
Inline citations	Footnotes Punctuation and footnotes Shortened footnotes Nesting footnotes
Help for beginners	Reference-tags Citations quick reference Introduction to referencing Referencing with citation templates Referencing without using templates Referencing dos and don'ts Citing Wikipedia
Advanced help	Cite link labels Cite errors Citation merging (bundling) Cite messages Converting between references formats Reference display customization References and page numbers Guidance on source reviewing at FAC
Footnote templates	Citation Style documentation Multiple references {{Reflist}} {{Refbegin}}
Find references	How to find sources Bibliographies Wikipedia Library Resource Exchange Reference Desk Book Sources Free newspaper sources
Citation tools (External links)	Citer Biomedical cite Citation bot MakeRef Refill WayBack OABot