Editing
Module:Message box/doc
(section)
Jump to navigation
Jump to search
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
== Technical details == The module uses the same basic code for each of the templates listed above; the differences between each of them are configured using the data at [[Module:Message box/configuration]]. Here are the various configuration options and what they mean: * <code>types</code> β 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. * <code>default</code> β the type to use if no value was passed to the type parameter, or if an invalid value was specified. * <code>showInvalidTypeError</code> β whether to show an error if the value passed to the type parameter was invalid. * <code>allowBlankParams</code> β usually blank values are stripped from parameters passed to the module. However, whitespace is preserved for the parameters included in the allowBlankParams table. * <code>allowSmall</code> β whether a small version of the message box can be produced with "small=yes". * <code>smallParam</code> β a custom name for the small parameter. For example, if set to "left" you can produce a small message box using "small=left". * <code>smallClass</code> β the class to use for small message boxes. * <code>substCheck</code> β whether to perform a subst check or not. * <code>classes</code> β an array of classes to use with the message box. * <code>imageEmptyCell</code> β whether to use an empty {{tag|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. * <code>imageEmptyCellStyle</code> β whether empty image cells should be styled. * <code>imageCheckBlank</code> β whether "image=blank" results in no image being displayed. * <code>imageSmallSize</code> β usually, images used in small message boxes are set to 30x30px. This sets a custom size. * <code>imageCellDiv</code> β whether to enclose the image in a div enforcing a maximum image size. * <code>useCollapsibleTextFields</code> β whether to use text fields that can be collapsed, i.e. "issue", "fix", "talk", etc. Currently only used in ambox. * <code>imageRightNone</code> β whether imageright=none results in no image being displayed on the right-hand side of the message box. * <code>sectionDefault</code> β the default name for the "section" parameter. Depends on <code>useCollapsibleTextFields</code>. * <code>allowMainspaceCategories</code> β allow categorisation in the main namespace. * <code>templateCategory</code> β the name of a category to be placed on the template page. * <code>templateCategoryRequireName</code> β whether the <code>name</code> parameter is required to display the template category. * <code>templateErrorCategory</code> β the name of the error category to be used on the template page. * <code>templateErrorParamsToCheck</code> β an array of parameter names to check. If any are absent, the <code>templateErrorCategory</code> is applied to the template page.
Summary:
Please note that all contributions to theredpill.info are considered to be released under the Creative Commons Attribution (see
Theredpill.info:Copyrights
for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource.
Do not submit copyrighted work without permission!
Cancel
Editing help
(opens in new window)
Navigation menu
Personal tools
Not logged in
Talk
Contributions
Create account
Log in
Namespaces
Module
Discussion
English
Views
Read
Edit source
View history
More
Search
Navigation
Main page
Recent changes
Random page
Help about MediaWiki
Tools
What links here
Related changes
Special pages
Page information