Template:Confusing/doc: Difference between revisions
m 1 revision imported |
m Text replacement - "Wikipedia[^:]" to "CAPipedia" |
||
| Line 7: | Line 7: | ||
== Usage == | == Usage == | ||
* This template categorises tagged articles into [[:Category: | * This template categorises tagged articles into [[:Category:CAPipediaarticles needing clarification]]. | ||
* You can specify whether the template applies to an article (default) or section by adding <code>|article</code> or <code>|section</code> after the template's name. There is also the [[Template:Confusing section]] template for the sections. | * You can specify whether the template applies to an article (default) or section by adding <code>|article</code> or <code>|section</code> after the template's name. There is also the [[Template:Confusing section]] template for the sections. | ||
* It is recommended to use the <code>reason</code> parameter to explain what is confusing. For example: | * It is recommended to use the <code>reason</code> parameter to explain what is confusing. For example: | ||
| Line 54: | Line 54: | ||
"description": "The date this template was added, in the format [full month name] [full year].", | "description": "The date this template was added, in the format [full month name] [full year].", | ||
"example": "January 2015", | "example": "January 2015", | ||
"autovalue": " | "autovalue": "January 2024", | ||
"required": true | "required": true | ||
}, | }, | ||
Latest revision as of 14:51, 23 January 2024
 | This is a documentation subpage for Template:Confusing. It contains usage information, categories and other content that is not part of the original Template page. |
[[Category:Template documentation pages{{#translation:}}]]
 | This template is used on approximately 2,300 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
 | If you plan to make breaking changes to this template, move it, or nominate it for deletion, please notify Twinkle's users and maintainers at Wikipedia talk:Twinkle as a courtesy, as the standard installation of Twinkle adds and removes this template. Thank you! |
Usage
- This template categorises tagged articles into Category:CAPipediaarticles needing clarification.
- You can specify whether the template applies to an article (default) or section by adding
|articleor|sectionafter the template's name. There is also the Template:Confusing section template for the sections. - It is recommended to use the
reasonparameter to explain what is confusing. For example:
{{Confusing|date=November 2024|reason=the Wangler is referred to in the plural but the diagram shows only one}}
 | This article may be confusing or unclear to readers. In particular, the Wangler is referred to in the plural but the diagram shows only one. (November 2024) |
- When a talk page discussion is held, a direct link to that discussion can be added via the
|talk=parameter. For example:
{{Confusing|date=November 2024|talk=Template talk:Confusing#Talk parameter please!}}
| This article may be confusing or unclear to readers. (November 2024) |
- Do not capitalize the beginning of the reason, since it is preceded by "In particular, ".
- Do not add a full stop/period at the end of the reason because the template automatically puts a full stop/period in.
- Please do not subst: this template.
{{Confusing|small=left}} generates:
| This article may be confusing or unclear to readers. |
{{Confusing|small=left|reason=the tensing of the article is ambiguous}} generates:
| This article may be confusing or unclear to readers. In particular, the tensing of the article is ambiguous. |
Template data
TemplateData for Confusing
<templatedata> { "description": "This template is used to mark an article or section as confusing and in need of clarification.", "params": { "1": { "label": "Article or section?", "type": "string", "description": "Set to 'section' to specify that you are referring to the section", "default": "article" }, "talk": { "label": "Discussion location", "description": "The location at which the discussion on the issue is being held. Should be full page name, followed by #, followed by section name. Please do not enclose between and . The link will be automatically formatted using the section sign (§).", "example": "Template talk:Confusing#Talk parameter please!", "type": "wiki-page-name", "suggested": true }, "reason": { "label": "What is confusing?", "type": "string", "description": "Explain what part of the text needs to be clarified." }, "date": { "label": "Date", "type": "date", "description": "The date this template was added, in the format [full month name] [full year].", "example": "January 2015", "autovalue": "January 2024", "required": true }, "small": { "type": "string", "description": "Set to 'left' if a small version should be shown instead of the default", "label": "Small?" } }, "paramOrder": [ "1", "talk", "reason", "date", "small" ], "format": "inline" } </templatedata>
See also
- Template:Clarify, an in-line version of this template
- Template:Confusing section, a section version of this template
- Wikipedia:Template messages/Cleanup for an overview of cleanup templates.