Difference between revisions of "Template:Template Explanation"

From Krafties
Jump to navigation Jump to search
m (Redirected page to Template:Documentation)
m (Replaced content with "#REDIRECT Template:Documentation")
 
Line 1: Line 1:
 
#REDIRECT [[Template:Documentation]]
 
#REDIRECT [[Template:Documentation]]
{|<onlyinclude>class="pinktable mw-collapsible" style="width:100%;background:white;"
 
!{{{title|Template Explanation}}}
 
|-
 
|style="{{{style|padding-left:10px;}}}" |{{TOC none}}</onlyinclude>
 
<noinclude>contents</noinclude>
 
|}
 
 
{|{{Template Explanation}}[[Category:Templates]]
 
:;This template does NOT automatically include the <code><nowiki><noinclude></nowiki></code>
 
:And a reminder to myself and others why this template is as it is. It is so we can use <code>|</code> in the template explanation without needing to use <code><nowiki>{{!}}</nowiki></code> constantly (normally it can break a template when used within template parameters).
 
The ''Template Explanation'' is for creating a obvious explanation section on the template page itself which is easy to identify. Within it should be the details about the specific template and how to use it.
 
 
There are various ways the <code>include</code> tags are used to direct what content displays when templates are used, thats why it has not been automatically included on this template. That is why you need to be sure that the ''Template Explanation'' is located in the appropriate place so it wont also appear when template is used.
 
 
==How to use "Template Explanation" template==
 
*You need to '''create the normal Table parameters''' yourself though, <code><nowiki>{|</nowiki></code> and <code><nowiki>|}</nowiki></code>, and insert this template within it at the top.
 
*Also remember to have the ''template explanation'' tags within <code><nowiki><noinclude></nowiki></code> tags so it wont appear outside of the template-page itself.
 
<pre>
 
{| {{Template Explanation}}
 
The information about specific template
 
|}
 
</pre>
 
 
:;Optional commands for the ''Template Explanation''
 
:*'''title=''' will let you change the text in the header
 
:*'''style=''' lets you customize the styling of the content cell (to change padding and such).
 
 
===Using the "help templates" for repeating information===
 
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''
 
*Insert the appropriate ''help template'' at the end, '''within''' the Explanation section
 
{|class=bluetable style="width:700px"
 
<!-- GENERAL HELP TEMPLATES -->
 
!colspan=2|Help Templates and info
 
|-
 
|[[Template:Tag/help|Tag/help]] ||General information about [[Template:Tag|Tag]] templates
 
|-
 
|[[Template:Table Cell Templates/help|Table Cell Templates/help]] ||General information about [[Template:Table Cell Templates|Table Cell Templates]]
 
|-
 
<!-- MULTI-TEMPLATES -->
 
!colspan=2|Multi-template directions
 
|-
 
|[[Template:Navbox/help|Navbox/help]] || how to use the [[Template:Navbox|Navbox]] templates together
 
|-
 
|[[Template:LearnSpell/help|LearnSpell/help]] || how to use the [[Template:LearnSpell|LearnSpell]] templates together
 
|}
 
==See Also==
 
{{Useful Templates}}
 
|}
 

Latest revision as of 06:59, 2 May 2017