×
Create a new article
Write your page title here:
We currently have 2,623 articles on Yume Nikki Fangames Wiki. Type your article name above or click on one of the titles below and start writing!



Yume Nikki Fangames Wiki

Template:Documentation/doc: Difference between revisions

>Default
No edit summary
 
(from YumeWiki)
 
Line 1: Line 1:
;Description
==Description==
:This template is used to insert descriptions on template pages.
This template is used to insert descriptions on template pages.
;Syntax
 
:Type <code><nowiki><noinclude></nowiki>{{t|documentation}}<nowiki></noinclude></nowiki></code> at the end of the template page.
==Syntax==
Add <code><nowiki><noinclude></nowiki>{{t|Documentation}}<nowiki></noinclude></nowiki></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. In this case the /doc subpage must still exist (perhaps as a redirect).
 
==Usage==
 
===On the template page===
This is the normal format used:


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


Note that, depending on the template, you may need to add a clear or complete a table/div just before <code><nowiki>{{documentation}}</nowiki></code> is inserted (within the noinclude tags).
===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]]).


The line break is also useful as it helps prevent the documentation template "running into" previous code.
Normally, you will want to write something like the following on the documentation page:


===On the Template/doc page===
<pre>
<pre>
;Description
==Description==
:This template is used to do something.
This template is used to do something.
;Syntax
 
:Type <code>{{t|templatename}}</code> somewhere.
==Syntax==
;Sample output
Type <code>{{t|templatename}}</code> somewhere.
:<code>&lt;nowiki>{{templatename|foo}}&lt;/nowiki></code> gives...
 
:{{templatename|foo}}
==Sample==
<code>&lt;nowiki>{{templatename|input}}&lt;/nowiki></code>  
 
results in...
 
{{templatename|input}}


<includeonly>Any categories for the template itself</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
<noinclude>__NOTOC__ [[Category:Template documentation]]</noinclude>
<includeonly>__NOEDITSECTION__
(Any categories for the template itself)
</includeonly>
</pre>
</pre>


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 the [[Template:T]] template.


Note that the above example also uses the [[Template:T]] and [[Template:T/piece]] templates.
===Preload===
If the template is used on a template page, but the /doc subpage does not exist, a link will be available that loads [[Template:Documentation/preload]]. This allows users to create the documentation with a suggested format already provided. Note that it is not an absolute requirement to use any particular structure. As long as it is understandable and covers all needed information, it is good documentation.


<includeonly>[[Category:General wiki templates|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
<noinclude>__NOTOC__ [[Category:Template documentation]]</noinclude>
<includeonly>__NOEDITSECTION__
[[Category:Documentation templates]]
</includeonly>

Latest revision as of 09:46, 29 July 2024

Description

This template is used to insert descriptions on template pages.

Syntax

Add <noinclude>{{Documentation}}</noinclude> at the end of the template page.

Add <noinclude>{{Documentation|<documentation page>}}</noinclude> to transclude an alternative page from the /doc subpage. In this case the /doc subpage must still exist (perhaps as a redirect).

Usage

On the template page

This is the normal format used:

TEMPLATE CODE
<noinclude>
{{Documentation}}
</noinclude>

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).

Normally, you will want to write something like the following on the documentation page:

==Description==
This template is used to do something.

==Syntax==
Type <code>{{t|templatename}}</code> somewhere.

==Sample==
<code><nowiki>{{templatename|input}}</nowiki></code> 

results in...

{{templatename|input}}

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

Note that the above example also uses the Template:T template.

Preload

If the template is used on a template page, but the /doc subpage does not exist, a link will be available that loads Template:Documentation/preload. This allows users to create the documentation with a suggested format already provided. Note that it is not an absolute requirement to use any particular structure. As long as it is understandable and covers all needed information, it is good documentation.