Template:Cite IETF/doc

This is a template to cite IETF documents including:
 * Request for Comments (RFC)
 * Internet Standard (STD)
 * Best current practice (BCP)
 * For Your Information (FYI)
 * Internet Draft (I-D)
 * Internet Experiment Note (IEN)
 * RARE Technical Reports (RTR)

Usage
This template supports most of the parameters available to. 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. A.1 produces "sec. A.1" Also used to create an anchor link for the document's URL.
 * autolink – yes or 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 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 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. 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. 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.

Examples






Regression testing
Regression tests are available here:
 * Cite IETF/regression tests

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.

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  and are linked via:

Internet Standard (STD) and For Your Information (FYI) documents are linked via the Rfcmarkup tool using the  parameter:

Internet Experiment Note (IEN) and RARE Technical Reports (RTR) documents are linked via the Rfcmarkup tool using the  parameter and a path to the document:

URL anchor generation
Anchors are generated for the URL using four parameters:
 * number generates
 * number generates
 * id generates
 * number generates

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.