Difference between revisions of "Template:Fix/doc"
test>He!ko (added to Category:Exclude in print) |
test>Thumperward (tidy) |
||
| Line 2: | Line 2: | ||
<!--EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE--> | <!--EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE--> | ||
| − | |||
'''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]].''' | '''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 | + | === Usage === |
| − | |link = <Page which text should link to, without brackets> (default = Wikipedia:Cleanup) | + | |
| − | |text = <Text to be displayed for the link> | + | <pre> |
| − | |pre-text = <Optional text to print before the linked text> | + | {{ fix |
| − | |post-text = <Optional text to print after the linked text> | + | | link = <Page which text should link to, without brackets> (default = Wikipedia:Cleanup) |
| − | |class = <Class to set text to> (default = "noprint Inline-Template"; neither should be removed, | + | | text = <Text to be displayed for the link> |
| − | but additional classes can be added, e.g. "noprint Inline-Template FooBarBazQuux") | + | | pre-text = <Optional text to print before the linked text> |
| − | |title = <Tooltip text to display when mouse is hovered over link> | + | | post-text = <Optional text to print after the linked text> |
| − | |special = <Optional replacement for text, link, title, pre-text, and post-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> | 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 to include page in> |
| − | |cat-date = <Category to include page in - with optional date parameter in the category name>}}</pre> | + | | cat-date = <Category to include page in - with optional date parameter in the category name> |
| + | }}</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. | ||
| Line 25: | Line 27: | ||
The value specified via <code>|cat-date=</code> 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 "since" (or the word "from", if the otherwise undocumented "from=" parameter is specified), and the date value. For example, given <code>|cat-date=Category:Articles with dead links|date={{CURRENTYEAR}}</code>, the article will be placed in [[:Category:Articles with dead links since {{CURRENTYEAR}}]]. | The value specified via <code>|cat-date=</code> 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 "since" (or the word "from", if the otherwise undocumented "from=" parameter is specified), and the date value. For example, given <code>|cat-date=Category:Articles with dead links|date={{CURRENTYEAR}}</code>, the article will be placed in [[:Category:Articles with dead links since {{CURRENTYEAR}}]]. | ||
| − | ==Purpose== | + | === Purpose === |
| + | |||
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. | 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. | ||
| Line 48: | Line 51: | ||
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. | 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. | ||
| − | == | + | === See also === |
| − | |||
| − | |||
* [[Wikipedia:Cleanup process]] | * [[Wikipedia:Cleanup process]] | ||
| Line 60: | Line 61: | ||
[[Category:Wikipedia metatemplates|{{PAGENAME}}]] | [[Category:Wikipedia metatemplates|{{PAGENAME}}]] | ||
[[Category:Exclude in print|{{PAGENAME}}]] | [[Category:Exclude in print|{{PAGENAME}}]] | ||
| − | |||
<!-- ADD INTERWIKIS BELOW THIS LINE --> | <!-- ADD INTERWIKIS BELOW THIS LINE --> | ||
Revision as of 11:27, 5 March 2009
Template:Template doc page viewed directly
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.
Usage
{{ fix
| 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>
}}
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. It defaults to |cat=[[Category:All pages needing cleanup]].
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 "since" (or the word "from", if the otherwise undocumented "from=" parameter is specified), and the date value. For example, given |cat-date=Category:Articles with dead links|date=2025, the article will be placed in Category:Articles with dead links since 2025.
Purpose
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,[not specific enough to verify], can be produced with:
{{fix
|link=Wikipedia:Verifiability
|pre-text=not specific enough to
|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]]}}
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.
See also