Template:Sum RFC/doc
Usage
[edit]Template {{Sum RFC}} is used to create summaries of IETF RFCs, generated from a repository of preformatted references.
You are explicitly invited to add new references or improve existing ones. It uses template {{Ref RFC/summary}} to generate the summary.
Examples
[edit]The use of this template is straightforward. It is to be used in generating lists, like this:
===RFC list===
* {{Sum RFC|10|plain=yes|ref=yes}}
* {{Sum RFC|15|title=no}}
* {{Sum RFC|826}}
* {{Sum RFC|903}}
* {{Sum RFC|879|notes=yes}}
* {{Sum RFC|2100|ref=yes}}
* {{Sum RFC|2321|ref=yes|refnotes=no}} <!-- This is an [[April Fool's Day RFC]] as well, but suppress the note that says so. -->
Which displays as:
RFC list
[edit]- 10[1]
- RFC 15
- RFC 826 –
An Ethernet Address Resolution Protocol,
Internet Standard 37. - RFC 903 –
A Reverse Address Resolution Protocol,
Internet Standard 38. - RFC 879 –
The TCP Maximum Segment Size and Related Topics,
Obsolete. Obsoleted by RFC 7805 and 9293. Updated by RFC 6691. - RFC 2100 –
The Naming of Hosts,
[2] Informational. - RFC 2321 –
RITA -- The Reliable Internetwork Troubleshooting Agent,
[3] Informational.
- ^ S. Crocker (April 1969). DOCUMENTATION CONVENTIONS. Network Working Group. doi:10.17487/RFC0010. RFC 10. Status Unknown. Obsoleted by RFC 16. Updated by RFC 24, 27 and 30. Obsoletes RFC 3.
- ^ J. Ashworth (1 April 1997). The Naming of Hosts. Network Working Group. doi:10.17487/RFC2100. RFC 2100. Informational. This is an April Fools' Day Request for Comments.
- ^ A. Bressen (1 April 1998). RITA -- The Reliable Internetwork Troubleshooting Agent. Network Working Group. doi:10.17487/RFC2321. RFC 2321. Informational.
Template data
[edit]Template {{Sum RFC}} is used to create a summary of an RFC (number, title, status). It uses the repository of preformatted reference texts of the {{Ref RFC}} template.
| 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: 'no'). If set to 'yes', notes are displayed.
| String | optional |
| Ref | ref | Generate an RFC reference after the title (default: 'no'). If set to 'yes', a reference is generated.
| String | optional |
| Ref Notes | refnotes | Display notes regarding the RFC or not (default: 'yes' from {{Ref RFC}}). If set to 'no', no notes are displayed in the generated reference.
| String | optional |
| Title | title | Display the title of the RFC or not (default: 'yes'). Useful in tables with a column for RFCs.
| String | optional |
| Plain | plain | Display the RFC number only (default: 'no'). Most useful when option 'ref' is set to 'yes'; otherwise it reduces to {{IETF RFC|xxx|plainlink=yes}} with no other benefits.
| String | optional |