Template:Documentation/Doc - Revision history

DoggoBit at 14:20, 11 June 2025

2025-06-11T14:20:11Z

← Older revision		Revision as of 14:20, 11 June 2025
Line 32:		Line 32:
	Any technical information about the template's implementation under the hood...		Any technical information about the template's implementation under the hood...
	}}		}}

	<includeonly>		<includeonly>
	=== Template data ===		=== Template data ===
Line 39:		Line 38:
	{		{
	"description": "Provide documentation for a template, under the /Doc subpage",		"description": "Provide documentation for a template, under the /Doc subpage",
	"~~fields~~": {}		"params": {}
	}		}
	</templatedata>		</templatedata>

DoggoBit at 14:19, 11 June 2025

2025-06-11T14:19:27Z

← Older revision		Revision as of 14:19, 11 June 2025
Line 32:		Line 32:
	Any technical information about the template's implementation under the hood...		Any technical information about the template's implementation under the hood...
	}}		}}

			<includeonly>
			=== Template data ===

			<templatedata>
			{
			"description": "Provide documentation for a template, under the /Doc subpage",
			"fields": {}
			}
			</templatedata>

DoggoBit at 21:27, 5 June 2025

2025-06-05T21:27:11Z

← Older revision		Revision as of 21:27, 5 June 2025
Line 5:		Line 5:
	In general, the documentation should not be part of the template itself, thus you might want to do follow this general pattern:		In general, the documentation should not be part of the template itself, thus you might want to do follow this general pattern:

	<~~pre~~>		{{code\|lang=mediawiki\|line=no\|highlight=3\|
	<~~includeonly~~>		<<nowiki>includeonly</nowiki>>
	<!-- Template-specific code -->		<!<nowiki>-- Template-specific code --</nowiki>>
	</includeonly><noinclude>{{Documentation}}</noinclude>		</includeonly><<nowiki>noinclude</nowiki>><nowiki>{{Documentation}}</nowiki></<nowiki>noinclude</nowiki>>
	</~~pre~~>		}}

	=== Writing the documentation ===		=== Writing the documentation ===
Line 17:		Line 17:
	Keep in mind that all documentation headings should be one level lower than what you'd normally write, because the heading ''Template Documentation'' is a level 2 header already. For example, a documentation outline might be:		Keep in mind that all documentation headings should be one level lower than what you'd normally write, because the heading ''Template Documentation'' is a level 2 header already. For example, a documentation outline might be:

	~~<pre>~~		{{code\|line=no\|lang=mediawiki\|
	Some introduction text...		Some introduction text...

Line 31:		Line 31:

	Any technical information about the template's implementation under the hood...		Any technical information about the template's implementation under the hood...
	~~</pre>~~		}}

DoggoBit at 14:25, 5 June 2025

2025-06-05T14:25:54Z

@@ Line 1: / Line 1: @@
 This template is used for providing documentation for templates. It will "grab" the documentation from the <code>/Doc</code> subpage under the template it's used for. For example, using it on [[Template:Documentation]] would grab the documentation from [[Template:Documentation/Doc]].
-== Usage ==
+=== Usage ===
 In general, the documentation should not be part of the template itself, thus you might want to do follow this general pattern:
@@ Line 9: / Line 9: @@
    <!-- Template-specific code -->
 </includeonly><noinclude>{{Documentation}}</noinclude>
 </pre>

DoggoBit: Created page with "This template is used for providing documentation for templates. It will "grab" the documentation from the /Doc subpage under the template it's used for. For example, using it on Template:Documentation would grab the documentation from Template:Documentation/Doc. == Usage == In general, the documentation should not be part of the template itself, thus you might want to do follow this general pattern: