Difference between revisions of "Template:High-use/doc"

← Older edit

Template:High-use/doc (view source)

Revision as of 15:12, 3 February 2009

2,176 bytes added , 15:12, 3 February 2009

m

1 revision

Budlight

Bots, Bureaucrats, Administrators

529

edits

@@ Line 1: / Line 1: @@
-{{{{{subst|}}}p{{{{{subst|}}}#ifeq:{{{1}}}|eq|1|2}}|{{{{{subst|}}}p{{{{{subst|}}}#ifeq:{{{2}}}|{{{3}}}|1|2}}|{{{4|}}}|{{{5}}}}}|{{{{{subst|}}}p{{{{{subst|}}}#if{{{1}}}:{{{2}}}|1|2}}|{{{3}}}|{{{4|}}}}}}}<noinclude>{{documentation}}</noinclude>
+{{Documentation subpage}}
+<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
+This is the {{tl|high-use}} message box.
+It is meant to be put at the top of the documentation for the most high-use (high-risk) templates.
+'''Note!''' It is normal that some of the links in the message box are red.
+=== Usage ===
+The template can be used as is. But it can also take some parameters:
+* First parameter is the number of pages. See [[Special:MostLinkedTemplates]] to find out how many pages use your template. If your template is not listed on the first or second page there, then you probably should not use this message box.
+* Second parameter is the name of some other talk page if you want discussion to be made there instead. A better option might be to redirect the talkpage of your template to that other talkpage.
+Here are some examples:
+<pre>
+{{high-use| 300,000+ | Wikipedia talk:High-risk templates }}
+</pre>
+{{high-use| 300,000+ | Wikipedia talk:High-risk templates }}
+<pre>
+{{high-use| 300,000+ }}
+</pre>
+{{high-use| 300,000+ }}
+<pre>
+{{high-use| | Wikipedia talk:High-risk templates }}
+</pre>
+{{high-use| | Wikipedia talk:High-risk templates }}
+When this template is placed on a template's /doc page it can be nice to put it within <code>&lt;includeonly></code> tags so it only gets visible on the template page. The full code for a /doc page top then can look like this:
+<pre>
+{{Documentation subpage}}
+<includeonly>{{high-use| 300,000+ }}</includeonly>
+<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
+</pre>
+=== Technical details ===
+The [[/sandbox]] and [[/testcases]] links are the standard names for such subpages. If those pages are created then the green /doc box for the template will detect them and link to them in its heading. For instance see the top of this documentation.
+=== See also ===
+* {{tl|intricate template}}
+* [[Wikipedia:Template test cases]]
+* [[Wikipedia:High-risk templates]]
+* {{tlx|pp-template|2=small=yes}} – The protection template that usually is put on high-use templates.
+<includeonly>
+<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
+[[Category:Template namespace templates|{{PAGENAME}}]]
+[[cs:Šablona:Tisíckrát]]
+[[dsb:Pśedłoga:Cesto wužywana]]
+[[eo:Ŝablono:Ofte uzata]]
+[[hsb:Předłoha:Často wužiwana]]
+[[ja:Template:使用箇所の多いテンプレート]]
+[[ru:Template:СИШ]]
+</includeonly>