Difference between revisions of "Template:EmbedVideo"

Latest revision as of 00:24, 10 December 2018

Template for the EmbedVideo extension. see https://www.mediawiki.org/wiki/Extension:EmbedVideo

Template parameters
Parameter		Description	Type	Status
Service	`service`	The name of the service Default empty Example vimeo, youtube Auto value empty	String	required
Id	`id`	The id of the video at the service Default empty Example 18335678, 3r1n63u773r Auto value empty	String	required
Dimensions	`dimensions`	The dimensions Default 1076 Example 800, 800x450 Auto value empty	String	optional
Alignment	`alignment`	The horizontal alignment Default center Example center, left, right Auto value empty	String	optional

@@ Line 1: / Line 1: @@
 <includeonly>
-{{#ev:{{{service}}}|{{{id}}}|{{{dimensions}}}|{{{alignment}}}|}}
+{{#ev:{{{service}}}|{{{id}}}|{{{dimensions|1076}}}|{{{alignment|center}}}|}}
 </includeonly>
 <noinclude>
+== Usage ==
+<nowiki>
+{{EmbedVideo|service=vimeo|id=12345678}}
+</nowiki>
+== Arguments ==
 <templatedata>
 {
@@ Line 8: / Line 13: @@
 	"params": {
 		"service": {
-			"type": "string"
+			"type": "string",
+                        "required": true,
+                        "description": "The name of the service",
+                        "example": "vimeo, youtube"
 		},
 		"id": {
-			"type": "string"
+			"type": "string",
+                        "required": true,
+                        "description": "The id of the video at the service",
+                        "example": "18335678, 3r1n63u773r"
 		},
 		"dimensions": {
-			"type": "string"
+			"type": "string",
+                        "description": "The dimensions",
+                        "example": "800, 800x450",
+                        "default": "1076"
 		},
 		"alignment": {
-			"type": "string"
+			"type": "string",
+                        "description": "The horizontal alignment",
+                        "example": "center, left, right",
+                        "default": "center"
 		}
 	}