Template:Confusing/doc
 | 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. |
 | 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 this template is used in the standard installation of Twinkle. Thank you! |
Usage
- This template categorises tagged articles into Category:Wikipedia articles 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. - Wikipedia recommends the use of the
reasonparameter to explain what is confusing. For example:
{{Confusing|reason=the furtlewangler is referred to in the plural but the diagram shows only one}}
 | This article may be confusing or unclear to readers. In particular, the furtlewangler is referred to in the plural but the diagram shows only one. (Learn how and when to remove this template message) |
- When a talk page discussion is held, a direct link to that discussion can be added via the
|talk=parameter. For example:
{{Confusing|talk=Template talk:Confusing#Talk parameter please!}}
| This article may be confusing or unclear to readers. (Learn how and when to remove this template message) |
- 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. (Learn how and when to remove this template message) |
{{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. (Learn how and when to remove this template message) |
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.
TemplateData
TemplateData for Confusing
<templatedata> { "description": "Mark text as confusing", "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 on 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": "string", "description": "Date when it was added or verified" }, "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>