Template:File other/doc
This is a documentation subpage for Template:File other. It contains usage information, categories and other content that is not part of the original template page. |
This template is used in system messages, and on approximately 913,000 pages, or roughly 64982% of all pages. Changes to it can cause immediate changes to the Wikipedia user interface. 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. Please discuss changes on the talk page before implementing them. |
This is the {{file other}} meta-template.
This template helps other templates detect if they are on a "File:" page or some "other" type of page.
This template was previously named {{image other}}. That name redirects here so it still works, but using the old name is now deprecated.
Usage
This template usually takes two parameters, like this:
{{file other | File page text | Other pages text }}
If the template is on a file (image) page, it will return this:
- File page text
If the template is on any other page, it will return this:
- Other pages text
A typical usage case could be to make it so that a template only adds a category when on file pages. Thus not adding other pages that just show the template. Like this:
{{file other | [[Category:Some file maintenance category]] }}
Or to warn that a template should not be used on other pages:
{{file other | | This template should only be used on file (image) pages. }}
Note that in the first case above the "other" parameter was not used, and in the second example the "file" parameter was left empty.
Demospace
For testing and demonstration purposes this template can take a parameter named demospace.
- If it has the value file it returns the file page text.
- It if has the value other or any other value such as the name of some other namespace it returns the other pages text.
- If the parameter is empty or undefined, the actual page type determines the result.
Like this:
{{file other | File page text | Other pages text | demospace = file }}
No matter on what kind of page the code above is used it will return this:
- File page text
You can make it so your template also understands the demospace parameter. That means you can demonstrate the different appearances of your template in the documentation for your template. Then do like this:
{{file other | File page text | Other pages text | demospace = {{{demospace|}}} }}
Technical details
This template detects "File talk:" pages as type other.
Namespace "Image" was renamed to "File" on 11 December 2008. This template was updated to understand both names well before that, thus it still works fine.
This template works like {{main talk other}}, for more examples and technical details see full documentation there.