Template:Current/doc: Difference between revisions

Content deleted Content added

Inline

Latest revision as of 23:58, 31 August 2024

This is a documentation subpage for Template:Current.
It may contain usage information, categories and other content that is not part of the original template page.

Any breaking changes to this template, including moving it or nominating it for deletion, must be communicated in advance to Twinkle's users and maintainers at Wikipedia talk:Twinkle. The standard installation of Twinkle relies on this template. Thank you.

This template uses Lua:

Module:Unsubst (sandbox)

This template displays the message above and adds the article to Category:Current events. The template is automatically removed by Yapperbot once an article has not been edited for five hours.

It may be used in tandem with {{Current event editnotice}} where applicable.

Usage

{{current}}
{{current|section}}
{{current||current election}}

Guidelines

Every article on Wikipedia has a general disclaimer that the article contents may not be accurate.
As an advisory to editors, the template may optionally be used on those extraordinary occasions that many editors (perhaps a hundred or more) edit an article on the same day (for example, in the case of natural disasters or other breaking news).
It is not intended to be used to mark an article that merely has recent news articles about the topic; if it were, hundreds of thousands of articles would have this template, with no informational consequence.
This and closely related templates are generally expected to appear on an article for less than a day, sometimes longer.
If you would like an article on a significant current event to be noticed, please see Wikipedia:How the Current events page works and Wikipedia:In the news/Candidates.

Check main (article) namespace links

Parameters

The template takes two positional (unnamed) and three named parameters; all are optional:

|1= – overrides the word article
|2= – overrides the words current event
|date= – use month name and year, e.g., |date=January 2025.

Details

Date:

Use month name and year only; for example: |date=January 2025. If omitted, this will be added by a bot. Categorizes the page into a monthly sub-category of Category:Current events for ease of navigation and maintenance.

Examples

1. {{current}}

2. {{current|section|date=January 2025}}

3. {{current||current election}}

4. {{current||tropical storm|date=January 2025}}

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Current in articles based on its TemplateData.

TemplateData for Current

Use this template to indicate that an article documents a current event, that information may change rapidly as the event progresses and that initial news reports may be unreliable.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Month and year	`date`	The month and year that the template was placed (in full). "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}" inserts the current month and year automatically. Example January 2013 Auto value `{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}`	Line	suggested
Type of event	`2`	Text to replace "current event" in the template Example current aviation incident	String	suggested
Affected area	`1`	Text to replace the word "article", usually "section" Example section Auto value `section`	String	optional

@@ Line 1: / Line 1: @@
+{{redirect|Template:Flux|the template for formatting fluctuations|Template:Fluctuation formatter}}
 {{Documentation subpage}}
 {{Nosubst}}
 {{Twinkle standard installation}}
-{{Template shortcuts|flux|live}}
+<!-- {{Template shortcuts|flux|live}} not a good idea, these are unprotected -->
 {{Lua|Module:Unsubst}}
-This template displays the tag above and adds articles to [[:Category:Current events]] or one of its dated subcategories.
+This template displays the message above and adds the article to [[:Category:Current events]]. The template is automatically removed by [[Wikipedia:Bots/Requests for approval/Yapperbot 2|Yapperbot]] once an article has not been edited for five hours.
+It may be used in tandem with {{t|Current event editnotice}} where applicable.
-==Guidelines==
-:*Note that every article on Wikipedia has a [[Wikipedia:General disclaimer|General disclaimer]] indicating that the article contents may not be accurate.
-:* As an advisory to editors, the template may optionally be used in those extraordinary occasions that many editors (perhaps a hundred or more) edit an article on the same day, for example, in the case of natural disasters or other breaking news.
-:* It is not intended to be used to mark an article that merely has recent news articles about the topic; if it were, hundreds of thousands of articles would have this template, with no informational consequence.
-:* Generally it is expected that this template and its closely related templates will appear on an article for a few days; occasionally longer.
-:* If you desire that an article be noticed as a topic about or related to a significant current event, see [[Wikipedia:How the Current events page works]], and also [[Wikipedia:In the news/Candidates]]
-:''[{{fullurl:Special:Whatlinkshere/Template:{{BASEPAGENAME}}|limit=999&namespace=0}} Check main (article) namespace links]''
 ==Usage==
+{{tlc|current}}{{br}}
-The template takes three parameters:
+{{tlc|current|section}}{{br}}
-* Parameter 1 overrides the word "article"
+{{tlc|current|{{zwsp}}|current election}}
-* Parameter 2 overrides the words "current event"
-* Named parameter "date" categorizes into a monthly sub category for ease of maintenance. This will be added by a [[WP:BOT|bot]] if omitted.
-===Examples===
+===Guidelines===
+* Every article on Wikipedia has a [[Wikipedia:General disclaimer|general disclaimer]] that the article contents may not be accurate.
-{{Current/examples}}
+* As an advisory to editors, the template may optionally be used on those extraordinary occasions that many editors (perhaps a hundred or more) edit an article on the same day (for example, in the case of natural disasters or other breaking news).
+* It is not intended to be used to mark an article that merely has recent news articles about the topic; if it were, hundreds of thousands of articles would have this template, with no informational consequence.
+* This and closely related templates are generally expected to appear on an article for less than a day, sometimes longer.
+* If you would like an article on a significant current event to be noticed, please see [[Wikipedia:How the Current events page works]] and [[Wikipedia:In the news/Candidates]].
+:''[{{fullurl:Special:Whatlinkshere/Template:{{BASEPAGENAME}}|limit=999&namespace=0}} Check main (article) namespace links]''
+==Parameters==
+The template takes two positional (unnamed) and three named parameters; all are optional:
+* {{para|1}} – overrides the word ''article''
+* {{para|2}} – overrides the words ''current event''
+* {{para|date}} – use month name and year, e.g., {{para|date|{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}.
+=== Details ===
+'''Date:'''
+: Use month name and year only; for example: {{para|date|{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}. If omitted, this will be added by a [[WP:BOT|bot]]. Categorizes the page into a monthly sub-category of [[:Category:Current events]] for ease of navigation and maintenance.
+==Examples==
+{{cot|bg=lightgreen|align=left|1. {{tlc|current}}}}
+{{current}}
+{{cob}}
+{{cot|bg=lightgreen|align=left|2. {{tlc|current|section|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}}}
+{{current|section|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
+{{cob}}
+{{cot|bg=lightgreen|align=left|3. {{tlc|current|{{zwsp}}|current election}}}}
+{{current||current election}}
+{{cob}}
+{{cot|bg=lightgreen|align=left|4. {{tlc|current|{{zwsp}}|tropical storm|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}}}
+{{current||tropical storm|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
+{{cob}}
+== TemplateData ==
-==Template data==
+{{TemplateData header}}
-{{TemplateDataHeader}}
 <templatedata>
 {
+    "description": "Use this template to indicate that an article documents a current event, that information may change rapidly as the event progresses and that initial news reports may be unreliable.",
+	"format": "inline",
 	"params": {
-		"1": {
+		"date": {
-			"label": "Type (typically section)",
+			"label": "Month and year",
-			"description": "Something to replace \"article\" in the template, typically \"section\"",
+			"description": "The month and year that the template was placed (in full). \"{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}\" inserts the current month and year automatically.",
-			"type": "string",
+			"type": "line",
+			"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}",
-			"default": "article"
+			"example": "January 2013",
+			"suggested": true
 		},
 		"2": {
-			"label": "Type",
+			"label": "Type of event",
-			"description": "Allows modification of the current link instead of displaying \"current event\"",
+			"description": "Text to replace \"current event\" in the template",
-			"example": "current aviation incident",
 			"type": "string",
+			"example": "current aviation incident",
 			"suggested": true
 		},
-		"date": {
+		"1": {
-			"label": "Date",
+			"label": "Affected area",
-			"description": "The month and year that the article is identified as current.",
+			"description": "Text to replace the word \"article\", usually \"section\"",
-			"example": "May 2015",
+			"type": "string",
-			"type": "date",
+			"autovalue": "section",
-			"required": true
+			"example": "section"
 		}
 	},
+	"paramOrder": [
-	"description": "This template generates a tag to indicate that the article documents a current event."
+		"date",
+		"2",
+        "1"
+	]
 }
 </templatedata>
-==Redirects==
-* {{tl|Current section}}
 ==See also==