Template:TutorialMeta - Revision history

Anthony: Changes made to align with the new hub revamp. Replaced topics with tags, removed difficulty.

2026-04-02T00:16:26Z

Changes made to align with the new hub revamp. Replaced topics with tags, removed difficulty.

← Older revision		Revision as of 00:16, 2 April 2026
Line 1:		Line 1:
	<noinclude>		<noinclude>
	== TutorialMeta ==		== TutorialMeta ==
	Stores tutorial metadata into the Cargo database (~~<code>~~Tutorials~~</code>~~ table) so it appears on the [[Tutorials]] hub ~~under the correct topic section. Also auto-tags the page into the relevant categories~~. Place at the top of every tutorial page.		Stores tutorial metadata into the Cargo database ('''Tutorials''' table) so it
			appears on the [[Tutorials]] hub. Place at the top of every tutorial page.

	=== Usage ===		=== Usage ===
Line 7:		Line 8:
	{{TutorialMeta		{{TutorialMeta
	\| name = How to Record Field Audio on a Budget		\| name = How to Record Field Audio on a Budget
	~~\| topic = Audio~~
	~~\| difficulty = Beginner~~
	\| description = A short description shown on the hub card (1–2 sentences).		\| description = A short description shown on the hub card (1–2 sentences).
	\| tags = audio recording field ~~budget beginner~~		\| tags = audio, recording, beginner, field-recording
	\| image = MyThumbnailImage.png		\| image = MyThumbnailImage.png
	}}		}}
Line 16:		Line 15:

	=== Parameters ===		=== Parameters ===
	; <code>name</code> : Tutorial display name ~~shown on the hub card~~. Defaults to the page name.		; <code>name</code> : Tutorial display name. Defaults to the page name.
	; <code>topic</code> : One or more topics, comma-separated (e.g. <code>Audio</code> or <code>Audio, Software</code>). Valid values: Audio, Digital Arts, Games, Handicrafts, Photography, Software, Video, Writing, World Building.
	~~; <code>difficulty</code> : Difficulty level shown as a coloured badge. Values: <code>Beginner</code>, <code>Intermediate</code>, <code>Advanced</code>. Defaults to Beginner~~.
	; <code>description</code> : Short description shown on the tutorial card hover. Keep to 1–2 sentences.		; <code>description</code> : Short description shown on the tutorial card hover. Keep to 1–2 sentences.
	; <code>tags</code> : ~~Space~~-separated ~~keywords~~ for filtering ~~within tutorial sections~~.		; <code>tags</code> : Comma-separated tags for filtering and searching. Include topic tags (e.g. <code>audio</code>, <code>software</code>) and difficulty tags (e.g. <code>beginner</code>, <code>intermediate</code>, <code>advanced</code>).
	; <code>image</code> : Cover image filename without <code>File:</code> prefix. Upload via [[Special:Upload]] first.		; <code>image</code> : Cover image filename without <code>File:</code> prefix. Upload via [[Special:Upload]] first.

	=== Notes ===		=== Notes ===
	* ~~The page~~ is ~~automatically tagged into~~ <code><~~nowiki~~>~~[[Category:Tutorials]]~~<~~/nowiki~~></code> ~~and~~ <code>~~<nowiki>[[Category:Tutorials/Audio]]</nowiki>~~</code> ~~etc~~.		* Difficulty is now handled via tags — add <code>beginner</code>, <code>intermediate</code>, or <code>advanced</code> to the tags field.
	* After saving, the tutorial appears on the hub within seconds (Cargo job queue).		* After saving, the tutorial appears on the hub within seconds (Cargo job queue).

	<templatedata>		<templatedata>
	{		{
	"description": "Registers a tutorial in the Cargo database so it appears on the Tutorials hub~~. Also auto-categorises the page~~. Place at the top of every tutorial page.",		"description": "Registers a tutorial in the Cargo database so it appears on the Tutorials hub. Place at the top of every tutorial page.",
	"params": {		"params": {
	"name": {		"name": {
	"label": "Tutorial name",		"label": "Tutorial name",
	"description": "Display name ~~shown on the hub card~~. Defaults to the page name.",		"description": "Display name. Defaults to the page name.",
	"type": "string",		"type": "string",
	"default": "{{PAGENAME}}",		"default": "{{PAGENAME}}",
	~~"required": false~~
	},
	~~"topic": {~~
	~~"label": "Topic(s)",~~
	~~"description": "One or more topics, comma-separated (e.g. Audio or Audio, Software).",~~
	~~"type": "string",~~
	~~"suggestedvalues": ["Audio", "Digital Arts", "Games", "Handicrafts", "Photography", "Software", "Video", "Writing", "World Building"],~~
	~~"required": true~~
	},
	~~"difficulty": {~~
	~~"label": "Difficulty",~~
	~~"description": "Difficulty level shown as a coloured badge on the card.",~~
	~~"type": "string",~~
	~~"default": "Beginner",~~
	~~"suggestedvalues": ["Beginner", "Intermediate", "Advanced"],~~
	"required": false		"required": false
	},		},
	"description": {		"description": {
	"label": "Description",		"label": "Description",
	"description": "Short description shown on the tutorial card hover~~. Keep to 1-2 sentences~~.",		"description": "Short description shown on the tutorial card hover.",
	"type": "content",		"type": "content",
	"required": false		"required": false
Line 61:		Line 43:
	"tags": {		"tags": {
	"label": "Tags",		"label": "Tags",
	"description": "~~Space~~-separated ~~keywords for filtering within tutorial sections~~.",		"description": "Comma-separated tags. Include topic and difficulty tags (e.g. audio, beginner, synthesis).",
	"type": "string",		"type": "string",
	"required": false		"required": false
Line 67:		Line 49:
	"image": {		"image": {
	"label": "Cover image",		"label": "Cover image",
	"description": "Cover image filename without ~~the~~ File: prefix ~~(e.g. MyThumbnail.png). Upload via Special:Upload first~~.",		"description": "Cover image filename without File: prefix.",
	"type": "wiki-file-name",		"type": "wiki-file-name",
	"required": false		"required": false
Line 79:		Line 61:
	_table = Tutorials		_table = Tutorials
	\| name = String		\| name = String
	~~\| topics = List (,) of String~~
	~~\| difficulty = String~~
	\| description = Text		\| description = Text
	\| image = File		\| image = File
Line 88:		Line 68:
	[[Category:Cargo Templates]]		[[Category:Cargo Templates]]
	[[Category:Layout Templates]]		[[Category:Layout Templates]]
	</noinclude><div class="tutorial-meta-data" data-name="{{{name\|{{PAGENAME}}}}}" data-link="{{FULLPAGENAME}}" data-topic="{{{topic\|}}}" data-difficulty="{{{difficulty\|Beginner}}}" data-description="{{{description\|}}}" data-tags="{{{tags\|}}}" data-image="{{{image\|}}}" style="display:none;"></div><includeonly>{{#cargo_store:		</noinclude><includeonly>{{#cargo_store:
	_table = Tutorials		_table = Tutorials
	\| name = {{{name\|{{PAGENAME}}}}}		\| name = {{{name\|{{PAGENAME}}}}}
	~~\| topics = {{{topic\|}}}~~
	~~\| difficulty = {{{difficulty\|Beginner}}}~~
	\| description = {{{description\|}}}		\| description = {{{description\|}}}
	\| image = {{{image\|}}}		\| image = {{{image\|}}}
	\| tags = {{{tags\|}}}		\| tags = {{{tags\|}}}
	}}[[Category:Tutorials]]~~{{#arraymap:{{{topic\|}}}\|,\|@@\|[[Category:Tutorials/@@]]\| }}~~</includeonly>		}}[[Category:Tutorials]]</includeonly>

Anthony: Add for Visual Editor Usage.

2026-03-23T08:30:56Z

Add <templatedata> for Visual Editor Usage.

@@ Line 17: / Line 17: @@
 === Parameters ===
 ; <code>name</code> : Tutorial display name shown on the hub card. Defaults to the page name.
-; <code>topic</code> : One or more topics, comma-separated (e.g. <code>Audio</code> or <code>Audio, Software</code>). The tutorial appears under all listed topic sections. Valid values: Audio, Digital Arts, Games, Handicrafts, Photography, Software, Video, Writing, World Building.
+; <code>topic</code> : One or more topics, comma-separated (e.g. <code>Audio</code> or <code>Audio, Software</code>). Valid values: Audio, Digital Arts, Games, Handicrafts, Photography, Software, Video, Writing, World Building.
 ; <code>difficulty</code> : Difficulty level shown as a coloured badge. Values: <code>Beginner</code>, <code>Intermediate</code>, <code>Advanced</code>. Defaults to Beginner.
 ; <code>description</code> : Short description shown on the tutorial card hover. Keep to 1–2 sentences.
-; <code>tags</code> : Space-separated keywords used for filtering within tutorial sections.
+; <code>tags</code> : Space-separated keywords for filtering within tutorial sections.
-; <code>image</code> : Cover image filename only — no <code>File:</code> prefix (e.g. <code>MyThumbnail.png</code>). Upload via [[Special:Upload]] first.
+; <code>image</code> : Cover image filename without <code>File:</code> prefix. Upload via [[Special:Upload]] first.
 === Notes ===
-* The page is automatically tagged into <code><nowiki>[[Category:Tutorials]]</nowiki></code> and <code><nowiki>[[Category:Tutorials/Audio]]</nowiki></code> etc. via <code>#arraymap</code> (requires [[Extension:Arrays]]).
+* The page is automatically tagged into <code><nowiki>[[Category:Tutorials]]</nowiki></code> and <code><nowiki>[[Category:Tutorials/Audio]]</nowiki></code> etc.
 * After saving, the tutorial appears on the hub within seconds (Cargo job queue).
-* A hidden <code>div.tutorial-meta-data</code> is added to the page for legacy JS compatibility. It has <code>display:none</code> and is not visible.
 {{#cargo_declare:

Anthony at 01:13, 18 March 2026

2026-03-18T01:13:58Z

New page

<noinclude>
== TutorialMeta ==
Stores tutorial metadata into the Cargo database (<code>Tutorials</code> table) so it appears on the [[Tutorials]] hub under the correct topic section. Also auto-tags the page into the relevant categories. Place at the top of every tutorial page.

=== Usage ===
<pre>
{{TutorialMeta
| name = How to Record Field Audio on a Budget
| topic = Audio
| difficulty = Beginner
| description = A short description shown on the hub card (1–2 sentences).
| tags = audio recording field budget beginner
| image = MyThumbnailImage.png
}}
</pre>

=== Parameters ===
; <code>name</code> : Tutorial display name shown on the hub card. Defaults to the page name.
; <code>topic</code> : One or more topics, comma-separated (e.g. <code>Audio</code> or <code>Audio, Software</code>). The tutorial appears under all listed topic sections. Valid values: Audio, Digital Arts, Games, Handicrafts, Photography, Software, Video, Writing, World Building.
; <code>difficulty</code> : Difficulty level shown as a coloured badge. Values: <code>Beginner</code>, <code>Intermediate</code>, <code>Advanced</code>. Defaults to Beginner.
; <code>description</code> : Short description shown on the tutorial card hover. Keep to 1–2 sentences.
; <code>tags</code> : Space-separated keywords used for filtering within tutorial sections.
; <code>image</code> : Cover image filename only — no <code>File:</code> prefix (e.g. <code>MyThumbnail.png</code>). Upload via [[Special:Upload]] first.

=== Notes ===
* The page is automatically tagged into <code><nowiki>[[Category:Tutorials]]</nowiki></code> and <code><nowiki>[[Category:Tutorials/Audio]]</nowiki></code> etc. via <code>#arraymap</code> (requires [[Extension:Arrays]]).
* After saving, the tutorial appears on the hub within seconds (Cargo job queue).
* A hidden <code>div.tutorial-meta-data</code> is added to the page for legacy JS compatibility. It has <code>display:none</code> and is not visible.

{{#cargo_declare:
_table = Tutorials
| name = String
| topics = List (,) of String
| difficulty = String
| description = Text
| image = File
| tags = List (,) of String
}}

[[Category:Cargo Templates]]
[[Category:Layout Templates]]
</noinclude><div class="tutorial-meta-data" data-name="{{{name|{{PAGENAME}}}}}" data-link="{{FULLPAGENAME}}" data-topic="{{{topic|}}}" data-difficulty="{{{difficulty|Beginner}}}" data-description="{{{description|}}}" data-tags="{{{tags|}}}" data-image="{{{image|}}}" style="display:none;"></div><includeonly>{{#cargo_store:
_table = Tutorials
| name = {{{name|{{PAGENAME}}}}}
| topics = {{{topic|}}}
| difficulty = {{{difficulty|Beginner}}}
| description = {{{description|}}}
| image = {{{image|}}}
| tags = {{{tags|}}}
}}[[Category:Tutorials]]{{#arraymap:{{{topic|}}}|,|@@|[[Category:Tutorials/@@]]| }}</includeonly>