Template:OpenGraph: Difference between revisions

Latest revision as of 18:45, 31 May 2025

For adding OpenGraph embed data for a page.

Template parameters[Edit template data]
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Title	`title`	The title shown when a page is embedded.	String	suggested
Description	`description`	The description that shows up when a page is embedded Example VRRat is one of VRChat's mascots!	String	suggested
Embed Image	`image`	The image shown when a page is embedded.	File	suggested

@@ Line 1: / Line 1: @@
-{{#if:{{{description|}}}|{{#description2:{{{description}}}}}}}{{#if:{{{image|}}}|{{#setmainimage:{{{image}}}}}}}{{#if:{{{title|}}}|{{#setmaintitle:{{{title}}}}}}}<noinclude>{{Documentation}}[[Category:Templates]]</noinclude>
+<onlyinclude>{{#if:{{{description|}}}|{{#description2:{{{description}}}}}}}{{#if:{{{image|}}}|{{#setmainimage:{{{image}}}}}}}{{#if:{{{title|}}}|{{#setmaintitle:{{{title}}}}}}}</onlyinclude><noinclude>{{Documentation}}[[Category:Templates]]<templatedata>
+{
+	"params": {
+		"description": {
+			"label": "Description",
+			"description": "The description that shows up when a page is embedded",
+			"example": "VRRat is one of VRChat's mascots!",
+			"type": "string",
+			"suggested": true
+		},
+		"image": {
+			"label": "Embed Image",
+			"description": "The image shown when a page is embedded.",
+			"type": "wiki-file-name",
+			"suggested": true
+		},
+		"title": {
+			"label": "Title",
+			"description": "The title shown when a page is embedded.",
+			"type": "string",
+			"suggested": true
+		}
+	},
+	"description": "For adding OpenGraph embed data for a page.",
+	"paramOrder": [
+		"title",
+		"description",
+		"image"
+	],
+	"format": "inline"
+}
+</templatedata></noinclude>