Template:Cite IETF/doc

Note: this template is currently for testing purposes only.

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
Note: All parameter names must be in lowercase.

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.

Wikilinks
Except where specifically prohibited in the parameter descriptions below, most parameters can be wikilinked (e.g. title), but should generally only be linked to an existing WikiQueer article. Any wikilinked parameter must not contain any brackets apart from normal round brackets  &mdash; don't use.

Syntax (for the technical-minded)
Nested parameters rely on their parent parameters:
 * parent
 * OR: parent2 &mdash; may be used instead of parent
 * child &mdash; may be used with parent (and is ignored if parent is not used)
 * OR: child2 &mdash; may be used instead of child (and is ignored if parent2 is not used)

Description

 * title: Title of the document. Do not use italics. If both the title and sectionname parameters are omitted, 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.
 * 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.
 * sectionname: The section name or section title of the document, written in full. Punctuation other than quotes should be included in the value passed to the parameter, e.g. Meet Dick and Jane. produces "Meet Dick and Jane." ahead of title.
 * 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"
 * OR: appendix: Appendix number of the document. A.1 produces "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.
 * page: Page number of the document. 5 produces "p. 5" 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.
 * pages: Page range of the document. 5–7 produces "pp. 5–7" The "pp." notation indicating multiple pages, and "p." notation indicating a single page, are placed automatically when you choose between the pages (plural) or page (singular) form of the parameter. These parameters are for listing the pages relevant to the citation, not the total number of pages in the document.
 * last: Surname of author. Don't wikilink (use authorlink instead).
 * first: First name(s) of author, including title(s) (e.g. Firstname Middlename or Firstname M. or Dr. Firstname M., Snr.). Don't wikilink (use authorlink instead).
 * The last and first parameters are not ideally suited to authors whose surname is usually written first (e.g. as in Chinese). Use the same format as the source uses to handle these cases.
 * authorlink: Title of WikiQueer article about author (not the author's personal website). Article should already exist. Must not be wikilinked itself. Do not use this on its own, but along with author or first and last.
 * coauthors: Full name of additional author or authors, separated by ", " (e.g. Joe Bloggs, John F. Kennedy, H. R. Dent).
 * Whether the surname of the co-authors goes first or last is dependent on the citation style (see the citation style section below) preferred.
 * OR: author: Full name of author, preferably surname first. (deprecated) Don't wikilink (use authorlink instead).
 * OR: for multiple authors, use the parameters first1, last1, ..., firstN, lastN to correctly record all the information about the document (the first eight authors are printed, then et al. is appended if even more authors were specified). Don't wikilink as there are corresponding authorlink1, ..., authorlink9 parameters as well. This usage is preferred to the use of coauthors.
 * editor: Name of editor/editors. Do not Wikilink any values in the editor parameter but use editor-link instead. The template automatically adds "ed." after the editor's name unless the sectionname parameter is used in which case the template adds "in" before the editor's name which appears after the section and before the title. This implies that the author is responsible only for part of the document (including the cited section) and the editor responsible for the whole document. If, however, the author(s) and editor(s) are responsible for the whole document, then the editor parameter or its alternates described below should not be used if the sectionname parameter is being used. Instead, the editor(s) should be included in an author parameter with possibly "(ed.)" after the surname(s). Alternatively, the editor parameter may be used if the section detail is included in the title parameter instead of using the sectionname parameter.
 * OR: alternatively editor-first and editor-last can be used in the same way as first and last.
 * OR: for multiple editors up to four in number, use the parameters editor1-first, editor1-last, ...,editorN-first, editorN-last to correctly record all the information about the document in the same way as firstN and lastN.
 * editor-link or editor1-link...editorN-link is used in the same way as authorlink or authorlinkN.
 * others: To record other contributors to the work, such as "illustrated by Smith" or "trans. Smith".
 * date: Full date of document publication, in the same format as the main text of the article. Must not be wikilinked.
 * OR: year: Year of document publication.
 * month: Name of the month of document publication. If you also have the day, use date instead. Must not be wikilinked.
 * origyear: Original publication year, for display alongside the date or year. For clarity, please specify as much information as possible, for instance First published 1859 or Composed 1904. This parameter only displays if a there is a value for year or date.
 * publisher: Should be IETF for RFC, STD, BCP, FYI, I-D (internet draft), IEN, and RTR documents published by IETF. Publisher should not include corporate designation such as "Ltd" or "Inc".
 * location: Geographical place of publication.
 * language: The language the document is written in, if it is not English. The template automatically puts parentheses around the text and adds "in" before the language name.
 * format: Format, e.g. PDF. HTML or text implied if not specified.
 * accessdate: Full date when the linked document was accessed. Should be in the same format as the rest of the article. Must not be wikilinked.
 * url: URL of an online location where text of the document can be found. Overrides an automatically generated URL (from the rfc, std, bcp, fyi, draft, ien, or rtr parameters) and should not be specified unless absolutely necessary. Start the url with the communications protocol, e.g. http://.
 * 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: 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)
 * id: A unique identifier for the document, used if none of the above are applicable. Overrides automatically generated document identifiers (from the rfc, std, bcp, fyi, draft, ien, or rtr parameters) 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 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 parameters to be present for the anchor link text.
 * OR: idlink: Internal document anchor or title of a WikiQueer 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: 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 rfc, std, bcp, fyi, draft, ien, or rtr.
 * doi: A digital object identifier for the document, such as  10.1038/news070508-7 . The parameter must not be wikilinked as the template automatically creates a link.
 * archive parameters (if used, must be used both of them together)
 * archiveurl: The URL of an archived copy of the document, if (or in case) the URL becomes unavailable. Typically used to refer to services like WebCite and Archive.org.
 * archivedate: Date when the document was archived. Should not be wikilinked.
 * quote: Relevant quote from the document.
 * nopp: Using page or pages automatically places the p. and pp. notations. If this is inappropriate—for instance, if Front cover, placing any value after nopp (e.g. y will hide the p. and pp. notation.
 * nosec: Using section, sections, or appendix automatically places the sec. notation. Placing any value after nosec (e.g. y will hide the sec. notation.
 * ref: ID for reference anchor. By default, no anchor is generated. The ordinary nonempty value ID generates an anchor with the given ; 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 ietf generates an anchor suitable for use with this template's idanchor parameter. The special value harv generates an anchor suitable for the harv template; see anchors for Harvard referencing templates. See "Wikilinks to full references" in Examples below for using the ref parameter in citation templates in conjunction with short citations.
 * laysummary: Link to a non-technical summary (or review) of the document
 * laydate: Date of summary
 * separator: The separator to use in lists of authors, editors, etc. Defaults to ".", but "," may be useful also.
 * postscript: The closing punctuation for the citation. Defaults to ".", but "" may be useful also.
 * lastauthoramp: The separator to use between the last two names in lists of authors. Defaults to "", but "&amp;" may be useful as well.
 * lastauthoramp: The separator to use between the last two names in lists of authors. Defaults to "", but "&amp;" may be useful as well.

Examples






Note
Note the extra full-stop when the last author ends with an initial, and there is no date: We don't know of a practical solution to this &mdash; unless there is a way to test the characters of a field?

Citation styles
Established citation styles for coauthors:


 * MLA style: Last, First and First Last. "If there are more than three authors, you may list only the first author followed by the phrase et al."
 * APA style: Last, F. & Last, F.
 * Chicago Manual of Style: Last, First, and First Last.
 * Turabian: same as Chicago Reference List, above.
 * Harvard: Last, F., Last, F. & Last, F.

Regression testing
Regression tests are available here:

Subtemplates
Cite IETF uses the following subtemplates:

URL generation
HTML versions of the IETF documents are created with 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.