Template:Ref RFC
References
Template documentation[view] [edit] [history] [purge]Usage
Template {{Ref RFC}} is used to create references to IETF RFCs, generated from a repository of preformatted references. This way, all references are of high quality, with a minimal chance of errors, and you don't have to create each reference from scratch. You are explicitly invited to add new references or improve existing ones.
It uses templates {{Cite IETF}} and {{Reference page}} to generate the reference itself.
Examples
The examples below generate a single full reference in the {{Reflist}} and can be referenced in the text many times.
{{Ref RFC|791}}yields a full reference:<ref name=rfc791>{{Cite IETF|rfc=791|std=5|title=...}} ...Updated by {{IETF RFC|1349|2474|6864|leadout=and|link=no}}.</ref>.[1]{{Ref RFC|791|repeat=yes}}gives you an empty reference:<ref name=rfc791 />.[1] Make sure the full reference is created elsewhere (for example, in a list of references). When using {{Ref RFC}} exclusively, references are generated automatically (thus having equal content everywhere). Specifyingrepeat=yesis not necessary in that case, but may be helpful when the full reference was created by other means.{{Ref RFC|1918|rp=17}}yields a reference with an inline page number:<ref name=rfc1918>{{Cite IETF|rfc=1918|title=...}}{{Rp|page=17}}</ref>.[2]: 17 The reference itself contains no page number. You can add another reference to the same RFC with inline page numbers, e.g.{{Ref RFC|1918|rpp=23-24}}, without adding a new full reference in the list.[2]: 23–24{{Ref RFC|1918|rsection=4.3}}yields a reference with an inline section number:<ref name=rfc1918>{{Cite IETF|rfc=1918|title=...}}{{Rp|at=§4.3}}</ref>.[2]: §4.3 The reference itself contains no section number. You can add another reference to the same RFC with inline page numbers or section, e.g.{{Ref RFC|1918|rpp=23-24}}, without adding a new full reference in the list.[2]: 23–24{{Ref RFC|8200|notes=no}}yields a reference to RFC 8200 without notes specifying which other RFC are affected by or are affecting this RFC.[3] It is not possible to add the same reference with notes later.
References with section or page numbers or a quote are generated with an anonymous <ref>...</ref> pair, to create individual full references in the {{Reflist}}.
{{Ref RFC|8201|section=5.4}}yields a reference to RFC 8201 with a section.[4]{{Ref RFC|8201|pp=17-18|quote=Removed a "Note" from Section 4.}}yields another reference to RFC 8201, now with page numbers and a quote.[5]{{Ref RFC|8201|section=5.3|p=11}}yields another reference to RFC 8201, now with a section and a page number.[6]
In some cases, you want the full reference, but not within <ref>...</ref> tags:
{{Ref RFC|791|ref=no}}which gives you: J. Postel, ed. (September 1981). INTERNET PROTOCOL - DARPA INTERNET PROGRAM PROTOCOL SPECIFICATION. IETF. doi:10.17487/RFC0791. STD 5. RFC 791. IEN 128, 123, 111, 80, 54, 44, 41, 28, 26. Internet Standard 5. Obsoletes RFC 760. Updated by RFC 1349, 2474 and 6864.
Example references
- ^ a b J. Postel, ed. (September 1981). INTERNET PROTOCOL - DARPA INTERNET PROGRAM PROTOCOL SPECIFICATION. IETF. doi:10.17487/RFC0791. STD 5. RFC 791. IEN 128, 123, 111, 80, 54, 44, 41, 28, 26. Internet Standard 5. Obsoletes RFC 760. Updated by RFC 1349, 2474 and 6864.
- ^ a b c d Y. Rekhter; B. Moskowitz; D. Karrenberg; G. J. de Groot; E. Lear (February 1996). Address Allocation for Private Internets. Network Working Group. doi:10.17487/RFC1918. BCP 5. RFC 1918. Best Current Practice 5. Obsoletes RFC 1627 and 1597. Updated by RFC 6761.
- ^ S. Deering; R. Hinden (July 2017). Internet Protocol, Version 6 (IPv6) Specification. Internet Engineering Task Force. doi:10.17487/RFC8200. STD 86. RFC 8200. Internet Standard 86.
- ^ J. McCann; S. Deering; J. Mogul (July 2017). R. Hinden (ed.). Path MTU Discovery for IP version 6. Internet Engineering Task Force. doi:10.17487/RFC8201. STD 87. RFC 8201. Internet Standard 87. sec. 5.4. Obsoletes RFC 1981.
- ^ J. McCann; S. Deering; J. Mogul (July 2017). R. Hinden (ed.). Path MTU Discovery for IP version 6. Internet Engineering Task Force. doi:10.17487/RFC8201. STD 87. RFC 8201. Internet Standard 87. pp. 17-18. Obsoletes RFC 1981.
Removed a "Note" from Section 4.
- ^ J. McCann; S. Deering; J. Mogul (July 2017). R. Hinden (ed.). Path MTU Discovery for IP version 6. Internet Engineering Task Force. doi:10.17487/RFC8201. STD 87. RFC 8201. Internet Standard 87. sec. 5.3, p. 11. Obsoletes RFC 1981.
TemplateData
TemplateData for Ref RFC
This template is used to create references to IETF Requests for Comments. It uses a repository of preformatted reference texts.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| RFC Number | 1 | The number of the RFC to reference.
| String | suggested |
| Notes | notes | Display notes regarding the RFC or not (default: 'yes'). If set to 'no', no notes are displayed.
| String | optional |
| Ref | ref | If set to 'no', no <ref>...</ref> is generated, just the reference itself.
| String | optional |
| Quote | quote | A quote from the RFC.
| String | optional |
| Repeat | repeat | This reference is a repeat of an earlier one. If set to 'yes', no new reference is created, just an empty <ref name=rfc9999 /> one.
| String | optional |
| Inline page number | rp | Page number alongside the reference itself. Uses {{rp|page=}}.
| String | optional |
| Inline page numbers | rpp | Page numbers alongside the reference itself. Uses {{rp|pages=}}.
| String | optional |
| Inline section number | rsection | Section number alongside the reference itself. Uses {{rp|at=§}}.
| String | optional |
| Page number | p | Creates new reference to specific page number. Displays as 'p.'
| String | optional |
| Page numbers | pp | Creates new reference to specific page numbers. Displays as 'pp.'
| String | optional |
| Section | section | Creates new reference to a specific section. Displays as 'Sec.'
| String | optional |