Template:Qrlite/doc: Difference between revisions

Latest revision as of 01:13, 1 September 2024

Generates a QR code using the QRLite extension. This is a thin wrapper around the {{#qrlite:...}} parser function so it can appear as a plain template, mainly for the visual editor.

TemplateData

Generates a QR code.

Template parameters
Parameter		Description	Type	Status
Content	`content` `1`	Content to encode in the QR code Example https://example.com	Unknown	required
Image format	`format`	Render the image as a PNG or SVG (not recommended) Suggested values `png` `svg` Default png	String	optional
Size	`size`	Overall image size Default 6	Number	optional
Margin	`margin`	Margin around the QR code Default 0	Number	optional
Error correction level	`ecc`	Defines the error correction level Suggested values `0` `1` `2` `3` `4` Default 2	Number	optional

@@ Line 1: / Line 1: @@
-Generates a QR code using the [[mw:Extension:QRlite|QRlite]] extension. This is a thin wrapper around the <code><nowiki>{{#qrlite:...}}</nowiki></code> parser function so it can appear as a plain template, mainly for the visual editor.
+Generates a QR code using the [[mw:Extension:QRLite|QRLite]] extension. This is a thin wrapper around the <code><nowiki>{{#qrlite:...}}</nowiki></code> parser function so it can appear as a plain template, mainly for the visual editor.
+=== TemplateData ===
+<templatedata>
+{
+	"params": {
+		"content": {
+			"aliases": [
+				"1"
+			],
+			"label": "Content",
+			"description": "Content to encode in the QR code",
+			"example": "https://example.com",
+			"required": true
+		},
+		"format": {
+			"label": "Image format",
+			"description": "Render the image as a PNG or SVG (not recommended)",
+			"type": "string",
+			"suggestedvalues": [
+				"png",
+				"svg"
+			],
+			"default": "png"
+		},
+		"size": {
+			"label": "Size",
+			"description": "Overall image size",
+			"type": "number",
+			"default": "6"
+		},
+		"margin": {
+			"label": "Margin",
+			"description": "Margin around the QR code",
+			"type": "number",
+			"default": "0"
+		},
+		"ecc": {
+			"label": "Error correction level",
+			"description": "Defines the error correction level",
+			"type": "number",
+			"suggestedvalues": [
+				"0",
+				"1",
+				"2",
+				"3",
+				"4"
+			],
+			"default": "2"
+		}
+	},
+	"description": "Generates a QR code."
+}
+</templatedata>