Template:Article problem editor notice/doc
Documentation
This template is called only by other templates that mark issues in articles needing attention from editors. It should never be used in articles directly. Instead, use one of the templates listed below.
The template {{article problem reader notice}} is very similar, but for marking issues specifically of interest to readers, like statements that may not actually be true. One distinction that could be drawn between the two types of notices is that editor notices generally wouldn't be useful if shown in a printed copy of the article, whereas reader notices might still be helpful in that context. That idea isn't actually implemented in the template code, though.
Usage
{{article problem editor notice
|problem-with-input-text=
|problem-with-preceding-text=
|input-text={{{1|}}}
|user-reason={{{reason|}}}
|scope={{{scope|text}}}
}}
Values should be provided for problem-with-input-text and problem-with-preceding-text, but everything else should remain as shown above.
Example
Template:Citation needed calls this template in the following way:
{{article problem editor notice
|input-text={{{1|}}}
|user-reason={{{reason|}}}
|problem-with-input-text=claims something that should be cited to a specific source
|problem-with-preceding-text=contains a claim that should be cited to a specific source
|scope={{{scope|text}}}
}}
Here on the page you are currently reading, this results in:
+
The value of problem-with-preceding-text is being used ("hover" on the little icon to see this) because this documentation was generated by a template call containing no input. Note that it follows the set phrase "The preceding text" or, say, "The preceding paragraph" if scope=paragraph is used. You can see how the value of problem-with-preceding-text is rendered in the documentation of Template:Citation needed (when that gets written). That one follows the single word "This".
As previously mentioned, this template should only be called directly by the specific templates listed below.
Templates that call this one
Full list of templates implemented through a call to this template: [edit this list]
{{citation needed}}– claim needs to be supported by citing a source{{clarify}}– wording should be improved{{image needed}}– needs to be illustrated by an image
See also
