Difference between revisions of "Template:Documentation/doc"

From Krafties
Jump to navigation Jump to search
m
m
Line 1: Line 1:
[[Category:Templates]]
+
{{Documentation subpage}}
;Documentation will not automatically be excluded when templates are used
+
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
 +
This template should be added to the bottom of every template page to easily add and access it's documentation.
 +
== Usage ==
 +
<pre><noinclude>{{Documentation}}</noinclude></Pre>
  
===Redirected Templates===
+
Here is an example of how a <code>/doc</code> subpage setup should look like to be proper.
The following templates redirect here (therefor automatically become this template), but it would be prefered if they would be replaced with <code>{{[[Template:Documentation|Documentation]]}}</code> when editing templates.
+
<pre>
#[[Template:Template Explanation]]
+
{{Documentation subpage}}
#[[Template:TemplateExplanation]]
+
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
  
===Using the "help templates" for repeating information===
+
== Usage ==
When multiple templates function identically, then it can be tedious to fill in repeating information. Thats why I have made a few ''help-templates''
+
 
*Please add any template specific information before the ''help template''
+
== See also ==
*Insert the appropriate ''help template'' at the end, '''within''' the Explanation section
+
 
{|class=bluetable style="width:700px"
+
<includeonly>
<!-- GENERAL HELP TEMPLATES -->
+
{{language}}
!colspan=2|Help Templates and info
+
<!-- Categories go here, and interwikis go here -->
|-
+
[[Category:Template documentation]]
|[[Template:Tag/help|Tag/help]] ||General information about [[Template:Tag|Tag]] templates
+
</includeonly>
|-
+
</pre>
|[[Template:Table Cell Templates/help|Table Cell Templates/help]] ||General information about [[Template:Table Cell Templates|Table Cell Templates]]
+
 
|-
+
== See also ==
<!-- MULTI-TEMPLATES -->
+
 
!colspan=2|Multi-template directions
+
<includeonly>
|-
+
{{language}}
|[[Template:Navbox/help|Navbox/help]] || how to use the [[Template:Navbox|Navbox]] templates together
+
<!-- Categories go here, and interwikis go here -->
|-
+
[[Category:Template documentation]]
|[[Template:LearnSpell/help|LearnSpell/help]] || how to use the [[Template:LearnSpell|LearnSpell]] templates together
+
</includeonly>
|}
 
==See Also==
 
{{Useful Templates}}
 

Revision as of 07:56, 3 May 2017

This is a documentation subpage for Template:Documentation.
It contains usage information, categories and other content that is not part of the original template page.

This template should be added to the bottom of every template page to easily add and access it's documentation.

Usage

<noinclude>{{Documentation}}</noinclude>

Here is an example of how a /doc subpage setup should look like to be proper.

{{Documentation subpage}}
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->

== Usage ==

== See also ==

<includeonly>
{{language}}
<!-- Categories go here, and interwikis go here -->
[[Category:Template documentation]]
</includeonly>

See also