Difference between revisions of "Template:Fix/doc"
test>Pinky sl m (sl:Predloga:Fix) |
m (92 revisions imported) |
||
| (19 intermediate revisions by 17 users not shown) | |||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
| − | + | <!-- EDIT TEMPLATE DOCUMENTATION AFTER THIS LINE --> | |
| − | <!--EDIT TEMPLATE DOCUMENTATION | + | {{High-risk| 638992 }} |
| − | This meta-template can be used to create in-line 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}}. | + | 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}}. |
| − | It should '''not''' be used directly on articles by itself | + | 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 === | === Usage === | ||
| + | |||
<pre style="overflow: auto"> | <pre style="overflow: auto"> | ||
{{Fix | {{Fix | ||
| − | | subst = <includeonly>{{subst: | + | | subst = <includeonly>{{subst:substcheck}}</includeonly> |
| link = <Page which text should link to, without brackets> (default = Wikipedia:Cleanup) | | link = <Page which text should link to, without brackets> (default = Wikipedia:Cleanup) | ||
| text = <Text to be displayed for the link> | | text = <Text to be displayed for the link> | ||
| pre-text = <Optional text to print before the linked text> | | pre-text = <Optional text to print before the linked text> | ||
| post-text = <Optional text to print after the linked text> | | post-text = <Optional text to print after the linked text> | ||
| − | | class = <Class to set text to> (default | + | | class = <Class(es) to set text to> (in addition to the default ones, "noprint" and "Inline-Template") |
| − | | title = <Tool | + | | 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> | | 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> | | date = <Optional date parameter to be displayed at end of 'title' and/or in cat-date> | ||
| − | | cat = <Category to include page in> | + | | cat = [[<Category name to include page in>]] |
| − | | cat-date = < | + | | cat-date = <First part of category name to include page in; there is an optional date parameter> |
}}</pre> | }}</pre> | ||
Categories are ignored if the template is used on a talk page or on any other non-article page. | Categories are ignored if the template is used on a talk page or on any other non-article page. | ||
| − | * The value specified via <code>|cat=</code> must be in wikicode, including square brackets. | + | * The value specified via <code>|cat=</code> must be in wikicode, {{em|including square brackets}}. |
| − | * The value specified via <code>|cat-date=</code> is used as part of a category name. | + | * 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. |
: 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}}]]. | : 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 | ||
| + | |||
| + | {{Inline tags}} | ||
| + | |||
| + | <includeonly>{{Sandbox other|| | ||
| − | + | <!-- ADD CATEGORIES AFTER THIS LINE --> | |
| − | <!-- ADD CATEGORIES | ||
[[Category:Inline cleanup templates| ]] | [[Category:Inline cleanup templates| ]] | ||
[[Category:Wikipedia metatemplates]] | [[Category:Wikipedia metatemplates]] | ||
[[Category:Exclude in print]] | [[Category:Exclude in print]] | ||
| − | + | }}</includeonly> | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | </includeonly> | ||
Latest revision as of 07:59, 6 September 2020
| 40px | This is a documentation subpage for Template:Fix. It contains usage information, categories and other content that is not part of the original template page. |
| 40px | This template is used on approximately 739,000 pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. Transclusion count updated automatically (see documentation). |
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=January 2026, the article will be placed in Category:Articles with dead external links from January 2026. - 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
- Wikipedia:Cleanup process
- {{fake fix}} used to create dummy versions of templates based on {{fix}} for use in documentation