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

From blackwiki
Jump to navigation Jump to search
imported>Guoguo12
(→‎Usage: Clarify)
imported>Guoguo12
(→‎Usage: Add)
Line 5: Line 5:
 
This template draws a progress bar using {{tl|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.
 
This template draws a progress bar using {{tl|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.
  
The example shown above uses [[:Category:Articles that need to be wikified from January 2009]]. The backlog started with 500 articles and the goal is to reach 0 articles.
+
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 2009]]. The backlog started with 500 articles and the goal is to reach 0 articles.
  
 
==Parameters==
 
==Parameters==

Revision as of 00:28, 1 May 2011

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 above uses Category:Articles that need to be wikified from February 2009. The backlog started with 500 articles and the goal is to reach 0 articles.

Parameters

Full version
{{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"

See also