Difference between revisions of "Template:Imbox/doc"
Dinoguy1000 (talk | contribs) (copy from wikipedia:Template:Imbox/doc) |
|||
Line 1: | Line 1: | ||
<noinclude>{{Wikipedia}}</noinclude>{{Documentation subpage}} | <noinclude>{{Wikipedia}}</noinclude>{{Documentation subpage}} | ||
− | <!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE --> | + | <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> |
{{mbox templates}} | {{mbox templates}} | ||
This is the {{tl|imbox}} or '''image message box''' meta-template. | This is the {{tl|imbox}} or '''image message box''' meta-template. | ||
Line 8: | Line 8: | ||
This template works almost exactly like {{tl|ambox}} and uses the same parameters. | This template works almost exactly like {{tl|ambox}} and uses the same parameters. | ||
− | === Usage === | + | ===Usage=== |
− | |||
Simple usage example: | Simple usage example: | ||
Line 25: | Line 24: | ||
| type = style | | type = style | ||
| image = [[Image:Emblem-question-yellow.svg|40px]] | | image = [[Image:Emblem-question-yellow.svg|40px]] | ||
− | | style = width: 400px; | + | | style = width: 400px; |
| textstyle = color: red; font-weight: bold; font-style: italic; | | textstyle = color: red; font-weight: bold; font-style: italic; | ||
| text = The message body text. | | text = The message body text. | ||
Line 34: | Line 33: | ||
| type = style | | type = style | ||
| image = [[Image:Emblem-question-yellow.svg|40px]] | | image = [[Image:Emblem-question-yellow.svg|40px]] | ||
− | | style = width: 400px; | + | | style = width: 400px; |
| textstyle = color: red; font-weight: bold; font-style: italic; | | textstyle = color: red; font-weight: bold; font-style: italic; | ||
| text = The message body text. | | text = The message body text. | ||
}} | }} | ||
− | === Image message box types === | + | ===Image message box types=== |
− | |||
The following examples use different '''type''' parameters but use no image parameters thus they use the default images for each type. | The following examples use different '''type''' parameters but use no image parameters thus they use the default images for each type. | ||
Line 80: | Line 78: | ||
}} | }} | ||
− | === Other images === | + | ===Other images=== |
− | |||
The default images shown above are mostly for convenience. In many cases it is more appropriate to use more specific images. These examples use the '''image''' parameter to specify an image other than the default images. | The default images shown above are mostly for convenience. In many cases it is more appropriate to use more specific images. These examples use the '''image''' parameter to specify an image other than the default images. | ||
Line 87: | Line 84: | ||
| type = style | | type = style | ||
| image = [[Image:Gnome-dev-camera.svg|42px]] | | image = [[Image:Gnome-dev-camera.svg|42px]] | ||
− | | text = type = style <br> image = <nowiki>[[Image:Gnome-dev-camera.svg|42px]]</nowiki> <br> This image is used for {{tl|cleanup-image}}. | + | | text = type = style <br> image = <nowiki>[[Image:Gnome-dev-camera.svg|42px]]</nowiki> <br> This image is used for {{tl|cleanup-image}}. |
}} | }} | ||
{{imbox | {{imbox | ||
| type = move | | type = move | ||
| image = [[Image:To Commons.svg|52px]] | | image = [[Image:To Commons.svg|52px]] | ||
− | | text = type = move <br> image = <nowiki>[[Image:To Commons.svg|52px]]</nowiki> <br> This image is used for {{tl|copy to Wikimedia Commons}}. | + | | text = type = move <br> image = <nowiki>[[Image:To Commons.svg|52px]]</nowiki> <br> This image is used for {{tl|copy to Wikimedia Commons}}. |
}} | }} | ||
{{imbox | {{imbox | ||
| type = license | | type = license | ||
− | | image = [[Image:Heckert GNU.svg|48px]] | + | | image = [[Image:Heckert GNU white.svg|48px]] |
− | | text = type = license <br> image = <nowiki>[[Image:Heckert GNU.svg|48px]]</nowiki> <br> This image is used for the GFDL license templates such as {{tl|GFDL}}. | + | | text = type = license <br> image = <nowiki>[[Image:Heckert GNU white.svg|48px]]</nowiki> <br> This image is used for the GFDL license templates such as {{tl|GFDL}}. |
}} | }} | ||
− | === Special === | + | ===Special=== |
− | |||
Some other parameter combinations. | Some other parameter combinations. | ||
Line 139: | Line 135: | ||
}} | }} | ||
− | === Parameters === | + | ===Parameters=== |
− | |||
List of all parameters: | List of all parameters: | ||
Line 153: | Line 148: | ||
| text = The message body text. | | text = The message body text. | ||
| below = More text or another imbox. | | below = More text or another imbox. | ||
+ | | plainlinks = no | ||
}} | }} | ||
</pre> | </pre> | ||
Line 160: | Line 156: | ||
'''image''' | '''image''' | ||
− | :'''No parameter''' = If no '''image''' parameter is given the template uses a default image. Which default image it uses depends on the '''type''' parameter. | + | :'''No parameter''' = If no '''image''' parameter is given the template uses a default image. Which default image it uses depends on the '''type''' parameter. |
− | :'''An image''' = Should be an image with usual wiki notation. 40px - 50px width are usually about right depending on the image height to width ratio. (But the message box can handle images of any size.) For example: | + | :'''An image''' = Should be an image with usual wiki notation. 40px - 50px width are usually about right depending on the image height to width ratio. (But the message box can handle images of any size.) For example: |
::<code><nowiki>image = [[Image:Gnome-dev-camera.svg|40px]]</nowiki></code> | ::<code><nowiki>image = [[Image:Gnome-dev-camera.svg|40px]]</nowiki></code> | ||
:'''none''' = Means that no image is used. | :'''none''' = Means that no image is used. | ||
Line 167: | Line 163: | ||
'''imageright''' | '''imageright''' | ||
:'''No parameter''' = If no '''imageright''' parameter is given then no image is shown on the right side. | :'''No parameter''' = If no '''imageright''' parameter is given then no image is shown on the right side. | ||
− | :'''An image''' = Should be an image with usual wiki notation. 40px - 50px width are usually about right depending on the image height to width ratio. (But the message box can handle images of any size.) For example: | + | :'''An image''' = Should be an image with usual wiki notation. 40px - 50px width are usually about right depending on the image height to width ratio. (But the message box can handle images of any size.) For example: |
::<code><nowiki>imageright = [[Image:Nuvola apps bookcase.png|40px]]</nowiki></code> | ::<code><nowiki>imageright = [[Image:Nuvola apps bookcase.png|40px]]</nowiki></code> | ||
:'''Anything''' = Any other object that you want to show on the right side. | :'''Anything''' = Any other object that you want to show on the right side. | ||
Line 186: | Line 182: | ||
::<code><nowiki>below = {{imbox | type = content | text = This license tag is deprecated. }} </nowiki></code> | ::<code><nowiki>below = {{imbox | type = content | text = This license tag is deprecated. }} </nowiki></code> | ||
− | = | + | '''plainlinks''' |
+ | :Defaults to yes. If external link arrows - [[File:External.svg|10px]] - are desired, specify: | ||
+ | ::<code><nowiki>plainlinks = no</nowiki></code> | ||
+ | ===Technical details=== | ||
Namespace "Image:" was renamed to "File:" on 11 December 2008. This template was created long before that, and that is why it is named "imbox" as in "image message box". | Namespace "Image:" was renamed to "File:" on 11 December 2008. This template was created long before that, and that is why it is named "imbox" as in "image message box". | ||
− | If you need to use special characters in the text parameter then you need to escape them like this: | + | If you need to use special characters in the text parameter then you need to escape them like this: |
<pre> | <pre> | ||
Line 212: | Line 211: | ||
This template uses the imbox CSS classes in [[MediaWiki:Common.css]] for most of its looks, thus it is fully skinnable. | This template uses the imbox CSS classes in [[MediaWiki:Common.css]] for most of its looks, thus it is fully skinnable. | ||
− | Internally this meta-template uses HTML markup instead of wiki markup for the table code. That is the usual way we make meta-templates since wiki markup has several drawbacks. For instance it makes it harder to use [[m:Help:ParserFunctions|parser functions]] and special characters in parameters. | + | Internally this meta-template uses HTML markup instead of wiki markup for the table code. That is the usual way we make meta-templates since wiki markup has several drawbacks. For instance it makes it harder to use [[m:Help:ParserFunctions|parser functions]] and special characters in parameters. |
The default images for this meta-template are in png format instead of svg format. The main reason is that some older web browsers have trouble with the transparent png images. For those older browsers these png images have been modified so that the color of their default backgrounds match the background color of the template. The default background that MediaWiki renders for svg images is always white. This creates a white box around the images when displayed in older browsers. | The default images for this meta-template are in png format instead of svg format. The main reason is that some older web browsers have trouble with the transparent png images. For those older browsers these png images have been modified so that the color of their default backgrounds match the background color of the template. The default background that MediaWiki renders for svg images is always white. This creates a white box around the images when displayed in older browsers. | ||
Line 218: | Line 217: | ||
For more technical details see the [[Template talk:Imbox|talk page]]. Since this template works almost exactly like the other mboxes their talk pages and related pages might also contain more details, see the "See also" section below. | For more technical details see the [[Template talk:Imbox|talk page]]. Since this template works almost exactly like the other mboxes their talk pages and related pages might also contain more details, see the "See also" section below. | ||
− | === See also === | + | ===See also=== |
+ | {{Mbox templates see also}} | ||
− | {{ | + | {{mbox template family}} |
− | <includeonly> | + | <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|| |
− | <!-- CATEGORIES HERE, THANKS --> | + | <!-- CATEGORIES AND INTERWIKIS HERE, THANKS --> |
− | [[Category:Wikipedia metatemplates | + | [[Category:Wikipedia metatemplates]] |
[[Category:File namespace templates| ]] | [[Category:File namespace templates| ]] | ||
− | </includeonly> | + | |
+ | }}</includeonly> |
Revision as of 23:29, 4 July 2013
This template uses Creative Commons licensed content from Wikipedia's Template:Imbox/doc template.
The list of authors can be seen in the page history there. See Wikipedia's copyrights page for more information. |
This is a documentation subpage for Template:Imbox. It contains usage information, categories and other content that is not part of the original template page. |
Message box meta-templates | |
---|---|
template | context |
{{Ambox}} | article |
{{Cmbox}} | category |
{{Imbox}} | image |
{{Tmbox}} | talk |
{{Fmbox}} | footer / header |
{{Ombox}} | other pages |
{{Mbox}} | auto-detect |
{{Asbox}} | article stub |
{{Dmbox}} | disambiguation |
This is the {{imbox}} or image message box meta-template.
It is used to build message box templates for file (image) pages, such as {{cleanup-image}} etc. It offers several different colours, uses default images if no image parameter is given and it has some other features.
This template works almost exactly like {{ambox}} and uses the same parameters.
Contents
Usage
Simple usage example:
{{imbox | text = Some text.}}
Some text. |
Complex example:
{{imbox | type = style | image = [[Image:Emblem-question-yellow.svg|40px]] | style = width: 400px; | textstyle = color: red; font-weight: bold; font-style: italic; | text = The message body text. }}
The message body text. |
Image message box types
The following examples use different type parameters but use no image parameters thus they use the default images for each type.
type=speedy – Speedy deletion templates such as {{isd}}. |
type=delete – Deletion templates such as {{ifd}}. |
type=content – Major warnings and problems, such as {{non-free reduce}}. |
type=style – Minor warnings and problems, such as {{cleanup-image}}. |
type=notice – Notices and messages of any kind, both permanent and temporary. |
type=move – Move and rename messages and proposals, such as {{rename media}}. |
40x40px | type=protection – Protection templates such as {{pp-protected}} when shown on an image page. |
type=license – License templates such as {{GFDL}}. |
40x40px | type=featured – Featured image templates such as {{FeaturedPicture}}. |
Other images
The default images shown above are mostly for convenience. In many cases it is more appropriate to use more specific images. These examples use the image parameter to specify an image other than the default images.
type = style image = [[Image:Gnome-dev-camera.svg|42px]] This image is used for {{cleanup-image}}. |
52px | type = move image = [[Image:To Commons.svg|52px]] This image is used for {{copy to Wikimedia Commons}}. |
48px | type = license image = [[Image:Heckert GNU white.svg|48px]] This image is used for the GFDL license templates such as {{GFDL}}. |
Special
Some other parameter combinations.
No type and no image given (default) |
No type and image=none – No image is used and the text uses the whole message box area. |
| type = license image = [[Image:Imbox license.svg|40px]] <br> [[Image:Ambox warning yellow.svg|40px]] imageright = [[Image:Shuttle.svg|30px]] |
| This file is in the public domain because it was created by NASA.
Note that use of NASA logos, insignia and emblems are restricted per US law. |
type = license image = [[Image:Imbox license.svg|40px]] below = {{imbox | type = content | text = '''This license tag is deprecated!''' }} | |||
|
Parameters
List of all parameters:
{{imbox | type = speedy / delete / content / style / notice / move / protection / license / featured | image = none / [[Image:Some image.svg|40px]] | imageright = [[Image:Some image.svg|40px]] | style = CSS value | textstyle = CSS value | text = The message body text. | below = More text or another imbox. | plainlinks = no }}
type
- If no type parameter is given the template defaults to type notice. That means it gets a blue border.
image
- No parameter = If no image parameter is given the template uses a default image. Which default image it uses depends on the type parameter.
- An image = Should be an image with usual wiki notation. 40px - 50px width are usually about right depending on the image height to width ratio. (But the message box can handle images of any size.) For example:
image = [[Image:Gnome-dev-camera.svg|40px]]
- none = Means that no image is used.
imageright
- No parameter = If no imageright parameter is given then no image is shown on the right side.
- An image = Should be an image with usual wiki notation. 40px - 50px width are usually about right depending on the image height to width ratio. (But the message box can handle images of any size.) For example:
imageright = [[Image:Nuvola apps bookcase.png|40px]]
- Anything = Any other object that you want to show on the right side.
style
- An optional CSS value used by the entire message box table. Without quotation marks
" "
. For example:style = margin-bottom: 0.5em;
textstyle
- An optional CSS value used by the text cell. For example:
textstyle = text-align: center;
text
- The message body text.
below
- A full width area below the images and text area. Can take a text or any kind of object, for instance another imbox:
below = {{imbox | type = content | text = This license tag is deprecated. }}
plainlinks
- Defaults to yes. If external link arrows - 10px - are desired, specify:
plainlinks = no
Technical details
Namespace "Image:" was renamed to "File:" on 11 December 2008. This template was created long before that, and that is why it is named "imbox" as in "image message box".
If you need to use special characters in the text parameter then you need to escape them like this:
{{imbox | text = <div> Equal sign = and a start and end brace { } work fine as they are. But here is a pipe {{!}} and two end braces <nowiki>}}</nowiki>. And now a pipe and end braces <nowiki>|}}</nowiki>. </div> }}
Equal sign = and a start and end brace { } work fine as they are. But here is a pipe | and two end braces }}. And now a pipe and end braces |}}. |
This template uses the imbox CSS classes in MediaWiki:Common.css for most of its looks, thus it is fully skinnable.
Internally this meta-template uses HTML markup instead of wiki markup for the table code. That is the usual way we make meta-templates since wiki markup has several drawbacks. For instance it makes it harder to use parser functions and special characters in parameters.
The default images for this meta-template are in png format instead of svg format. The main reason is that some older web browsers have trouble with the transparent png images. For those older browsers these png images have been modified so that the color of their default backgrounds match the background color of the template. The default background that MediaWiki renders for svg images is always white. This creates a white box around the images when displayed in older browsers.
For more technical details see the talk page. Since this template works almost exactly like the other mboxes their talk pages and related pages might also contain more details, see the "See also" section below.
See also
- {{Ambox}}, for messageboxes on article pages.
- {{Cmbox}}, for messageboxes on category pages.
- {{Imbox}}, for messageboxes on file (image) pages.
- {{Tmbox}}, for messageboxes on talk pages.
- {{Fmbox}}, for header and footer messageboxes.
- {{Ombox}}, for messageboxes on other types of page.
- {{Mbox}}, for messageboxes that are used in different namespaces and change their presentation accordingly.
Closely related metatemplates:
- {{Asbox}}, for messageboxes in article stubs.
- {{Dmbox}}, for messageboxes on disambiguation or set-index pages.
- {{Ivmbox}}, a simple full-width box with default ivory background intended to frame important messages or notices.