Template:Documentation/doc: Difference between revisions

Use {{Shortcut}}
 
(Use {{Shortcut}})
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{Shortcut|doc|template=1}}
The <code><nowiki>{{documentation}}</nowiki></code> template is used to contain the documented information and instructions of a certain template, usually from a /doc subpage. It can also be configured to load the content from other pages or be directly fed by text.
The <code><nowiki>{{documentation}}</nowiki></code> template is used to contain the documented information and instructions of a certain template, usually from a /doc subpage. It can also be configured to load the content from other pages or be directly fed by text.


Line 48: Line 49:
* Template namespace: [[File:Template-info.svg|x24px]] Template Documentation
* Template namespace: [[File:Template-info.svg|x24px]] Template Documentation
* Module namespace: [[File:Template-info.svg|x24px]] Module Documentation
* Module namespace: [[File:Template-info.svg|x24px]] Module Documentation
* Other namespaces: Page Documentation
* Other namespaces: [[File:Template-info.svg|x24px]] Page Documentation


To change the word before "Documentation", simply set the parameter <code>|type=</code> to anything you like, for example <code>|type=Infobox</code>.
To change the word before "Documentation", simply set the parameter <code>|type=</code> to anything you like, for example <code>|type=Infobox</code>.
Line 66: Line 67:


== Automatic functions ==
== Automatic functions ==
If the documentation page does not exist, the body of the documentation box will say "Documentation page ''<u>link to doc</u>'' doesn't exist. Click the link to create one!" where ''<u>link to doc</u>'' is a red link to the wanted page. The toolbar is not shown in this case.
If the documentation page does not exist, the body of the documentation box will say "Documentation page ''<u>link to doc</u>'' doesn't exist. Click the link to create it!" where ''<u>link to doc</u>'' is a red link to the wanted page. The toolbar is not shown in this case.<!--


== Template alias ==
--><includeonly>
* {{noredirect|Template:Doc}}
[[Category:Documentation templates]]
 
</includeonly><noinclude>
<includeonly>{{#ifeq:{{FULLPAGENAME}}|Template:Documentation|
[[Category:Template documentation]]
[[Category:Documentation templates| ]]
</noinclude>
}}</includeonly>
420

edits