Template:Fix/doc: Difference between revisions
Jump to navigation
Jump to search
no edit summary
>Rusty.perrin (Copied from wikipedia) |
>64.114 etc No edit summary |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
<!--EDIT TEMPLATE DOCUMENTATION | <!-- EDIT TEMPLATE DOCUMENTATION AFTER THIS LINE --> | ||
{{ | {{High-risk}} | ||
{{cascade-protected template}} | |||
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 | It should '''not''' be used directly on pages by itself, except to build templates — 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 === | ||
< | |||
<syntaxhighlight lang="wikitext" 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 --> | ||
}}</ | }}</syntaxhighlight> | ||
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. 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}}]]. | |||
*: 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 === | |||
* [[Wikipedia:Cleanup process]] | |||
{{Inline tags}} | |||
<includeonly>{{Sandbox other|| | |||
<!-- ADD CATEGORIES AFTER THIS LINE --> | |||
<!-- ADD CATEGORIES | |||
[[Category:Inline cleanup templates| ]] | [[Category:Inline cleanup templates| ]] | ||
[[Category: | [[Category:Wikipedia metatemplates]] | ||
}}</includeonly> | }}</includeonly> | ||
<templatedata> | |||
{ | |||
"params": { | |||
"nocat": {}, | |||
"cat-date": {}, | |||
"cat": {}, | |||
"cat-date2": {}, | |||
"cat2": {}, | |||
"cat-date3": {}, | |||
"cat3": {}, | |||
"date": {}, | |||
"name": {}, | |||
"text": { | |||
"label": "Text", | |||
"description": "Text to be displayed for the link" | |||
}, | |||
"class": { | |||
"description": "Additional CSS classes to add to the tag", | |||
"type": "string" | |||
}, | |||
"pre-text": { | |||
"label": "Pre-text", | |||
"description": "Optional unlinked text to be printed before the linked text", | |||
"type": "line" | |||
}, | |||
"link": { | |||
"label": "Link", | |||
"description": "The page that the text should link to", | |||
"type": "wiki-page-name", | |||
"default": "Wikipedia:Cleanup" | |||
}, | |||
"title": { | |||
"label": "Hover text", | |||
"description": "Text that will be shown when the link is hovered over", | |||
"type": "string", | |||
"default": "The value of the {{{link}}} parameter" | |||
}, | |||
"post-text": { | |||
"label": "Post-text", | |||
"description": "Optional unlinked text to print after the linked text", | |||
"type": "line" | |||
}, | |||
"special": {} | |||
}, | |||
"format": "{{_|_=_}}" | |||
} | |||
</templatedata> | |||