Template:Wfmessage/doc

From OpenStreetMap Wiki
Jump to navigation Jump to search

Usage

The Website flex message box template is a message box template like Template:Mbox but based on the style of the OSM 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

This is a messagebox like Ambox but based on the style of the OSM webpage.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
typetype

basic style of the template

Default
notice
Example
notice
Stringsuggested
imageimage

name of an image to display before the text

Example
example.png{{!}}alt=some example image
Unbalanced wikitextoptional
texttext

text shown in the message box

Unbalanced wikitextsuggested
edittextedittext

text shown below the other "text" but visible to users only (should be used to give some advice to editors)

Unbalanced wikitextoptional
image2image2

image shown after the text (to the right on LTR languages)

Default
(none)
Example
Example.svg{{!}}alt=an example file
Unbalanced wikitextoptional
nocatnocat

insert any text to supress the categorisation

Default
(empty)
Booleanoptional
categoriescategories

categories to be added to a page using a template derived from this one

Example
[[Category:Templates|~some sort key]]
Unbalanced wikitextoptional
  • type=advice

exclamation mark

some text goes here
Advice contains important information the user should take into consideration. This refers to import guidelines and other OSM guidelines. It basically says "you should take that into consideration. Otherwise, you provoke a conflict or worse."
  • type=content

broom

some text goes here
Content issues indicate problems arising from translations or cleanup necessities. Similarly, it can also be used for incomplete or dubious content. It basically suggests "please double check what is written here".
  • type=delete

trash bin

some text goes here
Type delete is used for content whose deletion is requested. That effectively limits its use to {{Delete}}. The intended message is "this may effect you soon".
  • type=notice

information sign

some text goes here
Notices are used for edit 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

arrows

some text goes here
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

information sign

This section is empty, insufficiently detailed or incomplete. Your help is welcome to develop it !

See also