Saintapedia:Template documentation: Difference between revisions

Line 14: Line 14:


* '''Usage''':
* '''Usage''':
<pre>{{Documentation subpage}}</pre>
<pre>{{Documentation subpage}}</pre>
Place this at the start of the documentation subpage. It displays a notice stating that the page documents a template, with links to the template, its talk page, and (if available) sandbox or testcases.
 
Place this at the start of the documentation subpage. It displays a notice stating that the page documents a template, with links to the template, its talk page, and (if available) sandbox or testcases.
 
* '''Purpose''':
* '''Purpose''':
* Clarifies that the page is documentation, not a standalone article.
* Clarifies that the page is documentation, not a standalone article.
* Encourages editors to discuss improvements on the template’s talk page.
* Encourages editors to discuss improvements on the template’s talk page.
* Supports testing in a sandbox to avoid breaking live templates.
* Supports testing in a sandbox to avoid breaking live templates.
* '''Example''': For a template named `{{tlx|Infobox saint}}`, the documentation page at `Template:Infobox saint/doc` would start with:
* '''Example''': For a template named `{{tlx|Infobox saint}}`, the documentation page at `Template:Infobox saint/doc` would start with:
<pre>{{tlx|Documentation subpage}}</pre>
<pre>{{tlx|Documentation subpage}}</pre>
Followed by sections explaining the template’s purpose, parameters, and usage.
Followed by sections explaining the template’s purpose, parameters, and usage.


== Creating Template Documentation ==
== Creating Template Documentation ==