Template:Unfocused/doc

From CAPipedia
Revision as of 12:28, 25 July 2021 by en>Trialpears (Remove broken exclude in print, succesion amboxes are hidden in other ways (via WP:JWB))
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

[[Category:Template documentation pages{{#translation:}}]]

Usage

This template is used to signal that the article taken as a whole may lack a single, central point of focus or appears to be about more than one topic. It may benefit from being split.

Placement and talk

This is a dispute template which should be placed at the top of the article.

After posting this template, please start a section on the article's talk page to discuss. You can use the optional |talk= parameter to specify the name of a specific section on the talk page.

If the article appears to be about two or more specific topics, or meanders such that you cannot identify a single central focus, please specify this using the |reason= parameter.

Example of use
{{Unfocused|reason=the article covers both widgets and doodads and should be split|date=November 2024}}

This renders as:

Do not capitalize the beginning of the reason, since it is preceded by, "In particular, ". Also do not add a full stop at the end of the reason because the template automatically supplies it.

Notes:

  • The date-substitution template may be used to automatically generate the date, e.g., {{Unfocused|{{SUBST:DATE}}}}. See Help:Substitution for more information.
  • The |date= parameter need not be added by the editor: if not entered, a bot will soon add it. The date parameter consists of the full English name of the current month with initial capital, a space, and the year, not full dates; e.g., "January 2013", but not "jan13". Any deviation from these two rules will result in an "invalid date parameter" error.

Parameters

  • |date=November 2024 - required parameter, will be added by a bot if omitted
  • |reason=text - optional parameter which adds advisory text
  • |talk=section - optional parameter which indicates the talk page section
  • |section=yes - optional parameter which replaces the word "article" with the word "section" to indicate that it is the section where it is placed that lacks focus

Examples

Paste-ready example: {{Unfocused|date=November 2024}}
Example with reason: {{Unfocused|date=November 2024|reason=}}
Example with talk: {{Unfocused|date=November 2024|talk=}}

TemplateData

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

TemplateData for Unfocused

<templatedata>{ "description": "A template to indicate that an article is unfocused", "params": { "date": { "label": "Date", "description": "The month and year the template was added", "example": "October 2015", "autovalue": "{{SUBST:CURRENTMONTHNAME}} {{SUBST:CURRENTYEAR}}", "type": "string", "required": true }, "reason": { "label": "Reason", "description": "A reason for adding the template", "type": "string" }, "talk": { "label": "Talk", "aliases": ["1"], "description": "The section heading on the article's talk page with relevant discussion", "type": "string" } }}</templatedata>

Redirects

See also