Module:Message box/configuration: Difference between revisions

Revision as of 23:25, 28 April 2024

{{#switch:<translate></translate> | = Template:Languages Template:Used in system Template:Module rating <translate> This module contains configuration data for <tvar name=1>Module:Message box</tvar>.

Configuration options

</translate> Template:(! class="wikitable plainrowheaders" ! scope="col" | <translate> Option</translate> ! scope="col" | <translate> Explanation</translate> |- ! scope="row" style="text-align:left;font-weight:normal" | types | <translate> A table containing data used by the type parameter of the message box.</translate> <translate> 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.</translate> |- ! scope="row" style="text-align:left;font-weight:normal" | default | <translate> The type to use if no value was passed to the type parameter, or if an invalid value was specified.</translate> |- ! scope="row" style="text-align:left;font-weight:normal" | showInvalidTypeError | <translate> Whether to show an error if the value passed to the type parameter was invalid.</translate> |- ! scope="row" style="text-align:left;font-weight:normal" | allowBlankParams | <translate> Usually blank values are stripped from parameters passed to the module.</translate> <translate> However, whitespace is preserved for the parameters included in the <tvar name=1>allowBlankParams</tvar> table.</translate> |- ! scope="row" style="text-align:left;font-weight:normal" | allowSmall | <translate> Whether a small version of the message box can be produced with <tvar name=1>Template:Para</tvar>.</translate> |- ! scope="row" style="text-align:left;font-weight:normal" | smallParam | <translate> A custom value for the <tvar name=1>Template:Para</tvar> parameter.</translate> <translate> For example, if set to <tvar name=1>Template:Inline-code</tvar> you can produce a small message box using <tvar name=2>Template:Para</tvar>.</translate> |- ! scope="row" style="text-align:left;font-weight:normal" | smallClass | <translate> The class to use for small message boxes.</translate> |- ! scope="row" style="text-align:left;font-weight:normal" | substCheck | <translate> Whether to perform a subst check or not.</translate> |- ! scope="row" style="text-align:left;font-weight:normal" | classes | <translate> An array of classes to use with the message box.</translate> |- ! scope="row" style="text-align:left;font-weight:normal" | imageEmptyCell | <translate> Whether to use an empty <tvar name=1>Template:Tag</tvar> cell if there is no image set.</translate> <translate> This is used to preserve spacing for message boxes with a width of less than <tvar name=1>100%</tvar> of the screen.</translate> |- ! scope="row" style="text-align:left;font-weight:normal" | imageEmptyCellStyle | <translate> Whether empty image cells should be styled.</translate> |- ! scope="row" style="text-align:left;font-weight:normal" | imageCheckBlank | <translate> Whether <tvar name=1>Template:Para</tvar> results in no image being displayed.</translate> |- ! scope="row" style="text-align:left;font-weight:normal" | imageSmallSize | <translate> Usually, images used in small message boxes are set to <tvar name=1>30x30px</tvar>.</translate> <translate> This sets a custom size.</translate> |- ! scope="row" style="text-align:left;font-weight:normal" | imageCellDiv | <translate> Whether to enclose the image in a <tvar name=1>Template:Tag</tvar> enforcing a maximum image size.</translate> |- ! scope="row" style="text-align:left;font-weight:normal" | useCollapsibleTextFields | <translate> Whether to use text fields that can be collapsed, i.e. <tvar name=1>Template:Inline-code</tvar>, <tvar name=2>Template:Inline-code</tvar>, <tvar name=3>Template:Inline-code</tvar>, etc.</translate> <translate> Currently only used in <tvar name=1>{{ambox}}</tvar>.</translate> |- ! scope="row" style="text-align:left;font-weight:normal" | imageRightNone | <translate> Whether <tvar name=1>Template:Para</tvar> results in no image being displayed on the right-hand side of the message box.</translate> |- ! scope="row" style="text-align:left;font-weight:normal" | sectionDefault | <translate> The default name for the <tvar name=1>Template:Para</tvar> parameter.</translate> <translate> Depends on <tvar name=1>useCollapsibleTextFields</tvar>.</translate> |- ! scope="row" style="text-align:left;font-weight:normal" | allowMainspaceCategories | <translate> Allow categorisation in the main namespace.</translate> |- ! scope="row" style="text-align:left;font-weight:normal" | templateCategory | <translate> The name of a category to be placed on the template page.</translate> |- ! scope="row" style="text-align:left;font-weight:normal" | templateCategoryRequireName | <translate> Whether the <tvar name=1>Template:Para</tvar> parameter is required to display the template category.</translate> |- ! scope="row" style="text-align:left;font-weight:normal" | templateErrorCategory | <translate> The name of the error category to be used on the template page.</translate> |- ! scope="row" style="text-align:left;font-weight:normal" | templateErrorParamsToCheck | <translate> An array of parameter names to check.</translate> <translate> If any are absent, the <tvar name=1>templateErrorCategory</tvar> is applied to the template page.</translate> Template:!) {{safesubst:#if:{{safesubst:#ifeq:configu|sandbox|1}}{{safesubst:#ifeq:configuration|doc|1}}|| }} | #default=

 {{#switch:

| = Template:Languages Template:Used in system Template:Module rating This module contains configuration data for Module:Message box.

Configuration options

Template:(! class="wikitable plainrowheaders" ! scope="col" | Option ! scope="col" | Explanation |- ! scope="row" style="text-align:left;font-weight:normal" | 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. |- ! scope="row" style="text-align:left;font-weight:normal" | default | The type to use if no value was passed to the type parameter, or if an invalid value was specified. |- ! scope="row" style="text-align:left;font-weight:normal" | showInvalidTypeError | Whether to show an error if the value passed to the type parameter was invalid. |- ! scope="row" style="text-align:left;font-weight:normal" | allowBlankParams | Usually blank values are stripped from parameters passed to the module. However, whitespace is preserved for the parameters included in the allowBlankParams table. |- ! scope="row" style="text-align:left;font-weight:normal" | allowSmall | Whether a small version of the message box can be produced with Template:Para. |- ! scope="row" style="text-align:left;font-weight:normal" | smallParam | A custom value for the Template:Para parameter. For example, if set to Template:Inline-code you can produce a small message box using Template:Para. |- ! scope="row" style="text-align:left;font-weight:normal" | smallClass | The class to use for small message boxes. |- ! scope="row" style="text-align:left;font-weight:normal" | substCheck | Whether to perform a subst check or not. |- ! scope="row" style="text-align:left;font-weight:normal" | classes | An array of classes to use with the message box. |- ! scope="row" style="text-align:left;font-weight:normal" | imageEmptyCell | Whether to use an empty Template:Tag 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. |- ! scope="row" style="text-align:left;font-weight:normal" | imageEmptyCellStyle | Whether empty image cells should be styled. |- ! scope="row" style="text-align:left;font-weight:normal" | imageCheckBlank | Whether Template:Para results in no image being displayed. |- ! scope="row" style="text-align:left;font-weight:normal" | imageSmallSize | Usually, images used in small message boxes are set to 30x30px. This sets a custom size. |- ! scope="row" style="text-align:left;font-weight:normal" | imageCellDiv | Whether to enclose the image in a Template:Tag enforcing a maximum image size. |- ! scope="row" style="text-align:left;font-weight:normal" | useCollapsibleTextFields | Whether to use text fields that can be collapsed, i.e. Template:Inline-code, Template:Inline-code, Template:Inline-code, etc. Currently only used in {{ambox}}. |- ! scope="row" style="text-align:left;font-weight:normal" | imageRightNone | Whether Template:Para results in no image being displayed on the right-hand side of the message box. |- ! scope="row" style="text-align:left;font-weight:normal" | sectionDefault | The default name for the Template:Para parameter. Depends on useCollapsibleTextFields. |- ! scope="row" style="text-align:left;font-weight:normal" | allowMainspaceCategories | Allow categorisation in the main namespace. |- ! scope="row" style="text-align:left;font-weight:normal" | templateCategory | The name of a category to be placed on the template page. |- ! scope="row" style="text-align:left;font-weight:normal" | templateCategoryRequireName | Whether the Template:Para parameter is required to display the template category. |- ! scope="row" style="text-align:left;font-weight:normal" | templateErrorCategory | The name of the error category to be used on the template page. |- ! scope="row" style="text-align:left;font-weight:normal" | templateErrorParamsToCheck | An array of parameter names to check. If any are absent, the templateErrorCategory is applied to the template page. Template:!) {{safesubst:#if:{{safesubst:#ifeq:configu|sandbox|1}}{{safesubst:#ifeq:configuration|doc|1}}|| }} | #default=

 Lua error: expandTemplate: template loop detected.

}} }}

--------------------------------------------------------------------------------
--                          Message box configuration                         --
--                                                                            --
-- This module contains configuration data for [[Module:Message box]].        --
--------------------------------------------------------------------------------

return {
	ambox = {
		types = {
			speedy = {
				class = 'ambox-speedy',
				image = 'Ambox warning pn.svg'
			},
			delete = {
				class = 'ambox-delete',
				image = 'Ambox warning pn.svg'
			},
			content = {
				class = 'ambox-content',
				image = 'Ambox important.svg'
			},
			style = {
				class = 'ambox-style',
				image = 'Edit-clear.svg'
			},
			move = {
				class = 'ambox-move',
				image = 'Merge-split-transwiki default.svg'
			},
			protection = {
				class = 'ambox-protection',
				image = 'Semi-protection-shackle-keyhole.svg'
			},
			notice = {
				class = 'ambox-notice',
				image = 'Information icon4.svg'
			}
		},
		default                     = 'notice',
		allowBlankParams            = {'talk', 'sect', 'date', 'issue', 'fix', 'subst', 'hidden'},
		allowSmall                  = true,
		smallParam                  = 'left',
		smallClass                  = 'mbox-small-left',
		substCheck                  = true,
		classes                     = {'metadata', 'ambox'},
		imageEmptyCell              = true,
		imageCheckBlank             = true,
		imageSmallSize              = '20x20px',
		imageCellDiv                = true,
		useCollapsibleTextFields    = true,
		imageRightNone              = true,
		sectionDefault              = 'article',
		allowMainspaceCategories    = true,
		templateCategory            = 'Article message templates',
	        templateCategoryRequireName = true,
		templateErrorCategory       = 'Article message templates with missing parameters',
		templateErrorParamsToCheck  = {'issue', 'fix', 'subst'},
		removalNotice               = '<small>[[Help:Maintenance template removal|Learn how and when to remove this message]]</small>',
		templatestyles              = 'Module:Message box/ambox.css'
	},
	
	cmbox = {
		types = {
			speedy = {
				class = 'cmbox-speedy',
				image = 'Ambox warning pn.svg'
			},
			delete = {
				class = 'cmbox-delete',
				image = 'Ambox warning pn.svg'
			},
			content = {
				class = 'cmbox-content',
				image = 'Ambox important.svg'
			},
			style = {
				class = 'cmbox-style',
				image = 'Edit-clear.svg'
			},
			move = {
				class = 'cmbox-move',
				image = 'Merge-split-transwiki default.svg'
			},
			protection = {
				class = 'cmbox-protection',
				image = 'Semi-protection-shackle-keyhole.svg'
			},
			notice = {
				class = 'cmbox-notice',
				image = 'Information icon4.svg'
			}
		},
		default              = 'notice',
		showInvalidTypeError = true,
		classes              = {'cmbox'},
		imageEmptyCell       = true,
		templatestyles       = 'Module:Message box/cmbox.css'
	},
	
	fmbox = {
		types = {
			warning = {
				class = 'fmbox-warning',
				image = 'Ambox warning pn.svg'
			},
			editnotice = {
				class = 'fmbox-editnotice',
				image = 'Information icon4.svg'
			},
			system = {
				class = 'fmbox-system',
				image = 'Information icon4.svg'
			}
		},
		default              = 'system',
		showInvalidTypeError = true,
		classes              = {'fmbox'},
		imageEmptyCell       = false,
		imageRightNone       = false,
		templatestyles       = 'Module:Message box/fmbox.css'
	},
	
	imbox = {
		types = {
			speedy = {
				class = 'imbox-speedy',
				image = 'Ambox warning pn.svg'
			},
			delete = {
				class = 'imbox-delete',
				image = 'Ambox warning pn.svg'
			},
			content = {
				class = 'imbox-content',
				image = 'Ambox important.svg'
			},
			style = {
				class = 'imbox-style',
				image = 'Edit-clear.svg'
			},
			move = {
				class = 'imbox-move',
				image = 'Merge-split-transwiki default.svg'
			},
			protection = {
				class = 'imbox-protection',
				image = 'Semi-protection-shackle-keyhole.svg'
			},
			license = {
				class = 'imbox-license licensetpl',
				image = 'Imbox-license.svg'
			},
			["license-related"] = {
				class = 'imbox-license',
				image = 'Imbox-license.svg'
			},
			featured = {
				class = 'imbox-featured',
				image = 'Cscr-featured.svg',
				imageNeedsLink = true
			},
			notice = {
				class = 'imbox-notice',
				image = 'Information icon4.svg'
			}
		},
		default              = 'notice',
		showInvalidTypeError = true,
		classes              = {'imbox'},
		imageEmptyCell       = true,
		below                = true,
		templateCategory     = 'File message boxes',
		templatestyles       = 'Module:Message box/imbox.css'
	},
	
	ombox = {
		types = {
			speedy = {
				class = 'ombox-speedy',
				image = 'Ambox warning pn.svg'
			},
			delete = {
				class = 'ombox-delete',
				image = 'Ambox warning pn.svg'
			},
			content = {
				class = 'ombox-content',
				image = 'Ambox important.svg'
			},
			style = {
				class = 'ombox-style',
				image = 'Edit-clear.svg'
			},
			move = {
				class = 'ombox-move',
				image = 'Merge-split-transwiki default.svg'
			},
			protection = {
				class = 'ombox-protection',
				image = 'Semi-protection-shackle-keyhole.svg'
			},
			notice = {
				class = 'ombox-notice',
				image = 'Information icon4.svg'
			}
		},
		default              = 'notice',
		showInvalidTypeError = true,
		classes              = {'ombox'},
		allowSmall           = true,
		imageEmptyCell       = true,
		imageRightNone       = true,
		templatestyles       = 'Module:Message box/ombox.css'
	},
	
	tmbox = {
		types = {
			speedy = {
				class = 'tmbox-speedy',
				image = 'Ambox warning pn.svg'
			},
			delete = {
				class = 'tmbox-delete',
				image = 'Ambox warning pn.svg'
			},
			content = {
				class = 'tmbox-content',
				image = 'Ambox important.svg'
			},
			style = {
				class = 'tmbox-style',
				image = 'Edit-clear.svg'
			},
			move = {
				class = 'tmbox-move',
				image = 'Merge-split-transwiki default.svg'
			},
			protection = {
				class = 'tmbox-protection',
				image = 'Semi-protection-shackle-keyhole.svg'
			},
			notice = {
				class = 'tmbox-notice',
				image = 'Information icon4.svg'
			}
		},
		default              = 'notice',
		showInvalidTypeError = true,
		classes              = {'tmbox'},
		allowSmall           = true,
		imageRightNone       = true,
		imageEmptyCell       = true,
		templateCategory     = 'Talk message boxes',
		templatestyles       = 'Module:Message box/tmbox.css'
	}
}