Template:Incomprehensible/doc: Difference between revisions

Latest revision as of 12:21, 8 August 2021

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

This template should not be substituted.

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 places articles into Category:Wikipedia articles that are incomprehensible.
Please use the |reason= parameter to provide details.

Notes:

The date-substitution template may be used to automatically generate the date, e.g., {{Incomprehensible|{{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
|machine=yes - optional parameter which adds "Sometimes this can be due to machine translation."
|section=text - optional parameter which changes the word "article" to "section" if 'y', 'yes', '1', or 'true' or its value otherwise
|talk=section - optional parameter which indicates the talk page section
|small=left - optional parameter which allows the use of the small format

Examples

Paste-ready example: {{Incomprehensible|date=November 2024}}

Example with reason: {{Incomprehensible|date=November 2024|reason=}}

Example with talk: {{Incomprehensible|date=November 2024|talk=}}

Example with machine: {{Incomprehensible|date=November 2024|machine=yes}}

Example with section: {{Incomprehensible|section|date=November 2024}} or {{Incomprehensible|date=November 2024|section=yes}}

Example with small: {{Incomprehensible|date=November 2024|small=left}}

{{Incomprehensible|small=left|machine=yes}} generates:

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Incomprehensible

<templatedata>{ "description": "A template to indicate that an article contains incomprehensible text", "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" }, "machine": { "label": "Machine Translation", "description": "Adds: Sometimes this can be due to machine translation.", "type": "string" }, "sect": { "label": "Section", "aliases": ["section", "1"], "description": "Changes the word article", "type": "string" }, "talk": { "label": "Talk", "aliases": ["2"], "description": "The section heading on the article's talk page with relevant discussion", "type": "string" }, "small": { "label": "Small", "description": "Allows the use of the small format", "example": "left", "type": "string" } }}</templatedata>