View source for Template:Wfmessage/doc

<noinclude>{{Languages|Template:Wfmessage/doc}}</noinclude>
{{Documentation subpage}}
__NOTOC__
== Usage ==
The '''W'''ebsite '''f'''lex '''message''' box template is a message box template like [[Template:Mbox]] but based on the style of the [[homepage|OSM home page]]. It uses {{wikipedia|en|CSS Flexible Box Layout|CSS flexboxes|text=no}} to style the content.

=== Notes ===
A detailed documentation for each parameter is provided below. The <code>type</code> needs some visual explanation

== Syntax ==
<pre>{{Wfmessage
| type = 
| image = 
| text = 
| nocat = 
| categories = 
}}</pre>

== Parameters ==
<templatedata>
{
	"params": {
		"image": {
			"description": {
				"en": "name of an image to display before the text",
				"pl": "Nazwa pliku do wyświetlenia przed tesktem"
			},
			"example": "example.png{{!}}alt=some example image",
			"type": "wiki-file-name",
			"label": {
				"de": "Abbildung",
                "pl": "Obrazek"
			}
		},
		"text": {
			"description": {
				"en": "text shown in the message box",
				"pl": "Tekst do wyświetlenia w wiadomości"
			},
			"type": "string",
			"label": {
				"de": "Text",
                "pl": "Tekst"
			},
			"required": true
		},
		"edittext": {
			"description": {
				"en": "text shown below the other \"text\" but visible to users only (should be used to give some advice to editors)",
				"pl": "Tekst wyświetlany pod głównym tekstem wiadomości, widoczny tylko dla użytkowników (należy go używać, aby dać wskazówki redaktorom Wiki)"
			},
			"type": "unbalanced-wikitext"
		},
		"image2": {
			"description": {
				"en": "image shown after the text (to the right on LTR languages)",
				"pl": "Obrazek wyświetlany po tekście wiadomości"
			},
			"example": "Example.svg{{!}}alt=an example file",
			"type": "wiki-file-name",
			"default": "(none)"
		},
		"nocat": {
			"description": {
				"en": "insert any text to supress the categorisation",
				"pl": "Dodaj dowolną wartość aby wyłączyć kategoryzację"
			},
			"type": "boolean",
			"default": {
				"en": "(empty)",
				"pl": "yes"
			},
			"example": {
				"pl": "yes"
			}
		},
		"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"
		},
		"type": {
			"label": {
				"de": "Typ",
                "pl": "Typ wiadomości"
			},
			"description": {
				"en": "basic style of the template",
				"pl": "Typ wiadomości - poszczególne typy różnią się od siebie kolorem, wyróżnieniem"
			},
			"example": {
				"en": "notice",
				"pl": "notice"
			},
			"type": "line",
			"suggestedvalues": [
				"advice",
				"content",
				"delete",
				"structural",
				"notice"
			],
			"default": {
				"en": "notice",
				"pl": "notice"
			},
			"autovalue": "notice",
			"suggested": true
		}
	},
	"description": {
		"en": "This is a messagebox like Ambox but based on the style of the OSM webpage. ",
		"pl": "Szablon do wstawiania wiadomości spójny ze stylami używanymi w innych miejscach Openstreetmap"
	},
	"format": "block",
	"paramOrder": [
		"type",
		"image",
		"text",
		"edittext",
		"image2",
		"nocat",
		"categories"
	]
}
</templatedata>

* type=advice
{{Wfmessage|type=advice}}

: Advice contains important information the user should take into consideration. This refers to [[Import|import guidelines]] and other OSM guidelines. It basically says "you should take that into consideration. Otherwise, you provoke a conflict or worse."

* 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 basically suggests "please double check what is written here". 

* 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 effect you soon". 

* type=notice
{{Wfmessage|type=notice}}

: Notices are used for edit requests, [[Wiki: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
{{Wfmessage|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 {{t|merge}}, {{t|move}}, {{t|split section}}, {{t|delete proposal}} ...

== Example ==
{{...}}

== See also ==
* {{T|Ambox}} - stands for '''A'''rticle '''m'''essage '''box'''. This template is used in many [[:Category:Ambox Derived Works|pages]]
* {{T|Questioned}}.<includeonly>

[[Category:Message box templates]]</includeonly>