Difference between revisions of "Template:Fix/doc"

From blackwiki
Jump to navigation Jump to search
(+iw)
m (92 revisions imported)
 
(78 intermediate revisions by 48 users not shown)
Line 1: Line 1:
<includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude>
+
{{Documentation subpage}}
<!--EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE-->
+
<!-- EDIT TEMPLATE DOCUMENTATION AFTER THIS LINE -->
 +
{{High-risk| 638992 }}
  
==Usage==
+
This meta-template can be used to create '''in-line tags''' with clean up messages which can be used to tag article issues on a line-by-line basis. Many templates are based upon it, like {{Tl|Citation needed}}.
'''Please do not use this template to create a new inline template without discussing and justifying the need for it at [[Wikipedia talk:WikiProject Inline Templates]], or the new template is likely to end up at [[Wikipedia:Templates for deletion]].'''
 
  
<pre>{{fix
+
It should '''not''' be used directly on articles by itself — instead, use one of the pre-existing derivatives if at all possible. Should there be no suitable derivative already, new ones can be created using the syntax that follows, but please discuss the need for any new template at [[Wikipedia talk:WikiProject Inline Templates]] first. Otherwise, the sub-template in question is likely to end up at [[Wikipedia:Templates for discussion]], as it is better for Wikipedia to have a finite and well-tested set of in-line tags than to allow for endless variation.
|link = <Page which text should link to, without brackets> (default = Wikipedia:Cleanup)
 
|text = <Text to be displayed for the link>
 
|pre-text = <Optional text to print before the linked text>
 
|post-text = <Optional text to print after the linked text>
 
|class = <Class to set text to> (default = "noprint Inline-Template"; neither should be removed,
 
but additional classes can be added, e.g. "noprint Inline-Template FooBarBazQuux")
 
|title = <Tooltip text to display when mouse is hovered over link>
 
|special = <Optional replacement for text, link, title, pre-text, and post-text -
 
allowing user to define a non-standard format>
 
|date = <Optional date parameter to be displayed at end of 'title' and/or in cat-date>
 
|cat = <Category to include page in>
 
|cat-date = <Category to include page in - with optional date parameter in the category name>}}</pre>
 
  
==Purpose==
+
=== Usage ===
Most inline notices use virtually identical formats. This template is designed to provide a single standardized format which can accommodate the different text, links, and categories of individual templates.
 
  
For example, {{fix
+
<pre style="overflow: auto">
|link=Wikipedia:Verifiability
+
{{Fix
|pre-text=not specific enough to&nbsp;
+
| subst    = <includeonly>{{subst:substcheck}}</includeonly>
|text=verify
+
| link     = <Page which text should link to, without brackets> (default = Wikipedia:Cleanup)
|title=The material in the vicinity of this tag may lack enough specific information to be verifiable
+
| text      = <Text to be displayed for the link>
|date={{{date|}}}
+
| pre-text = <Optional text to print before the linked text>
|cat=[[Category:Wikipedia articles needing factual verification]]}}, can be produced with:
+
| post-text = <Optional text to print after the linked text>
 +
| class    = <Class(es) to set text to> (in addition to the default ones, "noprint" and "Inline-Template")
 +
| title    = <Tool-tip text to display when mouse is hovered over link>
 +
| special  = <Optional replacement for text, link, title, pre-text, and post-text - allowing user to define a non-standard format>
 +
| date     = <Optional date parameter to be displayed at end of 'title' and/or in cat-date>
 +
| cat       = [[<Category name to include page in>]]
 +
| cat-date  = <First part of category name to include page in; there is an optional date parameter>
 +
}}</pre>
  
<!-- To use below source, remove amp; when copying -->
+
Categories are ignored if the template is used on a talk page or on any other non-article page.
<pre>{{fix
 
|link=Wikipedia:Verifiability
 
|pre-text=not specific enough to&amp;nbsp;
 
|text=verify
 
|title=The material in the vicinity of this tag may lack enough specific information to be verifiable
 
|date={{{date|}}}
 
|cat=[[Category:Wikipedia articles needing factual verification]]}}</pre>
 
  
This methodology allows new inline templates to be created by just filling in the parameters above. This also allows consistent formatting, features, and syntax across the range of templates.
+
* The value specified via <code>|cat=</code> must be in wikicode, {{em|including square brackets}}.  
  
==Historical note==
+
* The value specified via <code>|cat-date=</code> is used as part of a category name. It must be specified {{em|without}} square brackets, but {{em|with}} a "Category:" prefix. The full category name is obtained from the cat-date value, the word "from", and the date value.
This template used to be called "fix-inline" and was moved over a previous "fix" which was part of the same scheme. See history.
+
: For example, given <code>|cat-date=Category:Articles with dead external links |date={{#time:F Y}}</code>, the article will be placed in [[:Category:Articles with dead external links from {{#time:F Y}}]].
 +
: The {{para|date}} parameter is {{em|not}} normally pre-filled by any template using {{tlx|Fix}} or {{tlx|Fix-span}} as a meta-template; rather, it is coded in those derived templates as <code><nowiki>|date={{{date|}}}</nowiki></code> so that an editor provided date is passed through (or null, otherwise).
  
==See also==
+
=== See also ===
 
* [[Wikipedia:Cleanup process]]
 
* [[Wikipedia:Cleanup process]]
 +
* {{tl|fake fix}} used to create dummy versions of templates based on {{tl|fix}} for use in documentation
  
<includeonly>
+
{{Inline tags}}
<!-- ADD CATEGORIES BELOW THIS LINE -->
 
[[Category:Cleanup templates|{{PAGENAME}}]]
 
[[Category:Inline templates|{{PAGENAME}}]]
 
[[Category:Wikipedia metatemplates|{{PAGENAME}}]]
 
  
<!-- ADD INTERWIKIS BELOW THIS LINE -->
+
<includeonly>{{Sandbox other||
[[ja:Template:Fix]]
+
 
</includeonly>
+
<!-- ADD CATEGORIES AFTER THIS LINE -->
 +
[[Category:Inline cleanup templates| ]]
 +
[[Category:Wikipedia metatemplates]]
 +
[[Category:Exclude in print]]
 +
 
 +
}}</includeonly>

Latest revision as of 07:59, 6 September 2020

This meta-template can be used to create in-line tags with clean up messages which can be used to tag article issues on a line-by-line basis. Many templates are based upon it, like {{Citation needed}}.

It should not be used directly on articles by itself — instead, use one of the pre-existing derivatives if at all possible. Should there be no suitable derivative already, new ones can be created using the syntax that follows, but please discuss the need for any new template at Wikipedia talk:WikiProject Inline Templates first. Otherwise, the sub-template in question is likely to end up at Wikipedia:Templates for discussion, as it is better for Wikipedia to have a finite and well-tested set of in-line tags than to allow for endless variation.

Usage

{{Fix
| subst     = <includeonly>{{subst:substcheck}}</includeonly>
| link      = <Page which text should link to, without brackets> (default = Wikipedia:Cleanup)
| text      = <Text to be displayed for the link>
| pre-text  = <Optional text to print before the linked text>
| post-text = <Optional text to print after the linked text>
| class     = <Class(es) to set text to> (in addition to the default ones, "noprint" and "Inline-Template")
| title     = <Tool-tip text to display when mouse is hovered over link>
| special   = <Optional replacement for text, link, title, pre-text, and post-text - allowing user to define a non-standard format>
| date      = <Optional date parameter to be displayed at end of 'title' and/or in cat-date>
| cat       = [[<Category name to include page in>]]
| cat-date  = <First part of category name to include page in; there is an optional date parameter>
}}

Categories are ignored if the template is used on a talk page or on any other non-article page.

  • The value specified via |cat= must be in wikicode, including square brackets.
  • The value specified via |cat-date= is used as part of a category name. It must be specified without square brackets, but with a "Category:" prefix. The full category name is obtained from the cat-date value, the word "from", and the date value.
For example, given |cat-date=Category:Articles with dead external links |date=December 2025, the article will be placed in Category:Articles with dead external links from December 2025.
The |date= parameter is not normally pre-filled by any template using {{Fix}} or {{Fix-span}} as a meta-template; rather, it is coded in those derived templates as |date={{{date|}}} so that an editor provided date is passed through (or null, otherwise).

See also