Template:Ombox/doc: Difference between revisions

← Older edit Newer edit →

@@ Line 243: / Line 243: @@
 {
 	"params": {
-		"text": {},
+		"text": {
-		"type": {},
+			"label": "Text of the box",
-		"image": {},
+			"description": "The text to be displayed inside the box",
-		"style": {},
+			"example": "Hello, I am a box created using {{ombox}}.",
-		"textstyle": {},
+			"type": "content",
-		"imageright": {},
+			"required": true
-		"plainlinks": {},
+		},
-		"small": {},
+		"type": {
-		"smallimage": {},
+			"label": "Type of box to display",
-		"smallimageright": {},
+			"description": "The type of box that will be displayed. Examples are \"speedy\", \"delete\", \"content\", \"style\", \"notice\", \"move\", and \"protection\".",
-		"smalltext": {}
+			"example": "notice",
+			"type": "string",
+			"suggestedvalues": [
+				"speedy",
+				"delete",
+				"content",
+				"style",
+				"notice",
+				"move",
+				"protection"
+			]
+		},
+		"image": {
+			"label": "Image",
+			"description": "The image to be displayed inside the box. This can be chosen automatically by setting the \"type\" parameter. Displays on the *left*. This should be given as a file wikilink, just as if you were adding an image on its own.",
+			"example": "[[File:Some image.svg|40px]]",
+			"type": "content"
+		},
+		"style": {
+			"label": "CSS style for entire box",
+			"description": "Inline CSS styles, which will be applied to the *entire* box.",
+			"example": "text-align: center",
+			"type": "string"
+		},
+		"textstyle": {
+			"label": "CSS style for text",
+			"description": "Inline CSS styles, which will only be applied to the text itself.",
+			"example": "text-align: center",
+			"type": "string"
+		},
+		"imageright": {
+			"label": "Image to the right",
+			"description": "The image to be displayed to the *right* of the text. This should be given as a file wikilink, just as if you were adding an image on its own.",
+			"example": "[[File:Some image.svg|40px]]",
+			"type": "content"
+		},
+		"plainlinks": {
+			"label": "Plain external links?",
+			"description": "In message boxes, external links have the arrow icon suppressed. Set this to \"no\" to restore the usual appearance of an external link.",
+			"example": "no",
+			"suggestedvalues": [
+				"no"
+			]
+		},
+		"small": {
+			"label": "Small?",
+			"description": "If set to \"yes\", the box becomes small.",
+			"example": "yes",
+			"suggestedvalues": [
+				"yes"
+			]
+		},
+		"smallimage": {
+			"label": "Small image",
+			"description": "A small image to be used. Displays on the left. Only use this parameter if \"small\" is set.",
+			"example": "[[File:Some image.svg|30px]]"
+		},
+		"smallimageright": {
+			"label": "Small image to the right",
+			"description": "A small image to be used. Displays on the left. Only use this parameter if \"small\" is set.",
+			"example": "[[File:Some image.svg|30px]]",
+			"type": "content"
+		},
+		"smalltext": {
+			"label": "Small text",
+			"description": "Smaller text to display. Falls back to the \"text\" parameter if not used.",
+			"example": "Hi, I'm a small box!",
+			"type": "content"
+		}
 	},
-	"description": "Other pages message box",
+	"description": "Other pages message box. This template is usually not used directly, but is more often used as a metatemplate to build other templates.",
 	"paramOrder": [
 		"text",