Template:Documentation/doc: Difference between revisions

>Default
No edit summary
 
>FANDOM
m 1 revision: Updates made for portability
 
Line 4: Line 4:
==Syntax==
==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}}<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.


==Usage==
==Usage==
Line 19: Line 21:
''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.''
''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 Template/doc page===
===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:
Normally, you will want to write something like the following on the documentation page: