Template:Documentation/preload: Difference between revisions

Latest revision as of 20:42, 23 September 2024

-- This preload is based off the original documentation template's own documentation. You do not have to follow it exactly. --

Description

This template can be used to...

Usage

Parameters

Sample

The following input:

{{Example|param=value|pa..}}

Produces:

noinclude>/noinclude> includeonly>

/includeonly>

@@ Line 1: / Line 1: @@
+<includeonly><!</includeonly>-- This preload is based off the original documentation template's own documentation. You do not have to follow it exactly. --<includeonly>></includeonly>
 ==Description==
-<!--Short summary of what the main function of the template is-->
+<!--Summary of what the main function of the template is-->
 This template can be used to...
-==Syntax==
-<!--Basically think of this as a simplified sample-->
-Add <code><nowiki>{{Example|param=value|pa..}}</nowiki></code> on a page to do...
 ==Usage==
@@ Line 19: / Line 16: @@
 ==Parameters==
-<includeonly><templatedata></includeonly>{	"description": "","params": {
+<!--Search for Help:TemplateData if you need help formatting this-->
+<includeonly><templatedata>
+{
+	"description": "The template does X and is used when you want Y.",
+	"format": "inline",
+	"params": {
 		"parameter1": {
 			"label": "Fancy_Name",
-			"type": "Choose one of: number, string, line(single), content(wikitext), wiki-page-name, wiki-file-name, wiki-user-name.",
+			"type": "string",
 			"description": "Explanation",
 			"example": "Example_Input",
@@ Line 29: / Line 31: @@
 		"parameter2": {
 			"label": "Fancy_Name",
-			"type": "Choose one of: number, string, line(single), content(wikitext), wiki-page-name, wiki-file-name, wiki-user-name.",
+			"type": "string",
 			"description": "Explanation",
 			"example": "Example_Input",
 			"default": "Default_If_Static"
-	}}}</templatedata>
+		}
-<!--The following is a template with all options listed:
+	}
+}
+</templatedata></includeonly>
+<!--The following comment holds a template you can copy-paste or reference with all options listed-->
+<!--
 		},
-		"parameter": {
+		"parameterN": {
 			"label": "Fancy_Name",
 			"aliases": ["Other_Name1","Other_Name2"],
-			"type": "Choose one of: number, string, line(no line breaks), content(formatted wikitext), boolean, url(https://example.com), date, wiki-page-name, wiki-file-name, wiki-user-name, wiki-template-name.",
+			"type": "Choose one of: number, string, line(no line breaks), content(formatted wikitext), boolean, url(https://example.com), date, wiki-page-name, wiki-file-name, wiki-user-name, wiki-template-name",
 			"description": "Explanation",
 			"example": "Example_Input",
@@ Line 49: / Line 55: @@
 			"deprecated": "What_To_Use_Instead",
 			"inherits": "put another parameter name here to copy its properties (gets overwritten by new ones)",
-IMPORTANT, the text < }, > must be removed from the very first parameter you list. Also, the last option you have for every parameter must not end with a comma (so for example if <"default"> was the last one you need to do <"default": "Default_If_Static"> - notice the lack of a comma)-->
+-->
+<!-- ## IMPORTANT ##
+TemplateData uses JSON, if you don't know how to write JSON then heavily reference other template docs.
+Search for Help:TemplateData and read that page for more help.
+If you still can't figure out an error, save the page with the error and try notifying someone, maybe by adding [[Category:Maintenance]]-->
 ==Sample==
 The following input:
-<pre>{{Example|param=value|pa..}}</pre>
+<pre>
+{{Example|param=value|pa..}}
+</pre>
 Produces:
-{{Example|param=value|pa..}}
-<includeonly><</includeonly>noinclude>__NOTOC__ [[Category:Template Documentation]]<includeonly><</includeonly>/noinclude>
+<Example here>
-<includeonly><</includeonly>includeonly>__NOEDITSECTION__<includeonly><</includeonly>/includeonly>
+<includeonly><</includeonly>noinclude><includeonly>[[Category:Template documentation]]</includeonly><includeonly><</includeonly>/noinclude>
+<includeonly><</includeonly>includeonly>__NOEDITSECTION__
+<includeonly>[[Category:Templates]]</includeonly>
+<includeonly><</includeonly>/includeonly><noinclude>[[Category:Preload]]</noinclude>