This is a mirror host of the KP Official Wiki on Miraheze. We dont actually mirror we host the same content

Template:Documentation/doc: Difference between revisions

From Kaiju Paradise Official Wiki
VisualWikitext
miraheze-user->FANDOM
No edit summary
 
miraheze-user->Aeywoo
 
Line 1: Line 1:
==Description==
<!-- you can remove this line and everything above it if you don't see any big bold red text -->
This template is used to insert descriptions on template pages.
;Description
 
:This template is used to insert documentation on template pages.
==Syntax==
;Syntax
Add <code><nowiki><noinclude></nowiki>{{t|Documentation}}<nowiki></noinclude></nowiki></code> at the end of the template page.
:Type <code>&lt;noinclude>{{T|Documentation}}&lt;/noinclude></code> at the end of the template page.
 
Add <code><nowiki><noinclude></nowiki>{{t|Documentation|documentation page}}<nowiki></noinclude></nowiki></code> to transclude an alternative page from the /doc subpage.
 
==Usage==
 
===On the Template page===
This is the normal format when used:


== General usage ==
=== On the Template page ===
<pre>
<pre>
TEMPLATE CODE
Template code<noinclude>
<includeonly>Any categories to be inserted into articles by the template</includeonly>
{{Documentation}}
<noinclude>{{Documentation}}</noinclude>
</noinclude>
</pre>
</pre>


''If your template is not a completed div or table, you may need to close the tags just before <code><nowiki>{{Documentation}}</nowiki></code> is inserted (within the noinclude tags).''
=== On the Template/doc page ===
 
''A line break right before <code><nowiki>{{Documentation}}</nowiki></code> can also be useful as it helps prevent the documentation template "running into" previous code.''
 
===On the documentation page===
The documentation page is usually located on the /doc subpage for a template, but a different page can be specified with the first parameter of the template (see [[#Syntax|Syntax]]).
 
Normally, you will want to write something like the following on the documentation page:
 
<pre>
<pre>
==Description==
;Description
This template is used to do something.
:This template is used to do something.
;Dependencies:
:* Uses (some CSS, JS, file, or other template).
;Syntax
:Type <code>{{T|Templatename}}</code> somewhere.
;Sample output
:<code>&lt;nowiki>{{Templatename|foo}}</nowiki></code> gives...
:{{Templatename|foo}}


==Syntax==
<includeonly>Any categories for the template itself
Type <code>{{t|templatename}}</code> somewhere.
</includeonly><noinclude>
 
[[Category:Template documentation]]
==Samples==
</noinclude>
<code>&lt;nowiki>{{templatename|input}}&lt;/nowiki></code>  
</pre>


results in...
Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or further usage information sections.


{{templatename|input}}
Note that the above example also uses {{T|T}}.
 
<includeonly>Any categories for the template itself</includeonly>
<noinclude>[[Category:Template documentation]]</noinclude>
</pre>


Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or other sections.
== Dependencies ==
;Templates
:[[Template:Documentation/preload]]
:[[Template:Documentation/preload-sandbox]]
:[[Template:Documentation/preload-testcases]]
:[[Template:Tocright]] ([[Template:Tocright/doc]])


Note that the above example also uses the [[Template:T]] template.
== TemplateData ==
<templatedata>
{
"params": {
"1": {
"description": "The name of the custom /doc subpage.",
"example": "Template:Documentation/doc",
"default": "{{FULLPAGENAME}}/doc",
"label": "Custom Documentation Location",
"type": "string"
},
"content": {
"description": "Content if documentation page will not be transcluded",
"example": "This template creates quotes.",
"label": "Inline Documentation Content",
"type": "string"
},
"sandbox": {
"label": "Custom Sandbox Location",
"description": "Specifies the /sandbox subpage location",
"example": "Template:Example/sandbox",
"type": "string",
"default": "{{FULLPAGENAME}}/sandbox"
},
"testcases": {
"label": "Custom Testcases Location",
"description": "Specifies the /testcases subpage location",
"example": "Template:Example/testcases",
"type": "string",
"default": "{{FULLPAGENAME}}/testcases"
},
        "heading": {
"label": "Heading text",
"description": "Changes the default \"Documentation\" header to a different one",
"example": "About this template",
"type": "string"
},
"footer": {
"label": "Custom footer content",
"description": "Replaces the default link box with a custom one",
"example": "Documentation is automatically generated by {{T|Ambox}}.<br/>Its contents are shown here.",
"type": "unbalanced-wikitext"
}
},
"description": "This template is used to display documentation on template pages. It also adds some tools to help the editor to modify the /doc subpage and the template."
}
</templatedata>


<includeonly>[[Category:Documentation templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>
<includeonly>[[Category:Documentation templates| ]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>

Latest revision as of 05:55, 21 January 2024

Description
This template is used to insert documentation on template pages.
Syntax
Type <noinclude>{{Documentation}}</noinclude> at the end of the template page.

General usage

On the Template page

Template code<noinclude>
{{Documentation}}
</noinclude>

On the Template/doc page

;Description
:This template is used to do something.
;Dependencies:
:* Uses (some CSS, JS, file, or other template).
;Syntax
:Type <code>{{T|Templatename}}</code> somewhere.
;Sample output
:<code><nowiki>{{Templatename|foo}}</nowiki></code> gives...
:{{Templatename|foo}}

<includeonly>Any categories for the template itself
</includeonly><noinclude>
[[Category:Template documentation]]
</noinclude>

Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or further usage information sections.

Note that the above example also uses {{T}}.

Dependencies

Templates
Template:Documentation/preload
Template:Documentation/preload-sandbox
Template:Documentation/preload-testcases
Template:Tocright (Template:Tocright/doc)

TemplateData

<templatedata> { "params": { "1": { "description": "The name of the custom /doc subpage.", "example": "Template:Documentation/doc", "default": "Template:Documentation/doc/doc", "label": "Custom Documentation Location", "type": "string" }, "content": { "description": "Content if documentation page will not be transcluded", "example": "This template creates quotes.", "label": "Inline Documentation Content", "type": "string" }, "sandbox": { "label": "Custom Sandbox Location", "description": "Specifies the /sandbox subpage location", "example": "Template:Example/sandbox", "type": "string", "default": "Template:Documentation/doc/sandbox" }, "testcases": { "label": "Custom Testcases Location", "description": "Specifies the /testcases subpage location", "example": "Template:Example/testcases", "type": "string", "default": "Template:Documentation/doc/testcases" }, 

       "heading": {

"label": "Heading text", "description": "Changes the default \"Documentation\" header to a different one", "example": "About this template", "type": "string" }, "footer": { "label": "Custom footer content", "description": "Replaces the default link box with a custom one", "example": "Documentation is automatically generated by {{Ambox}}.
Its contents are shown here.", "type": "unbalanced-wikitext" } }, "description": "This template is used to display documentation on template pages. It also adds some tools to help the editor to modify the /doc subpage and the template." } </templatedata>

Retrieved from "https://kpmir.wikihoster.xyz/index.php?title=Template:Documentation/doc&oldid=151"