Template:Mbox: Difference between revisions

From PZwiki
(update)
(doc: added protection notice)
(12 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<noinclude>
<noinclude>
{{Documentation/sandbox|doc =
{{Documentation/sandbox|doc =
This template is used to create a {{ll|PZwiki:Mboxes|mbox}}.
{{Protection}}
This template is used to create a collapsible {{ll|PZwiki:Mboxes|mbox}}.


Do not use this template directly, instead use one of the types listed in {{ll|PZwiki:Mboxes}}.
This is a [[mw:Manual:Collapsible elements|collapsible element]]. You can toggle it by clicking the "◥" sign on the top-right corner.
 
When collapsed, the image, content and note will be hidden, only the title will be displayed.


==Usage==
==Usage==
Do not use this template directly, use one of the types listed in {{ll|PZwiki:Mboxes}} instead.
===Syntax===
===Syntax===
<pre>
<pre>
{{Mbox
{{Mbox
| background = background color
| background =  
| color = left bar colors
| color =  
| sign = image (collapsible)
| sign =  
| title = title
| title =  
| content = normal text (collapsible)
| content =  
| note = bottom text (collapsible)
| note =  
| cat = category name, omit 'Category:'
| cat =  
| id = id for each Mbox
| id =  
| collapsed = initial state
| collapsed =  
}}
}}
</pre>
</pre>
Line 23: Line 28:
===Parameters===
===Parameters===
;<code>background</code>
;<code>background</code>
:Background color. Default is <code>#f8f9fa</code>.
:Background color. Default to <code>#f8f9fa</code>.
;<code>color</code>
;<code>color</code>
:Left bar color. Default is <code>#f28500</code>.
:Left bar color. Default to <code>#eaecf0</code>.
;<code>sign</code>
;<code>sign</code>
:Mbox image. Default is <code><nowiki>[[File:Imbox content.png|link=]]</nowiki></code>.
:Mbox image. Default to <code><nowiki>[[File:Imbox content.png|link=]]</nowiki></code>.
;<code>title</code>
;<code>title</code>
:Mbox title. Displayed in bold and large font. Default is <code>This is an Mbox.</code>.
:Mbox title. Displayed in bold and large font.
;<code>content</code>
;<code>content</code>
:Normal text. Default is <code>This is content of the Mbox.</code>.
:Normal text.
;<code>note</code>
;<code>note</code>
:Bottom text. Displayed in italic and small font. Will be empty if not specified.
:Bottom text. Displayed in italic and small font.
;<code>cat</code>
;<code>cat</code>
:Category name, omit <code>Category:</code> prefix. Will be empty if not specified.
:Category name, omit <code>Category:</code> prefix.
;<code>id</code>
;<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>.
:Id for each Mbox to collapse the content. Should be unique. Recommended to use the template name. The mbox will not be collapsible if not specified.
;<code>collapsed</code>
;<code>collapsed</code>
:Initial state of the content. Will be collapsed if specified.
:Initial state of the content. Will be collapsed if set to <code>true</code>. Only works when <code>id</code> is specified.


===Example===
==Example==
<pre>
{{Mbox
| title = This is an Mbox.
| content = This is content of the Mbox.
| note = This is a note of the Mbox.
| id = example
| collapsed = true
}}
</pre>
{{Mbox
{{Mbox
| background = #f8f9fa
| color = #f28500
| sign = [[File:Imbox content.png|link=]]
| title = This is an Mbox.
| title = This is an Mbox.
| content = This is content of the Mbox.
| content = This is content of the Mbox.
| note = This is a note of the Mbox.
| note = This is a note of the Mbox.
| id = mbox
| id = example
| collapsed = true
| collapsed = true
}}
}}
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.


{{Translation guide}}
{{Translation guide}}
Line 61: Line 69:
*{{ll|PZwiki:Mboxes}}
*{{ll|PZwiki:Mboxes}}


==Attribution==
*[https://oxygennotincluded.fandom.com/zh/wiki/Template:%E9%80%9A%E7%9F%A5%E6%A1%86 Mbox on Chinese Oxygen Not Included Wiki]
}}
}}
{{ll|Category:Metatemplates}}
{{ll|Category:Metatemplates}}
{{ll|Category:Mbox templates}}
{{ll|Category:Mbox}}
</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}}};"}}>
   <div {{#if:{{{color|}}}|style="background-color: {{{color}}};"}}></div>
   <div {{#if:{{{color|}}}|style="background-color: {{{color}}};"}}></div>
   <div class="mw-collapsible {{#if:{{{collapsed|}}}|mw-collapsed}}" id="mw-customcollapsible-{{#if:{{{id|}}}|{{{id}}}|mbox}}">{{#if:{{{sign|}}}|{{{sign}}}|[[File:Imbox content.png|link=]]}}</div>
   <div {{#if:{{{id|}}}
   <div class="mbox-toggle mw-customtoggle-{{#if:{{{id|}}}|{{{id}}}|mbox}}" title="toggle"></div>
    | class="mw-collapsible {{yesno|{{{collapsed|}}}|yes=mw-collapsed|def=[[Category:Incorrect template usage]]}}" id="mw-customcollapsible-mbox-{{{id}}}"
    }}>{{#if:{{{sign|}}}|{{{sign}}}|[[File:Imbox content.png|link=]]}}</div>
   {{#if:{{{id|}}}
  | <div class="toggle mw-customtoggle-mbox-{{{id}}}" title="{{int:show}}/{{int:hide}}"></div>
  }}
   <div>
   <div>
     <div style="font-size: 120%; font-weight: bold;">{{#if:{{{title|}}}|{{{title}}}|Mbox title.}}</div>
     {{#if:{{{title|}}}
     <div class="mw-collapsible {{#if:{{{collapsed|}}}|mw-collapsed}}" id="mw-customcollapsible-{{#if:{{{id|}}}|{{{id}}}|mbox}}">{{#if:{{{content|}}}|{{{content}}}|Mbox content.}}</div>
    | <div style="font-size: 120%; font-weight: bold; padding-right: 1em;">{{{title}}}</div>
    }}
     <div {{#if:{{{id|}}}
      | class="mw-collapsible {{yesno|{{{collapsed|}}}|yes=mw-collapsed|def=}}" id="mw-customcollapsible-mbox-{{{id}}}"
      }}>{{#if:{{{content|}}}|{{{content}}}}}</div>
     {{#if: {{{note|}}}
     {{#if: {{{note|}}}
     | <div class="mw-collapsible {{#if:{{{collapsed|}}}|mw-collapsed}}" id="mw-customcollapsible-{{#if:{{{id|}}}|{{{id}}}|mbox}}" style="font-size: 80%; font-style: italic;">{{{note}}}</div>
     | <div {{#if:{{{id|}}}
        | class="mw-collapsible {{yesno|{{{collapsed|}}}|yes=mw-collapsed|def=}}" id="mw-customcollapsible-mbox-{{{id}}}"
        }} style="font-size: 80%; font-style: italic;">{{{note}}}</div>
     }}
     }}
   </div>
   </div>
</div></includeonly>
</div>{{#if:{{{cat|}}}|[[Category:{{{cat}}}]]}}</includeonly>

Revision as of 02:07, 10 February 2024

Notebook.pngTemplate Documentation
Lock-locked.png
This page has been put into protection by a PZwiki administrator.
Only users in the sysop user group may edit this page.

This template is used to create a collapsible mbox.

This is a collapsible element. You can toggle it by clicking the "◥" sign on the top-right corner.

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

Usage

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

Syntax

{{Mbox
| background = 
| color = 
| sign = 
| title = 
| content = 
| note = 
| cat = 
| id = 
| collapsed = 
}}

Parameters

background
Background color. Default to #f8f9fa.
color
Left bar color. Default to #eaecf0.
sign
Mbox image. Default to [[File:Imbox content.png|link=]].
title
Mbox title. Displayed in bold and large font.
content
Normal text.
note
Bottom text. Displayed in italic and small font.
cat
Category name, omit Category: prefix.
id
Id for each Mbox to collapse the content. Should be unique. Recommended to use the template name. The mbox will not be collapsible if not specified.
collapsed
Initial state of the content. Will be collapsed if set to true. Only works when id is specified.

Example

{{Mbox
| title = This is an Mbox.
| content = This is content of the Mbox.
| note = This is a note of the Mbox.
| id = example
| collapsed = true
}}
Imbox content.png
This is an Mbox.
This is content of the Mbox.
This is a note of the Mbox.

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

Attribution

Editors can experiment in this template's sandbox.