View source for Template:Rfc/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{Selfref|You may be looking for [[Template:R from CamelCase]].}}
{{Selfref|You may be looking for help automatic linking to the Internet standards documents known as [[Requests for Comments]], which can be found at {{tl|IETF RFC}}.}}
{{nosubst}}
{{Wikipedia:Article alerts/Bot use warning}}
{{Bot use warning|bots=[[User:Legobot]] operated by [[User:Legoktm]]. And [[User:Cewbot/log/20201008/configuration]]}}

== Usage ==
:{{tlx|rfc|<var>topic</var>}}

Use this template when making a [[Wikipedia:Requests for comment|request for comment]]. This template should immediately precede the signed (or just dated) text of the request. Do not begin the request with a wikilink; this may cause formatting errors.

Both the template and the request for comment itself should be placed in a discussion page related to the RfC topic; alternately, a new page dedicated to the RfC may be created.

Up to ten topics can be included in the same tag; i.e. {{tlx|rfc|<var>topic 1</var>|<var>topic 2</var>}}.

Within an hour or two after the edit has been saved, {{user|Legobot}} will add an {{para|rfcid}} parameter to the template, and will also add the discussion to the lists of RfCs that are indicated by the topic area parameters, e.g. [[Wikipedia:Requests for comment/Biographies]] if the topic area {{para||bio}} was specified. Do not add {{para|rfcid}} without a value; do not choose your own value for the {{para|rfcid}} parameter, or re-use a value that is in use (or was previously used) on another RfC – instead, always let Legobot select a value. If you would like to add another topic area to the RfC after Legobot has already processed the {{tlx|rfc}} tag, simply add the additional topic(s) to those already within the tag, before the {{para|rfcid}} parameter; Legobot will notice the addition and add the discussion to the new RfC topic pages.

Do not include any opening html tags (e.g., {{tag|small|o}}) in the initial RfC statement unless its corresponding closing tag (e.g., {{tag|small|c}}) also comes before the first timestamp, i.e., don't "straddle" the first timestamp inside html code, otherwise it may corrupt the entry of the RfC on the topic discussion pages.

If Legobot finds two or more {{tlc|rfc}} templates on the same page which do not yet have an {{para|rfcid}} parameter, it is liable to assign the same {{para|rfcid}} to different RfCs ({{diff|Talk:Halimah Yacob|prev|792491582|example}}), with the consequence that only one of them is publicised ({{diff|Wikipedia:Requests for comment/Biographies|prev|792499582|example}}). If it is felt necessary to hold two or more RfCs on the same page, the discussions may be started together but you should add the {{tlc|rfc}} template to just one discussion at a time, and wait for Legobot to set an {{para|rfcid}} on that one before you add an {{tlc|rfc}} template to another discussion.

If you find a page with two or more {{tlc|rfc}} templates that have the same value for the {{para|rfcid}} parameter, remove that parameter from the {{tlc|rfc}} template which occurs first on the page, wait for Legobot to assign a fresh value, and check for further duplication.

<b id="Inactive usage">Inactive usage:</b> If giving an example of the use of this template, or suspending an ongoing RfC, do not use the constructs {{tag|nowiki|content={{tlf|rfc}}}}, {{tag|syntaxhighlight|content={{tlf|rfc}}}} or {{tag|!--|content={{tlf|rfc}}}} because the bot may consider that it is an actual RfC, and will add an RFC ID or remove the template entirely, as it sees fit. Instead, use one of the template-linking templates such as {{tlx|tlx}}, as in {{tlx|tlx|rfc|bio}} which produces {{tlx|rfc|bio}}.

'''Note:''' It is a very good idea to let the section heading begin with "RfC" or "Request for comment", as for example "RfC: Past or present tense for television series?"

===Expiry===
The template does not provide a parameter for an expiry date. The bot will look for the first datestamp that occurs in the page text at any point after the template, and will treat that as the starting time for the RfC, and will remove the template thirty days after that time. If the {{tlx|rfc}} template is added at the top of an existing thread where discussion has been going on for some time, it is important to add some text that includes the current timestamp between the {{tlx|rfc}} template and the first posting, so that the RfC runs its full thirty days ({{diff|Wikipedia talk:Manual of Style/Novels|prev|609477813|example}}).

===Definition of topic areas===
{{Wikipedia RFC topics|float=left;}}
{{-}}

===Note to template editors===
It looks to be the case that Legobot will fail to remove RfCs if there are any parameters on the RfC tag other than the categories and the {{para|rfcid}} parameter that Legobot sets. Be cautious when adding new parameters, even no-op parameters, as this may cause Legobot to behave unpredictably.

== See also ==
*[[WP:Closing discussions]]
*[[WP:Dispute resolution]]
*[[WP:Requests for comment]]

'''Other templates'''
*{{tl|RFC countdown}} - clearly communicate time remaining on RFC
*To archive a RfC discussion, use these two templates: {{tl|archivetop}}, {{tl|archivebottom}}
*{{tl|Cite IETF}}, a different type of RFC
*{{tl|IETF RFC}}, the same different type of RFC
*{{tl|Draft RfC}}, for RfC drafts not yet open for comment

<includeonly>{{Sandbox other||
<!-- CATEGORIES HERE, THANKS -->
[[Category:Dispute templates]]
[[Category:Wikipedia requests for comment templates]]
}}</includeonly>
<templatedata>
{
	"params": {
		"1": {
			"label": "RFC category",
			"description": "The topic of the RFC (Article topics or Project-wide topics)",
			"example": "tech",
			"type": "string",
			"required": true
		},
		"rfcid": {
			"aliases": [
				"2"
			],
			"label": "RFC ID",
			"description": "The ID of the RFC filled by Legobot",
			"type": "number",
			"suggested": true
		}
	},
	"format": "inline"
}
</templatedata>