Difference between revisions of "Template:Backlog progress bar/doc"

From blackwiki
Jump to navigation Jump to search
imported>Guoguo12
(Update example category)
imported>Vanisaac
m (→‎Parameters: clean up per WP:CAT#T and WP:AWBREQ add template:Sandbox other)
 
(3 intermediate revisions by 2 users not shown)
Line 7: Line 7:
 
At the end of the drive, if the statistics are to be preserved as they are, one must first [[WP:SUBST|substitute]] the template, then substitute the two PAGESINCATEGORY [[WP:MAGICWORD|magic words]] within. Invisible comments have been added to the code to make this process easier.  
 
At the end of the drive, if the statistics are to be preserved as they are, one must first [[WP:SUBST|substitute]] the template, then substitute the two PAGESINCATEGORY [[WP:MAGICWORD|magic words]] within. Invisible comments have been added to the code to make this process easier.  
  
The example shown above uses [[:Category:Articles that need to be wikified from February 2011]]. The backlog started with 500 articles and the goal is to reach 0 articles.
+
The example shown below uses [[:Category:Articles that need to be wikified from February 2011]]. The backlog started with 500 articles and the goal is to reach 0 articles.
  
 +
{{Backlog progress bar|initial=500 |goal=0 |category=Category:Articles that need to be wikified from February 2011}}
 
==Parameters==
 
==Parameters==
;Full version:
+
:{{tlc|Backlog progress bar|initial{{=}} |goal{{=}} |category{{=}} |unit{{=}} }}
<code><nowiki>{{Backlog progress bar|initial= |goal= |category= |unit= }}</nowiki></code>
 
  
 
;Required fields:
 
;Required fields:
Line 20: Line 20:
 
*'''unit''': Unit used, defaults to "articles"
 
*'''unit''': Unit used, defaults to "articles"
  
=== See also ===
+
{{Progress templates}}
* {{tl|Percentage bar}}
 
* {{tl|Percent-done}}
 
* {{tl|Progress}}
 
* {{t1|Progress bar}}
 
* {{tl|Progress box}}
 
* {{tl|Progress meter}}
 
  
<includeonly>
+
<includeonly>{{Sandbox other||
 
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
 
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
 
[[Category:Wikipedia utility templates]]
 
[[Category:Wikipedia utility templates]]
</includeonly>
+
}}</includeonly>

Latest revision as of 23:32, 23 April 2020

Usage

This template draws a progress bar using {{Progression}} and displays a statistics box. It differs from the original bar in that is designed for use in backlog category elimination drives; as articles are removed from the category specified, the percentage goes up based on the original population (e.g., at the start of the drive) and the goal.

At the end of the drive, if the statistics are to be preserved as they are, one must first substitute the template, then substitute the two PAGESINCATEGORY magic words within. Invisible comments have been added to the code to make this process easier.

The example shown below uses Category:Articles that need to be wikified from February 2011. The backlog started with 500 articles and the goal is to reach 0 articles.


Template:Progression Backlog: Category:Articles that need to be wikified from February 2011
Goal: 0 articles
Current: 0 articles
Initial: 500 articles
Script error: No such module "Purge".

Parameters

{{Backlog progress bar|initial=|goal=|category=|unit=}}
Required fields
  • initial: Initial backlog population (e.g., at the start of the drive)
  • category: Backlog category, omitting the "Category:" prefix
Optional fields
  • goal: Target category population, defaults to "0"
  • unit: Unit used, defaults to "articles"

Template:Progress templates