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

From blackwiki
Jump to navigation Jump to search
imported>Funandtrvl
imported>Funandtrvl
(ce)
Line 2: Line 2:
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
  
This is the {{tl|high-risk}} message box.
+
This is the {{tl|high-risk}} message box. It is meant to be put at the top of the documentation page on the most high-use (high-risk) templates, i.e., for templates used on 100,000 pages or more. For templates used on 2,000–100,000 pages, it is recommended to use the {{tl|high-use}} template instead, which has a softer wording.
  
It is meant to be put at the top of the documentation for the most high-use (high-risk) templates. That is for templates used on 100,000 pages or more.
+
'''''Note:''''' It is normal that some of the links in the message box are red.  
 
 
For templates used on 2000 - 100,000 pages we instead recommend using {{tl|high-use}} which has a softer wording.
 
 
 
'''Note!''' It is normal that some of the links in the message box are red.  
 
  
 
=== Usage ===
 
=== Usage ===
 
 
The template can be used as is. But it can also take some parameters:  
 
The template can be used as is. But it can also take some parameters:  
 
* First parameter is the number of pages. See [[Wikipedia:Database reports/Templates with the most transclusions]] to find out how many pages use a given template.
 
* First parameter is the number of pages. See [[Wikipedia:Database reports/Templates with the most transclusions]] to find out how many pages use a given template.
 
* Second parameter is the name of some other talk page if you want discussion to be made there instead. But a better option might be to redirect the talkpage of your template to that other talkpage.
 
* Second parameter is the name of some other talk page if you want discussion to be made there instead. But a better option might be to redirect the talkpage of your template to that other talkpage.
  
Here are some examples:
+
===Examples===
 
 
 
<pre>
 
<pre>
 
{{high-risk| 300,000+ | Wikipedia talk:High-risk templates }}
 
{{high-risk| 300,000+ | Wikipedia talk:High-risk templates }}
Line 45: Line 39:
  
 
=== Technical details ===
 
=== 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.
 
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.
  

Revision as of 23:58, 24 April 2012

This is the {{high-risk}} message box. It is meant to be put at the top of the documentation page on the most high-use (high-risk) templates, i.e., for templates used on 100,000 pages or more. For templates used on 2,000–100,000 pages, it is recommended to use the {{high-use}} template instead, which has a softer wording.

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 Wikipedia:Database reports/Templates with the most transclusions to find out how many pages use a given template.
  • Second parameter is the name of some other talk page if you want discussion to be made there instead. But a better option might be to redirect the talkpage of your template to that other talkpage.

Examples

{{high-risk| 300,000+ | Wikipedia talk:High-risk templates }}
{{high-risk| 300,000+ }}
{{high-risk| | Wikipedia talk:High-risk templates }}

The full code for a /doc page top can look like this:

{{documentation subpage}}
{{high-risk| 300,000+ }}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->

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