Difference between revisions of "Template:Wfmessage/doc"
Jump to navigation
Jump to search
(Commenting out the bit regarding <templatedata> (not supported on the SL Wiki)) |
m (Slight change of template name) |
||
(3 intermediate revisions by the same user not shown) | |||
Line 6: | Line 6: | ||
=== Notes === | === Notes === | ||
A detailed documentation for each parameter is provided below. The <code>type</code> needs some visual explanation | A detailed documentation for each parameter is provided below. The <code>type</code> needs some visual explanation. | ||
== Syntax == | == Syntax == | ||
Line 18: | Line 18: | ||
== Parameters == | == Parameters == | ||
<!-- | <!--<templatedata>--> | ||
< | <syntaxhighlight lang="JSON"> | ||
{ | { | ||
"params": { | "params": { | ||
Line 60: | Line 60: | ||
} | } | ||
}, | }, | ||
"description": "This is a messagebox like Ambox but based on the style of the | "description": "This is a messagebox like Ambox but based on the style of the OpenStreetMap webpage. ", | ||
"format": "block" | "format": "block" | ||
} | } | ||
</templatedata> | </syntaxhighlight> | ||
--> | <!--</templatedata>--> | ||
* type=advice | * type=advice | ||
{{Wfmessage|type=advice}} | {{Wfmessage|type=advice}} | ||
: Advice contains important information the user should take into consideration. This refers to [[Import|import guidelines]] and | : Advice contains important information the user should take into consideration. This refers to [[Import|import guidelines]] and others. It basically says "you should take that into consideration. Otherwise, you provoke a conflict or worse." | ||
* type=content | * type=content | ||
{{Wfmessage|type=content}} | {{Wfmessage|type=content}} | ||
: Content issues indicate problems arising from translations or cleanup necessities. Similarly, it can also be used for incomplete or dubious content. It | : Content issues indicate problems arising from translations or cleanup necessities. Similarly, it can also be used for incomplete or dubious content. It suggests to "please double check what is written here". | ||
* type=delete | * type=delete | ||
{{Wfmessage|type=delete}} | {{Wfmessage|type=delete}} | ||
: Type <code>delete</code> is used for content whose deletion is requested. That effectively limits its use to {{t|Delete}}. The intended message is "this may | : Type <code>delete</code> is used for content whose deletion is requested. That effectively limits its use to {{t|Delete}}. The intended message is "this may affect you soon". | ||
* type=notice | * type=notice | ||
{{Wfmessage|type=notice}} | {{Wfmessage|type=notice}} | ||
: Notices are used for | : Notices are used for editing requests, {{Wikipedia|Stub|stubs}}, and general notices that may or may not be relevant to the user. It is basically an equivalent to "for your interest"/"FYI". | ||
* type=structural | * type=structural | ||
Line 92: | Line 92: | ||
== Example == | == Example == | ||
{{...}} | {{t|...}} | ||
== See also == | == See also == | ||
* {{T|Ambox}} - stands for '''A'''rticle '''m'''essage '''box'''. This template is used in many [[:Category:Ambox Derived Works|pages]].<includeonly> | * {{T|Ambox}} - stands for '''A'''rticle '''m'''essage '''box'''. This template is used in many [[:Category:Ambox Derived Works|pages]].<includeonly> | ||
[[Category: | [[Category:Mbox and messagebox templates]]</includeonly> |
Latest revision as of 14:31, 5 December 2023
This is a documentation subpage for Template:Wfmessage. It contains usage information, categories and other content or metadata that is not part of the original template. |
Usage
The Website flex message box template is a message box template like Template:Mbox but based on the style of the home page. It uses CSS flexboxes to style the content.
Notes
A detailed documentation for each parameter is provided below. The type
needs some visual explanation.
Syntax
{{Wfmessage | type = | image = | text = | nocat = | categories = }}
Parameters
{
"params": {
"type": {
"description": "basic style of the template",
"example": "notice",
"type": "string",
"default": "notice",
"suggested": true
},
"image": {
"description": "name of an image to display before the text",
"example": "example.png{{!}}alt=some example image",
"type": "unbalanced-wikitext"
},
"text": {
"description": "text shown in the message box",
"type": "unbalanced-wikitext",
"suggested": true
},
"edittext": {
"description": "text shown below the other \"text\" but visible to users only (should be used to give some advice to editors)",
"type": "unbalanced-wikitext"
},
"image2": {
"description": "image shown after the text (to the right on LTR languages)",
"example": "Example.svg{{!}}alt=an example file",
"type": "unbalanced-wikitext",
"default": "(none)"
},
"nocat": {
"description": "insert any text to supress the categorisation",
"type": "boolean",
"default": "(empty)"
},
"categories": {
"description": "categories to be added to a page using a template derived from this one",
"example": "[[Category:Templates|~some sort key]]",
"type": "unbalanced-wikitext"
}
},
"description": "This is a messagebox like Ambox but based on the style of the OpenStreetMap webpage. ",
"format": "block"
}
- type=advice
- Advice contains important information the user should take into consideration. This refers to import guidelines and others. It basically says "you should take that into consideration. Otherwise, you provoke a conflict or worse."
- type=content
- Content issues indicate problems arising from translations or cleanup necessities. Similarly, it can also be used for incomplete or dubious content. It suggests to "please double check what is written here".
- type=delete
- Type
delete
is used for content whose deletion is requested. That effectively limits its use to {{Delete}}. The intended message is "this may affect you soon".
- type=notice
- Notices are used for editing requests, stubs, and general notices that may or may not be relevant to the user. It is basically an equivalent to "for your interest"/"FYI".
- type=structural
- This type indicates structural changes to one or multiple pages about a similar topic. For the ordinary reader, it should be understood as "this is some information in case you are interested in wiki matters". This would be used for {{Merge}}, {{Move}}, {{Split section}}, {{Delete proposal}} ...
Example
{{...}}