Module:Message box/configuration: Difference between revisions

From NARA
Jump to navigation Jump to search
NARA>Pppery
(Remove error category; it was the idea of one enwiki-an years ago and there's no evidence anyone on MediaWiki.org cares)
 
NARA>Izno
(add templatestyles, remove a variable or two as a result)
Line 10: Line 10:
speedy = {
speedy = {
class = 'ambox-speedy',
class = 'ambox-speedy',
image = 'OOjs UI icon clock-destructive.svg'
image = 'Ambox warning pn.svg'
},
},
delete = {
delete = {
class = 'ambox-delete',
class = 'ambox-delete',
image = 'OOjs UI icon alert-destructive.svg'
image = 'Ambox warning pn.svg'
},
warning = { -- alias for content
class = 'ambox-content',
image = 'OOjs UI icon notice-warning.svg'
},
},
content = {
content = {
class = 'ambox-content',
class = 'ambox-content',
image = 'OOjs UI icon notice-warning.svg'
image = 'Ambox important.svg'
},
},
style = {
style = {
Line 38: Line 34:
notice = {
notice = {
class = 'ambox-notice',
class = 'ambox-notice',
image = 'OOjs UI icon information-progressive.svg'
image = 'Information icon4.svg'
}
}
},
},
Line 47: Line 43:
smallClass                  = 'mbox-small-left',
smallClass                  = 'mbox-small-left',
substCheck                  = true,
substCheck                  = true,
classes                    = {'metadata', 'plainlinks', 'ambox'},
classes                    = {'metadata', 'ambox'},
imageEmptyCell              = true,
imageEmptyCell              = true,
imageCheckBlank            = true,
imageCheckBlank            = true,
Line 58: Line 54:
templateCategory            = 'Article message templates',
templateCategory            = 'Article message templates',
        templateCategoryRequireName = true,
        templateCategoryRequireName = true,
templateErrorCategory      = nil,
templateErrorCategory      = 'Article message templates with missing parameters',
templateErrorParamsToCheck  = {'issue', 'fix', 'subst'}
templateErrorParamsToCheck  = {'issue', 'fix', 'subst'},
removalNotice              = '<small>[[Help:Maintenance template removal|Learn how and when to remove this template message]]</small>',
templatestyles              = 'Module:Message box/ambox.css'
},
},
Line 66: Line 64:
speedy = {
speedy = {
class = 'cmbox-speedy',
class = 'cmbox-speedy',
image = 'OOjs UI icon clock-destructive.svg'
image = 'Ambox warning pn.svg'
},
},
delete = {
delete = {
class = 'cmbox-delete',
class = 'cmbox-delete',
image = 'OOjs UI icon alert-destructive.svg'
image = 'Ambox warning pn.svg'
},
},
content = {
content = {
class = 'cmbox-content',
class = 'cmbox-content',
image = 'OOjs UI icon notice-warning.svg'
image = 'Ambox important.svg'
},
},
style = {
style = {
Line 90: Line 88:
notice = {
notice = {
class = 'cmbox-notice',
class = 'cmbox-notice',
image = 'OOjs UI icon information-progressive.svg'
image = 'Information icon4.svg'
},
caution = {
class = 'cmbox-style',
image = 'Ambox warning yellow.svg'
}
}
},
},
default              = 'notice',
default              = 'notice',
showInvalidTypeError = true,
showInvalidTypeError = true,
classes              = {'plainlinks', 'cmbox'},
classes              = {'cmbox'},
imageEmptyCell      = true
imageEmptyCell      = true,
templatestyles      = 'Module:Message box/cmbox.css'
},
},
Line 107: Line 102:
warning = {
warning = {
class = 'fmbox-warning',
class = 'fmbox-warning',
image = 'OOjs UI icon clock-destructive.svg'
image = 'Ambox warning pn.svg'
},
},
editnotice = {
editnotice = {
class = 'fmbox-editnotice',
class = 'fmbox-editnotice',
image = 'OOjs UI icon information-progressive.svg'
image = 'Information icon4.svg'
},
},
system = {
system = {
class = 'fmbox-system',
class = 'fmbox-system',
image = 'OOjs UI icon information-progressive.svg'
image = 'Information icon4.svg'
}
}
},
},
default              = 'system',
default              = 'system',
showInvalidTypeError = true,
showInvalidTypeError = true,
classes              = {'plainlinks', 'fmbox'},
classes              = {'fmbox'},
imageEmptyCell      = false,
imageEmptyCell      = false,
imageRightNone      = false
imageRightNone      = false,
templatestyles      = 'Module:Message box/fmbox.css'
},
},
Line 129: Line 125:
speedy = {
speedy = {
class = 'imbox-speedy',
class = 'imbox-speedy',
image = 'OOjs UI icon clock-destructive.svg'
image = 'Ambox warning pn.svg'
},
},
delete = {
delete = {
class = 'imbox-delete',
class = 'imbox-delete',
image = 'OOjs UI icon alert-destructive.svg'
image = 'Ambox warning pn.svg'
},
},
content = {
content = {
class = 'imbox-content',
class = 'imbox-content',
image = 'OOjs UI icon notice-warning.svg'
image = 'Ambox important.svg'
},
},
style = {
style = {
Line 161: Line 157:
notice = {
notice = {
class = 'imbox-notice',
class = 'imbox-notice',
image = 'OOjs UI icon information-progressive.svg'
image = 'Information icon4.svg'
}
}
},
},
Line 167: Line 163:
showInvalidTypeError = true,
showInvalidTypeError = true,
classes              = {'imbox'},
classes              = {'imbox'},
usePlainlinksParam  = true,
imageEmptyCell      = true,
imageEmptyCell      = true,
below                = true,
below                = true,
templateCategory    = 'File message boxes'
templateCategory    = 'File message boxes',
templatestyles      = 'Module:Message box/imbox.css'
},
},
Line 177: Line 173:
speedy = {
speedy = {
class = 'ombox-speedy',
class = 'ombox-speedy',
image = 'OOjs UI icon clock-destructive.svg'
image = 'Ambox warning pn.svg'
},
},
delete = {
delete = {
class = 'ombox-delete',
class = 'ombox-delete',
image = 'OOjs UI icon alert-destructive.svg'
image = 'Ambox warning pn.svg'
},
warning = { -- alias for content
class = 'ombox-content',
image = 'OOjs UI icon notice-warning.svg'
},
},
content = {
content = {
class = 'ombox-content',
class = 'ombox-content',
image = 'OOjs UI icon notice-warning.svg'
image = 'Ambox important.svg'
},
},
style = {
style = {
Line 205: Line 197:
notice = {
notice = {
class = 'ombox-notice',
class = 'ombox-notice',
image = 'OOjs UI icon information-progressive.svg'
image = 'Information icon4.svg'
},
critical = {
class = 'mbox-critical',
image = 'OOjs UI icon clock-destructive.svg'
}
}
},
},
default              = 'notice',
default              = 'notice',
showInvalidTypeError = true,
showInvalidTypeError = true,
classes              = {'plainlinks', 'ombox'},
classes              = {'ombox'},
allowSmall          = true,
allowSmall          = true,
imageEmptyCell      = true,
imageEmptyCell      = true,
imageRightNone      = true
imageRightNone      = true,
templatestyles      = 'Module:Message box/ombox.css'
},
},
Line 224: Line 213:
speedy = {
speedy = {
class = 'tmbox-speedy',
class = 'tmbox-speedy',
image = 'OOjs UI icon clock-destructive.svg'
image = 'Ambox warning pn.svg'
},
},
delete = {
delete = {
class = 'tmbox-delete',
class = 'tmbox-delete',
image = 'OOjs UI icon alert-destructive.svg'
image = 'Ambox warning pn.svg'
},
},
content = {
content = {
class = 'tmbox-content',
class = 'tmbox-content',
image = 'OOjs UI icon notice-warning.svg'
image = 'Ambox important.svg'
},
},
style = {
style = {
Line 248: Line 237:
notice = {
notice = {
class = 'tmbox-notice',
class = 'tmbox-notice',
image = 'OOjs UI icon information-progressive.svg'
image = 'Information icon4.svg'
}
}
},
},
default              = 'notice',
default              = 'notice',
showInvalidTypeError = true,
showInvalidTypeError = true,
classes              = {'plainlinks', 'tmbox'},
classes              = {'tmbox'},
allowSmall          = true,
allowSmall          = true,
imageRightNone      = true,
imageRightNone      = true,
imageEmptyCell      = true,
imageEmptyCell      = true,
imageEmptyCellStyle  = true,
templateCategory    = 'Talk message boxes',
templateCategory    = 'Talk message boxes'
templatestyles      = 'Module:Message box/tmbox.css'
}
}
}
}

Revision as of 13:19, 11 July 2022

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 Whether a small version of the message box can be produced with |small=1.
smallParam A custom value for the |small= parameter. For example, if set to <syntaxhighlight inline="1" id="" class="" style="" lang="lua">"left"</syntaxhighlight> you can produce a small message box using |small=left.
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 Whether to use an empty ‎<td>...‎</td> 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 Whether |image=blank results in no image being displayed.
imageSmallSize Usually, images used in small message boxes are set to 30x30px. This sets a custom size.
imageCellDiv Whether to enclose the image in a ‎<div> enforcing a maximum image size.
useCollapsibleTextFields Whether to use text fields that can be collapsed, i.e. <syntaxhighlight inline="1" id="" class="" style="" lang="lua">"issue"</syntaxhighlight>, <syntaxhighlight inline="1" id="" class="" style="" lang="lua">"fix"</syntaxhighlight>, <syntaxhighlight inline="1" id="" class="" style="" lang="lua">"talk"</syntaxhighlight>, etc. Currently only used in {{ambox}}.
imageRightNone Whether |imageright=none results in no image being displayed on the right-hand side of the message box.
sectionDefault The default name for the |section= 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 Whether the |name= 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.

--------------------------------------------------------------------------------
--                          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 template 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.png' -- @todo We need an SVG version of this
			},
			featured = {
				class = 'imbox-featured',
				image = 'Cscr-featured.svg'
			},
			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'
	}
}