|
|
| (8 versions intermédiaires par le même utilisateur non affichées) |
| Ligne 1 : |
Ligne 1 : |
| This is a meta-module that implements the message box templates {{tl|mbox}}, {{tl|ambox}}, {{tl|cmbox}}, {{tl|fmbox}}, {{tl|imbox}}, {{tl|ombox}}, and {{tl|tmbox}}. It is intended to be used from Lua modules, and should not be used directly from wiki pages. If you want to use this module's functionality from a wiki page, please use the individual message box templates instead.
| | {{Documentation subpage}} |
| | <!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]) --> |
| | <!--{{Lua|Module:Message box}} |
|
| |
|
| == Usage ==
| | {{tl|Mbox}} ("['''M''']uti-namespace message['''box''']") is a [[Help:Metatemplating|metatemplate]] with which [[Wikipedia:Namespace|namespace]]-sensitive {{cl|Mbox and messagebox templates|messagebox templates}} can be implemented. The most common of these are {{tl|Ambox}} for articles, {{tl|Tmbox}} for talk pages, {{tl|Imbox}} for file (formerly image) pages, {{tl|Cmbox}} for category pages and {{tl|Ombox}} for other types of page. |
|
| |
|
| To use this module from another Lua module, first you need to load it.
| | Note that this template should only be used for message boxes that really need to adapt their style. Most message boxes do not need this and should use one of the varieties just listed. Using those templates directly means that your template will look the same on its template page and at any other place you show it, which makes it clear on what kind of pages it is supposed to be used. It also gives you access to any extra features those templates offer, and it saves some server load. |
|
| |
|
| <source lang="lua">
| | == Usage == |
| local messageBox = require('Module:Message box')
| |
| </source>
| |
| | |
| To create a message box, use the <code>main</code> function. It takes two parameters: the first is the box type (as a string), and the second is a table containing the message box parameters.
| |
|
| |
|
| <source lang="lua">
| | This template takes the same parameters as {{tl|Ambox}}, {{tl|Imbox}}, etc. See full documentation there. |
| local box = messageBox.main( boxType, {
| |
| param1 = param1,
| |
| param2 = param2,
| |
| -- More parameters...
| |
| })
| |
| </source>
| |
|
| |
|
| There are seven available box types:
| | Some of the boxes this template calls only handles images of max 52px width, thus that limitation also applies to this template or you will get ugly padding problems. |
|
| |
|
| {| class="wikitable"
| | == Demospace == |
| ! Box type !! Template !! Purpose
| |
| |-
| |
| | <code>mbox</code> || {{tl|mbox}} || For message boxes to be used in multiple namespaces
| |
| |-
| |
| | <code>ambox</code> || {{tl|ambox}} || For article message boxes
| |
| |-
| |
| | <code>cmbox</code> || {{tl|cmbox}} || For category message boxes
| |
| |-
| |
| | <code>fmbox</code> || {{tl|fmbox}} || For interface message boxes
| |
| |-
| |
| | <code>imbox</code> || {{tl|imbox}} || For file namespace message boxes
| |
| |-
| |
| | <code>tmbox</code> || {{tl|tmbox}} || For talk page message boxes
| |
| |-
| |
| | <code>ombox</code> || {{tl|ombox}} || For message boxes in other namespaces
| |
| |}
| |
|
| |
|
| See the template page of each box type for the available parameters.
| | This template optionally takes the "demospace" parameter as described at {{tl|Namespace detect}}. That parameter is only for testing and demonstration purposes. If you want to lock your message box to one style then instead use one of the other mboxes directly. |
|
| |
|
| == Usage from #invoke == | | Namespace "Image:" was renamed to "File:" on 11 December 2008. This template was updated to understand both names well before that, thus it still works fine. For backwards compatibility it still understands "demospace = image" which means the same thing as "demospace = file". But using "demospace = image" is now deprecated. |
|
| |
|
| As well as the <code>main</code> function, this module has separate functions for each box type. They are accessed using the code <code><nowiki>{{#invoke:Message box|mbox|...}}</nowiki></code>, <code><nowiki>{{#invoke:Message box|ambox|...}}</nowiki></code>, etc. These will work when called from other modules, but they access code used to process arguments passed from #invoke, and so calling them will be less efficient than calling <code>main</code>.
| | Namespace "Book:" was added to the English Wikipedia on 28 December 2009. This template uses the {{tl|Ombox}} style on "Book:" pages (or when "demospace = book") and the {{tl|Tmbox}} style on "Book talk:" pages (or when "demospace = talk"). Note that "demospace = talk" means any talk space. |
|
| |
|
| == Technical details == | | == Parameters == |
|
| |
|
| 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: | | List of all parameters: |
| | <pre> |
| | {{Mbox |
| | | demospace = {{{demospace|}}} / main / talk / file / category / other |
| | | type = speedy / delete / content / style / notice / move / protection |
| | | image = none / [[File:Some image.svg|40px]] |
| | | imageright = [[File:Some image.svg|40px]] |
| | | style = CSS values |
| | | textstyle = CSS values |
| | | text = The message body text. |
| | | small = {{{small|}}} / left / yes |
| | | smallimage = none / [[File:Some image.svg|30px]] |
| | | smallimageright = none / [[File:Some image.svg|30px]] |
| | | smalltext = A shorter message body text. |
| | }} |
| | </pre> |
|
| |
|
| * <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.
| | Note: The small parameters only have effect when the template appears on an article, talk or "other" page type. For their associated documentation, see {{tl|Ambox}}, {{tl|Tmbox}} and/or {{tl|Ombox}}. Using the small parameters when they are not valid has no effect, but also does no harm. |
| * <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.
| | <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|| |
| * <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.
| | <!-- Categories go below this line, please; interwikis go to Wikidata, thank you! --> |
| * <code>allowId</code> - whether it is possible to set an "id" attribute to the html table tag.
| | [[Category:Modèle Encart]] |
| * <code>allowSmall</code> - whether a small version of the message box can be produced with "small=yes".
| | }}</includeonly> |
| * <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>usePlainlinksParam</code> - whether to allow "plainlinks=no" to turn off the plainlinks class.
| |
| * <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.
| |
