Template:Ref RFC

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 {{Rp}} 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>.

{{Ref RFC|791|repeat=yes}} gives you an empty reference: <ref name=rfc791 />. Make sure the full reference is created elsewhere. When using {{Ref RFC}} exclusively, references are generated automatically (thus having equal content everywhere). Specifying repeat=yes is 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>. 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.

{{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>. 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.

{{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. 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.

{{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.

{{Ref RFC|8201|section=5.3|p=11}} yields another reference to RFC 8201, now with a section and a page number.

In some cases, you want the full reference, but not within <ref>...</ref> tags:

{{Ref RFC|791|ref=no}} which gives you: {{#section:Template:Ref RFC/db/7|rfc791ref}} {{#section:Template:Ref RFC/db/7|rfc791status}}. {{#section:Template:Ref RFC/db/7|rfc791notes}}

Example references

Template data

Template {{Ref RFC}} is used to create references to RFCs. It uses a repository of preformatted reference texts.

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
RFC Number	1	The number of the RFC to reference. Example 8200	String	suggested
Notes	notes	Display notes regarding the RFC or not (default: 'yes'). If set to 'no', no notes are displayed. Example notes=no	String	optional
Ref	ref	If set to 'no', no <ref>...</ref> is generated, just the reference itself. Example ref=no	String	optional
Quote	quote	A quote from the RFC. Example quote=Nodes not implementing Path MTU Discovery must use the IPv6 minimum link MTU defined in [RFC8200] as the maximum packet size.	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. Example repeat=yes	String	optional
Inline page number	rp	Page number alongside the reference itself. Uses {{rp|page=}}. Example rp=37	String	optional
Inline page numbers	rpp	Page numbers alongside the reference itself. Uses {{rp|pages=}}. Example rpp=13-15	String	optional
Inline section number	rsection	Section number alongside the reference itself. Uses {{rp|at=§}}. Example rsection=4.3	String	optional
Page number	p	Creates new reference to specific page number. Displays as 'p.' Example p=37	String	optional
Page numbers	pp	Creates new reference to specific page numbers. Displays as 'pp.' Example pp=37,116-19	String	optional
Section	section	Creates new reference to a specific section. Displays as 'Sec.' Example section=4.3	String	optional

See also

• {{Cite IETF}} – general IETF citations
• {{IETF RFC}} – direct links to RFCs
• {{Rp}} – wiki-syntax for citing page numbers

The above documentation is transcluded from Template:Ref RFC/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.