×
Create a new article
Write your page title here:
We currently have 3,035 articles on YumeWiki. Type your article name above or click on one of the titles below and start writing!



YumeWiki
3,035Articles

Template:Documentation/preload: Difference between revisions

(remove syntax header, info can be put under usages)
(fix missing brace in templatedata, and reformat braces)
 
(2 intermediate revisions by the same user not shown)
Line 16: Line 16:


==Parameters==
==Parameters==
<includeonly><templatedata>{ "description": "SHORT DESCRIPTION HERE","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": {
"parameter1": {
"label": "Fancy_Name",
"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",
"description": "Explanation",
"example": "Example_Input",
"example": "Example_Input",
Line 26: Line 31:
"parameter2": {
"parameter2": {
"label": "Fancy_Name",
"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",
"description": "Explanation",
"example": "Example_Input",
"example": "Example_Input",
"default": "Default_If_Static"
"default": "Default_If_Static"
}}}</templatedata></includeonly>
}
<!--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",
"label": "Fancy_Name",
"aliases": ["Other_Name1","Other_Name2"],
"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",
"description": "Explanation",
"example": "Example_Input",
"example": "Example_Input",
Line 46: Line 55:
"deprecated": "What_To_Use_Instead",
"deprecated": "What_To_Use_Instead",
"inherits": "put another parameter name here to copy its properties (gets overwritten by new ones)",
"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==
==Sample==
The following input:
The following input:
<pre>{{Example|param=value|pa..}}</pre>
 
<pre>
{{Example|param=value|pa..}}
</pre>
 
Produces:
Produces:
Example here


<includeonly><</includeonly>noinclude><includeonly>__NOTOC__ [[Category:Template documentation]]</includeonly><includeonly><</includeonly>/noinclude>
<Example here>
<includeonly><</includeonly>includeonly>__NOEDITSECTION__<includeonly><</includeonly>/includeonly><noinclude>[[Template:Documentation]]
 
[[Category:Preload]]</noinclude>
<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>

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:

<Example here>

noinclude>/noinclude> includeonly>

/includeonly>