Difference between revisions of "Template:Imbox/doc"

From RimWorld Wiki
Jump to navigation Jump to search
m
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<includeonly>{{high-risk| 20,000+ }}</includeonly>
 
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
 
{{mbox templates}}
 
{{mbox templates}}
Line 10: Line 9:
  
 
=== We are deploying! ===
 
=== We are deploying! ===
 
After long discussion on the [[Template talk:Imbox|talk page]] of this template and at other places we are finally deploying this template. Feel free to convert any message boxes used on file pages to use this meta-template. If you find any tricky cases then list them on the talk page of this template and you'll get help.
 
  
 
When this template is used to build image message boxes those boxes should contain explanatory texts just like before. (The same texts as before or new improved texts.) If there are more specific images in the boxes or you know a better image, then use them instead of the default images shown here.
 
When this template is used to build image message boxes those boxes should contain explanatory texts just like before. (The same texts as before or new improved texts.) If there are more specific images in the boxes or you know a better image, then use them instead of the default images shown here.
Line 31: Line 28:
 
{{imbox
 
{{imbox
 
| type      = style
 
| type      = style
| image    = [[Image:Emblem-question-yellow.svg|40px]]
+
| image    = [[Image:Emblem-question-yellow.png|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;
Line 40: Line 37:
 
{{imbox
 
{{imbox
 
| type      = style
 
| type      = style
| image    = [[Image:Emblem-question-yellow.svg|40px]]
+
| image    = [[Image:Emblem-question-yellow.png|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;
Line 93: Line 90:
 
{{imbox
 
{{imbox
 
| type  = style
 
| type  = style
| image = [[Image:Gnome-dev-camera.svg|42px]]
+
| image = [[Image:IdeologyIcon.png|42px]]
| text  = type = style <br> image = <nowiki>[[Image:Gnome-dev-camera.svg|42px]]</nowiki>.  
+
| text  = type = style <br> image = <nowiki>[[Image:IdeologyIcon.png|42px]]</nowiki>.  
 
}}
 
}}
 
{{imbox
 
{{imbox
 
| type  = move
 
| type  = move
| image = [[Image:To Commons.svg|52px]]
+
| image = [[File:Double Eleven Logo Only.png|52px]]
| text  = type = move <br> image = <nowiki>[[Image:To Commons.svg|52px]]</nowiki>.  
+
| text  = type = move <br> image = <nowiki>[[File:Double Eleven Logo Only.png|52px]]</nowiki>.  
 
}}
 
}}
 
{{imbox
 
{{imbox
 
| type  = license
 
| type  = license
| image = [[Image:Heckert GNU white.svg|48px]]
+
| image = [[Image:RoyaltyIcon.png|48px]]
| text  = type = license <br> image = <nowiki>[[Image:Heckert GNU white.svg|48px]]</nowiki>.
+
| text  = type = license <br> image = <nowiki>[[Image:RoyaltyIcon.png|48px]]</nowiki>.
 
}}
 
}}
  
Line 121: Line 118:
 
{{imbox
 
{{imbox
 
| type = license
 
| type = license
| image = [[Image:Imbox license.svg|40px]] <br> [[Image:Ambox warning yellow.png|40px]]
+
| image = [[Image:Copyright.png|40px]] <br> [[Image:Ambox warning yellow.png|40px]]
| imageright = [[Image:Shuttle.svg|30px]]
+
| imageright = [[Image:Double Eleven Logo.png|30px]]
| text  = type = license <br> image = <nowiki>[[Image:Imbox license.svg|40px]] &lt;br> [[Image:Ambox warning yellow.png|40px]]</nowiki> <br> imageright = <nowiki>[[Image:Shuttle.svg|30px]]</nowiki>
+
| text  = type = license <br> image = <nowiki>[[Image:Copyright.png|40px]] &lt;br> [[Image:Ambox warning yellow.png|40px]]</nowiki> <br> imageright = <nowiki>[[Image:Double Eleven Logo.png|30px]]</nowiki>
 
}}
 
}}
  
 
{{imbox
 
{{imbox
 
| type = license
 
| type = license
| image = [[Image:Imbox license.svg|40px]] <br> [[Image:Ambox warning yellow.png|40px]]
+
| image = [[Image:Copyright.png|40px]] <br> [[Image:Ambox warning yellow.png|40px]]
| imageright = [[Image:Shuttle.svg|30px]]
+
| imageright = [[Image:Double Eleven Logo.png|30px]]
| text  = '''This file is in the public domain because it was created by NASA.'''
+
| text  = '''This file is in the public domain because it was created by Double Eleven Logo.'''
<br>Note that use of NASA logos, insignia and emblems are restricted per US law.
+
<br>Note that use of Double Eleven logos, insignia and emblems are restricted per US law.
 
}}
 
}}
  
 
{{imbox
 
{{imbox
 
| type      = license
 
| type      = license
| image      = [[Image:Imbox license.svg|40px]]
+
| image      = [[Image:Copyright.png|40px]]
 
| text      =  
 
| text      =  
type = license <br> image = <nowiki>[[Image:Imbox license.svg|40px]]</nowiki> <br> below = <nowiki>{{imbox | type = content | text = '''This license tag is deprecated!''' }}</nowiki>
+
type = license <br> image = <nowiki>[[Image:Copyright.png|40px]]</nowiki> <br> below = <nowiki>{{imbox | type = content | text = '''This license tag is deprecated!''' }}</nowiki>
 
| below =  
 
| below =  
 
   {{imbox
 
   {{imbox

Latest revision as of 01:34, 24 April 2023

Modal Info Icon.png Message box templates {{ambox}} • {{asbox}} • {{cmbox}} • {{dmbox}} • {{fmbox}} • {{imbox}} • {{ombox}} • {{tmbox}}

This is the {{imbox}} or image message box meta-template.

It is used to build message box templates for file (image) pages. 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.

We are deploying![edit]

When this template is used to build image message boxes those boxes should contain explanatory texts just like before. (The same texts as before or new improved texts.) If there are more specific images in the boxes or you know a better image, then use them instead of the default images shown here.

Usage[edit]

Simple usage example:

{{imbox | text = Some text.}}


Complex example:

{{imbox
| type      = style
| image     = [[Image:Emblem-question-yellow.png|40px]]
| style     = width: 400px; 
| textstyle = color: red; font-weight: bold; font-style: italic;
| text      = The message body text.
}}

Image message box types[edit]

The following examples use different type parameters but use no image parameters thus they use the default images for each type.

Other images[edit]

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.

Special[edit]

Some other parameter combinations.

Parameters[edit]

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.
}}

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. }}

Technical details[edit]

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>
}}

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.

Modal Info Icon.png Message box templates {{ambox}} • {{asbox}} • {{cmbox}} • {{dmbox}} • {{fmbox}} • {{imbox}} • {{ombox}} • {{tmbox}}