Template:Confusing/doc
This is a documentation subpage for Template:Confusing. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on many 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. |
Usage
- This template categorises tagged articles into Category:Articles needing clarification.
- You can specify whether the template applies to an article (default) or section by adding
|article
or|section
after the template's name. There is also the Template:Confusing section template for the sections. - It is recommended to use the
reason
parameter to explain what is confusing. For example:
{{Confusing|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. |
- 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. |
- 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." }, "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.