Module:Message box/configuration/doc/en

From Convention Master Documentation
Jump to navigation Jump to search

{{#ifeq:en|doc||{{#switch:<translate></translate> | = {{#if:{{#ifexpr: ( {{#ifeq:en|doc|1|0}} or ( {{#ifeq:{{#titleparts:module:message box/configuration/doc/en|-1|-2}}|doc|1|0}} and {{#if:{{#translation:}}|1|0}} ) )|1|}}

    | 

{{#ifeq:show |show

         | Lua error: Cannot create process: proc_open(/dev/null): Failed to open stream: Operation not permitted
        }}{{#if: |
         |   {{#ifexist:Module:Message box/configuration/doc
                  | [[Category:{{#switch:Module
                          | Template | Project = Template
                          | Module   = Module
                          | User     = User
                          | #default = MediaWiki
                      }} documentation pages{{#translation:}}]]
                  | [[Category:Documentation subpages without corresponding pages{{#translation:}}]]
                 }}
        }}
    | 
   }}

| #default=

 Lua error: Cannot create process: proc_open(/dev/null): Failed to open stream: Operation not permitted

}}}}<languages />{{#switch: | =

{{#switch:<translate></translate> | = Lua error: Cannot create process: proc_open(/dev/null): Failed to open stream: Operation not permitted | #default=

 Lua error: Cannot create process: proc_open(/dev/null): Failed to open stream: Operation not permitted

}} {{#switch:

 {{#if:
 |     
 | {{#ifeq:Module|Module
   | module
   | other
   }}
 }}

| module = Lua error: Cannot create process: proc_open(/dev/null): Failed to open stream: Operation not permitted | other | #default = Template:Error }} This module contains configuration data for Module:Message box.

Configuration options

Option Explanation
types A table containing data used by the type parameter of the message box. The table keys are the values that can be passed to the type parameter, and the table values are tables containing the class and the image used by that type.
default The type to use if no value was passed to the type parameter, or if an invalid value was specified.
showInvalidTypeError Whether to show an error if the value passed to the type parameter was invalid.
allowBlankParams Usually blank values are stripped from parameters passed to the module. However, whitespace is preserved for the parameters included in the allowBlankParams table.
allowSmall <templatestyles src="Template:Mono/styles.css"/>}}{{safesubst:#if:{{safesubst:#switch: 1 no n false 0 = = ¬ = yes y true 1 = yes #default = yes

}}|<templatestyles src="Template:Nowrap/styles.css"/>}}<{{safesubst:#if:|span class="monospaced {{safesubst:#if:{{safesubst:#switch: 1

no n false 0 = = ¬ = yes y true 1 = yes #default = yes

}}|nowrap}}"|code {{safesubst:#if:{{safesubst:#switch: 1

no n false 0 = = ¬ = yes y true 1 = yes #default = yes

}}|class="nowrap"}}}}>|{{safesubst:#if:small|small=}}1</{{safesubst:#if:|span|code}}>.

smallParam <templatestyles src="Template:Mono/styles.css"/>}}{{safesubst:#if:{{safesubst:#switch: 1 no n false 0 = = ¬ = yes y true 1 = yes #default = yes

}}|<templatestyles src="Template:Nowrap/styles.css"/>}}<{{safesubst:#if:|span class="monospaced {{safesubst:#if:{{safesubst:#switch: 1

no n false 0 = = ¬ = yes y true 1 = yes #default = yes

}}|nowrap}}"|code {{safesubst:#if:{{safesubst:#switch: 1

no n false 0 = = ¬ = yes y true 1 = yes #default = yes

}}|class="nowrap"}}}}>|{{safesubst:#if:small|small=}}</{{safesubst:#if:|span|code}}> parameter. For example, if set to {{#if:{{safesubst:#switch:

no n false 0 = = ¬ = yes y true 1 = yes #default = yes

}}|<templatestyles src="Template:Nowrap/styles.css"/>}}"left" you can produce a small message box using {{safesubst:#if:|<templatestyles src="Template:Mono/styles.css"/>}}{{safesubst:#if:{{safesubst:#switch: 1

no n false 0 = = ¬ = yes y true 1 = yes #default = yes

}}|<templatestyles src="Template:Nowrap/styles.css"/>}}<{{safesubst:#if:|span class="monospaced {{safesubst:#if:{{safesubst:#switch: 1

no n false 0 = = ¬ = yes y true 1 = yes #default = yes

}}|nowrap}}"|code {{safesubst:#if:{{safesubst:#switch: 1

no n false 0 = = ¬ = yes y true 1 = yes #default = yes

}}|class="nowrap"}}}}>|{{safesubst:#if:small|small=}}left</{{safesubst:#if:|span|code}}>.

smallClass The class to use for small message boxes.
substCheck Whether to perform a subst check or not.
classes An array of classes to use with the message box.
imageEmptyCell

}}{{#switch:pair

close = single open pair = ‎<td{{#if:| {{{params}}}}}

}}{{#switch:pair

close = single = /> open = > pair = >...

}}{{#switch:pair

single open = close pair = ‎</td>

}}{{#if:|

}} cell if there is no image set. This is used to preserve spacing for message boxes with a width of less than 100% of the screen.

imageEmptyCellStyle Whether empty image cells should be styled.
imageCheckBlank <templatestyles src="Template:Mono/styles.css"/>}}{{safesubst:#if:{{safesubst:#switch: 1 no n false 0 = = ¬ = yes y true 1 = yes #default = yes

}}|<templatestyles src="Template:Nowrap/styles.css"/>}}<{{safesubst:#if:|span class="monospaced {{safesubst:#if:{{safesubst:#switch: 1

no n false 0 = = ¬ = yes y true 1 = yes #default = yes

}}|nowrap}}"|code {{safesubst:#if:{{safesubst:#switch: 1

no n false 0 = = ¬ = yes y true 1 = yes #default = yes

}}|class="nowrap"}}}}>|{{safesubst:#if:image|image=}}blank</{{safesubst:#if:|span|code}}> results in no image being displayed.

imageSmallSize Usually, images used in small message boxes are set to 30x30px. This sets a custom size.
imageCellDiv

}}{{#switch:o

close = single open pair = ‎<div{{#if:| {{{params}}}}}

}}{{#switch:o

close = single = /> open = > pair = >...

}}{{#switch:o

single open = close pair = ‎</div>

}}{{#if:|

}} enforcing a maximum image size.

useCollapsibleTextFields Whether to use text fields that can be collapsed, i.e. {{#if:{{safesubst:#switch: no n false 0 = = ¬ = yes y true 1 = yes #default = yes

}}|<templatestyles src="Template:Nowrap/styles.css"/>}}"issue", {{#if:{{safesubst:#switch:

no n false 0 = = ¬ = yes y true 1 = yes #default = yes

}}|<templatestyles src="Template:Nowrap/styles.css"/>}}"fix", {{#if:{{safesubst:#switch:

no n false 0 = = ¬ = yes y true 1 = yes #default = yes

}}|<templatestyles src="Template:Nowrap/styles.css"/>}}"talk", etc. Currently only used in <templatestyles src="Template:Mono/styles.css"/>{{#if:{{safesubst:#switch:

no n false 0 = = ¬ = yes y true 1 = yes #default = yes

}}|<templatestyles src="Template:Nowrap/styles.css"/>}}{{[[{{#if:|{{{SISTER}}}Template|Template}}:ambox|ambox]]{{#if:||{{{2}}}}}{{#if:||{{{3}}}}}{{#if:||{{{4}}}}}{{#if:||{{{5}}}}}{{#if:||{{{6}}}}}{{#if:||{{{7}}}}}{{#if:||...}}}}.

imageRightNone <templatestyles src="Template:Mono/styles.css"/>}}{{safesubst:#if:{{safesubst:#switch: 1 no n false 0 = = ¬ = yes y true 1 = yes #default = yes

}}|<templatestyles src="Template:Nowrap/styles.css"/>}}<{{safesubst:#if:|span class="monospaced {{safesubst:#if:{{safesubst:#switch: 1

no n false 0 = = ¬ = yes y true 1 = yes #default = yes

}}|nowrap}}"|code {{safesubst:#if:{{safesubst:#switch: 1

no n false 0 = = ¬ = yes y true 1 = yes #default = yes

}}|class="nowrap"}}}}>|{{safesubst:#if:imageright|imageright=}}none</{{safesubst:#if:|span|code}}> results in no image being displayed on the right-hand side of the message box.

sectionDefault <templatestyles src="Template:Mono/styles.css"/>}}{{safesubst:#if:{{safesubst:#switch: 1 no n false 0 = = ¬ = yes y true 1 = yes #default = yes

}}|<templatestyles src="Template:Nowrap/styles.css"/>}}<{{safesubst:#if:|span class="monospaced {{safesubst:#if:{{safesubst:#switch: 1

no n false 0 = = ¬ = yes y true 1 = yes #default = yes

}}|nowrap}}"|code {{safesubst:#if:{{safesubst:#switch: 1

no n false 0 = = ¬ = yes y true 1 = yes #default = yes

}}|class="nowrap"}}}}>|{{safesubst:#if:section|section=}}</{{safesubst:#if:|span|code}}> parameter. Depends on useCollapsibleTextFields.

allowMainspaceCategories Allow categorisation in the main namespace.
templateCategory The name of a category to be placed on the template page.
templateCategoryRequireName <templatestyles src="Template:Mono/styles.css"/>}}{{safesubst:#if:{{safesubst:#switch: 1 no n false 0 = = ¬ = yes y true 1 = yes #default = yes

}}|<templatestyles src="Template:Nowrap/styles.css"/>}}<{{safesubst:#if:|span class="monospaced {{safesubst:#if:{{safesubst:#switch: 1

no n false 0 = = ¬ = yes y true 1 = yes #default = yes

}}|nowrap}}"|code {{safesubst:#if:{{safesubst:#switch: 1

no n false 0 = = ¬ = yes y true 1 = yes #default = yes

}}|class="nowrap"}}}}>|{{safesubst:#if:name|name=}}</{{safesubst:#if:|span|code}}> parameter is required to display the template category.

templateErrorCategory The name of the error category to be used on the template page.
templateErrorParamsToCheck An array of parameter names to check. If any are absent, the templateErrorCategory is applied to the template page.

[[Category:Module documentation pages{{#translation:}}]]

| #default=

 Lua error: Cannot create process: proc_open(/dev/null): Failed to open stream: Operation not permitted

}}