Difference between revisions of "Template:Template Explanation/doc"

From Krafties
Jump to navigation Jump to search
(Keeping things for demonstration purposes. This template content is obsolete.)
 
m
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
{{Tag Attention|message=This template is no longer used since the parser functions and subpages were enabled so I could make a proper do proper documentations of how to use templates without cluttering the template page itself.
 +
This page remains as a explanation on how previous template used to function to hopefully clarify for some how to remove it and replace it with the <code>{{[[Template:Documentation|Documentation]]}}</code> as they migrate the information to the correct <code>/doc</code> subpages.
 +
<br>'''Since all Template Explanation templates now redirect and use the [[Template:Documentation|Documentation]] layout, you will find it already in place and providing a link to the <code>/doc</code> subpage in red link when it has yet to be created. Simply create the subpage and migrate the information that was originally within the 'template explanation' tags'''
 +
 +
Thank you dearly for your assistance }}
 +
 
[[Category:Templates]]
 
[[Category:Templates]]
 
:;This template does NOT automatically include the <code><nowiki><noinclude></nowiki></code>
 
:;This template does NOT automatically include the <code><nowiki><noinclude></nowiki></code>
Line 40: Line 46:
 
==See Also==
 
==See Also==
 
{{Useful Templates}}
 
{{Useful Templates}}
|}
 

Latest revision as of 08:53, 2 May 2017

<tag>...</tag>

This template does NOT automatically include the <noinclude>
And a reminder to myself and others why this template is as it is. It is so we can use | in the template explanation without needing to use {{!}} 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 include 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[edit]

  • You need to create the normal Table parameters yourself though, {| and |}, and insert this template within it at the top.
  • Also remember to have the template explanation tags within <noinclude> tags so it wont appear outside of the template-page itself.
{| {{Template Explanation}}
The information about specific template
|}
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[edit]

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
Help Templates and info
Tag/help General information about Tag templates
Table Cell Templates/help General information about Table Cell Templates
Multi-template directions
Navbox/help how to use the Navbox templates together
LearnSpell/help how to use the LearnSpell templates together

See Also[edit]