Template:Cite IETF/doc
| This is a documentation subpage for Template:Cite IETF. It contains usage information, categories and other content that is not part of the original template page. |
This is a template to cite IETF documents[1][2] including:
- Request for Comments (RFC)[3]
- Internet Standard (STD)[4][5]
- Best current practice (BCP)[6]
- For Your Information (FYI)[7][8]
- Internet Draft (I-D)
- Internet Experiment Note (IEN)
- RARE Technical Reports (RTR)[9]
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
Title
- title: Title of the document; displays in italics. If both title and sectionname are omitted, then the template will attempt to auto-generate a title using the first of the rfc, std, bcp, fyi, draft, ien, rtr or id document identifier parameters, in that order.
- sectionname: The section name or section title of the document, written in full; displays before title and enclosed in quotes.
In-source locations
- page: Page in the source that supports the content. Displays preceded with
p.unless|nopp=y. Also used to create an anchor link for the document's URL. If either section or appendix is also given, the anchor will link to the section or appendix instead of the page. Can also be used in combination with pages to link to the first page in the given page range if section and appendix are not specified. - OR: pages: Pages in the source that supports the content; separate page ranges with an en dash (–); separate non-sequential pages with a comma (,); do not use to indicate the total number of pages in the source. Displays preceded with
pp.unless|nopp=y.- nopp: Set to y to suppress the
p.orpp.notations where this is inappropriate; for example, where|page=Front cover.
- nopp: Set to y to suppress the
- section: Section number of the document.
|section=4.3.1produces "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.7produces "sec. 4.3-4.7" - OR: appendix: Appendix number of the document.
|appendix=A.1produces "sec. A.1" Also used to create an anchor link for the document's URL. - OR: referenceid: Reference id for the document. Used to create an anchor link for the document's URL.
- nosec: Using section, 'sections, or appendix automatically places the sec. notation. Se
|nosec=yto hide the sec. notation.
URL
- section-url: URL to an individual section of the document (including an anchor if required). Overrides an automatically generated URL and should not be specified unless absolutely necessary. Should be at the same site as
|url=, if any. - page-url: URL to an individual page of the document (including an anchor if required). Overrides an automatically generated URL and should not be specified unless absolutely necessary. Should be at the same site as
|url=, if any. - autolink:
|autolink=yesor|autolink=noAutomatically generate a link to ietf.org for documents specified with|rfc=,|std=,|bcp=,|fyi=,|draft=,|ien=, or|rtr=. (enabled by default)
Anchor
- ref: ID for anchor. By default, no anchor is generated. The ordinary nonempty value
|ref=IDgenerates an anchor with the given ID; such a linkable reference can be made the target of wikilinks to full references, especially useful in short citations like shortened notes and parenthetical referencing. The special value|ref=harvgenerates an anchor suitable for the {{harv}} template. See: Anchors for Harvard referencing templates. The special value|ref=ietfgenerates an anchor suitable for use with this template's idanchor parameter.
Identifiers
- rfc: Number of the Request for Comments (RFC) document. Also used to automatically generate a link to ietf.org.
- std: Number of the Internet Standard (STD) document. Also used to automatically generate a link to ietf.org.
- bcp: Number of the Best Current Practice (BCP) document. 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.
- draft: Name of the Internet Draft (I-D) document, including the leading draft-. Also used to automatically generate a link to ietf.org.
- ien: Number of the Internet Experiment Note (IEN) 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.
- id: A unique identifier for the document, used if none of the above are applicable. Overrides automatically generated document identifiers—rfc, std, bcp, fyi, draft, ien or rtr—and should not be specified unless absolutely necessary. If used, you also need to specify the kind of identifier you are using. Don't wikilink, use idlink instead.
- idanchor: Anchor link target. By default, no anchor link is generated. The special value
|idanchor=ietfgenerates 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. - OR: 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.
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) | ||
|---|---|---|
| ||
| Most commonly used parameters (use this and you won't have to delete as much) | ||
| ||
| Example 1 |
|
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]]
| accessdate = 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
| year = 1999
| month = June
| 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. (1999). Hypertext Transfer Protocol -- HTTP/1.1. IETF. doi:10.17487/RFC2616. RFC 2616. Unknown parameter|month=ignored (help)
- {{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
| year = 1987
| month = November
| publisher = [[Internet Engineering Task Force|IETF]]
| accessdate = 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 (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 ' '.
Unknown parameter|month=ignored (help)
Technical notes
Regression testing
Regression tests are available here:
Subtemplates
{{Cite IETF}} uses the following subtemplates:
- {{Cite IETF/doctypes}}
- {{Cite IETF/makelink}}
- {{Cite IETF/refanchor}}
URL generation
HTML versions of the IETF documents are created with the Rfcmarkup tool from Henrik Levkowetz.[10][11]
Request for Comments (RFC), Best Current Practice (BCP), and Internet Draft (I-D) documents which have been processed by the Rfcmarkup tool are cached by https://tools.ietf.org/html/[12][13] and are linked via:
https://tools.ietf.org/html/rfc<document number>https://tools.ietf.org/html/bcp<document number>https://tools.ietf.org/html/draft-<draft name>
Internet Standard (STD) and For Your Information (FYI) documents are linked via the Rfcmarkup tool using the doc= parameter:
https://tools.ietf.org/rfcmarkup?doc=std<document number>https://tools.ietf.org/rfcmarkup?doc=fyi<document number>
Internet Experiment Note (IEN) and RARE Technical Reports (RTR) documents are linked via the Rfcmarkup tool using the url= parameter and a path to the document:
https://tools.ietf.org/rfcmarkup?url=ftp://ftp.rfc-editor.org/in-notes/ien/ien<document number>.txthttps://tools.ietf.org/rfcmarkup?url=ftp://ftp.rfc-editor.org/in-notes/museum/RAREreports/rtr<document number>.txt
URL anchor generation
Anchors are generated for the URL using four parameters:
|section=numbergenerates#section-<number>|appendix=numbergenerates#appendix-<number>|referenceid=idgenerates#ref-<id>|page=numbergenerates#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.
- ↑ 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.
- ↑ 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.
- ↑ "RARE Technical Reports". A Primer On Internet and TCP/IP Tools. p. 40. sec. 4.4. doi:10.17487/RFC1739. RFC 1739.
- ↑ Levkowetz, Henrik (March 7, 2017). "Rfcmarkup Tool". IETF. Retrieved November 26, 2017.
- ↑ Levkowetz, Henrik (July 13, 2016). "rfcmarkup-1.121.tgz (29.7 KB)". IETF. Retrieved November 26, 2017.
- ↑ "IETF Documents". IETF. Retrieved November 2, 2009.
- ↑ "HTTP 404 handler for a directory of htmlized documents". IETF. October 14, 2009. Retrieved November 2, 2009.
Further reading
- Internet Official Protocol Standards. IETF. May 2008. doi:10.17487/RFC5000. STD 1. RFC 5000. Retrieved November 2, 2009.
- Huitema, Christian; Postel, Jon; Crocker, Steve (April 1995). Not All RFCs are Standards. IETF. doi:10.17487/RFC1796. RFC 1796. Retrieved November 2, 2009.
- Stewart, William. "Related RFC's, BCP, FYI, IEN, RTR, STD". LivingInternet.com. Retrieved November 2, 2009.
This template produces COinS metadata; see COinS in Wikipedia for background information.