Template:Vague/doc: Difference between revisions

(One intermediate revision by one other user not shown)

Line 1:

Use this template in the [[body text]] of an article as a request for other editors to clarify specific words or statements that are vague. This [[Wikipedia:Template|template]] is a [[Wikipedia:Avoid self-references|self-reference]] and so is part of the Wikipedia project rather than the encyclopedic content.

=== Usage ===

==Usage==

~~Use this for specific words or statements that are vague. See~~ [[Wikipedia:~~Ambiguous words~~]], ~~[[Wikipedia~~:~~Vagueness]], [[MoS~~:~~Words~~ to ~~watch]], and~~ [[Wikipedia:~~Please clarify~~]].

This is an [[Wikipedia:WikiProject Inline Templates|inline template]] which should be placed immediately after the material in question, as with a footnote. For example:

:<code>This statement is too vague.{{tlp|Vague|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}</code> → This statement is too vague.{{Vague|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}

::The wikilink on "vague" is set to [[Wikipedia:Vagueness]].

~~This template is a self-reference and so is part of the Wikipedia project rather than the encyclopedic content. This template will add articles to [[~~:~~Category~~:~~All Wikipedia articles needing clarification]].~~

==Parameters==

;Abbreviated parameter sets:

:{{tlx|Vague|2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}

:{{tlx|Vague|2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|3=reason= }}

:{{tlx|Vague|2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|3=text= }}

~~Use the following format~~:

;Full parameter set:

:{{tlx|Vague|2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|3=reason= |4=text= }}

: {{~~Tlx~~|Vague|date{{=}}{{~~CURRENTMONTHNAME~~}} {{~~CURRENTYEAR~~}}}}

;Parameter descriptions

;{{Para|date}}

:Like all inline templates, this template allows a date parameter which records when the vague tag was added. If the date parameter was not included when this template was added, the date parameter will automatically be added soon after by a [[WP:BOT|bot]]. Alternatively, you may add the date automatically (without requiring bot intervention) by [[WP:SUBST|substituting]] the template. That is: {{tlxs|Vague}} is equivalent to {{tlx|Vague|2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}. This substitution technique also works if other parameters{{snd}}{{para|reason}} {{para|text}}{{snd}} are included.

~~This produces~~:{{Vague|~~date=~~{{~~CURRENTMONTHNAME~~}} {{~~CURRENTYEAR}}~~}}

;{{Para|reason}}

:Because it may not be immediately apparent to other readers and/or editors what the specific reason the tagged statement is in need of clarification, it is generally helpful to add a brief reason for the vague tag: <code>{{tlp|Vague|reason{{=}}What the problem is.}}</code> (this is preferable to using an HTML <code></code> after the tag, as it is tidier to keep all of the {{Tlx|Vague}}-related code inside the template). If the request reason would be lengthy, use the article's talk page to address the issue in detail.

:As well as being visible in the source code for readers and editors' benefit, the <code>reason</code> parameter is, if provided, displayed as a pop-up when the mouse is hovered over the 'vague' link in the article.

~~=== See also ===~~

;{{Para|text}}

* {{tl|~~Ambiguous~~}}

:The particular text needing clarification may be highlighted within the prose by wrapping this vague template around it:

* {{tl|~~Clarify~~}} ~~for other~~ text ~~that is difficult to understand~~.

::As an example:

* {{tl|~~Which one~~}} ~~for~~ text ~~which could refer to one of numerous people or items but which is not linked to~~ a ~~disambiguation page~~.

:::''Understandable text preceding the template'', <code>{{tlp|Vague|text{{=}}vague text|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}</code> ''understandable text following the template''.

::produces:

:::''Understandable text preceding the template'', {{Vague|text=vague text|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}} ''understandable text following the template''.

:Please note: when using this <code>text</code> parameter, please ensure you leave a '''space''' before starting the template code.

== TemplateData ==

==TemplateData==

Line 33:

Line 48:

"suggested": true,

"autovalue": ""

},

"text": {

"label": "Text",

"type": "string",

"description": "Text fragment containing concerns the tag is supposed to address."

},

"date": {

Line 48:

Line 68:

</templatedata>

==See also==

*{{tl|Unfocused}}

{|

|'''Related inline templates'''

*{{tl|Ambiguous}}

*{{tl|Clarify}}

*{{tl|Which one}}

|}

{|

|'''Related pages'''

*[[Wikipedia:Vagueness]]

*[[Wikipedia:Manual of Style/Words to watch]]

*[[Wikipedia:Please clarify]]

|}

@@ Line 1: / Line 1: @@
 {{Documentation subpage}}
 <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
+Use this template in the [[body text]] of an article as a request for other editors to clarify specific words or statements that are vague. This [[Wikipedia:Template|template]] is a [[Wikipedia:Avoid self-references|self-reference]] and so is part of the Wikipedia project rather than the encyclopedic content.
-=== Usage ===
+==Usage==
-Use this for specific words or statements that are vague. See [[Wikipedia:Ambiguous words]], [[Wikipedia:Vagueness]], [[MoS:Words to watch]], and [[Wikipedia:Please clarify]].
+This is an [[Wikipedia:WikiProject Inline Templates|inline template]] which should be placed immediately after the material in question, as with a footnote. For example:
+:<code>This statement is too vague.{{tlp|Vague|date{{=}}{{CURRENTMONTHNAME}}&nbsp;{{CURRENTYEAR}}}}</code> → This statement is too vague.{{Vague|date={{CURRENTMONTHNAME}}&nbsp;{{CURRENTYEAR}}}}
+::The wikilink on "vague" is set to [[Wikipedia:Vagueness]].
-This template is a self-reference and so is part of the Wikipedia project rather than the encyclopedic content. This template will add articles to [[:Category:All Wikipedia articles needing clarification]].
+==Parameters==
+;Abbreviated parameter sets:
+:{{tlx|Vague|2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
+:{{tlx|Vague|2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|3=reason=&nbsp;}}
+:{{tlx|Vague|2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|3=text=&nbsp;}}
-Use the following format:
+;Full parameter set:
+:{{tlx|Vague|2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|3=reason=&nbsp;|4=text=&nbsp;}}
-: {{Tlx|Vague|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
+;Parameter descriptions
+;{{Para|date}}
+:Like all inline templates, this template allows a date parameter which records when the vague tag was added. If the date parameter was not included when this template was added, the date parameter will automatically be added soon after by a [[WP:BOT|bot]]. Alternatively, you may add the date automatically (without requiring bot intervention) by [[WP:SUBST|substituting]] the template. That is: {{tlxs|Vague}} is equivalent to {{tlx|Vague|2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}. This substitution technique also works if other parameters{{snd}}{{para|reason}} {{para|text}}{{snd}} are included.
-This produces:{{Vague|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
+;{{Para|reason}}
+:Because it may not be immediately apparent to other readers and/or editors what the specific reason the tagged statement is in need of clarification, it is generally helpful to add a brief reason for the vague tag: <code>{{tlp|Vague|reason{{=}}What the problem is.}}</code> (this is preferable to using an HTML <code>&lt;!-- comment --&gt;</code> after the tag, as it is tidier to keep all of the {{Tlx|Vague}}-related code inside the template). If the request reason would be lengthy, use the article's talk page to address the issue in detail.
+:As well as being visible in the source code for readers and editors' benefit, the <code>reason</code> parameter is, if provided, displayed as a pop-up when the mouse is hovered over the 'vague' link in the article.
-=== See also ===
+;{{Para|text}}
-* {{tl|Ambiguous}}
+:The particular text needing clarification may be highlighted within the prose by wrapping this vague template around it:
-* {{tl|Clarify}} for other text that is difficult to understand.
+::As an example:
-* {{tl|Which one}} for text which could refer to one of numerous people or items but which is not linked to a disambiguation page.
+:::''Understandable text preceding the template'', <code>{{tlp|Vague|text{{=}}vague text|date{{=}}{{CURRENTMONTHNAME}}&nbsp;{{CURRENTYEAR}}}}</code> ''understandable text following the template''.
+::produces:
+:::''Understandable text preceding the template'', {{Vague|text=vague text|date={{CURRENTMONTHNAME}}&nbsp;{{CURRENTYEAR}}}} ''understandable text following the template''.
+:Please note: when using this <code>text</code> parameter, please ensure you leave a '''space''' before starting the template code.
-== TemplateData ==
+==TemplateData==
 {{TemplateDataHeader}}
 <templatedata>
@@ Line 33: / Line 48: @@
 			"suggested": true,
 			"autovalue": ""
+		},
+		"text": {
+			"label": "Text",
+			"type": "string",
+			"description": "Text fragment containing concerns the tag is supposed to address."
 		},
 		"date": {
@@ Line 48: / Line 68: @@
 </templatedata>
+==See also==
+*{{tl|Unfocused}}
+{|
+|'''Related inline templates'''
+*{{tl|Ambiguous}}
+*{{tl|Clarify}}
+*{{tl|Which one}}
+|}
+{|
+|'''Related pages'''
+*[[Wikipedia:Vagueness]]
+*[[Wikipedia:Manual of Style/Words to watch]]
+*[[Wikipedia:Please clarify]]
+|}
 {{Inline tags}}