User:Dandorid/sandbox/Ref RFC/doc

Usage edit

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 edit

{{Ref RFC|791}} yields a full reference: <ref name=rfc791>{{Cite IETF|rfc=791|title=...}} Updated by {{IETF RFC|1349|2474|6864}}.</ref>.[1]

{{Ref RFC|791|repeat=yes}} gives you an empty reference: <ref name=rfc791 />.[1] Make sure the full reference is created elsewhere. As this reference is generated automatically (thus having equal content everywhere), specifying repeat=yes does not seem necessary.

{{Ref RFC|1918|p=17}} yields a reference with a page number: <ref name=rfc1918>{{Cite IETF|rfc=1918|title=...}}{{Rp|17}}</ref>.[2] The reference itself contains no page number.

{{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.TEST TEST. doi:10.17487/RFC0123. RFC 123. {{citation}}: Unknown parameter |notes= ignored (help) It is not possible to add the same reference with notes later.

Example references edit

  1. ^ 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.
  2. ^ 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 Common Practice. p. 17. Obsoletes RFC 1627 and 1597. Updated by RFC 6761.

Template data edit

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.

ParameterDescriptionTypeStatus
RFC Number1

The number of the RFC to reference.

Example
8200
Stringsuggested
Notesnotes

Display notes regarding the RFC or not (default: 'yes'). If set to 'no', no notes are displayed.

Example
notes=no
Stringoptional
Repeatrepeat

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
Stringoptional
Page numberp

Page number to reference.

Example
p=37
Stringoptional
Page numberspp

Page numbers to reference.

Example
pp=37,116-19
Stringoptional

See also edit