Template:Sum RFC/doc

This template is about IETF RFCs. For Wikipedia Requests for Comment, see Template:Rfc.

Usage

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.

Examples

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. -->
* {{Sum RFC|9405|ref=yes|comment=The AI Sarcasm Detection Protocol (ASDP) is a [[Software framework|framework]] for detecting [[sarcasm]] in [[Artificial intelligence|AI systems]] (written with the help of [[ChatGPT]]). Detecting sarcasm may help improve AI - human intercommunication.}}

Which displays as:

RFC list

• 10
• 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," Informational.
• RFC 2321 – "RITA -- The Reliable Internetwork Troubleshooting Agent," Informational.
• RFC 9405 – "AI Sarcasm Detection: Insult Your AI without Offending It," Informational.
  The AI Sarcasm Detection Protocol (ASDP) is a framework for detecting sarcasm in AI systems (written with the help of ChatGPT). Detecting sarcasm may help improve AI - human intercommunication.

Template data

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.

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: 'no'). If set to 'yes', notes are displayed. Example notes=yes	String	optional
Ref	ref	Generate an RFC reference after the title (default: 'no'). If set to 'yes', a reference is generated. Example ref=yes	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. Example refnotes=no	String	optional
Title	title	Display the title of the RFC or not (default: 'yes'). Useful in tables with a column for RFCs. Example titles=no	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. Example plain=yes	String	optional
Comment	comment	Add a comment about the RFC in a {{Block indent}} element below the reference. Example comment=Version 2.0 of this protocol introduces enhanced security.	String	optional