Template:High-use/doc
This page will only parse completely when it is included in another page.
[template]Documentation subpage[/template]
This is the [template]tl|high-use[/template] message box.
It can be put at the top of the documentation for any high-use or high-risk template.
[b]Note![/b] It is normal that some of the links in the message box are red.
[h="3"] Usage [/h]
The template can be used as is. But it can also take some parameters:
[list][*] First parameter is the number of pages. See [special]MostLinkedTemplates[/special] to find out how many pages use your template.
[*] 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.
[/redirect]
Here are some examples:
<div class="bbcode_container"> <div class="bbcode_description">Code:</div> <pre class="bbcode_code" style="height:36px;">{{high-use| 300,000+ | BrWiki talk:High-risk templates }}</pre></div>[template]high-use| 300,000+ | BrWiki talk:High-risk templates [/template]
<div class="bbcode_container"> <div class="bbcode_description">Code:</div> <pre class="bbcode_code" style="height:36px;">{{high-use| 300,000+ }}</pre></div>[template]high-use| 300,000+ [/template]
<div class="bbcode_container"> <div class="bbcode_description">Code:</div> <pre class="bbcode_code" style="height:36px;">{{high-use| | BrWiki talk:High-risk templates }}</pre></div>[template]high-use| | BrWiki talk:High-risk templates [/template]
When this template is placed on a template's /doc page it can be nice to put it within <code><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:
<div class="bbcode_container"> <div class="bbcode_description">Code:</div> <pre class="bbcode_code" style="height:60px;">{{Documentation subpage}}<br /><includeonly>{{high-use 4; 300,000+ }}</includeonly><br />[comment] PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE [/comment]</pre></div>=== Technical details ===
The [wiki]/sandbox[/wiki] and [wiki]/testcases[/wiki] 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.
[h="3"] See also [/h]
[list][*] [template]tl|intricate template[/template]
[*] [brwiki]Template test cases[/brwiki]
[*] [brwiki]High-risk templates[/brwiki]
[*] [template]tlx|pp-template|2=small=yes[/template] ? The protection template that usually is put on high-use templates.
[/redirect]
This is the [template]tl|high-use[/template] message box.
It can be put at the top of the documentation for any high-use or high-risk template.
[b]Note![/b] It is normal that some of the links in the message box are red.
[h="3"] Usage [/h]
The template can be used as is. But it can also take some parameters:
[list][*] First parameter is the number of pages. See [special]MostLinkedTemplates[/special] to find out how many pages use your template.
[*] 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.
[/redirect]
Here are some examples:
<div class="bbcode_container"> <div class="bbcode_description">Code:</div> <pre class="bbcode_code" style="height:36px;">{{high-use| 300,000+ | BrWiki talk:High-risk templates }}</pre></div>[template]high-use| 300,000+ | BrWiki talk:High-risk templates [/template]
<div class="bbcode_container"> <div class="bbcode_description">Code:</div> <pre class="bbcode_code" style="height:36px;">{{high-use| 300,000+ }}</pre></div>[template]high-use| 300,000+ [/template]
<div class="bbcode_container"> <div class="bbcode_description">Code:</div> <pre class="bbcode_code" style="height:36px;">{{high-use| | BrWiki talk:High-risk templates }}</pre></div>[template]high-use| | BrWiki talk:High-risk templates [/template]
When this template is placed on a template's /doc page it can be nice to put it within <code><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:
<div class="bbcode_container"> <div class="bbcode_description">Code:</div> <pre class="bbcode_code" style="height:60px;">{{Documentation subpage}}<br /><includeonly>{{high-use 4; 300,000+ }}</includeonly><br />[comment] PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE [/comment]</pre></div>=== Technical details ===
The [wiki]/sandbox[/wiki] and [wiki]/testcases[/wiki] 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.
[h="3"] See also [/h]
[list][*] [template]tl|intricate template[/template]
[*] [brwiki]Template test cases[/brwiki]
[*] [brwiki]High-risk templates[/brwiki]
[*] [template]tlx|pp-template|2=small=yes[/template] ? The protection template that usually is put on high-use templates.
[/redirect]
Contributors: | ,
Created by Last edited by , 10-23-2011 at 02:14 PM 0 Comments, 1,395 Views |
, 11-23-2008 at 08:42 PM
Tags for this Page
Similar Pages
-
High-use
By Arjan in forum TemplateComments: 0Last Post: 11-23-2008, 08:41 PM -
High Proselytizer (Epic Class)
By Arjan in forum D20 system reference documentComments: 0Last Post: 05-20-2007, 09:41 AM
Bookmarks