Template:Mbox: Difference between revisions

From PZwiki
(new mbox)
 
(update)
Line 1: Line 1:
<noinclude>
<noinclude>
{{Documentation/sandbox|doc =
{{Documentation/sandbox|doc =
This template is used to create a {{Abbr|mbox|message box}}.
This template is used to create a {{ll|PZwiki:Mboxes|mbox}}.


Do not use this template directly, instead use one of the types listed [[#Types|below]].
Do not use this template directly, instead use one of the types listed in {{ll|PZwiki:Mboxes}}.


==Usage==
==Usage==
===Syntax===
<pre>
<pre>
{{Mbox
{{Mbox
Line 19: Line 20:
}}
}}
</pre>
</pre>
===Parameters===
;<code>background</code>
:Background color. Default is <code>#f8f9fa</code>.
;<code>color</code>
:Left bar color. Default is <code>#f28500</code>.
;<code>sign</code>
:Mbox image. Default is <code><nowiki>[[File:Imbox content.png|link=]]</nowiki></code>.
;<code>title</code>
:Mbox title. Displayed in bold and large font. Default is <code>This is an Mbox.</code>.
;<code>content</code>
:Normal text. Default is <code>This is content of the Mbox.</code>.
;<code>note</code>
:Bottom text. Displayed in italic and small font. Will be empty if not specified.
;<code>cat</code>
:Category name, omit <code>Category:</code> prefix. Will be empty if not specified.
;<code>id</code>
:Id for each Mbox to collapse the content. Should be unique. Recommended to use <code>mbox-xxx</code> format. Default is <code>mbox</code>.
;<code>collapsed</code>
:Initial state of the content. Will be collapsed if specified.
===Example===
===Example===
{{Mbox
{{Mbox
Line 30: Line 52:
| collapsed = true
| collapsed = true
}}
}}
==Types==
This is a collpasable element. You can toggle it by clicking the button on the top-right corner.
===Delete===
 
{{Mbox
When collapsed, the image, content and note will be hidden, only the title will be displayed.
| background = #ffeeee
| color = #b22222
| sign = [[File:Imbox deletion.png|link=]]
| title = This page is a candidate for deletion.
| content = Reason: ...
| note = This page (and any subpages) will be deleted if '''1 week''' after this notice was added and no one has objected to its deletion. Users may discuss this request for speedy deletion on the page's [[{{TALKPAGENAME}}|talk page]].
| cat = <!-- Pages requested for deletion -->
| id = delmbox
}}
===Deprecated===
{{Mbox
| color = #f28500
| sign = [[File:Imbox content.png|link=]]
| title = This template is [[Help:Deprecation|deprecated]].
| content = Please use ... instead.
| note = This template will eventually be removed.
| cat = <!-- Deprecated templates -->
| id = depmbox
}}
===Future===
{{Mbox
| color = #ff00aa
| sign = [[File:PictureKate.png|link=]]
| title = This is a future feature.
| content = This article/section is about an item or mechanic that is currently '''unimplemented''' and planned for Build xx.
| note = It has either been previewed or found in the game files and does not exist yet.
| cat = <!-- Future -->
| id = futmbox
}}
===Improve===
{{Mbox
| color = #f4c430
| sign = [[File:WhiskeyHalf.png|link=]]
| title = This article/section may be in need of improvement.
| content = Editors are encouraged to add any missing information to the article, while verifying that the article's current content is correct.
| cat = <!-- Articles in need of improvement -->
| id = impmbox
}}
===Maintenance===
{{Mbox
| color = #f28500
| sign = [[File:NailsBox.png|link=]]
| title = This page has recently undergone maintenance.
| content = There could have potentially broken parts of the page. If you notice any issues, we'd appreciate it if you reported them on the [[PZwiki:Community portal|community portal]].
| id = mainmbox
}}
===Merge===
{{Mbox
| color = #9932cc
| sign = [[File:Furniture Pickup.png|link=]]
| title = It has been suggested that this article be merged with xxx.
| content = Reason: ...
| cat = <!-- Articles to be merged -->
| id = mergmbox
}}
===Move===
{{Mbox
| color = #9932cc
| sign = [[File:Furniture Pickup.png|link=]]
| title = It has been suggested that this article be moved to xxx.
| content = Reason: ...
| cat = <!-- Articles to be moved -->
| id = movembox
}}
===Obsolete===
{{Mbox
| color = #f28500
| sign = [[File:BoxSmall.png|40px|link=]]
| title = This item or feature is obsolete.
| content = It has been removed from the game or replaced by something else.
| cat = <!-- Obsolete items -->
| id = obsmbox
}}
===Outdated===
{{Mbox
| color = #00ffaa
| sign = [[File:AppleRotten.png|link=]]
| title = This article/section may be outdated.
| content = Editors are encouraged to update this article/section with new information.
| cat = <!-- Outdated articles -->
| id = outmbox
}}
===Protection===
{{Mbox
| color = #bbbbaa
| sign = [[File:Lock-locked.png|link=]]
| title = This page has been put into protection by a PZwiki [[PZwiki:Administrators|administrator]].
| content = Reason: xxx.
| id = protmbox
}}
===Reupload===
{{Mbox
| color = #1e90ff
| sign = [[File:Frame.png|link=]]
| title = This article contains outdated/low-quality [[Help:Images|images]].
| content = Please help the PZwiki by [[Special:Upload|uploading]] an improved/updated version of the image(s) found on this page.
| cat = <!-- Images in need of improvement -->
| id = reupmbox
}}
===Spoiler===
{{Mbox
| color = #ff6666
| sign = [[File:Pillow.png|link=]]
| title = SPOILER WARNING!!!
| content = This section is likely to contain major spoilers pertaining to the story of Project Zomboid.
| id = spolmbox
}}
===Stub===
{{Mbox
| color = #00aaff
| sign = [[File:Notebook.png|link=]]
| title = This article/section may need more content.
| content = Editors are encouraged to add new material to the page while expanding upon current topics.
| cat = <!-- Stub articles -->
| id = stubmbox
}}
===Testing===
{{Mbox
| color = #ff00aa
| sign = [[File:Profession engineer.png|40px|link=]]
| title = This is a testing feature.
| content = This article/section is about an item or mechanic that is currently in '''testing''' and not part of the stable version of the game.
| note = This feature can be accessed via the testing branch for xxx.
| cat = <!-- Testing -->
| id = testmbox
}}
===Translate===
{{Mbox
| color = #f4c430
| sign = [[File:Translation icon.png|link=]]
| title = This article/section needs to be translated.
| content = Editors are encouraged to translate this page to the best of their ability.
| cat = <!-- Translation needed -->
| id = transmbox
}}
===WIP===
{{Mbox
| color = #ee0000
| sign = [[File:Hammer.png|link=]]
| title = This article or section is currently under construction.
| content = It is in the process of an expansion or major restructuring. You are welcome to assist in its construction by editing it as well.
| note = If this page has not been updated in a while, please remove this notice. Last edit was xx/xx/xx.
| cat = <!-- WIP articles -->
| id = wipmbox
}}
===Unverified===
{{Mbox
| color = #ee0000
| sign = [[File:CandleLit.png|link=]]
| title = This article may have claims which require verification.
| content = Editors should verify the article's current content and, while adding content, check new information.
| cat = <!-- Articles require verification -->
| id = unvembox
}}


{{Translation guide}}
{{Translation guide}}
==See also==
*{{ll|PZwiki:Mboxes}}
}}
}}
{{ll|Category:Metatemplates}}
{{ll|Category:Metatemplates}}
{{ll|Category:Mbox templates}}
</noinclude><includeonly><div class="mbox" {{#if:{{{background|}}}|style="background-color: {{{background}}};"}}>{{#if:{{{cat|}}}|{{ll|Category:{{{cat}}}}}}}
</noinclude><includeonly><div class="mbox" {{#if:{{{background|}}}|style="background-color: {{{background}}};"}}>{{#if:{{{cat|}}}|{{ll|Category:{{{cat}}}}}}}
   <div {{#if:{{{color|}}}|style="background-color: {{{color}}};"}}></div>
   <div {{#if:{{{color|}}}|style="background-color: {{{color}}};"}}></div>

Revision as of 03:23, 29 December 2023

Notebook.pngTemplate Documentation

This template is used to create a mbox.

Do not use this template directly, instead use one of the types listed in PZwiki:Mboxes.

Usage

Syntax

{{Mbox
| background = background color
| color = left bar colors
| sign = image (collapsible)
| title = title
| content = normal text (collapsible)
| note = bottom text (collapsible)
| cat = category name, omit 'Category:'
| id = id for each Mbox
| collapsed = initial state
}}

Parameters

background
Background color. Default is #f8f9fa.
color
Left bar color. Default is #f28500.
sign
Mbox image. Default is [[File:Imbox content.png|link=]].
title
Mbox title. Displayed in bold and large font. Default is This is an Mbox..
content
Normal text. Default is This is content of the Mbox..
note
Bottom text. Displayed in italic and small font. Will be empty if not specified.
cat
Category name, omit Category: prefix. Will be empty if not specified.
id
Id for each Mbox to collapse the content. Should be unique. Recommended to use mbox-xxx format. Default is mbox.
collapsed
Initial state of the content. Will be collapsed if specified.

Example

Imbox content.png
◥
This is an Mbox.
This is content of the Mbox.
This is a note of the Mbox.

This is a collpasable element. You can toggle it by clicking the button on the top-right corner.

When collapsed, the image, content and note will be hidden, only the title will be displayed.

How to translate

This template doesn't need to/shouldn't be translated, but you can translate the documentation of this template with the following steps:

  1. Create a subpage of this template with the language code of the language you want to translate to.
  2. Copy the code wrapped in the <noinclude> tag in this template into the page you created.
    {{Translation guide}} template should be removed from the translated documentation.
  3. Translate the page according to the translation requirements of normal pages.

See also

Editors can experiment in this template's sandbox.
Retrieved from "https://pzwiki.net/w/index.php?title=Template:Mbox&oldid=185543"