Difference between revisions of "Template:Cite IETF/doc"

From blackwiki
Jump to navigation Jump to search
imported>Sardanaphalus
(TOC limit, sandbox non-categorization)
imported>Gadget850
(update obsolete HTML)
Line 114: Line 114:
 
|- width="50%" style="vertical-align:top;"
 
|- width="50%" style="vertical-align:top;"
 
| colspan="3" |
 
| colspan="3" |
:<tt><nowiki>{{cite IETF |title= |rfc= |std= |bcp= |fyi= |draft= |ien= |rtr= |sectionname= |section= |sections= |appendix= |referenceid= |page= |pages= |last1= |first1= |authorlink1= |last2= |first2= |authorlink2= |authormask= |coauthors= |editor1-last= |editor1-first= |editor1-link= |others= |date= |year= |month= |origyear= |publisher=[[Internet Engineering Task Force|IETF]] |location= |language= |format= |accessdate= |url= |section-url= |page-url= |autolink= |id= |idanchor= |idlink= |idlinktype= |doi= |doi_brokendate= |issn= |archiveurl= |archivedate= |quote= |nopp= |nosec= |ref= |laysummary= |laydate= |separator= |postscript= |lastauthoramp= }}</nowiki></tt>
+
:<code><nowiki>{{cite IETF |title= |rfc= |std= |bcp= |fyi= |draft= |ien= |rtr= |sectionname= |section= |sections= |appendix= |referenceid= |page= |pages= |last1= |first1= |authorlink1= |last2= |first2= |authorlink2= |authormask= |coauthors= |editor1-last= |editor1-first= |editor1-link= |others= |date= |year= |month= |origyear= |publisher=[[Internet Engineering Task Force|IETF]] |location= |language= |format= |accessdate= |url= |section-url= |page-url= |autolink= |id= |idanchor= |idlink= |idlinktype= |doi= |doi_brokendate= |issn= |archiveurl= |archivedate= |quote= |nopp= |nosec= |ref= |laysummary= |laydate= |separator= |postscript= |lastauthoramp= }}</nowiki></code>
 
|- width="50%" style="vertical-align:top;"
 
|- width="50%" style="vertical-align:top;"
 
! colspan="3" | Most commonly used parameters (use this and you won't have to delete as much)
 
! colspan="3" | Most commonly used parameters (use this and you won't have to delete as much)
 
|- width="50%" style="vertical-align:top;"
 
|- width="50%" style="vertical-align:top;"
 
| colspan="3" |
 
| colspan="3" |
:<tt><nowiki>{{cite IETF |title= |rfc= |sectionname= |section= |page= |last= |first= |authorlink= |coauthors= |year= |month= |publisher=[[Internet Engineering Task Force|IETF]] |accessdate= }}</nowiki></tt>
+
:<code><nowiki>{{cite IETF |title= |rfc= |sectionname= |section= |page= |last= |first= |authorlink= |coauthors= |year= |month= |publisher=[[Internet Engineering Task Force|IETF]] |accessdate= }}</nowiki></code>
 
|- width="50%" style="vertical-align:top;"
 
|- width="50%" style="vertical-align:top;"
 
! Example 1
 
! Example 1
 
| style="vertical-align: top;" |
 
| style="vertical-align: top;" |
<tt><nowiki>{{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 (VPNC) |last2= Harris |first2= S. |year= 2006 |month= September |publisher=[[Internet Engineering Task Force|IETF]] |accessdate=October 20, 2009}}</nowiki></tt>
+
<code><nowiki>{{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 (VPNC) |last2= Harris |first2= S. |year= 2006 |month= September |publisher=[[Internet Engineering Task Force|IETF]] |accessdate=October 20, 2009}}</nowiki></code>
 
| style="vertical-align: top;" |
 
| 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. |authorlink1= Paul Hoffman (VPNC) |last2= Harris |first2= S. |year= 2006 |month= September |publisher=[[Internet Engineering Task Force|IETF]] |accessdate=October 20, 2009}}
 
{{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 (VPNC) |last2= Harris |first2= S. |year= 2006 |month= September |publisher=[[Internet Engineering Task Force|IETF]] |accessdate=October 20, 2009}}

Revision as of 16:31, 17 January 2015

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

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.

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= |coauthors= |editor1-last= |editor1-first= |editor1-link= |others= |date= |year= |month= |origyear= |publisher=[[Internet Engineering Task Force|IETF]] |location= |language= |format= |accessdate= |url= |section-url= |page-url= |autolink= |id= |idanchor= |idlink= |idlinktype= |doi= |doi_brokendate= |issn= |archiveurl= |archivedate= |quote= |nopp= |nosec= |ref= |laysummary= |laydate= |separator= |postscript= |lastauthoramp= }}
Most commonly used parameters (use this and you won't have to delete as much)
{{cite IETF |title= |rfc= |sectionname= |section= |page= |last= |first= |authorlink= |coauthors= |year= |month= |publisher=[[Internet Engineering Task Force|IETF]] |accessdate= }}
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 (VPNC) |last2= Harris |first2= S. |year= 2006 |month= September |publisher=[[Internet Engineering Task Force|IETF]] |accessdate=October 20, 2009}}

Hoffman, P.; Harris, S. (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. Unknown parameter |month= ignored (help)

Example 2
{{cite IETF
| title = Telnet protocol specification
| rfc = 854
| std = 8
| sectionname = Are You There (AYT)
| page = 8
| last1 = Postel
| first1 = J.
| authorlink1 = Jon Postel
| last2 = Reynolds
| first2 = J.
| authorlink2 = Joyce K. Reynolds
| year = 1983
| month = May
| publisher = [[Internet Engineering Task Force|IETF]]
| accessdate =October 20, 2009
}}

Postel, J.; Reynolds, J. (1983). "Are You There (AYT)". Telnet protocol specification. IETF. p. 8. doi:10.17487/RFC0854. STD 8. RFC 854. Retrieved October 20, 2009. Unknown parameter |month= ignored (help)

Vertical list Prerequisites Brief instructions
{{cite IETF
| title       = 
| rfc         = 
| std         = 
| bcp         = 
| fyi         = 
| draft       = 
| ien         = 
| rtr         = 
| sectionname = 
| section     = 
| sections    = 
| appendix    = 
| referenceid = 
| page        = 
| pages       = 
| last        = 
| first       = 
| authorlink  = 
| authormask  = 
| coauthors   = 
| lastN       = 
| firstN      = 
| authorN-link = 
| editor      = 
| editorN     = 
| editorN-last = 
| editorN-first = 
| editor-link = 
| editorN-link = 
| others      = 
| date        = 
| year        = 
| month       = 
| origyear    = 
| publisher   = 
| location    = 
| language    = 
| format      = 
| accessdate  = 
| url         = 
| section-url = 
| page-url    = 
| autolink    = 
| id          = 
| idanchor    = 
| idlink      = 
| idlinktype  = 
| doi         = 
| doi_brokendate = 
| issn        = 
| archiveurl  = 
| archivedate = 
| quote       = 
| nopp        = 
| nosec       = 
| ref         = 
| laysummary  = 
| laydate     = 
| separator   = 
| postscript  = 
| lastauthoramp = 
}}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
last
last
 
last
 
lastN
 
 
 
 
editorN-last
editor or editor-last
editorN or editorN-last
 
 
 
year
year or date
 
publisher
 
 
rfc, std, bcp, fyi, draft, ien, rtr, or url
 
sectionname
sectionname
rfc, std, bcp, fyi, draft, ien, rtr, or url
 
id, rfc, std, bcp, fyi, draft, ien, or rtr
id, rfc, std, bcp, fyi, draft, ien, or rtr
idanchor or idlink
 
doi
 
url, rfc, std, bcp, fyi, draft, ien, or rtr
archiveurl
 
page or pages
section, sections, or appendix
 
 
laysummary
 
 
coauthors or >1 lastN
 
 
(no wikilink) RFC number; 4677
(no wikilink) STD number
(no wikilink) BCP number
(no wikilink) FYI number; 17
(no wikilink) I-D (internet draft) name
(no wikilink) IEN number
(no wikilink) RTR number
 
(no wikilink) section number; 3.3
(no wikilink) section range (can be used together with the section parameter)
(no wikilink) appendix number; A.1
(no wikilink) reference id
(no wikilink) page number
(no wikilink) page range (can be used together with the page parameter)
 
(no wikilink)
(no wikilink)
 
 
alternative to first2, last2...first9, last9
(no wikilink) N=1 through 9
N=1 through 9
N=1 through 9
 
N=1 through 4
N=1 through 4
N=1 through 4
 
N=1 through 4
 
preferred (no wikilink) This is the preferred parameter with its alternates listed below.
alternative to date
 
 
should be [[Internet Engineering Task Force|IETF]] for IETF documents.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
hides automatic 'p.' or 'pp.'
hides automatic 'sec.'
 
 
 
 
 
 
 

Examples

  • {{cite IETF | title = JSON | rfc = 4267 | sectionname = IANA Considerations | section = 6 | author = Douglas Crockford | authorlink = Douglas Crockford | date = July 2006 | publisher = [[Internet Engineering Task Force|IETF]] | accessdate =July 3, 2009 }}
    Douglas Crockford (July 2006). "IANA Considerations". JSON. IETF. sec. 6. doi:10.17487/RFC4267. RFC 4267. Retrieved July 3, 2009.
  • {{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]] }}
    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 | 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)

Parameters

Syntax

Nested parameters rely on their parent parameters:

  • parent
  • OR: parent2—may be used instead of parent
    • child—may be used with parent (and is ignored if parent is not used)
    • OR: child2—may be used instead of child (and is ignored if parent2 is not used)
Where aliases are listed, only one of the parameters may be defined; if multiple aliased parameters are defined, then only one will show.

If non-hyphenated aliases of parameters with hyphens are defined, they exist only for legacy support (and are subject to become unsupported in the future); therefore, to streamline the appearance and improve consistency, select the hyphenated variant when adding parameters to a citation template and also consider switching already present non-hyphenated parameters to their hyphenated equivalents at the same time.

This template embeds COinS metadata in the HTML output, allowing reference management software to retrieve bibliographic metadata. See Wikipedia:COinS. As a general rule, only one data item per parameter. Do not include explanatory or alternate text:

  • use |date=27 September 2007 not |date=27 September 2007 (print version 25 September)

Use of templates within the citation template is discouraged because many of these templates will add extraneous HTML or CSS that will be included raw in the metadata. Also, HTML entities, for example &nbsp;, &ndash;, etc., should not be used in parameters that contribute to the metadata. Do not include Wiki markup '' (italic font) or ''' (bold font) because these markup characters will contaminate the metadata.

COinS metadata is created for these parameters

Note: This table of metadata is displayed for all Citation Style 1 templates. Not all of these parameters are supported by every CS1 template. Some of these parameters are mutually exclusive, some are aliases of another parameter, and some require other parameters to be present. Please refer to each template's documentation for a full list of supported parameters, their aliases, and their dependencies.

  • |periodical=, |journal=, |newspaper=, |magazine=, |work=, |website=, |encyclopedia=, |encyclopaedia=, |dictionary=
  • |chapter=, |script-chapter=, |contribution=, |script-contribution=, |entry=, |script-entry=, |article=, |script-article=, |section=, |script-section=
  • |title=, |script-title=, |book-title=, |booktitle=
  • |publication-place=, |place=, |location=, |publicationplace=
  • |date=, |year=, |publication-date=, |publicationdate=
  • |series=, |version=
  • |volume=, |issue=, |number=
  • |page=, |pages=, |at=
  • |edition=
  • |publisher=, |institution=
  • |url=, |chapter-url=, |contribution-url=, |section-url=, |chapterurl=, |contributionurl=, |sectionurl=
  • |author-last=, |author-last#=, |author#-last=, |author-surname=, |author-surname#=, |author#-surname=, |last=, |last#=, |surname=, |surname#=, |author=, |author#=, |subject=, |subject#=, |host=, |host#=
  • |author-first=, |author-first#=, |author#-first=, |author-given=, |author-given#=, |author#-given=, |first=, |first#=, |given=, |given#=
  • |degree=
  • |arxiv=, |bibcode=, |biorxiv=, |citeseerx=, |doi=, |eissn=, |eprint=, |hdl=, |isbn=, |issn=, |jfm=, |jstor=, |lccn=, |message-id=, |mr=, |oclc=, |osti=, |pmc=, |pmid=, |rfc=, |ssrn=, |s2cid=, |zbl=

By default, sets of fields are terminated with a period (.).

Description

Authors

  • last: Surname of a single author. Do not wikilink—use author-link instead. For corporate authors or authors for whom only one name is listed by the source, use last or one of its aliases (e.g. |author=Bono). Aliases: surname, author, last1, surname1, author1.
    • author: this parameter is used to hold the complete name of a single author (first and last) or to hold the name of a corporate author. This parameter should never hold the names of more than one author. Do not wikilink—use author-link instead.
    • first: Given or first names of author; for example: Firstname Middlename or Firstname M. or Firstname M., Sr. Do not wikilink—use author-link instead. Aliases: given, first1, given1. Requires last; first name will not display if last is empty.
    • OR: for multiple authors, use last1, first1 through lastn, firstn, where n is any consecutive number for an unlimited number of authors (each firstn requires a corresponding lastn, but not the other way around). See the display parameters to change how many authors are displayed. Aliases: surname1, given1 through surnamen, givenn, or author1 through authorn. For an individual author plus an institutional author, you can use |first1=...|last1=...|author2=....
    • author-link: Title of existing Wikipedia article about the author—not the author's website; do not wikilink. Aliases: author-link1, authorlink, authorlink1, author1-link, author1link.
    • OR: for multiple authors, use author-link1 through author-linkn. Aliases: authorlink1 through authorlinkn, or author1-link through authorn-link, or author1link through authornlink.
    • name-list-style: accepts a limited list of keywords as value; when set to amp, ampersand, or &, inserts an ampersand between the last two names in a name list; when set to and, inserts the conjunction 'and' between the last two names of a name list; when set to vancdisplays name lists in Vancouver style when the lists use the last/first forms of name parameters. Alias: name-list-format (deprecated)
  • vauthors: comma-separated list of author names in Vancouver style; enclose corporate or institutional author names in doubled parentheses. End with etal if appropriate:
    |vauthors=Smythe JB, ((Megabux Corp.)), etal
    • author-link and author-mask may be used for the individual names in |vauthors= as described above
  • authors: Free-form list of author names; use of this parameter is discouraged because it does not contribute to a citation's metadata; not an alias of last.
  • translator-last: Surname of translator. Do not wikilink—use translator-link instead. Aliases: translator-surname, translator1, translator1-last, translator-last1.
    • translator-first: Given or first names of translator. Do not wikilink—use translator-link instead. Aliases: translator-given, translator1-first, translator-first1.
    • OR: for multiple translators, use translator-last1, translator-first1 through translator-lastn, translator-firstn, where n is any consecutive number for an unlimited number of translators (each translator-firstn requires a corresponding translator-lastn, but not the other way around). Aliases: translator1-last, translator1-first through translatorn-last, translatorn-first, or translator1 through translatorn.
    • translator-link: Title of existing Wikipedia article about the translator—not the translator's website; do not wikilink. Aliases: translator-link1, translator1-link.
    • OR: for multiple translators, use translator-link1 through translator-linkn. Aliases: translator1-link through translatorn-link.
  • collaboration: Name of a group of authors or collaborators; requires author, last, or vauthors listing one or more primary authors; follows author name-list; appends "et al." to author name-list.
  • others: To record other contributors to the work, including illustrators. For the parameter value, write Illustrated by John Smith.
  • Note: When using shortened footnotes or parenthetical referencing styles with templates, do not use multiple names in one field, or else the anchor will not match the inline link.

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.
Titles containing certain characters will display and link incorrectly unless those characters are encoded.
newline [ ] |
space &#91; &#93; &#124;
  • sectionname: The section name or section title of the document, written in full; displays before title and enclosed in quotes.
  • language: The language (or a comma-separated list of the languages) in which the source is written, as either the ISO 639 language code (preferred) or the full language name. Examples: |language=ru;, |lang=fr, pt-br; |lang=Russian; |language=French, Portuguese. See the list of supported codes and names. Do not use templates or wikilinks. Displays in parentheses with "in" before the language name or names. When the only source language is English, no language is displayed in the citation. The use of languages recognized by the citation module adds the page to the appropriate subcategory of Category:CS1 foreign language sources. Because cs1|2 templates are often copied from en.wiki to other wikis, use of language codes is preferred so that language names render in the correct language and form: espagnol at a French-language wiki instead of the English word "Spanish". Aliases: lang

Date

  • date: Date of referenced source. Can be full date (day, month, and year) or partial date (month and year, season and year, or year). Use same format as other publication dates in the citations.[date 1] Required when year is used to disambiguate {{sfn}} links to multiple-work citations by the same author in the same year.[more] Do not wikilink. Displays after the authors and is enclosed in parentheses. If there is no author, then displays after publisher.. For acceptable date formats, see Script error: No such module "Section link"..
For approximate year, precede with "c. ", like this: |date=c. 1900.

For no date, or "undated", use |date=n.d.
Automatic date formatting: Citation Style 1 and 2 templates, including this template, automatically render dates in all date parameters (such as |date=, |publication-date=, |access-date=, |archive-date=, etc.) except for |orig-date= in the style specified by the article's {{use dmy dates}} or {{use mdy dates}} template. See those templates' documentation for details.
  • year: Year of source being referenced. The usage of this parameter is discouraged; use the more flexible |date= parameter instead unless both of the following conditions are met:
    1. The |date= format is YYYY-MM-DD.
    2. The citation requires a CITEREF disambiguator.
  • orig-date: Original publication date or year; displays in square brackets after the date (or year). For clarity, please supply specifics. For example: |orig-date=First published 1859 or |orig-date=Composed 1904. As |orig-date= does not support automatic date formatting, use the same date format as defined by |df= (or, if it exists in the article, by |cs1-dates= of a {{use dmy dates}} or {{use mdy dates}} template), or as used in the |date= parameter. Alias: orig-year, origyear
  • df: date format; sets rendered dates to the specified format; does not support date ranges or seasonal dates; overrides the automatic date formatting described above. Accepts one value which may be one of these:
    dmy – set publication dates to day month year format; access- and archive-dates are not modified;
    mdy – as above for month day, year format
    ymd – as above for year initial numeric format YYYY-MM-DD
    dmy-all – set publication, access-, and archive-dates to day month year format;
    mdy-all – as above for month day, year format
    ymd-all – as above for year initial numeric format YYYY-MM-DD
  1. Publication dates in references within an article should all have the same format. This may be a different format from that used for archive and access dates. See MOS:DATEUNIFY.

Publisher

  • publisher: Name of publisher; may be wikilinked if relevant. Not normally included for periodicals. Corporate designations such as "Ltd", "Inc" or "GmbH" are not usually included. Displays after title.
Should normally be set to IETF for RFC, STD, BCP, FYI, I-D (internet draft), IEN, and RTR documents.
Note: There are reasons this can't just be the default; see Template talk:Cite IETF#Make publisher always IETF?
  • location: Geographical place of publication; generally not wikilinked; omit when the name of the work includes the location (examples: The Boston Globe, The Times of India). Displays preceding publisher.

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. or pp. notations where this is inappropriate; for example, where |page=Front cover.
  • 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"
  • OR: 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.
  • 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=y to hide the sec. notation.

URL

  • url: URL of an online location where the text of the publication named by title can be found. Cannot be used if title is wikilinked. If applicable, the link may point to the specific page(s) referenced. Remove tracking parameters from URLs, e.g. #ixzz2rBr3aO94 or ?utm_source=google&utm_medium=...&utm_term=...&utm_campaign=.... For linking to pages in PDF files or in Google Books, see WP:PAGELINKS. Do not link to any commercial booksellers, such as Amazon; use |isbn= or |oclc= to provide neutral search links for books. Invalid URLs, including those containing spaces, will result in an error message.
    • access-date: Full date when the content pointed to by url was last verified to support the text in the article; do not wikilink; requires url; use the same format as other access and archive dates in the citations.[date 1] Not required for linked documents that do not change. For example, access-date is required for online sources, such as personal websites, that do not have a publication date; see WP:CITEWEB. Access dates are not required for links to published research papers, published books, or news articles with publication dates. Note that access-date is the date that the URL was found to be working and to support the text being cited. See "Automatic date formatting" above for details about interaction with {{use dmy dates}} and {{use mdy dates}}. Can be hidden or styled by registered editors. Alias: accessdate.
    • archive-url: The URL of an archived snapshot of a web page. Typically used to refer to services such as Internet Archive (see Wikipedia:Using the Wayback Machine), WebCite (see Wikipedia:Using WebCite) and archive.is (see Wikipedia:Using archive.is); requires archive-date and url. By default (overridden by |url-status=live) the archived link is displayed first, with the original link at the end. Alias: archiveurl.
      • archive-date: Archive-service snapshot-date; preceded in display by default text "archived from the original on". Use the same format as other access and archive dates in the citations. This does not necessarily have to be the same format that was used for citing publication dates.[date 1] Do not wikilink; templated dates are discouraged. See "Automatic date formatting" above for details about interaction with {{use dmy dates}} and {{use mdy dates}}. Alias: archivedate.
      • url-status: this optional parameter is ignored if archive-url is not set. If omitted, or with null value, the default value is |url-status=dead. When the URL is still live, but pre-emptively archived, then set |url-status=live; this changes the display order, with the title retaining the original link and the archive linked at the end. When the original URL has been usurped for the purposes of spam, advertising, or is otherwise unsuitable, setting |url-status=unfit or |url-status=usurped suppresses display of the original URL (but |url= and |archive-url= are still required).
      • archive-format: File format of the work referred to by archive-url; for example: PDF, DOC, or XLS; displayed in parentheses after the archive link. HTML is implied and should not be specified. File format annotation is automatically rendered when a PDF icon is displayed. Does not change the external link icon. Note: External link icons do not include alt text; thus, they do not add file format information for the visually impaired. See Using |format=
    • url-access: See Access indicators for url-holding parameters
  • format: File format of the work referred to by url; for example: PDF, DOC, or XLS; displayed in parentheses after title. (For media format, use type.) HTML is implied and should not be specified. File format annotation is automatically rendered when a PDF icon is displayed. Does not change the external link icon. Note: External link icons do not include alt text; thus, they do not add file format information for the visually impaired. See Using |format=

URLs must begin with a supported URI scheme. http:// and https:// will be supported by all browsers; however, ftp://, gopher://, irc://, ircs://, mailto: and news: may require a plug-in or an external application and should normally be avoided. IPv6 host-names are currently not supported.

If URLs in citation template parameters contain certain characters, then they will not display and link correctly. Those characters need to be percent-encoded. For example, a space must be replaced by %20. To encode the URL, replace the following characters with:

sp " ' < > [ ] { | }
%20 %22 %27 %3c %3e %5b %5d %7b %7c %7d

Single apostrophes do not need to be encoded; however, unencoded multiples will be parsed as italic or bold markup. Single curly closing braces also do not need to be encoded; however, an unencoded pair will be parsed as the double closing braces for the template transclusion.

  1. 1.0 1.1 Access-date and archive-date in references should all have the same format – either the format used for publication dates, or YYYY-MM-DD. See MOS:DATEUNIFY.
  • 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=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)

Anchor

  • ref: the citation's HTML anchor identifier, when different from its default. When set, |ref=ID generates an anchor with the given ID (the id= attribute in the citation's <cite id="ID"> HTML tag). Setting |ref=ID identifies the template as a target and allows wikilinking to full references, especially useful with short-form citations like shortened notes and parenthetical referencing. The default anchor ID is suitable for use with {{sfn}} and {{harv}} templates. Since April 2020, the parameter / keyword pair |ref=harv has no special meaning; |ref=harv may be removed from existing cs1|2 templates. To inhibit anchor ID creation, set |ref=none. Aliases: none. See Script error: No such module "Section link".. The special value |ref=ietf generates 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=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.
  • 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.
  • doi: A digital object identifier for the document, such as 10.1038/news070508-7. The field must not be wikilinked as the template automatically creates a link.
    • doi_brokendate: The date that the DOI was determined to be broken
  • issn: International Standard Serial Number for the document; 8 characters; may be split into two groups of four using a hyphen. The field must not be wikilinked as the template automatically creates a link.

Quote

  • quote: Relevant text quoted from the source. Displays enclosed in quotes. When supplied, the citation terminator (a period by default) is suppressed, so the quote must include terminating punctuation. If script-quote is defined, use quote to hold a Romanization (if available) of the text in script-quote.
    • script-quote: Original quotation for languages that do not use a Latin-based script (Arabic, Chinese, Cyrillic, Greek, Hebrew, Japanese, Korean, etc.); not italicized, follows italicized Romanization defined in quote (if available). Alias: none. Must be prefixed with one of the supported language codes to help browsers properly display the script:
      ... |quote=Tōkyō tawā |script-quote=ja:東京タワー |trans-quote=Tokyo Tower ...
    • trans-quote: English translation of the quotation if the source quoted is in a foreign language. Displays in square brackets. Alias: none.
  • quote-page: The number of a single page quoted in |quote=. Use either |quote-page= or |quote-pages=, but not both. Should be a subset of the page(s) specified in |page= or |pages=. Displays preceded by p. unless |no-pp=yes. If hyphenated, use {{hyphen}} to indicate this is intentional (e.g. |quote-page=3{{hyphen}}12). Alias: none.
  • OR: quote-pages: A list or range of pages quoted in |quote=. Use either |quote-page= or |quote-pages=, but not both. Should be a subset of the pages specified in |pages=. Separate using an en dash (–); separate non-sequential pages with a comma (,). Displays preceded by colon pp. unless |no-pp=yes is defined. Hyphens are automatically converted to en dashes. Alias: none.

Editors

  • editor-last: surname of editor. Do not wikilink—use editor-link instead. Where the surname is usually written first—as in Chinese—or for corporate authors, simply use editor-last to include the same format as the source. Aliases: editor-last1, editor1-last, editor-surname, editor-surname1, editor1-surname, editor, editor1.
    • editor: This parameter is used to hold the complete name of a single editor (first and last), or the name of an editorial committee. This parameter should never hold the names of more than one editor.
    • editor-first: given or first names of editor, including title(s); example: Firstname Middlename or Firstname M. or Dr. Firstname M., Sr. Do not wikilink—use editor-link instead. Aliases: editor-first1, editor1-first, editor-given, editor-given1, editor1-given.
    • OR: for multiple editors, use editor-last1, editor-first1 through editor-lastn, editor-firstn (Aliases: editorn-last, editor-surnamen or editorn-surname; editorn-first, editor-givenn or editorn-given; editorn). For an individual editor plus an institutional editor, you can use |editor-first1=...|editor-last1=... |editor2=....
    • editor-link: title of existing Wikipedia article about the editor—not the editor's website; do not wikilink. Aliases: editor-link1.
    • OR: for multiple editors, use editor-link1 through editor-linkn (alias editorn-link).
    • name-list-style: accepts a limited list of keywords as value; when set to amp, ampersand, or &, inserts an ampersand between the last two names in a name list; when set to and, inserts the conjunction 'and' between the last two names of a name list; when set to vancdisplays name lists in Vancouver style when the lists use the last/first forms of name parameters. Alias: name-list-format (deprecated)
  • veditors: comma separated list of editor names in Vancouver style; enclose corporate or institutional names in doubled parentheses. End with etal if appropriate:
    |veditors=Smythe JB, ((Megabux Corp.)), etal
    • editor-linkn and editor-maskn may be used for the individual names in |veditors=, as described above
  • editors (deprecated): free-form list of editor names; use of this parameter is discouraged; not an alias of editor-last
  • Display:
    Use display-editors to control the length of the displayed editor name list and to specify when "et al." is included.
    If authors: Authors are first, followed by the included work, then "In" and the editors, then the main work.
    If no authors: Editors appear before the included work; a single editor is followed by "ed."; multiple editors are followed by "eds."

Laysummary

  • lay-url: URL link to a non-technical summary or review of the source; the URL title is set to "Lay summary". Alias: layurl.
    • lay-source: Name of the source of the lay summary. Displays in italics and preceded by a spaced endash. Alias: laysource.
    • lay-date: Date of the lay summary. Displays in parentheses. Alias: laydate.
    • lay-format: File format of the work referred to by lay-url; for example: PDF, DOC, or XLS; displayed in parentheses after lay summary. HTML is implied and should not be specified. File format annotation is automatically rendered when a PDF icon is displayed. Does not change the external link icon. Note: External link icons do not include alt text; thus, they do not add file format information for the visually impaired. See Using |format=

Display options

  • mode: Sets element separator, default terminal punctuation, and certain capitalization according to the value provided. For |mode=cs1, element separator and terminal punctuation is a period (.); where appropriate, initial letters of certain words are capitalized ('Retrieved...'). For |mode=cs2, element separator is a comma (,); terminal punctuation is omitted; where appropriate, initial letters of certain words are not capitalized ('retrieved...'). To override default terminal punctuation use postscript.
  • author-mask:
  • contributor-mask:
  • editor-mask:
  • interviewer-mask:
  • subject-mask:
  • translator-mask:
    Replaces the name of the (first) author with em dashes or text. Set <name>-mask to a numeric value n to set the dash n em spaces wide; set <name>-mask to a text value to display the text without a trailing author separator; for example, "with". The numeric value 0 is a special case to be used in conjunction with <name>-link—in this case, the value of <name>-link will be used as (linked) text. In either case, you must still include the values for all names for metadata purposes. Primarily intended for use with bibliographies or bibliography styles where multiple works by a single author are listed sequentially such as shortened footnotes. Do not use in a list generated by {{reflist}}, <references /> or similar as there is no control of the order in which references are displayed. Mask parameters can take an enumerator in the name of the parameter (e.g. |authorn-mask=) to apply the mask to a specific name.
  • display-authors:
  • display-contributors:
  • display-editors:
  • display-interviewers:
  • display-subjects:
  • display-translators:
    Controls the number of author or editor names that are displayed when a citation is published. To change the displayed number of names, set display-authors and/or display-editors to the desired number. For example, |display-authors=2 will display only the first two authors in a citation (and not affect the display of editors). Likewise, |display-editors=2 will display only the first two editors (and all authors). |display-authors=0 and |display-editors=0 are special cases suppressing the display of all authors or editors including the et al. By default, all authors and editors are displayed. |display-authors=etal displays all authors in the list followed by et al. Aliases: displayauthors (deprecated).
  • last-author-amp (deprecated; use name-list-style): Switches the separator between the last two names of the author list to space ampersand space ( & ) when set to y, yes, or true. Example: |last-author-amp=yes
  • postscript: Controls the closing punctuation for a citation; defaults to a period (.); for no terminating punctuation, specify |postscript=none – leaving |postscript= empty is the same as omitting it, but is ambiguous. Additional text or templates beyond the terminating punctuation may generate an error message. |postscript= is ignored if quote is defined.

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.

Technical notes

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 the Rfcmarkup tool from Henrik Levkowetz.[12][13]

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 tools.ietf.org/html/[14][15] and are linked via:

http://tools.ietf.org/html/rfc<document number>
http://tools.ietf.org/html/bcp<document number>
http://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:

http://tools.ietf.org/rfcmarkup?doc=std<document number>
http://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:

http://tools.ietf.org/rfcmarkup?url=ftp://ftp.rfc-editor.org/in-notes/ien/ien<document number>.txt
http://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=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

  1. Hoffman, Paul; Harris, Susan (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. Unknown parameter |month= ignored (help)
  2. Kessler, Gary C.; Shepard, Steven D. (1994). "Internet Documentation". A Primer On Internet and TCP/IP Tools. IETF. sec. 4. doi:10.17487/RFC1739. RFC 1739. Retrieved November 2, 2009. Unknown parameter |month= ignored (help)
  3. "Request for Comments (RFCs)". pp. 36 – 38. sec. 4.1. doi:10.17487/RFC1739. RFC 1739. Missing or empty |title= (help)
  4. Bradner, Scott O. (1996). The Internet Standards Process -- Revision 3. IETF. doi:10.17487/RFC2026. BCP 9. RFC 2026. Retrieved November 2, 2009. Unknown parameter |month= ignored (help)
  5. "Internet Standards". pp. 38 – 39. sec. 4.2. doi:10.17487/RFC1739. RFC 1739. Missing or empty |title= (help)
  6. Postel, Jon; Rekhter, Yakov; Li, Tony (1995). Best Current Practices. IETF. doi:10.17487/RFC1818. BCP 1. RFC 1818. Retrieved November 2, 2009. Unknown parameter |month= ignored (help)
  7. Malkin, Gary Scott; Reynolds, Joyce K. (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. Unknown parameter |month= ignored (help)
  8. "For Your Information Documents". p. 39. sec. 4.3. doi:10.17487/RFC1739. RFC 1739. Missing or empty |title= (help)
  9. "RARE Technical Reports". p. 40. sec. 4.4. doi:10.17487/RFC1739. RFC 1739. Missing or empty |title= (help)
  10. Levkowetz, Henrik (October 16, 2009). "Rfcmarkup Tool". IETF. Retrieved November 2, 2009.
  11. Levkowetz, Henrik (October 16, 2009). "rfcmarkup-1.85.tgz (25 KB)". IETF. Retrieved November 2, 2009.
  12. "IETF Documents". IETF. Retrieved November 2, 2009.
  13. "HTTP 404 handler for a directory of htmlized documents". IETF. October 14, 2009. Retrieved November 2, 2009.

Further reading

This template produces COinS metadata; see COinS in Wikipedia for background information.